com.amazonaws.services.medialive.model

Class RtmpGroupSettings

java.lang.Object

com.amazonaws.services.medialive.model.RtmpGroupSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RtmpGroupSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Rtmp Group Settings

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RtmpGroupSettings()

Method Summary

Modifier and Type	Method and Description
RtmpGroupSettings	clone()
boolean	equals(Object obj)
List<String>	getAdMarkers() Choose the ad marker type for this output group.
String	getAuthenticationScheme() Authentication scheme to use when connecting with CDN
String	getCacheFullBehavior() Controls behavior when content cache fills up.
Integer	getCacheLength() Cache length, in seconds, is used to calculate buffer size.
String	getCaptionData() Controls the types of data that passes to onCaptionInfo outputs.
String	getIncludeFillerNalUnits() Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate).
String	getInputLossAction() Controls the behavior of this RTMP group if input becomes unavailable.
Integer	getRestartDelay() If a streaming output fails, number of seconds to wait until a restart is initiated.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAdMarkers(Collection<String> adMarkers) Choose the ad marker type for this output group.
void	setAuthenticationScheme(String authenticationScheme) Authentication scheme to use when connecting with CDN
void	setCacheFullBehavior(String cacheFullBehavior) Controls behavior when content cache fills up.
void	setCacheLength(Integer cacheLength) Cache length, in seconds, is used to calculate buffer size.
void	setCaptionData(String captionData) Controls the types of data that passes to onCaptionInfo outputs.
void	setIncludeFillerNalUnits(String includeFillerNalUnits) Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate).
void	setInputLossAction(String inputLossAction) Controls the behavior of this RTMP group if input becomes unavailable.
void	setRestartDelay(Integer restartDelay) If a streaming output fails, number of seconds to wait until a restart is initiated.
String	toString() Returns a string representation of this object.
RtmpGroupSettings	withAdMarkers(Collection<String> adMarkers) Choose the ad marker type for this output group.
RtmpGroupSettings	withAdMarkers(RtmpAdMarkers... adMarkers) Choose the ad marker type for this output group.
RtmpGroupSettings	withAdMarkers(String... adMarkers) Choose the ad marker type for this output group.
RtmpGroupSettings	withAuthenticationScheme(AuthenticationScheme authenticationScheme) Authentication scheme to use when connecting with CDN
RtmpGroupSettings	withAuthenticationScheme(String authenticationScheme) Authentication scheme to use when connecting with CDN
RtmpGroupSettings	withCacheFullBehavior(RtmpCacheFullBehavior cacheFullBehavior) Controls behavior when content cache fills up.
RtmpGroupSettings	withCacheFullBehavior(String cacheFullBehavior) Controls behavior when content cache fills up.
RtmpGroupSettings	withCacheLength(Integer cacheLength) Cache length, in seconds, is used to calculate buffer size.
RtmpGroupSettings	withCaptionData(RtmpCaptionData captionData) Controls the types of data that passes to onCaptionInfo outputs.
RtmpGroupSettings	withCaptionData(String captionData) Controls the types of data that passes to onCaptionInfo outputs.
RtmpGroupSettings	withIncludeFillerNalUnits(IncludeFillerNalUnits includeFillerNalUnits) Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate).
RtmpGroupSettings	withIncludeFillerNalUnits(String includeFillerNalUnits) Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate).
RtmpGroupSettings	withInputLossAction(InputLossActionForRtmpOut inputLossAction) Controls the behavior of this RTMP group if input becomes unavailable.
RtmpGroupSettings	withInputLossAction(String inputLossAction) Controls the behavior of this RTMP group if input becomes unavailable.
RtmpGroupSettings	withRestartDelay(Integer restartDelay) If a streaming output fails, number of seconds to wait until a restart is initiated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RtmpGroupSettings

public RtmpGroupSettings()

Method Detail

getAdMarkers

public List<String> getAdMarkers()

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.

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.

See Also:

RtmpAdMarkers

setAdMarkers

public void setAdMarkers(Collection<String> 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.

Parameters:

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.

See Also:

RtmpAdMarkers

withAdMarkers

public RtmpGroupSettings withAdMarkers(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setAdMarkers(java.util.Collection) or withAdMarkers(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpAdMarkers

withAdMarkers

public RtmpGroupSettings withAdMarkers(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpAdMarkers

withAdMarkers

public RtmpGroupSettings withAdMarkers(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpAdMarkers

setAuthenticationScheme

public void setAuthenticationScheme(String authenticationScheme)

Authentication scheme to use when connecting with CDN

Parameters:

authenticationScheme - Authentication scheme to use when connecting with CDN

See Also:

AuthenticationScheme

getAuthenticationScheme

public String getAuthenticationScheme()

Authentication scheme to use when connecting with CDN

Returns:

Authentication scheme to use when connecting with CDN

See Also:

AuthenticationScheme

withAuthenticationScheme

public RtmpGroupSettings withAuthenticationScheme(String authenticationScheme)

Authentication scheme to use when connecting with CDN

Parameters:

authenticationScheme - Authentication scheme to use when connecting with CDN

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationScheme

withAuthenticationScheme

public RtmpGroupSettings withAuthenticationScheme(AuthenticationScheme authenticationScheme)

Authentication scheme to use when connecting with CDN

Parameters:

authenticationScheme - Authentication scheme to use when connecting with CDN

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationScheme

setCacheFullBehavior

public void setCacheFullBehavior(String 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.

Parameters:

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.

See Also:

RtmpCacheFullBehavior

getCacheFullBehavior

public String getCacheFullBehavior()

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.

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

withCacheFullBehavior

public RtmpGroupSettings withCacheFullBehavior(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpCacheFullBehavior

withCacheFullBehavior

public RtmpGroupSettings withCacheFullBehavior(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpCacheFullBehavior

setCacheLength

public void setCacheLength(Integer cacheLength)

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

Parameters:

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

getCacheLength

public Integer getCacheLength()

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

Returns:

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

withCacheLength

public RtmpGroupSettings withCacheLength(Integer cacheLength)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCaptionData

public void setCaptionData(String 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.

Parameters:

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.

See Also:

RtmpCaptionData

getCaptionData

public String getCaptionData()

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.

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

withCaptionData

public RtmpGroupSettings withCaptionData(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpCaptionData

withCaptionData

public RtmpGroupSettings withCaptionData(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RtmpCaptionData

setInputLossAction

public void setInputLossAction(String 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.

Parameters:

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.

See Also:

InputLossActionForRtmpOut

getInputLossAction

public String getInputLossAction()

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.

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

withInputLossAction

public RtmpGroupSettings withInputLossAction(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InputLossActionForRtmpOut

withInputLossAction

public RtmpGroupSettings withInputLossAction(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InputLossActionForRtmpOut

setRestartDelay

public void setRestartDelay(Integer restartDelay)

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

Parameters:

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

getRestartDelay

public Integer getRestartDelay()

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.

withRestartDelay

public RtmpGroupSettings withRestartDelay(Integer restartDelay)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setIncludeFillerNalUnits

public void setIncludeFillerNalUnits(String includeFillerNalUnits)

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Parameters:

includeFillerNalUnits - Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

See Also:

IncludeFillerNalUnits

getIncludeFillerNalUnits

public String getIncludeFillerNalUnits()

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Returns:

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

See Also:

IncludeFillerNalUnits

withIncludeFillerNalUnits

public RtmpGroupSettings withIncludeFillerNalUnits(String includeFillerNalUnits)

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Parameters:

includeFillerNalUnits - Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IncludeFillerNalUnits

withIncludeFillerNalUnits

public RtmpGroupSettings withIncludeFillerNalUnits(IncludeFillerNalUnits includeFillerNalUnits)

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Parameters:

includeFillerNalUnits - Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IncludeFillerNalUnits

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RtmpGroupSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.