Show / Hide Table of Contents

Class CmafIngestOutputDefinition

(experimental) Output definition for a CMAF Ingest output group.

Inheritance
object
CmafIngestOutputDefinition
Implements
ICmafIngestOutputDefinition
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.MediaLive.Alpha
Assembly: Amazon.CDK.AWS.MediaLive.Alpha.dll
Syntax (csharp)
public class CmafIngestOutputDefinition : ICmafIngestOutputDefinition
Syntax (vb)
Public Class CmafIngestOutputDefinition Implements ICmafIngestOutputDefinition
Remarks

CMAF Ingest requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode.

Stability: Experimental

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.MediaLive.Alpha;

             EncodeConfiguration encodeConfiguration;

             var cmafIngestOutputDefinition = new CmafIngestOutputDefinition {
                 Encode = encodeConfiguration,
                 OutputName = "outputName",

                 // the properties below are optional
                 Captions = new [] { encodeConfiguration },
                 NameModifier = "nameModifier"
             };

Synopsis

Constructors

CmafIngestOutputDefinition()

(experimental) Output definition for a CMAF Ingest output group.

Properties

Captions

(experimental) Caption encodes that ride alongside the primary encode.

Encode

(experimental) The primary encode for this output — one video or one audio track.

NameModifier

(experimental) A string concatenated to the end of the destination file name.

OutputName

(experimental) The name of this output.

Constructors

CmafIngestOutputDefinition()

(experimental) Output definition for a CMAF Ingest output group.

public CmafIngestOutputDefinition()
Remarks

CMAF Ingest requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode.

Stability: Experimental

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.MediaLive.Alpha;

             EncodeConfiguration encodeConfiguration;

             var cmafIngestOutputDefinition = new CmafIngestOutputDefinition {
                 Encode = encodeConfiguration,
                 OutputName = "outputName",

                 // the properties below are optional
                 Captions = new [] { encodeConfiguration },
                 NameModifier = "nameModifier"
             };

Properties

Captions

(experimental) Caption encodes that ride alongside the primary encode.

public EncodeConfiguration[]? Captions { get; set; }
Property Value

EncodeConfiguration[]

Remarks

Only in-band caption types are allowed (burn-in, embedded) — out-of-band captions must go in their own output.

Default: - no captions on this output

Stability: Experimental

Encode

(experimental) The primary encode for this output — one video or one audio track.

public EncodeConfiguration Encode { get; set; }
Property Value

EncodeConfiguration

Remarks

Stability: Experimental

NameModifier

(experimental) A string concatenated to the end of the destination file name.

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

string

Remarks

Default: - no name modifier

Stability: Experimental

OutputName

(experimental) The name of this output.

public string OutputName { get; set; }
Property Value

string

Remarks

Must be unique across all outputs in the channel.

Stability: Experimental

Implements

ICmafIngestOutputDefinition
Back to top Generated by DocFX