Experimental
@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
RenditionConfiguration Class
Rendition configuration for IVS Recording configuration.
Example
ts
declare const recordingBucket: s3.Bucket;
const recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
bucket: recordingBucket,
// set rendition configuration
renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),
});
python
# recording_bucket: s3.Bucket
recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
bucket=recording_bucket,
# set rendition configuration
rendition_configuration=ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD])
)
java
Bucket recordingBucket;
RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
.bucket(recordingBucket)
// set rendition configuration
.renditionConfiguration(RenditionConfiguration.custom(List.of(Resolution.HD, Resolution.SD)))
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.IVS.Alpha
Bucket recordingBucket;
var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
Bucket = recordingBucket,
// set rendition configuration
RenditionConfiguration = RenditionConfiguration.Custom(new [] { Resolution.HD, Resolution.SD })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkivsalpha/v2
var recordingBucket Bucket
recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
Bucket: recordingBucket,
// set rendition configuration
RenditionConfiguration: ivs.RenditionConfiguration_Custom([]Resolution{
ivs.Resolution_HD,
ivs.Resolution_SD,
}),
})
Properties
renditionsmay be undefinedResolution[]renditionsmay be undefinedtyping.List[Resolution]renditionsmay be undefinedList<Resolution>Renditionsmay be undefinedResolution[]Renditionsmay be undefined*[]Resolution#A list of which renditions are recorded for a stream.
If you do not specify this property, no resolution is selected.
renditionSelectionRenditionSelectionrendition_selectionRenditionSelectionrenditionSelectionRenditionSelectionRenditionSelectionRenditionSelectionRenditionSelectionRenditionSelection#The set of renditions are recorded for a stream.
Methods
all(): RenditionConfiguration // chainable@staticmethod def all() -> RenditionConfigurationpublic static RenditionConfiguration all()public static RenditionConfiguration All()func All() RenditionConfigurationstatic#Record all available renditions.
custom(renditions: Resolution[]): RenditionConfiguration // chainable@staticmethod def custom(renditions: typing.List[Resolution]) -> RenditionConfigurationpublic static RenditionConfiguration custom(List<Resolution> renditions)public static RenditionConfiguration Custom(Resolution[] renditions)func Custom(Renditions *[]Resolution) RenditionConfigurationstatic#Record a subset of video renditions.
1 parameter
Parameters
renditionsrenditionsrenditionsrenditionsRenditions— A list of which renditions are recorded for a stream.
none(): RenditionConfiguration // chainable@staticmethod def none() -> RenditionConfigurationpublic static RenditionConfiguration none()public static RenditionConfiguration None()func None() RenditionConfigurationstatic#Does not record any video.