Data object GraphicsFrameMetadata
interface struct GraphicsFrameMetadata
Interface that contains per frame dynamic meta data which helps define a frame. Please see [IMediaSurface#presentBuffer]
Fields
frameSeqNumber
i32 — Required
Frame sequence number starts with ‘0’ and monotonically increases by ‘1’ for each new
frame. It is essential for maintaining the correct temporal order of video frames and
ensure that frames are displayed in the sequence intended by the content creators,
preserving the timing and flow of the video content.
crop
RectI — Required
Crop area of the frame. If RectI.width or height is 0, crop is treated as no-op.
pixelWidth
i32 — Required
Pixel Aspect Ratio (PAR) is the ratio of the width to the height of a single pixel
in a frame. Unlike the more commonly discussed aspect ratio of the entire image or
video frame (which describes the ratio of its width to its height), PAR focuses
specifically on the individual pixels that make up the image. Pixels may not be always
square i.e they might be wider than they are tall (PAR > 1) or taller than they are
wide (PAR < 1). We can calculate PAR information of a frame based on “pixelWidth” and
“pixelHeight”.
Pixel width, needed to calculate PAR
pixelHeight
i32 — Required
Pixel height, needed to calculate PAR
roi
RectI — Required
Region of interest (ROI) refers to a specific portion of the image or video frame
that is of higher interest for further processing or analysis compared to the rest
of the frame. If RectI.width or height is 0, ROI is treated as no-op.