interface ThumbnailConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnRecordingConfiguration_ThumbnailConfigurationProperty |
![]() | software.amazon.awscdk.services.ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty |
![]() | aws_cdk.aws_ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty |
![]() | aws-cdk-lib » aws_ivs » CfnRecordingConfiguration » ThumbnailConfigurationProperty |
The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.
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 thumbnailConfigurationProperty: ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty = {
recordingMode: 'recordingMode',
// the properties below are optional
targetIntervalSeconds: 123,
};
Properties
Name | Type | Description |
---|---|---|
recording | string | Thumbnail recording mode. Valid values:. |
target | number | The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL . |
recordingMode
Type:
string
Thumbnail recording mode. Valid values:.
DISABLED
: Use DISABLED to disable the generation of thumbnails for recorded video.INTERVAL
: Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.
Default : INTERVAL
targetIntervalSeconds?
Type:
number
(optional)
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL
.
Setting a value for
TargetIntervalSeconds
does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at theTargetIntervalSeconds
interval, theIDR/Keyframe
value for the input video must be less than theTargetIntervalSeconds
value. See Amazon IVS Streaming Configuration for information on settingIDR/Keyframe
to the recommended value in video-encoder settings.
Default : 60
Valid Range : Minumum value of 5. Maximum value of 60.