JavaFX 24 · com.sun.prism.MediaFrame · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public MediaFrame	Returns: valid MediaFrame in the specified format, or null if it cannot be converted convertToFormat(PixelFormat The new video pixel format, if the same format is specified then the same frame will be returned. If a conversion is unsupported then this will return null. The converted frame must be released when you're done with it by calling `releaseFrame` or it will leak. fmt) Converts the video frame to a different video format.
public ByteBuffer	Returns: the `ByteBuffer` for the specified plane or null for non-existent planes getBufferForPlane(int the numeric index of the plane, for chunky formats pass zero plane)
public int	Returns: height in pixels of the video image as produced by the video decoder getEncodedHeight()
public int	Returns: width in pixels of the video image as produced by the video decoder getEncodedWidth()
public int	Returns: height in pixels of the video image contained in this frame getHeight()
public PixelFormat	Returns: `PixelFormat` describing how pixels are stored in this frame's buffer getPixelFormat()
public int	Returns: width in pixels of the video image contained in this frame getWidth()
public void	holdFrame() This method will prevent the frame from being deallocated or recycled.
public int	Returns: the number of component planes, for packed formats this will always be one planeCount()
public int[]	Returns: int array containing the line stride for each plane planeStrides() The plane line stride is the number of bytes between two consecutive lines in the buffer.
public void	releaseFrame() When you're finished with a video frame, call this to allow the media subsystem to deallocate or recycle the frame immediately.
public int	Returns: the line stride for the specified plane strideForPlane(int which plane to get the stride for, valid range is zero to `planeCount()` non-inclusive planeIndex) The plane line stride is the number of bytes between two consecutive lines in the buffer.

Method Detail

convertToFormat back to summary

convertToFormat	back to summary
public MediaFrame convertToFormat(PixelFormat fmt) Converts the video frame to a different video format. Parameters fmt:PixelFormat The new video pixel format, if the same format is specified then the same frame will be returned. If a conversion is unsupported then this will return null. The converted frame must be released when you're done with it by calling `releaseFrame` or it will leak. Returns:MediaFrame valid MediaFrame in the specified format, or null if it cannot be converted

public MediaFrame convertToFormat(PixelFormat fmt)

Converts the video frame to a different video format.

Parameters

fmt:PixelFormat: The new video pixel format, if the same format is specified then the same frame will be returned. If a conversion is unsupported then this will return null. The converted frame must be released when you're done with it by calling releaseFrame or it will leak.

Returns:MediaFrame

valid MediaFrame in the specified format, or null if it cannot be converted

getBufferForPlane	back to summary
public ByteBuffer getBufferForPlane(int plane) Parameters plane:int the numeric index of the plane, for chunky formats pass zero Returns:ByteBuffer the `ByteBuffer` for the specified plane or null for non-existent planes

getEncodedHeight	back to summary
public int getEncodedHeight() Returns:int height in pixels of the video image as produced by the video decoder

getEncodedWidth	back to summary
public int getEncodedWidth() Returns:int width in pixels of the video image as produced by the video decoder

getHeight	back to summary
public int getHeight() Returns:int height in pixels of the video image contained in this frame

getPixelFormat	back to summary
public PixelFormat getPixelFormat() Returns:PixelFormat `PixelFormat` describing how pixels are stored in this frame's buffer

getWidth	back to summary
public int getWidth() Returns:int width in pixels of the video image contained in this frame

holdFrame	back to summary
public void holdFrame() This method will prevent the frame from being deallocated or recycled. It is very important to balance the use of this method by calling releaseFrame when you're done with it otherwise the memory occupied by the frame will never be released which could lead to out of memory conditions.

planeCount	back to summary
public int planeCount() Returns:int the number of component planes, for packed formats this will always be one

planeStrides back to summary

planeStrides	back to summary
public int[] planeStrides() The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's `PixelFormat` and decoder output. Returns:int[] int array containing the line stride for each plane

public int[] planeStrides()

The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's PixelFormat and decoder output.

Returns:int[]: int array containing the line stride for each plane

releaseFrame	back to summary
public void releaseFrame() When you're finished with a video frame, call this to allow the media subsystem to deallocate or recycle the frame immediately.

strideForPlane back to summary

strideForPlane	back to summary
public int strideForPlane(int planeIndex) The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's `PixelFormat` and decoder output. Parameters planeIndex:int which plane to get the stride for, valid range is zero to `planeCount()` non-inclusive Returns:int the line stride for the specified plane

public int strideForPlane(int planeIndex)

The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's PixelFormat and decoder output.

Parameters

planeIndex:int: which plane to get the stride for, valid range is zero to planeCount() non-inclusive

Returns:int

the line stride for the specified plane

public Interface MediaFrame

Method Summary

Method Detail