Package software.amazon.awscdk.services.medialive

Interface CfnChannel.CaptionDescriptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.CaptionDescriptionProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.CaptionDescriptionProperty
extends software.amazon.jsii.JsiiSerializable

The encoding information for output captions.

The parent of this entity is EncoderSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 CaptionDescriptionProperty captionDescriptionProperty = CaptionDescriptionProperty.builder()
         .accessibility("accessibility")
         .captionDashRoles(List.of("captionDashRoles"))
         .captionSelectorName("captionSelectorName")
         .destinationSettings(CaptionDestinationSettingsProperty.builder()
                 .aribDestinationSettings(AribDestinationSettingsProperty.builder().build())
                 .burnInDestinationSettings(BurnInDestinationSettingsProperty.builder()
                         .alignment("alignment")
                         .backgroundColor("backgroundColor")
                         .backgroundOpacity(123)
                         .font(InputLocationProperty.builder()
                                 .passwordParam("passwordParam")
                                 .uri("uri")
                                 .username("username")
                                 .build())
                         .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)
                         .build())
                 .dvbSubDestinationSettings(DvbSubDestinationSettingsProperty.builder()
                         .alignment("alignment")
                         .backgroundColor("backgroundColor")
                         .backgroundOpacity(123)
                         .font(InputLocationProperty.builder()
                                 .passwordParam("passwordParam")
                                 .uri("uri")
                                 .username("username")
                                 .build())
                         .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)
                         .build())
                 .ebuTtDDestinationSettings(EbuTtDDestinationSettingsProperty.builder()
                         .copyrightHolder("copyrightHolder")
                         .fillLineGap("fillLineGap")
                         .fontFamily("fontFamily")
                         .styleControl("styleControl")
                         .build())
                 .embeddedDestinationSettings(EmbeddedDestinationSettingsProperty.builder().build())
                 .embeddedPlusScte20DestinationSettings(EmbeddedPlusScte20DestinationSettingsProperty.builder().build())
                 .rtmpCaptionInfoDestinationSettings(RtmpCaptionInfoDestinationSettingsProperty.builder().build())
                 .scte20PlusEmbeddedDestinationSettings(Scte20PlusEmbeddedDestinationSettingsProperty.builder().build())
                 .scte27DestinationSettings(Scte27DestinationSettingsProperty.builder().build())
                 .smpteTtDestinationSettings(SmpteTtDestinationSettingsProperty.builder().build())
                 .teletextDestinationSettings(TeletextDestinationSettingsProperty.builder().build())
                 .ttmlDestinationSettings(TtmlDestinationSettingsProperty.builder()
                         .styleControl("styleControl")
                         .build())
                 .webvttDestinationSettings(WebvttDestinationSettingsProperty.builder()
                         .styleControl("styleControl")
                         .build())
                 .build())
         .dvbDashAccessibility("dvbDashAccessibility")
         .languageCode("languageCode")
         .languageDescription("languageDescription")
         .name("name")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannel.CaptionDescriptionProperty.Builder	A builder for CfnChannel.CaptionDescriptionProperty
static final class	CfnChannel.CaptionDescriptionProperty.Jsii$Proxy	An implementation for CfnChannel.CaptionDescriptionProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannel.CaptionDescriptionProperty.Builder	builder()
default String	getAccessibility()
default List<String>	getCaptionDashRoles()
default String	getCaptionSelectorName()	Specifies which input captions selector to use as a captions source when generating output captions.
default Object	getDestinationSettings()	Additional settings for a captions destination that depend on the destination type.
default String	getDvbDashAccessibility()
default String	getLanguageCode()	An ISO 639-2 three-digit code.
default String	getLanguageDescription()	Human-readable information to indicate the captions that are available for players (for example, English or Spanish).
default String	getName()	The name of the captions description.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessibility

@Stability(Stable)
@Nullable
default String getAccessibility()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-accessibility

getCaptionDashRoles

@Stability(Stable)
@Nullable
default List<String> getCaptionDashRoles()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-captiondashroles

getCaptionSelectorName

@Stability(Stable)
@Nullable
default String getCaptionSelectorName()

Specifies which input captions selector to use as a captions source when generating output captions.

This field should match a captionSelector name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-captionselectorname

getDestinationSettings

@Stability(Stable)
@Nullable
default Object getDestinationSettings()

Additional settings for a captions destination that depend on the destination type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-destinationsettings

getDvbDashAccessibility

@Stability(Stable)
@Nullable
default String getDvbDashAccessibility()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-dvbdashaccessibility

getLanguageCode

@Stability(Stable)
@Nullable
default String getLanguageCode()

An ISO 639-2 three-digit code.

For more information, see http://www.loc.gov/standards/iso639-2/.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-languagecode

getLanguageDescription

@Stability(Stable)
@Nullable
default String getLanguageDescription()

Human-readable information to indicate the captions that are available for players (for example, English or Spanish).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-languagedescription

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the captions description.

The name is used to associate a captions description with an output. Names must be unique within a channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-name

builder

@Stability(Stable)
static CfnChannel.CaptionDescriptionProperty.Builder builder()

Returns:

a CfnChannel.CaptionDescriptionProperty.Builder of CfnChannel.CaptionDescriptionProperty