Interface VideoProperties.Builder

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

  • Method Details

    • bitDepth

      VideoProperties.Builder bitDepth(Integer bitDepth)
      The number of bits used per color component such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR).
      Parameters:
      bitDepth - The number of bits used per color component such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bitRate

      VideoProperties.Builder bitRate(Long bitRate)
      The bit rate of the video track, in bits per second.
      Parameters:
      bitRate - The bit rate of the video track, in bits per second.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codecMetadata

      VideoProperties.Builder codecMetadata(CodecMetadata codecMetadata)
      Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions.
      Parameters:
      codecMetadata - Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codecMetadata

      default VideoProperties.Builder codecMetadata(Consumer<CodecMetadata.Builder> codecMetadata)
      Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions. This is a convenience method that creates an instance of the CodecMetadata.Builder avoiding the need to create one manually via CodecMetadata.builder().

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

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

    • colorPrimaries

      VideoProperties.Builder colorPrimaries(String colorPrimaries)
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      Parameters:
      colorPrimaries - The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorPrimaries

      VideoProperties.Builder colorPrimaries(ColorPrimaries colorPrimaries)
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      Parameters:
      colorPrimaries - The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frameRate

      VideoProperties.Builder frameRate(FrameRate frameRate)
      The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.
      Parameters:
      frameRate - The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • frameRate

      default VideoProperties.Builder frameRate(Consumer<FrameRate.Builder> frameRate)
      The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values. This is a convenience method that creates an instance of the FrameRate.Builder avoiding the need to create one manually via FrameRate.builder().

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

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

    • hdrMetadata

      VideoProperties.Builder hdrMetadata(HdrMetadata hdrMetadata)
      HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content.
      Parameters:
      hdrMetadata - HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hdrMetadata

      default VideoProperties.Builder hdrMetadata(Consumer<HdrMetadata.Builder> hdrMetadata)
      HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content. This is a convenience method that creates an instance of the HdrMetadata.Builder avoiding the need to create one manually via HdrMetadata.builder().

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

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

    • height

      VideoProperties.Builder height(Integer height)
      The height of the video track, in pixels.
      Parameters:
      height - The height of the video track, in pixels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matrixCoefficients

      VideoProperties.Builder matrixCoefficients(String matrixCoefficients)
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      Parameters:
      matrixCoefficients - The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matrixCoefficients

      VideoProperties.Builder matrixCoefficients(MatrixCoefficients matrixCoefficients)
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      Parameters:
      matrixCoefficients - The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rotation

      VideoProperties.Builder rotation(Integer rotation)
      The clockwise rotation angle of the video track, in degrees, as derived from container-level metadata (e.g. the MP4 tkhd transformation matrix or the Matroska ProjectionPoseRoll element). Common values are 90, 180, and 270. This field is null when no rotation metadata is present or when the rotation is 0 degrees. For MP4, non-standard transformation matrices also yield null.
      Parameters:
      rotation - The clockwise rotation angle of the video track, in degrees, as derived from container-level metadata (e.g. the MP4 tkhd transformation matrix or the Matroska ProjectionPoseRoll element). Common values are 90, 180, and 270. This field is null when no rotation metadata is present or when the rotation is 0 degrees. For MP4, non-standard transformation matrices also yield null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transferCharacteristics

      VideoProperties.Builder transferCharacteristics(String transferCharacteristics)
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      Parameters:
      transferCharacteristics - The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • transferCharacteristics

      VideoProperties.Builder transferCharacteristics(TransferCharacteristics transferCharacteristics)
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      Parameters:
      transferCharacteristics - The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • width

      VideoProperties.Builder width(Integer width)
      The width of the video track, in pixels.
      Parameters:
      width - The width of the video track, in pixels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.