class ThumbnailConfiguration
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ivs.Alpha.ThumbnailConfiguration |
![]() | github.com/aws/aws-cdk-go/awscdkivsalpha/v2#ThumbnailConfiguration |
![]() | software.amazon.awscdk.services.ivs.alpha.ThumbnailConfiguration |
![]() | aws_cdk.aws_ivs_alpha.ThumbnailConfiguration |
![]() | @aws-cdk/aws-ivs-alpha ยป ThumbnailConfiguration |
Thumbnail configuration for IVS Recording configuration.
Example
declare const recordingBucket: s3.Bucket;
const recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
bucket: recordingBucket,
// set thumbnail settings
thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),
});
Properties
Name | Type | Description |
---|---|---|
recording | Recording | Thumbnail recording mode. |
resolution? | Resolution | The desired resolution of recorded thumbnails for a stream. |
storage? | Storage [] | The format in which thumbnails are recorded for a stream. |
target | Duration | The targeted thumbnail-generation interval. |
recordingMode?
Type:
Recording
(optional)
Thumbnail recording mode.
If you do not specify this property, ThumbnailRecordingMode.INTERVAL
is set.
resolution?
Type:
Resolution
(optional)
The desired resolution of recorded thumbnails for a stream.
If you do not specify this property, same resolution as Input stream is used.
storage?
Type:
Storage
[]
(optional)
The format in which thumbnails are recorded for a stream.
If you do not specify this property, ThumbnailStorage.SEQUENTIAL
is set.
targetInterval?
Type:
Duration
(optional)
The targeted thumbnail-generation interval.
Must be between 1 and 60 seconds. If you do not specify this property, Duration.seconds(60)
is set.
Methods
Name | Description |
---|---|
static disable() | Disable the generation of thumbnails for recorded video. |
static interval(resolution?, storage?, targetInterval?) | Enable the generation of thumbnails for recorded video at a time interval. |
static disable()
public static disable(): ThumbnailConfiguration
Returns
Disable the generation of thumbnails for recorded video.
static interval(resolution?, storage?, targetInterval?)
public static interval(resolution?: Resolution, storage?: Storage[], targetInterval?: Duration): ThumbnailConfiguration
Parameters
- resolution
Resolution
โ The desired resolution of recorded thumbnails for a stream. - storage
Storage
[]
โ The format in which thumbnails are recorded for a stream. - targetInterval
Duration
โ The targeted thumbnail-generation interval.
Returns
Enable the generation of thumbnails for recorded video at a time interval.