@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BlackFrame extends Object implements Serializable, Cloneable, StructuredPojo
A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats, and time periods, they may contain different standards and varying noise levels for black frames that need to be accounted for. For more information, see StartSegmentDetection.
| Constructor and Description |
|---|
BlackFrame() |
| Modifier and Type | Method and Description |
|---|---|
BlackFrame |
clone() |
boolean |
equals(Object obj) |
Float |
getMaxPixelThreshold()
A threshold used to determine the maximum luminance value for a pixel to be considered black.
|
Float |
getMinCoveragePercentage()
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.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setMaxPixelThreshold(Float maxPixelThreshold)
A threshold used to determine the maximum luminance value for a pixel to be considered black.
|
void |
setMinCoveragePercentage(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.
|
String |
toString()
Returns a string representation of this object.
|
BlackFrame |
withMaxPixelThreshold(Float maxPixelThreshold)
A threshold used to determine the maximum luminance value for a pixel to be considered black.
|
BlackFrame |
withMinCoveragePercentage(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.
|
public void setMaxPixelThreshold(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.
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.
public Float getMaxPixelThreshold()
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.
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.
public BlackFrame withMaxPixelThreshold(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.
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.
public void setMinCoveragePercentage(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.
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.
public Float getMinCoveragePercentage()
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.
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.
public BlackFrame withMinCoveragePercentage(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.
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.
public String toString()
toString in class ObjectObject.toString()public BlackFrame clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.