Skip to main content

AudioCaptureSettings

Struct AudioCaptureSettings 

Source
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) 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,
}
Expand description

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§use_silence_gate: bool§debug_logging: bool§latency_ms: i32§omit_audio_header: bool§red_distance: i32

Implementations§

Source§

impl AudioCaptureSettings

Source

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

Trait Implementations§

Source§

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

Source§

type Target = AudioCaptureSettings

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl PyClass for AudioCaptureSettings

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for AudioCaptureSettings

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// accepts `str | bytes | None`.

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<AudioCaptureSettings>

This handles following two situations: Read more
Source§

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

Immutable or mutable
Source§

type Dict = PyClassDictSlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

fn dict_offset() -> Option<Py_ssize_t>

Source§

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

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for AudioCaptureSettings

Source§

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

Source§

impl PyMethods<AudioCaptureSettings> for PyClassImplCollector<AudioCaptureSettings>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for AudioCaptureSettings

Source§

const NAME: &'static str = "AudioCaptureSettings"

Class name.
Source§

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

Module name, if any.
Source§

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.
Source§

impl DerefToPyAny for AudioCaptureSettings

Source§

impl ExtractPyClassWithClone for AudioCaptureSettings

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0:

Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.

Name of self. This is used in error messages, for example.
§

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

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,