interface RenditionConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Ivs.CfnRecordingConfiguration.RenditionConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnRecordingConfiguration_RenditionConfigurationProperty |
 Java | software.amazon.awscdk.services.ivs.CfnRecordingConfiguration.RenditionConfigurationProperty |
 Python | aws_cdk.aws_ivs.CfnRecordingConfiguration.RenditionConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_ivs » CfnRecordingConfiguration » RenditionConfigurationProperty |
The RenditionConfiguration property type describes which renditions should be recorded for a stream.
Example
// 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 renditionConfigurationProperty: ivs.CfnRecordingConfiguration.RenditionConfigurationProperty = {
renditions: ['renditions'],
renditionSelection: 'renditionSelection',
};
Properties
| Name | Type | Description |
|---|---|---|
| rendition | string | The set of renditions are recorded for a stream. |
| renditions? | string[] | A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ; |
renditionSelection?
Type:
string
(optional, default: "ALL")
The set of renditions are recorded for a stream.
For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions can be specified in the renditions field. Default: ALL .
renditions?
Type:
string[]
(optional)
A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;
otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3 .