CaptionSourceSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.CaptionSourceSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CaptionSourceSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CaptionSourceSettings()

Constructors
Constructor and Description
`CaptionSourceSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CaptionSourceSettings`	`clone()`
`boolean`	`equals(Object obj)`
`AncillarySourceSettings`	`getAncillarySourceSettings()` Settings for ancillary captions source.
`DvbSubSourceSettings`	`getDvbSubSourceSettings()` DVB Sub Source Settings
`EmbeddedSourceSettings`	`getEmbeddedSourceSettings()` Settings for embedded captions Source
`FileSourceSettings`	`getFileSourceSettings()` If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.
`String`	`getSourceType()` Use Source (SourceType) to identify the format of your input captions.
`TeletextSourceSettings`	`getTeletextSourceSettings()` Settings specific to Teletext caption sources, including Page number.
`TrackSourceSettings`	`getTrackSourceSettings()` Settings specific to caption sources that are specified by track number.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAncillarySourceSettings(AncillarySourceSettings ancillarySourceSettings)` Settings for ancillary captions source.
`void`	`setDvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings)` DVB Sub Source Settings
`void`	`setEmbeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings)` Settings for embedded captions Source
`void`	`setFileSourceSettings(FileSourceSettings fileSourceSettings)` If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.
`void`	`setSourceType(String sourceType)` Use Source (SourceType) to identify the format of your input captions.
`void`	`setTeletextSourceSettings(TeletextSourceSettings teletextSourceSettings)` Settings specific to Teletext caption sources, including Page number.
`void`	`setTrackSourceSettings(TrackSourceSettings trackSourceSettings)` Settings specific to caption sources that are specified by track number.
`String`	`toString()` Returns a string representation of this object.
`CaptionSourceSettings`	`withAncillarySourceSettings(AncillarySourceSettings ancillarySourceSettings)` Settings for ancillary captions source.
`CaptionSourceSettings`	`withDvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings)` DVB Sub Source Settings
`CaptionSourceSettings`	`withEmbeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings)` Settings for embedded captions Source
`CaptionSourceSettings`	`withFileSourceSettings(FileSourceSettings fileSourceSettings)` If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.
`CaptionSourceSettings`	`withSourceType(CaptionSourceType sourceType)` Use Source (SourceType) to identify the format of your input captions.
`CaptionSourceSettings`	`withSourceType(String sourceType)` Use Source (SourceType) to identify the format of your input captions.
`CaptionSourceSettings`	`withTeletextSourceSettings(TeletextSourceSettings teletextSourceSettings)` Settings specific to Teletext caption sources, including Page number.
`CaptionSourceSettings`	`withTrackSourceSettings(TrackSourceSettings trackSourceSettings)` Settings specific to caption sources that are specified by track number.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CaptionSourceSettings
```
public CaptionSourceSettings()
```
- Method Detail
  - setAncillarySourceSettings
```
public void setAncillarySourceSettings(AncillarySourceSettings ancillarySourceSettings)
```
    Settings for ancillary captions source.
    
    Parameters:
    
    ancillarySourceSettings - Settings for ancillary captions source.
  - getAncillarySourceSettings
```
public AncillarySourceSettings getAncillarySourceSettings()
```
    Settings for ancillary captions source.
    
    Returns:
    
    Settings for ancillary captions source.
  - withAncillarySourceSettings
```
public CaptionSourceSettings withAncillarySourceSettings(AncillarySourceSettings ancillarySourceSettings)
```
    Settings for ancillary captions source.
    
    Parameters:
    
    ancillarySourceSettings - Settings for ancillary captions source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDvbSubSourceSettings
```
public void setDvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings)
```
    DVB Sub Source Settings
    
    Parameters:
    
    dvbSubSourceSettings - DVB Sub Source Settings
  - getDvbSubSourceSettings
```
public DvbSubSourceSettings getDvbSubSourceSettings()
```
    DVB Sub Source Settings
    
    Returns:
    
    DVB Sub Source Settings
  - withDvbSubSourceSettings
```
public CaptionSourceSettings withDvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings)
```
    DVB Sub Source Settings
    
    Parameters:
    
    dvbSubSourceSettings - DVB Sub Source Settings
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmbeddedSourceSettings
```
public void setEmbeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings)
```
    Settings for embedded captions Source
    
    Parameters:
    
    embeddedSourceSettings - Settings for embedded captions Source
  - getEmbeddedSourceSettings
```
public EmbeddedSourceSettings getEmbeddedSourceSettings()
```
    Settings for embedded captions Source
    
    Returns:
    
    Settings for embedded captions Source
  - withEmbeddedSourceSettings
```
public CaptionSourceSettings withEmbeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings)
```
    Settings for embedded captions Source
    
    Parameters:
    
    embeddedSourceSettings - Settings for embedded captions Source
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSourceSettings
```
public void setFileSourceSettings(FileSourceSettings fileSourceSettings)
```
    If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
    
    Parameters:
    
    fileSourceSettings - If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
  - getFileSourceSettings
```
public FileSourceSettings getFileSourceSettings()
```
    If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
    
    Returns:
    
    If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
  - withFileSourceSettings
```
public CaptionSourceSettings withFileSourceSettings(FileSourceSettings fileSourceSettings)
```
    If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
    
    Parameters:
    
    fileSourceSettings - If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceType
```
public void setSourceType(String sourceType)
```
    Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Parameters:
    
    sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    See Also:
    
    CaptionSourceType
  - getSourceType
```
public String getSourceType()
```
    Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Returns:
    
    Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    See Also:
    
    CaptionSourceType
  - withSourceType
```
public CaptionSourceSettings withSourceType(String sourceType)
```
    Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Parameters:
    
    sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CaptionSourceType
  - withSourceType
```
public CaptionSourceSettings withSourceType(CaptionSourceType sourceType)
```
    Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Parameters:
    
    sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CaptionSourceType
  - setTeletextSourceSettings
```
public void setTeletextSourceSettings(TeletextSourceSettings teletextSourceSettings)
```
    Settings specific to Teletext caption sources, including Page number.
    
    Parameters:
    
    teletextSourceSettings - Settings specific to Teletext caption sources, including Page number.
  - getTeletextSourceSettings
```
public TeletextSourceSettings getTeletextSourceSettings()
```
    Settings specific to Teletext caption sources, including Page number.
    
    Returns:
    
    Settings specific to Teletext caption sources, including Page number.
  - withTeletextSourceSettings
```
public CaptionSourceSettings withTeletextSourceSettings(TeletextSourceSettings teletextSourceSettings)
```
    Settings specific to Teletext caption sources, including Page number.
    
    Parameters:
    
    teletextSourceSettings - Settings specific to Teletext caption sources, including Page number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrackSourceSettings
```
public void setTrackSourceSettings(TrackSourceSettings trackSourceSettings)
```
    Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
    
    Parameters:
    
    trackSourceSettings - Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
  - getTrackSourceSettings
```
public TrackSourceSettings getTrackSourceSettings()
```
    Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
    
    Returns:
    
    Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
  - withTrackSourceSettings
```
public CaptionSourceSettings withTrackSourceSettings(TrackSourceSettings trackSourceSettings)
```
    Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
    
    Parameters:
    
    trackSourceSettings - Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CaptionSourceSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CaptionSourceSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaptionSourceSettings

Method Detail

setAncillarySourceSettings

getAncillarySourceSettings

withAncillarySourceSettings

setDvbSubSourceSettings

getDvbSubSourceSettings

withDvbSubSourceSettings

setEmbeddedSourceSettings

getEmbeddedSourceSettings

withEmbeddedSourceSettings

setFileSourceSettings

getFileSourceSettings

withFileSourceSettings

setSourceType

getSourceType

withSourceType

withSourceType

setTeletextSourceSettings

getTeletextSourceSettings

withTeletextSourceSettings

setTrackSourceSettings

getTrackSourceSettings

withTrackSourceSettings

toString

equals

hashCode

clone

marshall