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>

Rtmp Group Settings

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
List<RtmpAdMarkers>	adMarkers() Choose the ad marker type for this output group.
List<String>	adMarkersAsStrings() Choose the ad marker type for this output group.
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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdMarkers() For responses, this returns true if the service returned a value for the AdMarkers property.
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()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

adMarkers

public final List<RtmpAdMarkers> adMarkers()

Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdMarkers() method.

Returns:

Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

hasAdMarkers

public final boolean hasAdMarkers()

For responses, this returns true if the service returned a value for the AdMarkers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

adMarkersAsStrings

public final List<String> adMarkersAsStrings()

Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdMarkers() method.

Returns:

Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

authenticationScheme

public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<RtmpGroupSettings.Builder,RtmpGroupSettings>

builder

public static RtmpGroupSettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo