Experimental
@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
RecordingConfigurationProps Struct
Properties of the 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]),
});
Properties
S3 bucket where recorded videos will be stored.
recordingConfigurationNameoptionalstringrecording_configuration_nameoptionalstrrecordingConfigurationNameoptionalStringRecordingConfigurationNameoptionalstringRecordingConfigurationNameoptional*string#The name of the Recording configuration.
Default: auto generate
The value does not need to be unique.
recordingReconnectWindowoptionalDurationrecording_reconnect_windowoptionalDurationrecordingReconnectWindowoptionalDurationRecordingReconnectWindowoptionalDurationRecordingReconnectWindowoptionalDuration#If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
Default: 0 seconds (means disabled)
recordingReconnectWindow must be between 0 and 300 seconds
renditionConfigurationoptionalRenditionConfigurationrendition_configurationoptionalRenditionConfigurationrenditionConfigurationoptionalRenditionConfigurationRenditionConfigurationoptionalRenditionConfigurationRenditionConfigurationoptionalRenditionConfiguration#A rendition configuration describes which renditions should be recorded for a stream.
Default: no rendition configuration
thumbnailConfigurationoptionalThumbnailConfigurationthumbnail_configurationoptionalThumbnailConfigurationthumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfiguration#A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.
Default: no thumbnail configuration