Amazonka.MediaTailor.Types.SegmentationDescriptor

Documentation

data 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.

See: newSegmentationDescriptor smart constructor.

Constructors

SegmentationDescriptor'

Fields

• segmentNum :: Maybe Int

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

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

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

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

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

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

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

  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.

Instances

FromJSON SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

parseJSON :: Value -> Parser SegmentationDescriptor

parseJSONList :: Value -> Parser [SegmentationDescriptor]

ToJSON SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

toJSON :: SegmentationDescriptor -> Value

toEncoding :: SegmentationDescriptor -> Encoding

toJSONList :: [SegmentationDescriptor] -> Value

toEncodingList :: [SegmentationDescriptor] -> Encoding

Generic SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Associated Types

type Rep SegmentationDescriptor :: Type -> Type

Methods

from :: SegmentationDescriptor -> Rep SegmentationDescriptor x

to :: Rep SegmentationDescriptor x -> SegmentationDescriptor

Read SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

readsPrec :: Int -> ReadS SegmentationDescriptor

readList :: ReadS [SegmentationDescriptor]

readPrec :: ReadPrec SegmentationDescriptor

readListPrec :: ReadPrec [SegmentationDescriptor]

Show SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

showsPrec :: Int -> SegmentationDescriptor -> ShowS

show :: SegmentationDescriptor -> String

showList :: [SegmentationDescriptor] -> ShowS

NFData SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

rnf :: SegmentationDescriptor -> ()

Eq SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

(==) :: SegmentationDescriptor -> SegmentationDescriptor -> Bool

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

Hashable SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

Methods

hashWithSalt :: Int -> SegmentationDescriptor -> Int

hash :: SegmentationDescriptor -> Int

type Rep SegmentationDescriptor

Defined in Amazonka.MediaTailor.Types.SegmentationDescriptor

type Rep SegmentationDescriptor = D1 ('MetaData "SegmentationDescriptor" "Amazonka.MediaTailor.Types.SegmentationDescriptor" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "SegmentationDescriptor'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "segmentNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "segmentationEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "segmentationTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "segmentationUpid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "segmentationUpidType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "segmentsExpected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "subSegmentNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "subSegmentsExpected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newSegmentationDescriptor :: SegmentationDescriptor

Create a value of SegmentationDescriptor 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:segmentNum:SegmentationDescriptor', segmentationDescriptor_segmentNum - 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.

$sel:segmentationEventId:SegmentationDescriptor', segmentationDescriptor_segmentationEventId - 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.

$sel:segmentationTypeId:SegmentationDescriptor', segmentationDescriptor_segmentationTypeId - 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.

$sel:segmentationUpid:SegmentationDescriptor', segmentationDescriptor_segmentationUpid - 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).

$sel:segmentationUpidType:SegmentationDescriptor', segmentationDescriptor_segmentationUpidType - 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.

$sel:segmentsExpected:SegmentationDescriptor', segmentationDescriptor_segmentsExpected - 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.

$sel:subSegmentNum:SegmentationDescriptor', segmentationDescriptor_subSegmentNum - 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.

$sel:subSegmentsExpected:SegmentationDescriptor', segmentationDescriptor_subSegmentsExpected - 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.

segmentationDescriptor_segmentNum :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_segmentationEventId :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_segmentationTypeId :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_segmentationUpid :: Lens' SegmentationDescriptor (Maybe Text)

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).

segmentationDescriptor_segmentationUpidType :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_segmentsExpected :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_subSegmentNum :: Lens' SegmentationDescriptor (Maybe Int)

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.

segmentationDescriptor_subSegmentsExpected :: Lens' SegmentationDescriptor (Maybe Int)

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.