@aws-cdk/aws-ivs-alpha.RenditionConfiguration

Experimental

@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RenditionConfiguration Class

Rendition configuration for IVS Recording configuration.

Stability

Experimental

Source

lib/rendition-configuration.ts

Example

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

renditionsResolution[]renditionstyping.List[Resolution]renditionsList<Resolution>RenditionsResolution[]Renditions*[]Resolution#

A list of which renditions are recorded for a stream.

If you do not specify this property, no resolution is selected.

renditionSelectionRenditionSelectionrendition_selectionRenditionSelectionrenditionSelectionRenditionSelectionRenditionSelectionRenditionSelectionRenditionSelectionRenditionSelectionrequired#

The set of renditions are recorded for a stream.

Methods

all(): RenditionConfiguration // chainable@staticmethod def all() -> RenditionConfigurationpublic static RenditionConfiguration all()public static RenditionConfiguration All()func All() RenditionConfigurationstatic#

Record all available renditions.

custom(renditions: Resolution[]): RenditionConfiguration // chainable@staticmethod def custom(renditions: typing.List[Resolution]) -> RenditionConfigurationpublic static RenditionConfiguration custom(List<Resolution> renditions)public static RenditionConfiguration Custom(Resolution[] renditions)func Custom(Renditions *[]Resolution) RenditionConfigurationstatic#

Record a subset of video renditions.

1 parameter

Parameters

• renditionsrenditionsrenditionsrenditionsRenditions — A list of which renditions are recorded for a stream.

none(): RenditionConfiguration // chainable@staticmethod def none() -> RenditionConfigurationpublic static RenditionConfiguration none()public static RenditionConfiguration None()func None() RenditionConfigurationstatic#

Does not record any video.