Struct AudioCaptureSettings 

pub(crate) struct AudioCaptureSettings {

    pub(crate) device_name: Py<PyAny>,
    pub(crate) sample_rate: u32,
    pub(crate) channels: i32,
    pub(crate) opus_bitrate: i32,
    pub(crate) frame_duration_ms: f64,
    pub(crate) use_vbr: bool,
    pub(crate) opus_complexity: Option<i32>,
    pub(crate) use_silence_gate: bool,
    pub(crate) debug_logging: bool,
    pub(crate) latency_ms: i32,
    pub(crate) omit_audio_header: bool,
    pub(crate) red_distance: i32,
    pub(crate) output_socket: String,
}

Python-facing capture/encode configuration read by start_capture.

Declared #[pyclass(dict)] so callers may stash extra attributes on instances; the fields below are the ones read by attribute name in extract_settings. device_name accepts str | bytes | None.

Fields

device_name: Py<PyAny>

sample_rate: u32

channels: i32

opus_bitrate: i32

frame_duration_ms: f64

use_vbr: bool

opus_complexity: Option<i32>

Opus encoder complexity, 0 (cheapest) to 10; out-of-range values raise ValueError at start. None leaves the encoder at libopus’s default. Applied when the encoder is created, so it does not change during a running capture.

use_silence_gate: bool

debug_logging: bool

latency_ms: i32

omit_audio_header: bool

red_distance: i32

output_socket: String

Unix socket path on which the capture serves its packets as an Ogg Opus stream to every consumer that connects; empty serves none. A path that cannot be bound fails the start like any other startup error.

Implementations

impl AudioCaptureSettings

pub(crate) fn new(py: Python<'_>) -> Self

Trait Implementations

impl DerefToPyAny for AudioCaptureSettings

impl ExtractPyClassWithClone for AudioCaptureSettings

impl<'py> IntoPyObject<'py> for AudioCaptureSettings

type Target = AudioCaptureSettings

The Python output type

type Output = Bound<'py, <AudioCaptureSettings 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 AudioCaptureSettings

const NAME: &str = "AudioCaptureSettings"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AudioCaptureSettings

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 = /// accepts `str | bytes | None`.

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 = <<AudioCaptureSettings as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<AudioCaptureSettings>

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 AudioCaptureSettings

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

impl PyMethods<AudioCaptureSettings> for PyClassImplCollector<AudioCaptureSettings>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for AudioCaptureSettings

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.