Interface BlackFrame.Builder

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

  • Method Details

    • maxPixelThreshold

      BlackFrame.Builder maxPixelThreshold(Float maxPixelThreshold)

      A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.

      For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.

      The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.

      Parameters:
      maxPixelThreshold - A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.

      For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.

      The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.

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

    • minCoveragePercentage

      BlackFrame.Builder minCoveragePercentage(Float minCoveragePercentage)

      The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix.

      The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold set. You can reduce this value to allow more noise on the black frame.

      Parameters:
      minCoveragePercentage - The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix.

      The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold set. You can reduce this value to allow more noise on the black frame.

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