MediaTailor / Client / update_program
update_program#
- MediaTailor.Client.update_program(**kwargs)#
Updates a program within a channel.
See also: AWS API Documentation
Request Syntax
response = client.update_program( AdBreaks=[ { 'AdBreakMetadata': [ { 'Key': 'string', 'Value': 'string' }, ], 'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL', 'OffsetMillis': 123, 'Slate': { 'SourceLocationName': 'string', 'VodSourceName': 'string' }, 'SpliceInsertMessage': { 'AvailNum': 123, 'AvailsExpected': 123, 'SpliceEventId': 123, 'UniqueProgramId': 123 }, 'TimeSignalMessage': { 'SegmentationDescriptors': [ { 'SegmentNum': 123, 'SegmentationEventId': 123, 'SegmentationTypeId': 123, 'SegmentationUpid': 'string', 'SegmentationUpidType': 123, 'SegmentsExpected': 123, 'SubSegmentNum': 123, 'SubSegmentsExpected': 123 }, ] } }, ], AudienceMedia=[ { 'AlternateMedia': [ { 'AdBreaks': [ { 'AdBreakMetadata': [ { 'Key': 'string', 'Value': 'string' }, ], 'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL', 'OffsetMillis': 123, 'Slate': { 'SourceLocationName': 'string', 'VodSourceName': 'string' }, 'SpliceInsertMessage': { 'AvailNum': 123, 'AvailsExpected': 123, 'SpliceEventId': 123, 'UniqueProgramId': 123 }, 'TimeSignalMessage': { 'SegmentationDescriptors': [ { 'SegmentNum': 123, 'SegmentationEventId': 123, 'SegmentationTypeId': 123, 'SegmentationUpid': 'string', 'SegmentationUpidType': 123, 'SegmentsExpected': 123, 'SubSegmentNum': 123, 'SubSegmentsExpected': 123 }, ] } }, ], 'ClipRange': { 'EndOffsetMillis': 123, 'StartOffsetMillis': 123 }, 'DurationMillis': 123, 'LiveSourceName': 'string', 'ScheduledStartTimeMillis': 123, 'SourceLocationName': 'string', 'VodSourceName': 'string' }, ], 'Audience': 'string' }, ], ChannelName='string', ProgramName='string', ScheduleConfiguration={ 'ClipRange': { 'EndOffsetMillis': 123, 'StartOffsetMillis': 123 }, 'Transition': { 'DurationMillis': 123, 'ScheduledStartTimeMillis': 123 } } )
- Parameters:
AdBreaks (list) –
The ad break configuration settings.
(dict) –
Ad break configuration parameters.
AdBreakMetadata (list) –
Defines a list of key/value pairs that MediaTailor generates within the
EXT-X-ASSET``tag for ``SCTE35_ENHANCED
output.(dict) –
For
SCTE35_ENHANCED
output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.Key (string) – [REQUIRED]
For
SCTE35_ENHANCED
output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.Value (string) – [REQUIRED]
For
SCTE35_ENHANCED
output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
MessageType (string) –
The SCTE-35 ad insertion type. Accepted value:
SPLICE_INSERT
,TIME_SIGNAL
.OffsetMillis (integer) – [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) –
Ad break slate configuration.
SourceLocationName (string) –
The name of the source location where the slate VOD source is stored.
VodSourceName (string) –
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) –
This defines the SCTE-35
splice_insert()
message inserted around the ad. For information about usingsplice_insert()
, see the SCTE-35 specficiaiton, section 9.7.3.1.AvailNum (integer) –
This is written to
splice_insert.avail_num
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.AvailsExpected (integer) –
This is written to
splice_insert.avails_expected
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.SpliceEventId (integer) –
This is written to
splice_insert.splice_event_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is1
.UniqueProgramId (integer) –
This is written to
splice_insert.unique_program_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.
TimeSignalMessage (dict) –
Defines the SCTE-35
time_signal
message inserted around the ad.Programs on a channel’s schedule can be configured with one or more ad breaks. You can attach a
splice_insert
SCTE-35 message to the ad break. This message provides basic metadata about the ad break.See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) –
The configurations for the SCTE-35
segmentation_descriptor
message(s) sent with thetime_signal
message.(dict) –
The
segmentation_descriptor
message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of theEXT-X-DATERANGE
orEventStream
ad marker’s SCTE-35 data.segmentation_descriptor
messages must be sent with thetime_signal
message type.See the
segmentation_descriptor()
table of the 2022 SCTE-35 specification for more information.SegmentNum (integer) –
The segment number to assign to the
segmentation_descriptor.segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SegmentationEventId (integer) –
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.SegmentationTypeId (integer) –
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.SegmentationUpid (string) –
The Upid to assign to the
segmentation_descriptor.segmentation_upid
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is “” (an empty string).SegmentationUpidType (integer) –
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.SegmentsExpected (integer) –
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SubSegmentNum (integer) –
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.SubSegmentsExpected (integer) –
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AudienceMedia (list) –
The list of AudienceMedia defined in program.
(dict) –
An AudienceMedia object contains an Audience and a list of AlternateMedia.
AlternateMedia (list) –
The list of AlternateMedia defined in AudienceMedia.
(dict) –
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
AdBreaks (list) –
Ad break configuration parameters defined in AlternateMedia.
(dict) –
Ad break configuration parameters.
AdBreakMetadata (list) –
Defines a list of key/value pairs that MediaTailor generates within the
EXT-X-ASSET``tag for ``SCTE35_ENHANCED
output.(dict) –
For
SCTE35_ENHANCED
output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.Key (string) – [REQUIRED]
For
SCTE35_ENHANCED
output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.Value (string) – [REQUIRED]
For
SCTE35_ENHANCED
output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
MessageType (string) –
The SCTE-35 ad insertion type. Accepted value:
SPLICE_INSERT
,TIME_SIGNAL
.OffsetMillis (integer) – [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) –
Ad break slate configuration.
SourceLocationName (string) –
The name of the source location where the slate VOD source is stored.
VodSourceName (string) –
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) –
This defines the SCTE-35
splice_insert()
message inserted around the ad. For information about usingsplice_insert()
, see the SCTE-35 specficiaiton, section 9.7.3.1.AvailNum (integer) –
This is written to
splice_insert.avail_num
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.AvailsExpected (integer) –
This is written to
splice_insert.avails_expected
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.SpliceEventId (integer) –
This is written to
splice_insert.splice_event_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is1
.UniqueProgramId (integer) –
This is written to
splice_insert.unique_program_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.
TimeSignalMessage (dict) –
Defines the SCTE-35
time_signal
message inserted around the ad.Programs on a channel’s schedule can be configured with one or more ad breaks. You can attach a
splice_insert
SCTE-35 message to the ad break. This message provides basic metadata about the ad break.See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) –
The configurations for the SCTE-35
segmentation_descriptor
message(s) sent with thetime_signal
message.(dict) –
The
segmentation_descriptor
message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of theEXT-X-DATERANGE
orEventStream
ad marker’s SCTE-35 data.segmentation_descriptor
messages must be sent with thetime_signal
message type.See the
segmentation_descriptor()
table of the 2022 SCTE-35 specification for more information.SegmentNum (integer) –
The segment number to assign to the
segmentation_descriptor.segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SegmentationEventId (integer) –
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.SegmentationTypeId (integer) –
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.SegmentationUpid (string) –
The Upid to assign to the
segmentation_descriptor.segmentation_upid
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is “” (an empty string).SegmentationUpidType (integer) –
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.SegmentsExpected (integer) –
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SubSegmentNum (integer) –
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.SubSegmentsExpected (integer) –
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
ClipRange (dict) –
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) –
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) –
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
DurationMillis (integer) –
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) –
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) –
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) –
The name of the source location for alternateMedia.
VodSourceName (string) –
The name of the VOD source for alternateMedia.
Audience (string) –
The Audience defined in AudienceMedia.
ChannelName (string) –
[REQUIRED]
The name of the channel for this Program.
ProgramName (string) –
[REQUIRED]
The name of the Program.
ScheduleConfiguration (dict) –
[REQUIRED]
The schedule configuration settings.
ClipRange (dict) –
Program clip range configuration.
EndOffsetMillis (integer) –
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) –
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
Transition (dict) –
Program transition configuration.
DurationMillis (integer) –
The duration of the live program in seconds.
ScheduledStartTimeMillis (integer) –
The date and time that the program is scheduled to start, in epoch milliseconds.
- Return type:
dict
- Returns:
Response Syntax
{ 'AdBreaks': [ { 'AdBreakMetadata': [ { 'Key': 'string', 'Value': 'string' }, ], 'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL', 'OffsetMillis': 123, 'Slate': { 'SourceLocationName': 'string', 'VodSourceName': 'string' }, 'SpliceInsertMessage': { 'AvailNum': 123, 'AvailsExpected': 123, 'SpliceEventId': 123, 'UniqueProgramId': 123 }, 'TimeSignalMessage': { 'SegmentationDescriptors': [ { 'SegmentNum': 123, 'SegmentationEventId': 123, 'SegmentationTypeId': 123, 'SegmentationUpid': 'string', 'SegmentationUpidType': 123, 'SegmentsExpected': 123, 'SubSegmentNum': 123, 'SubSegmentsExpected': 123 }, ] } }, ], 'Arn': 'string', 'AudienceMedia': [ { 'AlternateMedia': [ { 'AdBreaks': [ { 'AdBreakMetadata': [ { 'Key': 'string', 'Value': 'string' }, ], 'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL', 'OffsetMillis': 123, 'Slate': { 'SourceLocationName': 'string', 'VodSourceName': 'string' }, 'SpliceInsertMessage': { 'AvailNum': 123, 'AvailsExpected': 123, 'SpliceEventId': 123, 'UniqueProgramId': 123 }, 'TimeSignalMessage': { 'SegmentationDescriptors': [ { 'SegmentNum': 123, 'SegmentationEventId': 123, 'SegmentationTypeId': 123, 'SegmentationUpid': 'string', 'SegmentationUpidType': 123, 'SegmentsExpected': 123, 'SubSegmentNum': 123, 'SubSegmentsExpected': 123 }, ] } }, ], 'ClipRange': { 'EndOffsetMillis': 123, 'StartOffsetMillis': 123 }, 'DurationMillis': 123, 'LiveSourceName': 'string', 'ScheduledStartTimeMillis': 123, 'SourceLocationName': 'string', 'VodSourceName': 'string' }, ], 'Audience': 'string' }, ], 'ChannelName': 'string', 'ClipRange': { 'EndOffsetMillis': 123, 'StartOffsetMillis': 123 }, 'CreationTime': datetime(2015, 1, 1), 'DurationMillis': 123, 'LiveSourceName': 'string', 'ProgramName': 'string', 'ScheduledStartTime': datetime(2015, 1, 1), 'SourceLocationName': 'string', 'VodSourceName': 'string' }
Response Structure
(dict) –
AdBreaks (list) –
The ad break configuration settings.
(dict) –
Ad break configuration parameters.
AdBreakMetadata (list) –
Defines a list of key/value pairs that MediaTailor generates within the
EXT-X-ASSET``tag for ``SCTE35_ENHANCED
output.(dict) –
For
SCTE35_ENHANCED
output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.Key (string) –
For
SCTE35_ENHANCED
output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.Value (string) –
For
SCTE35_ENHANCED
output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
MessageType (string) –
The SCTE-35 ad insertion type. Accepted value:
SPLICE_INSERT
,TIME_SIGNAL
.OffsetMillis (integer) –
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) –
Ad break slate configuration.
SourceLocationName (string) –
The name of the source location where the slate VOD source is stored.
VodSourceName (string) –
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) –
This defines the SCTE-35
splice_insert()
message inserted around the ad. For information about usingsplice_insert()
, see the SCTE-35 specficiaiton, section 9.7.3.1.AvailNum (integer) –
This is written to
splice_insert.avail_num
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.AvailsExpected (integer) –
This is written to
splice_insert.avails_expected
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.SpliceEventId (integer) –
This is written to
splice_insert.splice_event_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is1
.UniqueProgramId (integer) –
This is written to
splice_insert.unique_program_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.
TimeSignalMessage (dict) –
Defines the SCTE-35
time_signal
message inserted around the ad.Programs on a channel’s schedule can be configured with one or more ad breaks. You can attach a
splice_insert
SCTE-35 message to the ad break. This message provides basic metadata about the ad break.See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) –
The configurations for the SCTE-35
segmentation_descriptor
message(s) sent with thetime_signal
message.(dict) –
The
segmentation_descriptor
message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of theEXT-X-DATERANGE
orEventStream
ad marker’s SCTE-35 data.segmentation_descriptor
messages must be sent with thetime_signal
message type.See the
segmentation_descriptor()
table of the 2022 SCTE-35 specification for more information.SegmentNum (integer) –
The segment number to assign to the
segmentation_descriptor.segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SegmentationEventId (integer) –
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.SegmentationTypeId (integer) –
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.SegmentationUpid (string) –
The Upid to assign to the
segmentation_descriptor.segmentation_upid
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is “” (an empty string).SegmentationUpidType (integer) –
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.SegmentsExpected (integer) –
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SubSegmentNum (integer) –
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.SubSegmentsExpected (integer) –
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
Arn (string) –
The ARN to assign to the program.
AudienceMedia (list) –
The list of AudienceMedia defined in program.
(dict) –
An AudienceMedia object contains an Audience and a list of AlternateMedia.
AlternateMedia (list) –
The list of AlternateMedia defined in AudienceMedia.
(dict) –
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
AdBreaks (list) –
Ad break configuration parameters defined in AlternateMedia.
(dict) –
Ad break configuration parameters.
AdBreakMetadata (list) –
Defines a list of key/value pairs that MediaTailor generates within the
EXT-X-ASSET``tag for ``SCTE35_ENHANCED
output.(dict) –
For
SCTE35_ENHANCED
output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.Key (string) –
For
SCTE35_ENHANCED
output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.Value (string) –
For
SCTE35_ENHANCED
output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
MessageType (string) –
The SCTE-35 ad insertion type. Accepted value:
SPLICE_INSERT
,TIME_SIGNAL
.OffsetMillis (integer) –
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) –
Ad break slate configuration.
SourceLocationName (string) –
The name of the source location where the slate VOD source is stored.
VodSourceName (string) –
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) –
This defines the SCTE-35
splice_insert()
message inserted around the ad. For information about usingsplice_insert()
, see the SCTE-35 specficiaiton, section 9.7.3.1.AvailNum (integer) –
This is written to
splice_insert.avail_num
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.AvailsExpected (integer) –
This is written to
splice_insert.avails_expected
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.SpliceEventId (integer) –
This is written to
splice_insert.splice_event_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is1
.UniqueProgramId (integer) –
This is written to
splice_insert.unique_program_id
, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is0
. Values must be between0
and256
, inclusive.
TimeSignalMessage (dict) –
Defines the SCTE-35
time_signal
message inserted around the ad.Programs on a channel’s schedule can be configured with one or more ad breaks. You can attach a
splice_insert
SCTE-35 message to the ad break. This message provides basic metadata about the ad break.See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) –
The configurations for the SCTE-35
segmentation_descriptor
message(s) sent with thetime_signal
message.(dict) –
The
segmentation_descriptor
message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of theEXT-X-DATERANGE
orEventStream
ad marker’s SCTE-35 data.segmentation_descriptor
messages must be sent with thetime_signal
message type.See the
segmentation_descriptor()
table of the 2022 SCTE-35 specification for more information.SegmentNum (integer) –
The segment number to assign to the
segmentation_descriptor.segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SegmentationEventId (integer) –
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.SegmentationTypeId (integer) –
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.SegmentationUpid (string) –
The Upid to assign to the
segmentation_descriptor.segmentation_upid
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is “” (an empty string).SegmentationUpidType (integer) –
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.SegmentsExpected (integer) –
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.SubSegmentNum (integer) –
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.SubSegmentsExpected (integer) –
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
ClipRange (dict) –
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) –
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) –
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
DurationMillis (integer) –
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) –
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) –
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) –
The name of the source location for alternateMedia.
VodSourceName (string) –
The name of the VOD source for alternateMedia.
Audience (string) –
The Audience defined in AudienceMedia.
ChannelName (string) –
The name to assign to the channel for this program.
ClipRange (dict) –
The clip range configuration settings.
EndOffsetMillis (integer) –
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) –
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
CreationTime (datetime) –
The time the program was created.
DurationMillis (integer) –
The duration of the live program in milliseconds.
LiveSourceName (string) –
The name of the LiveSource for this Program.
ProgramName (string) –
The name to assign to this program.
ScheduledStartTime (datetime) –
The scheduled start time for this Program.
SourceLocationName (string) –
The name to assign to the source location for this program.
VodSourceName (string) –
The name that’s used to refer to a VOD source.