Class: AWSCDK::MediaLive::CfnChannel::M3u8SettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

Settings for the M3U8 container.

The parent of this entity is StandardHlsSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(audio_frames_per_pes: nil, audio_pids: nil, ecm_pid: nil, klv_behavior: nil, klv_data_pids: nil, nielsen_id3_behavior: nil, pat_interval: nil, pcr_control: nil, pcr_period: nil, pcr_pid: nil, pmt_interval: nil, pmt_pid: nil, program_num: nil, scte35_behavior: nil, scte35_pid: nil, timed_metadata_behavior: nil, timed_metadata_pid: nil, transport_stream_id: nil, video_pid: nil) ⇒ M3u8SettingsProperty

Returns a new instance of M3u8SettingsProperty.

Parameters:

  • audio_frames_per_pes (Numeric, nil) (defaults to: nil) —

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

  • audio_pids (String, nil) (defaults to: nil) —

    The PID of the elementary audio streams in the transport stream.

  • ecm_pid (String, nil) (defaults to: nil) —

    This parameter is unused and deprecated.

  • klv_behavior (String, nil) (defaults to: nil)
  • klv_data_pids (String, nil) (defaults to: nil)
  • nielsen_id3_behavior (String, nil) (defaults to: nil) —

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

  • pat_interval (Numeric, nil) (defaults to: nil) —

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

  • pcr_control (String, nil) (defaults to: nil) —

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

  • pcr_period (Numeric, nil) (defaults to: nil) —

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

  • pcr_pid (String, nil) (defaults to: nil) —

    The PID of the Program Clock Reference (PCR) in the transport stream.

  • pmt_interval (Numeric, nil) (defaults to: nil) —

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

  • pmt_pid (String, nil) (defaults to: nil) —

    The PID for the Program Map Table (PMT) in the transport stream.

  • program_num (Numeric, nil) (defaults to: nil) —

    The value of the program number field in the Program Map Table (PMT).

  • scte35_behavior (String, nil) (defaults to: nil) —

    If set to passthrough, passes any SCTE-35 signals from the input source to this output.

  • scte35_pid (String, nil) (defaults to: nil) —

    The PID of the SCTE-35 stream in the transport stream.

  • timed_metadata_behavior (String, nil) (defaults to: nil) —

    When set to passthrough, timed metadata is passed through from input to output.

  • timed_metadata_pid (String, nil) (defaults to: nil) —

    The PID of the timed metadata stream in the transport stream.

  • transport_stream_id (Numeric, nil) (defaults to: nil) —

    The value of the transport stream ID field in the Program Map Table (PMT).

  • video_pid (String, nil) (defaults to: nil) —

    The PID of the elementary video stream in the transport stream.



9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
 
# File 'media_live/cfn_channel.rb', line 9711

def initialize(audio_frames_per_pes: nil, audio_pids: nil, ecm_pid: nil, klv_behavior: nil, klv_data_pids: nil, nielsen_id3_behavior: nil, pat_interval: nil, pcr_control: nil, pcr_period: nil, pcr_pid: nil, pmt_interval: nil, pmt_pid: nil, program_num: nil, scte35_behavior: nil, scte35_pid: nil, timed_metadata_behavior: nil, timed_metadata_pid: nil, transport_stream_id: nil, video_pid: nil)
  @audio_frames_per_pes = audio_frames_per_pes
  Jsii::Type.check_type(@audio_frames_per_pes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "audioFramesPerPes") unless @audio_frames_per_pes.nil?
  @audio_pids = audio_pids
  Jsii::Type.check_type(@audio_pids, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "audioPids") unless @audio_pids.nil?
  @ecm_pid = ecm_pid
  Jsii::Type.check_type(@ecm_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ecmPid") unless @ecm_pid.nil?
  @klv_behavior = klv_behavior
  Jsii::Type.check_type(@klv_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "klvBehavior") unless @klv_behavior.nil?
  @klv_data_pids = klv_data_pids
  Jsii::Type.check_type(@klv_data_pids, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "klvDataPids") unless @klv_data_pids.nil?
  @nielsen_id3_behavior = nielsen_id3_behavior
  Jsii::Type.check_type(@nielsen_id3_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nielsenId3Behavior") unless @nielsen_id3_behavior.nil?
  @pat_interval = pat_interval
  Jsii::Type.check_type(@pat_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "patInterval") unless @pat_interval.nil?
  @pcr_control = pcr_control
  Jsii::Type.check_type(@pcr_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pcrControl") unless @pcr_control.nil?
  @pcr_period = pcr_period
  Jsii::Type.check_type(@pcr_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "pcrPeriod") unless @pcr_period.nil?
  @pcr_pid = pcr_pid
  Jsii::Type.check_type(@pcr_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pcrPid") unless @pcr_pid.nil?
  @pmt_interval = pmt_interval
  Jsii::Type.check_type(@pmt_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "pmtInterval") unless @pmt_interval.nil?
  @pmt_pid = pmt_pid
  Jsii::Type.check_type(@pmt_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pmtPid") unless @pmt_pid.nil?
  @program_num = program_num
  Jsii::Type.check_type(@program_num, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "programNum") unless @program_num.nil?
  @scte35_behavior = scte35_behavior
  Jsii::Type.check_type(@scte35_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scte35Behavior") unless @scte35_behavior.nil?
  @scte35_pid = scte35_pid
  Jsii::Type.check_type(@scte35_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scte35Pid") unless @scte35_pid.nil?
  @timed_metadata_behavior = timed_metadata_behavior
  Jsii::Type.check_type(@timed_metadata_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timedMetadataBehavior") unless @timed_metadata_behavior.nil?
  @timed_metadata_pid = timed_metadata_pid
  Jsii::Type.check_type(@timed_metadata_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timedMetadataPid") unless @timed_metadata_pid.nil?
  @transport_stream_id = transport_stream_id
  Jsii::Type.check_type(@transport_stream_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "transportStreamId") unless @transport_stream_id.nil?
  @video_pid = video_pid
  Jsii::Type.check_type(@video_pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "videoPid") unless @video_pid.nil?
end

Instance Attribute Details

#audio_frames_per_pes ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



9756
9757
9758
 
# File 'media_live/cfn_channel.rb', line 9756

def audio_frames_per_pes
  @audio_frames_per_pes
end

#audio_pids ⇒ String? (readonly)

The PID of the elementary audio streams in the transport stream.

Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value.

Returns:

  • (String, nil)

See Also:



9763
9764
9765
 
# File 'media_live/cfn_channel.rb', line 9763

def audio_pids
  @audio_pids
end

#ecm_pid ⇒ String? (readonly)

This parameter is unused and deprecated.

Returns:

  • (String, nil)

See Also:



9768
9769
9770
 
# File 'media_live/cfn_channel.rb', line 9768

def ecm_pid
  @ecm_pid
end

#klv_behavior ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



9771
9772
9773
 
# File 'media_live/cfn_channel.rb', line 9771

def klv_behavior
  @klv_behavior
end

#klv_data_pids ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



9774
9775
9776
 
# File 'media_live/cfn_channel.rb', line 9774

def klv_data_pids
  @klv_data_pids
end

#nielsen_id3_behavior ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



9779
9780
9781
 
# File 'media_live/cfn_channel.rb', line 9779

def nielsen_id3_behavior
  @nielsen_id3_behavior
end

#pat_interval ⇒ Numeric? (readonly)

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

A value of "0" writes out the PMT once per segment file.

Returns:

  • (Numeric, nil)

See Also:



9786
9787
9788
 
# File 'media_live/cfn_channel.rb', line 9786

def pat_interval
  @pat_interval
end

#pcr_control ⇒ String? (readonly)

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

This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

Returns:

  • (String, nil)

See Also:



9793
9794
9795
 
# File 'media_live/cfn_channel.rb', line 9793

def pcr_control
  @pcr_control
end

#pcr_period ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



9798
9799
9800
 
# File 'media_live/cfn_channel.rb', line 9798

def pcr_period
  @pcr_period
end

#pcr_pid ⇒ String? (readonly)

The PID of the Program Clock Reference (PCR) in the transport stream.

When no value is given, MediaLive assigns the same value as the video PID. You can enter the value as a decimal or hexadecimal value.

Returns:

  • (String, nil)

See Also:



9805
9806
9807
 
# File 'media_live/cfn_channel.rb', line 9805

def pcr_pid
  @pcr_pid
end

#pmt_interval ⇒ Numeric? (readonly)

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

A value of "0" writes out the PMT once per segment file.

Returns:

  • (Numeric, nil)

See Also:



9812
9813
9814
 
# File 'media_live/cfn_channel.rb', line 9812

def pmt_interval
  @pmt_interval
end

#pmt_pid ⇒ String? (readonly)

The PID for the Program Map Table (PMT) in the transport stream.

You can enter the value as a decimal or hexadecimal value.

Returns:

  • (String, nil)

See Also:



9819
9820
9821
 
# File 'media_live/cfn_channel.rb', line 9819

def pmt_pid
  @pmt_pid
end

#program_num ⇒ Numeric? (readonly)

The value of the program number field in the Program Map Table (PMT).

Returns:

  • (Numeric, nil)

See Also:



9824
9825
9826
 
# File 'media_live/cfn_channel.rb', line 9824

def program_num
  @program_num
end

#scte35_behavior ⇒ String? (readonly)

If set to passthrough, passes any SCTE-35 signals from the input source to this output.

Returns:

  • (String, nil)

See Also:



9829
9830
9831
 
# File 'media_live/cfn_channel.rb', line 9829

def scte35_behavior
  @scte35_behavior
end

#scte35_pid ⇒ String? (readonly)

The PID of the SCTE-35 stream in the transport stream.

You can enter the value as a decimal or hexadecimal value.

Returns:

  • (String, nil)

See Also:



9836
9837
9838
 
# File 'media_live/cfn_channel.rb', line 9836

def scte35_pid
  @scte35_pid
end

#timed_metadata_behavior ⇒ String? (readonly)

When set to passthrough, timed metadata is passed through from input to output.

Returns:

  • (String, nil)

See Also:



9841
9842
9843
 
# File 'media_live/cfn_channel.rb', line 9841

def timed_metadata_behavior
  @timed_metadata_behavior
end

#timed_metadata_pid ⇒ String? (readonly)

The PID of the timed metadata stream in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

Returns:

  • (String, nil)

See Also:



9848
9849
9850
 
# File 'media_live/cfn_channel.rb', line 9848

def timed_metadata_pid
  @timed_metadata_pid
end

#transport_stream_id ⇒ Numeric? (readonly)

The value of the transport stream ID field in the Program Map Table (PMT).

Returns:

  • (Numeric, nil)

See Also:



9853
9854
9855
 
# File 'media_live/cfn_channel.rb', line 9853

def transport_stream_id
  @transport_stream_id
end

#video_pid ⇒ String? (readonly)

The PID of the elementary video stream in the transport stream.

You can enter the value as a decimal or hexadecimal value.

Returns:

  • (String, nil)

See Also:



9860
9861
9862
 
# File 'media_live/cfn_channel.rb', line 9860

def video_pid
  @video_pid
end

Class Method Details

.jsii_properties ⇒ Object 



9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
 
# File 'media_live/cfn_channel.rb', line 9862

def self.jsii_properties
  {
    :audio_frames_per_pes => "audioFramesPerPes",
    :audio_pids => "audioPids",
    :ecm_pid => "ecmPid",
    :klv_behavior => "klvBehavior",
    :klv_data_pids => "klvDataPids",
    :nielsen_id3_behavior => "nielsenId3Behavior",
    :pat_interval => "patInterval",
    :pcr_control => "pcrControl",
    :pcr_period => "pcrPeriod",
    :pcr_pid => "pcrPid",
    :pmt_interval => "pmtInterval",
    :pmt_pid => "pmtPid",
    :program_num => "programNum",
    :scte35_behavior => "scte35Behavior",
    :scte35_pid => "scte35Pid",
    :timed_metadata_behavior => "timedMetadataBehavior",
    :timed_metadata_pid => "timedMetadataPid",
    :transport_stream_id => "transportStreamId",
    :video_pid => "videoPid",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
 
# File 'media_live/cfn_channel.rb', line 9886

def to_jsii
  result = {}
  result.merge!({
    "audioFramesPerPes" => @audio_frames_per_pes,
    "audioPids" => @audio_pids,
    "ecmPid" => @ecm_pid,
    "klvBehavior" => @klv_behavior,
    "klvDataPids" => @klv_data_pids,
    "nielsenId3Behavior" => @nielsen_id3_behavior,
    "patInterval" => @pat_interval,
    "pcrControl" => @pcr_control,
    "pcrPeriod" => @pcr_period,
    "pcrPid" => @pcr_pid,
    "pmtInterval" => @pmt_interval,
    "pmtPid" => @pmt_pid,
    "programNum" => @program_num,
    "scte35Behavior" => @scte35_behavior,
    "scte35Pid" => @scte35_pid,
    "timedMetadataBehavior" => @timed_metadata_behavior,
    "timedMetadataPid" => @timed_metadata_pid,
    "transportStreamId" => @transport_stream_id,
    "videoPid" => @video_pid,
  })
  result.compact
end