Struct crabgrab::frame::VideoFrame

pub struct VideoFrame { /* private fields */ }

A frame of captured video

Implementations

impl VideoFrame

pub fn frame_id(&self) -> u64

Get the sequence id of this video frame (monotonically increasing)

Note: This is separate from audio frame ids

pub fn capture_time(&self) -> Instant

Get the Instant that this frame was delivered to the application

pub fn origin_time(&self) -> Duration

Get the time since the start of the stream that this frame was generated

pub fn size(&self) -> Size

Get the raw size of the frame

For planar image formats, this is the size of the largest plane

pub fn dpi(&self) -> f64

Get the dpi of the contents of the frame (accounting for capture scaling)

pub fn content_rect(&self) -> Rect

Get the rectangle of the frame representing containing the captured contents

Trait Implementations

impl Debug for VideoFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MacosIoSurfaceVideoFrameExt for VideoFrame

fn get_iosurface(&self) -> Result<IoSurface, GetIoSurfaceError>

Get the IOSurface representing the video frame’s texture

impl MetalVideoFrameExt for VideoFrame

fn get_metal_texture( &self, plane: MetalVideoFramePlaneTexture ) -> Result<Texture, MacosVideoFrameError>

Get the texture for the given plane of the video frame

impl VideoFrameBitmap for VideoFrame

fn get_bitmap(&self) -> Result<BoxedSliceFrameBitmap, VideoFrameBitmapError>

Create a bitmap image from this frame. This usually involves a memory transfer from VRAM to system RAM, and is an expensive operation.

fn get_pooled_bitmap( &self, bitmap_pool: &FrameBitmapPool ) -> Result<PooledFrameBitmap, VideoFrameBitmapError>

Get a pooled bitmap, waiting for one to become available if max pooled bitmaps are checked out

fn try_get_pooled_bitmap( &self, bitmap_pool: &FrameBitmapPool ) -> Result<Option<PooledFrameBitmap>, VideoFrameBitmapError>

Try and get a pooled bitmap using the given bitmap pool, and return Ok(None) if there are no pooled bitmaps available and max pooled bitmaps exist

impl WgpuVideoFrameExt for VideoFrame

fn get_wgpu_texture( &self, plane: WgpuVideoFramePlaneTexture, label: Option<&'static str> ) -> Result<Texture, WgpuVideoFrameError>

Get the texture for the given plane of the video frame

impl Send for VideoFrame

impl Sync for VideoFrame