Package software.amazon.awscdk.services.medialive.alpha

Class CaptionEncodeProps.Builder

java.lang.Object

software.amazon.awscdk.services.medialive.alpha.CaptionEncodeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CaptionEncodeProps>

Enclosing interface:

CaptionEncodeProps

@Stability(Experimental)
public static final class CaptionEncodeProps.Builder
extends Object
implements software.amazon.jsii.Builder<CaptionEncodeProps>

A builder for CaptionEncodeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CaptionEncodeProps.Builder	accessibility(CaptionAccessibility accessibility)	Sets the value of CaptionEncodeProps.getAccessibility()
CaptionEncodeProps	build()	Builds the configured instance.
CaptionEncodeProps.Builder	captionDashRoles(List<? extends CaptionDashRole> captionDashRoles)	Sets the value of CaptionEncodeProps.getCaptionDashRoles()
CaptionEncodeProps.Builder	captionSelectorName(String captionSelectorName)	Sets the value of CaptionEncodeProps.getCaptionSelectorName()
CaptionEncodeProps.Builder	destination(CaptionDestination destination)	Sets the value of CaptionEncodeProps.getDestination()
CaptionEncodeProps.Builder	dvbDashAccessibility(DvbDashAccessibility dvbDashAccessibility)	Sets the value of CaptionEncodeProps.getDvbDashAccessibility()
CaptionEncodeProps.Builder	languageCode(String languageCode)	Sets the value of CaptionEncodeProps.getLanguageCode()
CaptionEncodeProps.Builder	languageDescription(String languageDescription)	Sets the value of CaptionEncodeProps.getLanguageDescription()
CaptionEncodeProps.Builder	name(String name)	Sets the value of CaptionEncodeProps.getName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

captionSelectorName

@Stability(Experimental)
public CaptionEncodeProps.Builder captionSelectorName(String captionSelectorName)

Sets the value of CaptionEncodeProps.getCaptionSelectorName()

Parameters:

captionSelectorName - The name of the caption selector in the input to use as the source. This parameter is required.

Returns:

this

destination

@Stability(Experimental)
public CaptionEncodeProps.Builder destination(CaptionDestination destination)

Sets the value of CaptionEncodeProps.getDestination()

Parameters:

destination - The output caption format. This parameter is required. Use the CaptionDestination factory methods (e.g. CaptionDestination.burnIn(), .webvtt(), .embedded()).

Returns:

this

name

@Stability(Experimental)
public CaptionEncodeProps.Builder name(String name)

Sets the value of CaptionEncodeProps.getName()

Parameters:

name - A unique name for this caption encode. This parameter is required.

Returns:

this

accessibility

@Stability(Experimental)
public CaptionEncodeProps.Builder accessibility(CaptionAccessibility accessibility)

Sets the value of CaptionEncodeProps.getAccessibility()

Parameters:

accessibility - Whether this caption track implements accessibility features.

Returns:

this

captionDashRoles

@Stability(Experimental)
public CaptionEncodeProps.Builder captionDashRoles(List<? extends CaptionDashRole> captionDashRoles)

Sets the value of CaptionEncodeProps.getCaptionDashRoles()

Parameters:

captionDashRoles - The DASH roles to assign to this captions output. Applies only when the output is configured for DVB DASH accessibility signaling.

Returns:

this

dvbDashAccessibility

@Stability(Experimental)
public CaptionEncodeProps.Builder dvbDashAccessibility(DvbDashAccessibility dvbDashAccessibility)

Sets the value of CaptionEncodeProps.getDvbDashAccessibility()

Parameters:

dvbDashAccessibility - DVB DASH accessibility signaling for this captions output.

Returns:

this

languageCode

@Stability(Experimental)
public CaptionEncodeProps.Builder languageCode(String languageCode)

Sets the value of CaptionEncodeProps.getLanguageCode()

Parameters:

languageCode - The ISO 639-2 language code for the captions (e.g. 'eng', 'spa').

Returns:

this

languageDescription

@Stability(Experimental)
public CaptionEncodeProps.Builder languageDescription(String languageDescription)

Sets the value of CaptionEncodeProps.getLanguageDescription()

Parameters:

languageDescription - Human-readable description of the captions (e.g. 'English', 'Spanish').

Returns:

this

build

@Stability(Experimental)
public CaptionEncodeProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CaptionEncodeProps>

Returns:

a new instance of CaptionEncodeProps

Throws:

NullPointerException - if any required attribute was not provided