Interface CaptionSource.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CaptionSource.Builder,CaptionSource>, SdkBuilder<CaptionSource.Builder,CaptionSource>, SdkPojo
Enclosing class:
CaptionSource
@Mutable @NotThreadSafe public static interface CaptionSource.Builder extends SdkPojo, CopyableBuilder<CaptionSource.Builder,CaptionSource>

  • Method Details

    • key

      CaptionSource.Builder key(String key)

      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

      Parameters:
      key - The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • language

      CaptionSource.Builder language(String language)

      A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

      • 2-character ISO 639-1 code

      • 3-character ISO 639-2 code

      For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

      Parameters:
      language - A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

      • 2-character ISO 639-1 code

      • 3-character ISO 639-2 code

      For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeOffset

      CaptionSource.Builder timeOffset(String timeOffset)

      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

      Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

      Parameters:
      timeOffset - For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

      Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • label

      CaptionSource.Builder label(String label)

      The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

      Parameters:
      label - The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryption

      CaptionSource.Builder encryption(Encryption encryption)

      The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

      Parameters:
      encryption - The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryption

      default CaptionSource.Builder encryption(Consumer<Encryption.Builder> encryption)

      The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

      This is a convenience method that creates an instance of the Encryption.Builder avoiding the need to create one manually via Encryption.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(Encryption).

      Parameters:
      encryption - a consumer that will call methods on Encryption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: