Package software.amazon.awssdk.services.medialive.model

Interface CaptionDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CaptionDescription.Builder,CaptionDescription>, SdkBuilder<CaptionDescription.Builder,CaptionDescription>, SdkPojo
Enclosing class:
CaptionDescription
public static interface CaptionDescription.Builder extends SdkPojo, CopyableBuilder<CaptionDescription.Builder,CaptionDescription>

  • Method Details

    • accessibility

      CaptionDescription.Builder accessibility(String accessibility)
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      Parameters:
      accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessibility

      CaptionDescription.Builder accessibility(AccessibilityType accessibility)
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      Parameters:
      accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • captionSelectorName

      CaptionDescription.Builder captionSelectorName(String captionSelectorName)
      Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
      Parameters:
      captionSelectorName - Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationSettings

      CaptionDescription.Builder destinationSettings(CaptionDestinationSettings destinationSettings)
      Additional settings for captions destination that depend on the destination type.
      Parameters:
      destinationSettings - Additional settings for captions destination that depend on the destination type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationSettings

      default CaptionDescription.Builder destinationSettings(Consumer<CaptionDestinationSettings.Builder> destinationSettings)
      Additional settings for captions destination that depend on the destination type. This is a convenience method that creates an instance of the CaptionDestinationSettings.Builder avoiding the need to create one manually via CaptionDestinationSettings.builder().

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

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

    • languageCode

      CaptionDescription.Builder languageCode(String languageCode)
      ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
      Parameters:
      languageCode - ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageDescription

      CaptionDescription.Builder languageDescription(String languageDescription)
      Human readable information to indicate captions available for players (eg. English, or Spanish).
      Parameters:
      languageDescription - Human readable information to indicate captions available for players (eg. English, or Spanish).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CaptionDescription.Builder name(String name)
      Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
      Parameters:
      name - Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionDashRolesWithStrings

      CaptionDescription.Builder captionDashRolesWithStrings(Collection<String> captionDashRoles)
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Parameters:
      captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionDashRolesWithStrings

      CaptionDescription.Builder captionDashRolesWithStrings(String... captionDashRoles)
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Parameters:
      captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionDashRoles

      CaptionDescription.Builder captionDashRoles(Collection<DashRoleCaption> captionDashRoles)
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Parameters:
      captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionDashRoles

      CaptionDescription.Builder captionDashRoles(DashRoleCaption... captionDashRoles)
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Parameters:
      captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dvbDashAccessibility

      CaptionDescription.Builder dvbDashAccessibility(String dvbDashAccessibility)
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      Parameters:
      dvbDashAccessibility - Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dvbDashAccessibility

      CaptionDescription.Builder dvbDashAccessibility(DvbDashAccessibility dvbDashAccessibility)
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      Parameters:
      dvbDashAccessibility - Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: