Interface CfnChannel.ICaptionDescriptionProperty
The encoding information for output captions.
Namespace: Amazon.CDK.AWS.MediaLive
Assembly: Amazon.CDK.AWS.MediaLive.dll
Syntax (csharp)
public interface ICaptionDescriptionProperty
Syntax (vb)
Public Interface ICaptionDescriptionProperty
Remarks
The parent of this entity is EncoderSettings.
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;
var captionDescriptionProperty = new CaptionDescriptionProperty {
Accessibility = "accessibility",
CaptionSelectorName = "captionSelectorName",
DestinationSettings = new CaptionDestinationSettingsProperty {
AribDestinationSettings = new AribDestinationSettingsProperty { },
BurnInDestinationSettings = new BurnInDestinationSettingsProperty {
Alignment = "alignment",
BackgroundColor = "backgroundColor",
BackgroundOpacity = 123,
Font = new InputLocationProperty {
PasswordParam = "passwordParam",
Uri = "uri",
Username = "username"
},
FontColor = "fontColor",
FontOpacity = 123,
FontResolution = 123,
FontSize = "fontSize",
OutlineColor = "outlineColor",
OutlineSize = 123,
ShadowColor = "shadowColor",
ShadowOpacity = 123,
ShadowXOffset = 123,
ShadowYOffset = 123,
TeletextGridControl = "teletextGridControl",
XPosition = 123,
YPosition = 123
},
DvbSubDestinationSettings = new DvbSubDestinationSettingsProperty {
Alignment = "alignment",
BackgroundColor = "backgroundColor",
BackgroundOpacity = 123,
Font = new InputLocationProperty {
PasswordParam = "passwordParam",
Uri = "uri",
Username = "username"
},
FontColor = "fontColor",
FontOpacity = 123,
FontResolution = 123,
FontSize = "fontSize",
OutlineColor = "outlineColor",
OutlineSize = 123,
ShadowColor = "shadowColor",
ShadowOpacity = 123,
ShadowXOffset = 123,
ShadowYOffset = 123,
TeletextGridControl = "teletextGridControl",
XPosition = 123,
YPosition = 123
},
EbuTtDDestinationSettings = new EbuTtDDestinationSettingsProperty {
CopyrightHolder = "copyrightHolder",
FillLineGap = "fillLineGap",
FontFamily = "fontFamily",
StyleControl = "styleControl"
},
EmbeddedDestinationSettings = new EmbeddedDestinationSettingsProperty { },
EmbeddedPlusScte20DestinationSettings = new EmbeddedPlusScte20DestinationSettingsProperty { },
RtmpCaptionInfoDestinationSettings = new RtmpCaptionInfoDestinationSettingsProperty { },
Scte20PlusEmbeddedDestinationSettings = new Scte20PlusEmbeddedDestinationSettingsProperty { },
Scte27DestinationSettings = new Scte27DestinationSettingsProperty { },
SmpteTtDestinationSettings = new SmpteTtDestinationSettingsProperty { },
TeletextDestinationSettings = new TeletextDestinationSettingsProperty { },
TtmlDestinationSettings = new TtmlDestinationSettingsProperty {
StyleControl = "styleControl"
},
WebvttDestinationSettings = new WebvttDestinationSettingsProperty {
StyleControl = "styleControl"
}
},
LanguageCode = "languageCode",
LanguageDescription = "languageDescription",
Name = "name"
};
Synopsis
Properties
Accessibility |
|
CaptionSelectorName | Specifies which input captions selector to use as a captions source when generating output captions. |
DestinationSettings | Additional settings for a captions destination that depend on the destination type. |
LanguageCode | An ISO 639-2 three-digit code. |
LanguageDescription | Human-readable information to indicate the captions that are available for players (for example, English or Spanish). |
Name | The name of the captions description. |
Properties
Accessibility
CfnChannel.CaptionDescriptionProperty.Accessibility
.
virtual string Accessibility { get; }
Property Value
System.String
Remarks
CaptionSelectorName
Specifies which input captions selector to use as a captions source when generating output captions.
virtual string CaptionSelectorName { get; }
Property Value
System.String
Remarks
This field should match a captionSelector name.
DestinationSettings
Additional settings for a captions destination that depend on the destination type.
virtual object DestinationSettings { get; }
Property Value
System.Object
Remarks
LanguageCode
An ISO 639-2 three-digit code.
virtual string LanguageCode { get; }
Property Value
System.String
Remarks
LanguageDescription
Human-readable information to indicate the captions that are available for players (for example, English or Spanish).
virtual string LanguageDescription { get; }
Property Value
System.String
Remarks
Name
The name of the captions description.
virtual string Name { get; }
Property Value
System.String
Remarks
The name is used to associate a captions description with an output. Names must be unique within a channel.