Class: AWSCDK::MediaLive::CfnChannel::VideoDescriptionProperty

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

Overview

Encoding information for one output video.

The parent of this entity is EncoderSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(codec_settings: nil, height: nil, name: nil, respond_to_afd: nil, scaling_behavior: nil, sharpness: nil, width: nil) ⇒ VideoDescriptionProperty

Returns a new instance of VideoDescriptionProperty.

Parameters:

  • codec_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::VideoCodecSettingsProperty, nil) (defaults to: nil) —

    The video codec settings.

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

    The output video height, in pixels.

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

    The name of this VideoDescription.

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

    Indicates how to respond to the AFD values in the input stream.

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

    STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width).

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

    Changes the strength of the anti-alias filter used for scaling.

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

    The output video width, in pixels.



13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
 
# File 'media_live/cfn_channel.rb', line 13944

def initialize(codec_settings: nil, height: nil, name: nil, respond_to_afd: nil, scaling_behavior: nil, sharpness: nil, width: nil)
  @codec_settings = codec_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::VideoCodecSettingsProperty.new(**codec_settings.transform_keys(&:to_sym)) : codec_settings
  Jsii::Type.check_type(@codec_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5WaWRlb0NvZGVjU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "codecSettings") unless @codec_settings.nil?
  @height = height
  Jsii::Type.check_type(@height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "height") unless @height.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @respond_to_afd = respond_to_afd
  Jsii::Type.check_type(@respond_to_afd, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "respondToAfd") unless @respond_to_afd.nil?
  @scaling_behavior = scaling_behavior
  Jsii::Type.check_type(@scaling_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scalingBehavior") unless @scaling_behavior.nil?
  @sharpness = sharpness
  Jsii::Type.check_type(@sharpness, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sharpness") unless @sharpness.nil?
  @width = width
  Jsii::Type.check_type(@width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "width") unless @width.nil?
end

Instance Attribute Details

#codec_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The video codec settings.

Returns:

See Also:



13965
13966
13967
 
# File 'media_live/cfn_channel.rb', line 13965

def codec_settings
  @codec_settings
end

#height ⇒ Numeric? (readonly)

The output video height, in pixels.

This must be an even number. For most codecs, you can keep this field and width blank in order to use the height and width (resolution) from the source. Note that we don't recommend keeping the field blank. For the Frame Capture codec, height and width are required.

Returns:

  • (Numeric, nil)

See Also:



13972
13973
13974
 
# File 'media_live/cfn_channel.rb', line 13972

def height
  @height
end

#name ⇒ String? (readonly)

The name of this VideoDescription.

Outputs use this name to uniquely identify this description. Description names should be unique within this channel.

Returns:

  • (String, nil)

See Also:



13979
13980
13981
 
# File 'media_live/cfn_channel.rb', line 13979

def name
  @name
end

#respond_to_afd ⇒ String? (readonly)

Indicates how to respond to the AFD values in the input stream.

RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for the FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Returns:

  • (String, nil)

See Also:



13986
13987
13988
 
# File 'media_live/cfn_channel.rb', line 13986

def respond_to_afd
  @respond_to_afd
end

#scaling_behavior ⇒ String? (readonly)

STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width).

This option overrides any position value. DEFAULT might insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Returns:

  • (String, nil)

See Also:



13993
13994
13995
 
# File 'media_live/cfn_channel.rb', line 13993

def scaling_behavior
  @scaling_behavior
end

#sharpness ⇒ Numeric? (readonly)

Changes the strength of the anti-alias filter used for scaling.

0 is the softest setting, and 100 is the sharpest. We recommend a setting of 50 for most content.

Returns:

  • (Numeric, nil)

See Also:



14000
14001
14002
 
# File 'media_live/cfn_channel.rb', line 14000

def sharpness
  @sharpness
end

#width ⇒ Numeric? (readonly)

The output video width, in pixels.

It must be an even number. For most codecs, you can keep this field and height blank in order to use the height and width (resolution) from the source. Note that we don't recommend keeping the field blank. For the Frame Capture codec, height and width are required.

Returns:

  • (Numeric, nil)

See Also:



14007
14008
14009
 
# File 'media_live/cfn_channel.rb', line 14007

def width
  @width
end

Class Method Details

.jsii_properties ⇒ Object 



14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
 
# File 'media_live/cfn_channel.rb', line 14009

def self.jsii_properties
  {
    :codec_settings => "codecSettings",
    :height => "height",
    :name => "name",
    :respond_to_afd => "respondToAfd",
    :scaling_behavior => "scalingBehavior",
    :sharpness => "sharpness",
    :width => "width",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
 
# File 'media_live/cfn_channel.rb', line 14021

def to_jsii
  result = {}
  result.merge!({
    "codecSettings" => @codec_settings,
    "height" => @height,
    "name" => @name,
    "respondToAfd" => @respond_to_afd,
    "scalingBehavior" => @scaling_behavior,
    "sharpness" => @sharpness,
    "width" => @width,
  })
  result.compact
end