software.amazon.awssdk.services.medialive.model

Class RtmpGroupSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.RtmpGroupSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RtmpGroupSettings.Builder,RtmpGroupSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class RtmpGroupSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RtmpGroupSettings.Builder,RtmpGroupSettings>

Placeholder documentation for RtmpGroupSettings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RtmpGroupSettings.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticationScheme	authenticationScheme() Authentication scheme to use when connecting with CDN
String	authenticationSchemeAsString() Authentication scheme to use when connecting with CDN
static RtmpGroupSettings.Builder	builder()
RtmpCacheFullBehavior	cacheFullBehavior() Controls behavior when content cache fills up.
String	cacheFullBehaviorAsString() Controls behavior when content cache fills up.
Integer	cacheLength() Cache length, in seconds, is used to calculate buffer size.
RtmpCaptionData	captionData() Controls the types of data that passes to onCaptionInfo outputs.
String	captionDataAsString() Controls the types of data that passes to onCaptionInfo outputs.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputLossActionForRtmpOut	inputLossAction() Controls the behavior of this RTMP group if input becomes unavailable.
String	inputLossActionAsString() Controls the behavior of this RTMP group if input becomes unavailable.
Integer	restartDelay() If a streaming output fails, number of seconds to wait until a restart is initiated.
List<SdkField<?>>	sdkFields()
static Class<? extends RtmpGroupSettings.Builder>	serializableBuilderClass()
RtmpGroupSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authenticationScheme

public AuthenticationScheme authenticationScheme()

Authentication scheme to use when connecting with CDN

If the service returns an enum value that is not available in the current SDK version, authenticationScheme will return AuthenticationScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationSchemeAsString().

Returns:

Authentication scheme to use when connecting with CDN

See Also:

AuthenticationScheme

authenticationSchemeAsString

public String authenticationSchemeAsString()

Authentication scheme to use when connecting with CDN

If the service returns an enum value that is not available in the current SDK version, authenticationScheme will return AuthenticationScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationSchemeAsString().

Returns:

Authentication scheme to use when connecting with CDN

See Also:

AuthenticationScheme

cacheFullBehavior

public RtmpCacheFullBehavior cacheFullBehavior()

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

If the service returns an enum value that is not available in the current SDK version, cacheFullBehavior will return RtmpCacheFullBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheFullBehaviorAsString().

Returns:

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

See Also:

RtmpCacheFullBehavior

cacheFullBehaviorAsString

public String cacheFullBehaviorAsString()

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

If the service returns an enum value that is not available in the current SDK version, cacheFullBehavior will return RtmpCacheFullBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheFullBehaviorAsString().

Returns:

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

See Also:

RtmpCacheFullBehavior

cacheLength

public Integer cacheLength()

Cache length, in seconds, is used to calculate buffer size.

Returns:

Cache length, in seconds, is used to calculate buffer size.

captionData

public RtmpCaptionData captionData()

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

If the service returns an enum value that is not available in the current SDK version, captionData will return RtmpCaptionData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionDataAsString().

Returns:

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

See Also:

RtmpCaptionData

captionDataAsString

public String captionDataAsString()

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

If the service returns an enum value that is not available in the current SDK version, captionData will return RtmpCaptionData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionDataAsString().

Returns:

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

See Also:

RtmpCaptionData

inputLossAction

public InputLossActionForRtmpOut inputLossAction()

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

If the service returns an enum value that is not available in the current SDK version, inputLossAction will return InputLossActionForRtmpOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().

Returns:

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

See Also:

InputLossActionForRtmpOut

inputLossActionAsString

public String inputLossActionAsString()

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

If the service returns an enum value that is not available in the current SDK version, inputLossAction will return InputLossActionForRtmpOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().

Returns:

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

See Also:

InputLossActionForRtmpOut

restartDelay

public Integer restartDelay()

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

Returns:

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

toBuilder

public RtmpGroupSettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RtmpGroupSettings.Builder,RtmpGroupSettings>

Returns:

a builder for type T

builder

public static RtmpGroupSettings.Builder builder()

serializableBuilderClass

public static Class<? extends RtmpGroupSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.