Struct VirtualCamera 

pub struct VirtualCamera {
    running: Mutex<Option<Running>>,
    stats: Arc<Stats>,
}

A virtual camera fed with encoded frames by the consumer.

Fields

running: Mutex<Option<Running>>

stats: Arc<Stats>

Implementations

impl VirtualCamera

pub const CODEC_MJPEG: u32

The codec ids push takes, as the client names a frame’s codec on the wire.

pub const CODEC_H264: u32

pub const CODEC_VP8: u32

pub const CODEC_VP9: u32

pub const CODEC_AV1: u32

pub const CODEC_HEVC: u32

pub const KEYFRAME_WANTED: u32 = 1

push() result bit: the decoder needs a keyframe from the client to resume.

pub fn new() -> Self

pub fn start(&self, settings: &VirtualCameraSettings) -> Result<(), Error>

Bind the socket, allocate the ring, open the kernel device if configured, and start the decoder thread. Restarting a running camera stops it first.

pub fn push( &self, data: &[u8], codec: u32, keyframe: bool, rotation: u32, flip: bool, ) -> Result<u32, Error>

Hand one encoded frame to the decoder. data is the encoded payload; empty data pushes nothing and only reports. rotation (clockwise degrees: 0, 90, 180, or 270) and flip (a horizontal mirror applied after the rotation) carry the frame’s upright transform when the client’s encoder left it as metadata instead of baking it into the pixels; the decoded picture is oriented before it is fitted. Returns a bit set (KEYFRAME_WANTED) the caller relays to the client. Fails when the camera is not running, the codec id is unknown, or the rotation is not a quarter turn.

pub fn stop(&self)

Stop the decoder thread, close every interposer client, and remove the socket.

pub fn is_running(&self) -> bool

pub fn clients(&self) -> usize

Interposer clients that completed the handshake.

pub fn socket_path(&self) -> Option<String>

pub fn device_path(&self) -> String

Kernel device currently mirrored, or “” when none is in use.

pub fn stats(&self) -> CameraStats

Counters and the negotiated geometry.

Trait Implementations

impl Default for VirtualCamera

fn default() -> Self

Returns the “default value” for a type.

impl Drop for VirtualCamera

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.