Package com.jwplayer.pub.api.media.captions

Class Caption.Builder

java.lang.Object
com.jwplayer.pub.api.media.captions.Caption.Builder
Enclosing class:
Caption
public static class Caption.Builder extends Object
Builder for Caption.

  • Constructor Details

    • Builder

      public Builder()

    • Builder

      public Builder(Caption caption)

  • Method Details

    • file

      public Caption.Builder file(String file)
      Parameters:
      file - URL to the captions, chapters or thumbnails text track file. All paths must have their protocol defined https://, file:///, asset:///

    • kind

      public Caption.Builder kind(CaptionType kind)
      Parameters:
      kind - The kind of text track.

    • label

      public Caption.Builder label(String label)
      Parameters:
      label - Label of the text track. Is only used in setups with multiple captions, where the label is displayed in the CC selection menu.

    • isDefault

      public Caption.Builder isDefault(boolean isDefault)
      Parameters:
      isDefault - Only for captions. Set this to true if you want a captions track to display by default

    • isIncludedInManifest

      public Caption.Builder isIncludedInManifest(boolean isIncludedInManifest)
      Parameters:
      isIncludedInManifest - Only for captions. Set this to true you have identical caption tracks in your HLS manifest to avoid duplicate caption options

    • build

      public Caption build()