SegmentationDescriptor
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 the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
Contents
- SegmentationEventId
-
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_idmessage, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.Type: Integer
Required: No
- SegmentationTypeId
-
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_idmessage, 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.Type: Integer
Required: No
- SegmentationUpid
-
The Upid to assign to the
segmentation_descriptor.segmentation_upidmessage, 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).Type: String
Required: No
- SegmentationUpidType
-
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_typemessage, 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.Type: Integer
Required: No
- SegmentNum
-
The segment number to assign to the
segmentation_descriptor.segment_nummessage, 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.Type: Integer
Required: No
- SegmentsExpected
-
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedSmessage, 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.Type: Integer
Required: No
- SubSegmentNum
-
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_nummessage, 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.Type: Integer
Required: No
- SubSegmentsExpected
-
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expectedmessage, 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.Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: