Package software.amazon.awscdk.services.ivs

Interface CfnEncoderConfiguration.VideoProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEncoderConfiguration.VideoProperty.Jsii$Proxy

Enclosing class:

CfnEncoderConfiguration

@Stability(Stable)
public static interface CfnEncoderConfiguration.VideoProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 VideoProperty videoProperty = VideoProperty.builder()
         .bitrate(123)
         .framerate(123)
         .height(123)
         .width(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEncoderConfiguration.VideoProperty.Builder	A builder for CfnEncoderConfiguration.VideoProperty
static final class	CfnEncoderConfiguration.VideoProperty.Jsii$Proxy	An implementation for CfnEncoderConfiguration.VideoProperty

Method Summary

Modifier and Type	Method	Description
static CfnEncoderConfiguration.VideoProperty.Builder	builder()
default Number	getBitrate()	Bitrate for generated output, in bps.
default Number	getFramerate()	Video frame rate, in fps.
default Number	getHeight()	Video-resolution height.
default Number	getWidth()	Video-resolution width.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBitrate

@Stability(Stable)
@Nullable
default Number getBitrate()

Bitrate for generated output, in bps.

Default: 2500000.

Default: - 2500000

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-bitrate

getFramerate

@Stability(Stable)
@Nullable
default Number getFramerate()

Video frame rate, in fps.

Default: 30.

Default: - 30

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-framerate

getHeight

@Stability(Stable)
@Nullable
default Number getHeight()

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.

Default: - 720

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-height

getWidth

@Stability(Stable)
@Nullable
default Number getWidth()

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.

Default: - 1280

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-width

builder

@Stability(Stable)
static CfnEncoderConfiguration.VideoProperty.Builder builder()

Returns:

a CfnEncoderConfiguration.VideoProperty.Builder of CfnEncoderConfiguration.VideoProperty