AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.

Inheritance Hierarchy

System.Object
  Amazon.MediaConvert.Model.CaptionDescription

Namespace: Amazon.MediaConvert.Model
Assembly: AWSSDK.MediaConvert.dll
Version: 3.x.y.z

Syntax

C#
public class CaptionDescription

The CaptionDescription type exposes the following members

Constructors

NameDescription
Public Method CaptionDescription()

Properties

NameTypeDescription
Public Property CaptionSelectorName System.String
Public Property CustomLanguageCode System.String

Gets and sets the property CustomLanguageCode. Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Public Property DestinationSettings Amazon.MediaConvert.Model.CaptionDestinationSettings

Gets and sets the property DestinationSettings. Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Public Property LanguageCode Amazon.MediaConvert.LanguageCode

Gets and sets the property LanguageCode. Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Public Property LanguageDescription System.String

Gets and sets the property LanguageDescription. Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5