You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaLive::Types::Scte35SegmentationDescriptor

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass Scte35SegmentationDescriptor data as a hash:

{
  delivery_restrictions: {
    archive_allowed_flag: "ARCHIVE_NOT_ALLOWED", # required, accepts ARCHIVE_NOT_ALLOWED, ARCHIVE_ALLOWED
    device_restrictions: "NONE", # required, accepts NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2
    no_regional_blackout_flag: "REGIONAL_BLACKOUT", # required, accepts REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUT
    web_delivery_allowed_flag: "WEB_DELIVERY_NOT_ALLOWED", # required, accepts WEB_DELIVERY_NOT_ALLOWED, WEB_DELIVERY_ALLOWED
  },
  segment_num: 1,
  segmentation_cancel_indicator: "SEGMENTATION_EVENT_NOT_CANCELED", # required, accepts SEGMENTATION_EVENT_NOT_CANCELED, SEGMENTATION_EVENT_CANCELED
  segmentation_duration: 1,
  segmentation_event_id: 1, # required
  segmentation_type_id: 1,
  segmentation_upid: "__string",
  segmentation_upid_type: 1,
  segments_expected: 1,
  sub_segment_num: 1,
  sub_segments_expected: 1,
}

Corresponds to SCTE-35 segmentation_descriptor.

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_restrictionsTypes::Scte35DeliveryRestrictions

Holds the four SCTE-35 delivery restriction parameters.



11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segment_numInteger

Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_cancel_indicatorString

Corresponds to SCTE-35 segmentation_event_cancel_indicator.

Returns:

  • (String)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_durationInteger

Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_event_idInteger

Corresponds to SCTE-35 segmentation_event_id.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_type_idInteger

Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_upidString

Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.

Returns:

  • (String)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segmentation_upid_typeInteger

Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#segments_expectedInteger

Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#sub_segment_numInteger

Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end

#sub_segments_expectedInteger

Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.

Returns:

  • (Integer)


11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11526

class Scte35SegmentationDescriptor < Struct.new(
  :delivery_restrictions,
  :segment_num,
  :segmentation_cancel_indicator,
  :segmentation_duration,
  :segmentation_event_id,
  :segmentation_type_id,
  :segmentation_upid,
  :segmentation_upid_type,
  :segments_expected,
  :sub_segment_num,
  :sub_segments_expected)
  include Aws::Structure
end