AvailSettings

class aws_cdk.aws_medialive_alpha.AvailSettings

Bases: object

(experimental) Avail settings — how SCTE-35 ad avail markers are handled.

Use the static factory methods to create.

Stability:: experimental
ExampleMetadata:: infused

Example:

from aws_cdk.aws_ssm import StringParameter

# stack: Stack
# input: medialive.IInput
# bucket: s3.IBucket
# video: medialive.EncodeConfiguration
# pois_password: StringParameter


medialive.Channel(stack, "Channel",
    inputs=[medialive.InputAttachment(input=input)],
    avail_settings=medialive.AvailSettings.esam(
        pois=medialive.PoisEndpoint(
            url="https://pois.example.com/esam",
            username="pois-user",
            password=pois_password
        ),
        acquisition_point_id="acquisition-point-1",
        ad_avail_offset=Duration.millis(200)
    ),
    scte35_segmentation_scope=medialive.Scte35SegmentationScope.SCTE35_ENABLED_OUTPUT_GROUPS,
    output_groups=[
        medialive.OutputGroupConfiguration.hls(
            name="hls",
            destinations=[medialive.OutputDestination.to_bucket(bucket, "live/stream")],
            outputs=[medialive.HlsOutputDefinition(encodes=[video], output_name="hls_out")]
        )
    ]
)

Stability:: experimental

Static Methods

classmethod esam(*, acquisition_point_id, pois, ad_avail_offset=None, zone_identity=None)

(experimental) Use ESAM (Event Signaling and Management) mode, signaling ad avails to an external POIS.

Parameters:

acquisition_point_id (str) – (experimental) The acquisition point identity sent to the POIS in MCC requests.
pois (Union[PoisEndpoint, Dict[str, Any]]) – (experimental) The POIS endpoint connection details — URL and optional credentials.
ad_avail_offset (Optional[Duration]) – (experimental) Offset added to the input ad avail PTS time. Default: - service default
zone_identity (Optional[str]) – (experimental) The ID of a zone the POIS uses to control the placement of ad avails. Default: - service default

Stability:

experimental

Return type:

AvailSettings

classmethod splice_insert(*, ad_avail_offset=None, no_regional_blackout_flag=None, web_delivery_allowed_flag=None)

(experimental) Use SCTE-35 splice insert mode for ad avail handling.

Parameters:

ad_avail_offset (Union[int, float, None]) – (experimental) Offset in milliseconds added to the input ad avail PTS time. Applies only to embedded SCTE 104/35 messages. Default: - service default
no_regional_blackout_flag (Optional[Scte35FlagBehavior]) – (experimental) When set to IGNORE, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates. Default: - service default
web_delivery_allowed_flag (Optional[Scte35FlagBehavior]) – (experimental) When set to IGNORE, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates. Default: - service default

Stability:

experimental

Return type:

AvailSettings

classmethod time_signal_apos(*, ad_avail_offset=None, no_regional_blackout_flag=None, web_delivery_allowed_flag=None)

(experimental) Use SCTE-35 time signal APOS mode for ad avail handling.

Parameters:

ad_avail_offset (Union[int, float, None]) – (experimental) Offset in milliseconds added to the input ad avail PTS time. Applies only to embedded SCTE 104/35 messages. Default: - service default
no_regional_blackout_flag (Optional[Scte35FlagBehavior]) – (experimental) When set to IGNORE, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates. Default: - service default
web_delivery_allowed_flag (Optional[Scte35FlagBehavior]) – (experimental) When set to IGNORE, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates. Default: - service default

Stability:

experimental

Return type:

AvailSettings