interface ParticipantThumbnailConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Ivs.CfnStage.ParticipantThumbnailConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnStage_ParticipantThumbnailConfigurationProperty
Java	software.amazon.awscdk.services.ivs.CfnStage.ParticipantThumbnailConfigurationProperty
Python	aws_cdk.aws_ivs.CfnStage.ParticipantThumbnailConfigurationProperty
TypeScript	aws-cdk-lib » aws_ivs » CfnStage » ParticipantThumbnailConfigurationProperty

An object representing a configuration of thumbnails for recorded video from an individual participant.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-participantthumbnailconfiguration.html

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 participantThumbnailConfigurationProperty: ivs.CfnStage.ParticipantThumbnailConfigurationProperty = {
  recordingMode: 'recordingMode',
  storage: ['storage'],
  targetIntervalSeconds: 123,
};

Properties

Name	Type	Description
recordingMode?	string	Thumbnail recording mode.
storage?	string[]	Indicates the format in which thumbnails are recorded.
targetIntervalSeconds?	number	The targeted thumbnail-generation interval in seconds.

---

recordingMode?

Type: string (optional, default: "INTERVAL")

Thumbnail recording mode.

Default: DISABLED.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-participantthumbnailconfiguration.html#cfn-ivs-stage-participantthumbnailconfiguration-recordingmode

---

storage?

Type: string[] (optional)

Indicates the format in which thumbnails are recorded.

SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-participantthumbnailconfiguration.html#cfn-ivs-stage-participantthumbnailconfiguration-storage

---

targetIntervalSeconds?

Type: number (optional, default: 60)

The targeted thumbnail-generation interval in seconds.

This is configurable only if recordingMode is INTERVAL. Default: 60.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-participantthumbnailconfiguration.html#cfn-ivs-stage-participantthumbnailconfiguration-targetintervalseconds