Class: AWSCDK::MediaLive::CfnChannel::Scte27SourceSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::MediaLive::CfnChannel::Scte27SourceSettingsProperty

Defined in:

media_live/cfn_channel.rb

Overview

Information about the SCTE-27 captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html

Instance Attribute Summary

• #ocr_language ⇒ String^? readonly

  If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

• #pid ⇒ Numeric^? readonly

  The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID;.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(ocr_language: nil, pid: nil) ⇒ Scte27SourceSettingsProperty constructor

  A new instance of Scte27SourceSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(ocr_language: nil, pid: nil) ⇒ Scte27SourceSettingsProperty

Returns a new instance of Scte27SourceSettingsProperty.

Parameters:

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

  If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

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

  The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID;

# File 'media_live/cfn_channel.rb', line 12921

def initialize(ocr_language: nil, pid: nil)
  @ocr_language = ocr_language
  Jsii::Type.check_type(@ocr_language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ocrLanguage") unless @ocr_language.nil?
  @pid = pid
  Jsii::Type.check_type(@pid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "pid") unless @pid.nil?
end

Instance Attribute Details

#ocr_language ⇒ String^? (readonly)

If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-ocrlanguage

# File 'media_live/cfn_channel.rb', line 12932

def ocr_language
  @ocr_language
end

#pid ⇒ Numeric^? (readonly)

The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID;

the language is "informational." Specify PID and omit Language: Extracts the specified PID. Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages are passed through.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-pid

# File 'media_live/cfn_channel.rb', line 12939

def pid
  @pid
end

Class Method Details

.jsii_properties ⇒ Object

# File 'media_live/cfn_channel.rb', line 12941

def self.jsii_properties
  {
    :ocr_language => "ocrLanguage",
    :pid => "pid",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'media_live/cfn_channel.rb', line 12948

def to_jsii
  result = {}
  result.merge!({
    "ocrLanguage" => @ocr_language,
    "pid" => @pid,
  })
  result.compact
end