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

Class: Aws::MediaConvert::Types::M2tsSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing M2tsSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  audio_buffer_model: "DVB", # accepts DVB, ATSC
  audio_frames_per_pes: 1,
  audio_pids: [1],
  bitrate: 1,
  buffer_model: "MULTIPLEX", # accepts MULTIPLEX, NONE
  dvb_nit_settings: {
    network_id: 1,
    network_name: "__stringMin1Max256",
    nit_interval: 1,
  },
  dvb_sdt_settings: {
    output_sdt: "SDT_FOLLOW", # accepts SDT_FOLLOW, SDT_FOLLOW_IF_PRESENT, SDT_MANUAL, SDT_NONE
    sdt_interval: 1,
    service_name: "__stringMin1Max256",
    service_provider_name: "__stringMin1Max256",
  },
  dvb_sub_pids: [1],
  dvb_tdt_settings: {
    tdt_interval: 1,
  },
  dvb_teletext_pid: 1,
  ebp_audio_interval: "VIDEO_AND_FIXED_INTERVALS", # accepts VIDEO_AND_FIXED_INTERVALS, VIDEO_INTERVAL
  ebp_placement: "VIDEO_AND_AUDIO_PIDS", # accepts VIDEO_AND_AUDIO_PIDS, VIDEO_PID
  es_rate_in_pes: "INCLUDE", # accepts INCLUDE, EXCLUDE
  force_ts_video_ebp_order: "FORCE", # accepts FORCE, DEFAULT
  fragment_time: 1.0,
  max_pcr_interval: 1,
  min_ebp_interval: 1,
  nielsen_id_3: "INSERT", # accepts INSERT, NONE
  null_packet_bitrate: 1.0,
  pat_interval: 1,
  pcr_control: "PCR_EVERY_PES_PACKET", # accepts PCR_EVERY_PES_PACKET, CONFIGURED_PCR_PERIOD
  pcr_pid: 1,
  pmt_interval: 1,
  pmt_pid: 1,
  private_metadata_pid: 1,
  program_number: 1,
  rate_mode: "VBR", # accepts VBR, CBR
  scte_35_esam: {
    scte_35_esam_pid: 1,
  },
  scte_35_pid: 1,
  scte_35_source: "PASSTHROUGH", # accepts PASSTHROUGH, NONE
  segmentation_markers: "NONE", # accepts NONE, RAI_SEGSTART, RAI_ADAPT, PSI_SEGSTART, EBP, EBP_LEGACY
  segmentation_style: "MAINTAIN_CADENCE", # accepts MAINTAIN_CADENCE, RESET_CADENCE
  segmentation_time: 1.0,
  timed_metadata_pid: 1,
  transport_stream_id: 1,
  video_pid: 1,
}

MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#audio_buffer_model ⇒ String

Selects between the DVB and ATSC buffer models for Dolby Digital audio.

Possible values:

  • DVB
  • ATSC

Returns:

  • (String) —

    Selects between the DVB and ATSC buffer models for Dolby Digital audio.

#audio_frames_per_pes ⇒ Integer

The number of audio frames to insert for each PES packet.

Returns:

  • (Integer) —

    The number of audio frames to insert for each PES packet.

#audio_pids ⇒ Array<Integer>

Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.

Returns:

  • (Array<Integer>) —

    Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output.

#bitrate ⇒ Integer

Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.

Returns:

  • (Integer) —

    Specify the output bitrate of the transport stream in bits per second.

#buffer_model ⇒ String

Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.

Possible values:

  • MULTIPLEX
  • NONE

Returns:

  • (String) —

    Controls what buffer model to use for accurate interleaving.

#dvb_nit_settings ⇒ Types::DvbNitSettings

Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

Returns:

  • (Types::DvbNitSettings) —

    Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

#dvb_sdt_settings ⇒ Types::DvbSdtSettings

Inserts DVB Service Description Table (NIT) at the specified table repetition interval.

Returns:

  • (Types::DvbSdtSettings) —

    Inserts DVB Service Description Table (NIT) at the specified table repetition interval.

#dvb_sub_pids ⇒ Array<Integer>

Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.

Returns:

  • (Array<Integer>) —

    Specify the packet identifiers (PIDs) for DVB subtitle data included in this output.

#dvb_tdt_settings ⇒ Types::DvbTdtSettings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

Returns:

  • (Types::DvbTdtSettings) —

    Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

#dvb_teletext_pid ⇒ Integer

Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) for DVB teletext data you include in this output.

#ebp_audio_interval ⇒ String

When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

Possible values:

  • VIDEO_AND_FIXED_INTERVALS
  • VIDEO_INTERVAL

Returns:

  • (String) —

    When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4.

#ebp_placement ⇒ String

Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

Possible values:

  • VIDEO_AND_AUDIO_PIDS
  • VIDEO_PID

Returns:

  • (String) —

    Selects which PIDs to place EBP markers on.

#es_rate_in_pes ⇒ String

Controls whether to include the ES Rate field in the PES header.

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String) —

    Controls whether to include the ES Rate field in the PES header.

#force_ts_video_ebp_order ⇒ String

Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).

Possible values:

  • FORCE
  • DEFAULT

Returns:

  • (String) —

    Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers.

#fragment_time ⇒ Float

The length, in seconds, of each fragment. Only used with EBP markers.

Returns:

  • (Float) —

    The length, in seconds, of each fragment.

#max_pcr_interval ⇒ Integer

Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

Returns:

  • (Integer) —

    Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

#min_ebp_interval ⇒ Integer

When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.

Returns:

  • (Integer) —

    When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video.

#nielsen_id_3 ⇒ String

If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

Possible values:

  • INSERT
  • NONE

Returns:

  • (String) —

    If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

#null_packet_bitrate ⇒ Float

Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.

Returns:

  • (Float) —

    Value in bits per second of extra null packets to insert into the transport stream.

#pat_interval ⇒ Integer

The number of milliseconds between instances of this table in the output transport stream.

Returns:

  • (Integer) —

    The number of milliseconds between instances of this table in the output transport stream.

#pcr_control ⇒ String

When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.

Possible values:

  • PCR_EVERY_PES_PACKET
  • CONFIGURED_PCR_PERIOD

Returns:

  • (String) —

    When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header.

#pcr_pid ⇒ Integer

Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).

Returns:

  • (Integer) —

    Specify the packet identifier (PID) for the program clock reference (PCR) in this output.

#pmt_interval ⇒ Integer

Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.

Returns:

  • (Integer) —

    Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.

#pmt_pid ⇒ Integer

Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) for the program map table (PMT) itself.

#private_metadata_pid ⇒ Integer

Specify the packet identifier (PID) of the private metadata stream. Default is 503.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) of the private metadata stream.

#program_number ⇒ Integer

Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

Returns:

  • (Integer) —

    Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output.

#rate_mode ⇒ String

When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.

Possible values:

  • VBR
  • CBR

Returns:

  • (String) —

    When set to CBR, inserts null packets into transport stream to fill specified bitrate.

#scte_35_esam ⇒ Types::M2tsScte35Esam

Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Returns:

  • (Types::M2tsScte35Esam) —

    Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document.

#scte_35_pid ⇒ Integer

Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.

#scte_35_source ⇒ String

For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don\'t want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).

Possible values:

  • PASSTHROUGH
  • NONE

Returns:

  • (String) —

    For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output.

#segmentation_markers ⇒ String

Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

Possible values:

  • NONE
  • RAI_SEGSTART
  • RAI_ADAPT
  • PSI_SEGSTART
  • EBP
  • EBP_LEGACY

Returns:

  • (String) —

    Inserts segmentation markers at each segmentation_time period.

#segmentation_style ⇒ String

The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.

Possible values:

  • MAINTAIN_CADENCE
  • RESET_CADENCE

Returns:

  • (String) —

    The segmentation style parameter controls how segmentation markers are inserted into the transport stream.

#segmentation_time ⇒ Float

Specify the length, in seconds, of each segment. Required unless markers is set to _none_.

Returns:

  • (Float) —

    Specify the length, in seconds, of each segment.

#timed_metadata_pid ⇒ Integer

Specify the packet identifier (PID) for timed metadata in this output. Default is 502.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) for timed metadata in this output.

#transport_stream_id ⇒ Integer

Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

Returns:

  • (Integer) —

    Specify the ID for the transport stream itself in the program map table for this output.

#video_pid ⇒ Integer

Specify the packet identifier (PID) of the elementary video stream in the transport stream.

Returns:

  • (Integer) —

    Specify the packet identifier (PID) of the elementary video stream in the transport stream.