Struct VirtualCameraSettings 

pub struct VirtualCameraSettings {
    pub socket_path: String,
    pub width: u32,
    pub height: u32,
    pub fps_num: u32,
    pub fps_den: u32,
    pub pixel_format: String,
    pub slots: u32,
    pub queue_depth: u32,
    pub device_path: String,
    pub pipewire: bool,
    pub pipewire_node_name: String,
}

Configuration for VirtualCamera::start.

Fields

socket_path: String

Unix socket the interposer connects to.

width: u32

Advertised frame size; incoming frames are scaled and letterboxed to fit.

height: u32

fps_num: u32

Advertised frame rate as a fraction.

fps_den: u32

pixel_format: String

Raw device pixel format: “I420”, “NV12” or “YUYV”. Device pixel format: “I420” (the default; the browsers’ preference), “NV12”, “YUYV”, or “MJPEG” — a compressed device that carries an MJPEG uplink’s frames as received (no decode, one copy) and re-encodes only frames that must be fitted into the device size or arrive in another codec.

slots: u32

Ring slots (2..4); more slots tolerate slower readers.

queue_depth: u32

Encoded frames buffered ahead of the decoder before the oldest is dropped.

device_path: String

v4l2loopback output device: “” for none, “auto” to use the first one found, or a path.

pipewire: bool

Also publish the camera as a PipeWire Video/Source node when a daemon is reachable.

pipewire_node_name: String

PipeWire node name (the description shown to users is fixed).

Trait Implementations

impl DerefToPyAny for VirtualCameraSettings

impl ExtractPyClassWithClone for VirtualCameraSettings

impl<'py> IntoPyObject<'py> for VirtualCameraSettings

type Target = VirtualCameraSettings

The Python output type

type Output = Bound<'py, <VirtualCameraSettings as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for VirtualCameraSettings

const NAME: &str = "VirtualCameraSettings"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for VirtualCameraSettings

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for [`VirtualCamera::start`].

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<VirtualCameraSettings as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<VirtualCameraSettings>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDictSlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for VirtualCameraSettings

const TEXT_SIGNATURE: &'static str = "()"

impl PyMethods<VirtualCameraSettings> for PyClassImplCollector<VirtualCameraSettings>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for VirtualCameraSettings

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.