Class: Aws::MediaTailor::Types::SegmentationDescriptor

Inherits:

Struct

• Object
• Struct
• Aws::MediaTailor::Types::SegmentationDescriptor

Defined in:

gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

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 Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #segment_num ⇒ 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.

• #segmentation_event_id ⇒ 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.

• #segmentation_type_id ⇒ 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.

• #segmentation_upid ⇒ 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.

• #segmentation_upid_type ⇒ 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.

• #segments_expected ⇒ 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.

• #sub_segment_num ⇒ 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.

• #sub_segments_expected ⇒ 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.

Instance Attribute Details

#segment_num ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#segmentation_event_id ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#segmentation_type_id ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#segmentation_upid ⇒ 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).

Returns:

• (String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#segmentation_upid_type ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#segments_expected ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#sub_segment_num ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end

#sub_segments_expected ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 4327

class SegmentationDescriptor < Struct.new(
  :segmentation_event_id,
  :segmentation_upid_type,
  :segmentation_upid,
  :segmentation_type_id,
  :segment_num,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  SENSITIVE = []
  include Aws::Structure
end