Show / Hide Table of Contents

Class CfnStage.ParticipantThumbnailConfigurationProperty

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

Inheritance
object
CfnStage.ParticipantThumbnailConfigurationProperty
Implements
CfnStage.IParticipantThumbnailConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStage.ParticipantThumbnailConfigurationProperty : CfnStage.IParticipantThumbnailConfigurationProperty
Syntax (vb)
Public Class CfnStage.ParticipantThumbnailConfigurationProperty Implements CfnStage.IParticipantThumbnailConfigurationProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Ivs;

             var participantThumbnailConfigurationProperty = new ParticipantThumbnailConfigurationProperty {
                 RecordingMode = "recordingMode",
                 Storage = new [] { "storage" },
                 TargetIntervalSeconds = 123
             };

Synopsis

Constructors

ParticipantThumbnailConfigurationProperty()

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

Properties

RecordingMode

Thumbnail recording mode.

Storage

Indicates the format in which thumbnails are recorded.

TargetIntervalSeconds

The targeted thumbnail-generation interval in seconds.

Constructors

ParticipantThumbnailConfigurationProperty()

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

public ParticipantThumbnailConfigurationProperty()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Ivs;

             var participantThumbnailConfigurationProperty = new ParticipantThumbnailConfigurationProperty {
                 RecordingMode = "recordingMode",
                 Storage = new [] { "storage" },
                 TargetIntervalSeconds = 123
             };

Properties

RecordingMode

Thumbnail recording mode.

public string? RecordingMode { get; set; }
Property Value

string

Remarks

Default: DISABLED.

Default: - "INTERVAL"

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

Storage

Indicates the format in which thumbnails are recorded.

public string[]? Storage { get; set; }
Property Value

string[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-participantthumbnailconfiguration.html#cfn-ivs-stage-participantthumbnailconfiguration-storage

TargetIntervalSeconds

The targeted thumbnail-generation interval in seconds.

public double? TargetIntervalSeconds { get; set; }
Property Value

double?

Remarks

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

Default: - 60

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

Implements

CfnStage.IParticipantThumbnailConfigurationProperty
Back to top Generated by DocFX