Class: AWSCDK::IVS::CfnEncoderConfiguration::VideoProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ivs/cfn_encoder_configuration.rb

Overview

The Video property type describes a stream's video configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bitrate: nil, framerate: nil, height: nil, width: nil) ⇒ VideoProperty

Returns a new instance of VideoProperty.

Parameters:

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

    Bitrate for generated output, in bps.

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

    Video frame rate, in fps.

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

    Video-resolution height.

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

    Video-resolution width.



551
552
553
554
555
556
557
558
559
560
 
# File 'ivs/cfn_encoder_configuration.rb', line 551

def initialize(bitrate: nil, framerate: nil, height: nil, width: nil)
  @bitrate = bitrate
  Jsii::Type.check_type(@bitrate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "bitrate") unless @bitrate.nil?
  @framerate = framerate
  Jsii::Type.check_type(@framerate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "framerate") unless @framerate.nil?
  @height = height
  Jsii::Type.check_type(@height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "height") unless @height.nil?
  @width = width
  Jsii::Type.check_type(@width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "width") unless @width.nil?
end

Instance Attribute Details

#bitrate ⇒ Numeric? (readonly)

Note:

Default: - 2500000

Bitrate for generated output, in bps.

Default: 2500000.

Returns:

  • (Numeric, nil)

See Also:



569
570
571
 
# File 'ivs/cfn_encoder_configuration.rb', line 569

def bitrate
  @bitrate
end

#framerate ⇒ Numeric? (readonly)

Note:

Default: - 30

Video frame rate, in fps.

Default: 30.

Returns:

  • (Numeric, nil)

See Also:



577
578
579
 
# File 'ivs/cfn_encoder_configuration.rb', line 577

def framerate
  @framerate
end

#height ⇒ Numeric? (readonly)

Note:

Default: - 720

Video-resolution height.

Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

Returns:

  • (Numeric, nil)

See Also:



585
586
587
 
# File 'ivs/cfn_encoder_configuration.rb', line 585

def height
  @height
end

#width ⇒ Numeric? (readonly)

Note:

Default: - 1280

Video-resolution width.

Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

Returns:

  • (Numeric, nil)

See Also:



593
594
595
 
# File 'ivs/cfn_encoder_configuration.rb', line 593

def width
  @width
end

Class Method Details

.jsii_properties ⇒ Object 



595
596
597
598
599
600
601
602
 
# File 'ivs/cfn_encoder_configuration.rb', line 595

def self.jsii_properties
  {
    :bitrate => "bitrate",
    :framerate => "framerate",
    :height => "height",
    :width => "width",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



604
605
606
607
608
609
610
611
612
613
 
# File 'ivs/cfn_encoder_configuration.rb', line 604

def to_jsii
  result = {}
  result.merge!({
    "bitrate" => @bitrate,
    "framerate" => @framerate,
    "height" => @height,
    "width" => @width,
  })
  result.compact
end