Skip to content
v2.277.0

VideoProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivs as ivs } from 'aws-cdk-lib';
const videoProperty: ivs.CfnEncoderConfiguration.VideoProperty = {
  bitrate: 123,
  framerate: 123,
  height: 123,
  width: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

video_property = ivs.CfnEncoderConfiguration.VideoProperty(
    bitrate=123,
    framerate=123,
    height=123,
    width=123
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Ivs;

var videoProperty = new VideoProperty {
    Bitrate = 123,
    Framerate = 123,
    Height = 123,
    Width = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

videoProperty := &VideoProperty{
	Bitrate: jsii.Number(123),
	Framerate: jsii.Number(123),
	Height: jsii.Number(123),
	Width: jsii.Number(123),
}

Properties ​

bitrateoptionalnumberbitrateoptionalint | floatbitrateoptionalNumberBitrateoptionaldoubleBitrateoptional*float64 = 2500000 #
Bitrate for generated output, in bps.

Default: 2500000.

framerateoptionalnumberframerateoptionalint | floatframerateoptionalNumberFramerateoptionaldoubleFramerateoptional*float64 = 30 #
Video frame rate, in fps.

Default: 30.

heightoptionalnumberheightoptionalint | floatheightoptionalNumberHeightoptionaldoubleHeightoptional*float64 = 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.

widthoptionalnumberwidthoptionalint | floatwidthoptionalNumberWidthoptionaldoubleWidthoptional*float64 = 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.