Amazonka.MediaLive.Types.RtmpGroupSettings

Documentation

data RtmpGroupSettings

Rtmp Group Settings

See: newRtmpGroupSettings smart constructor.

Constructors

RtmpGroupSettings'

Fields

• adMarkers :: Maybe [RtmpAdMarkers]

  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 :: Maybe AuthenticationScheme

  Authentication scheme to use when connecting with CDN

• cacheFullBehavior :: Maybe RtmpCacheFullBehavior

  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.

• cacheLength :: Maybe Natural

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

• captionData :: Maybe RtmpCaptionData

  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.

• inputLossAction :: Maybe InputLossActionForRtmpOut

  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.

• restartDelay :: Maybe Natural

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

Instances

FromJSON RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

parseJSON :: Value -> Parser RtmpGroupSettings

parseJSONList :: Value -> Parser [RtmpGroupSettings]

ToJSON RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

toJSON :: RtmpGroupSettings -> Value

toEncoding :: RtmpGroupSettings -> Encoding

toJSONList :: [RtmpGroupSettings] -> Value

toEncodingList :: [RtmpGroupSettings] -> Encoding

Generic RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Associated Types

type Rep RtmpGroupSettings :: Type -> Type

Methods

from :: RtmpGroupSettings -> Rep RtmpGroupSettings x

to :: Rep RtmpGroupSettings x -> RtmpGroupSettings

Read RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

readsPrec :: Int -> ReadS RtmpGroupSettings

readList :: ReadS [RtmpGroupSettings]

readPrec :: ReadPrec RtmpGroupSettings

readListPrec :: ReadPrec [RtmpGroupSettings]

Show RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

showsPrec :: Int -> RtmpGroupSettings -> ShowS

show :: RtmpGroupSettings -> String

showList :: [RtmpGroupSettings] -> ShowS

NFData RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

rnf :: RtmpGroupSettings -> ()

Eq RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

(==) :: RtmpGroupSettings -> RtmpGroupSettings -> Bool

(/=) :: RtmpGroupSettings -> RtmpGroupSettings -> Bool

Hashable RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

Methods

hashWithSalt :: Int -> RtmpGroupSettings -> Int

hash :: RtmpGroupSettings -> Int

type Rep RtmpGroupSettings

Defined in Amazonka.MediaLive.Types.RtmpGroupSettings

type Rep RtmpGroupSettings = D1 ('MetaData "RtmpGroupSettings" "Amazonka.MediaLive.Types.RtmpGroupSettings" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "RtmpGroupSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "adMarkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RtmpAdMarkers])) :*: (S1 ('MetaSel ('Just "authenticationScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationScheme)) :*: S1 ('MetaSel ('Just "cacheFullBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RtmpCacheFullBehavior)))) :*: ((S1 ('MetaSel ('Just "cacheLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "captionData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RtmpCaptionData))) :*: (S1 ('MetaSel ('Just "inputLossAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputLossActionForRtmpOut)) :*: S1 ('MetaSel ('Just "restartDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newRtmpGroupSettings :: RtmpGroupSettings

Create a value of RtmpGroupSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:adMarkers:RtmpGroupSettings', rtmpGroupSettings_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.

$sel:authenticationScheme:RtmpGroupSettings', rtmpGroupSettings_authenticationScheme - Authentication scheme to use when connecting with CDN

$sel:cacheFullBehavior:RtmpGroupSettings', rtmpGroupSettings_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.

$sel:cacheLength:RtmpGroupSettings', rtmpGroupSettings_cacheLength - Cache length, in seconds, is used to calculate buffer size.

$sel:captionData:RtmpGroupSettings', rtmpGroupSettings_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.

$sel:inputLossAction:RtmpGroupSettings', rtmpGroupSettings_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.

$sel:restartDelay:RtmpGroupSettings', rtmpGroupSettings_restartDelay - If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

rtmpGroupSettings_adMarkers :: Lens' RtmpGroupSettings (Maybe [RtmpAdMarkers])

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.

rtmpGroupSettings_authenticationScheme :: Lens' RtmpGroupSettings (Maybe AuthenticationScheme)

Authentication scheme to use when connecting with CDN

rtmpGroupSettings_cacheFullBehavior :: Lens' RtmpGroupSettings (Maybe RtmpCacheFullBehavior)

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.

rtmpGroupSettings_cacheLength :: Lens' RtmpGroupSettings (Maybe Natural)

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

rtmpGroupSettings_captionData :: Lens' RtmpGroupSettings (Maybe RtmpCaptionData)

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.

rtmpGroupSettings_inputLossAction :: Lens' RtmpGroupSettings (Maybe InputLossActionForRtmpOut)

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.

rtmpGroupSettings_restartDelay :: Lens' RtmpGroupSettings (Maybe Natural)

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