Struct AudioFrame 

pub(crate) struct AudioFrame {
    pub(crate) data: Vec<u8>,
    pub(crate) pts: u64,
    pub(crate) pool: Option<Arc<BufferPool>>,
}

Zero-copy buffer-protocol result type handed to the Python callback.

Owns its Vec<u8> and exposes it read-only through the buffer protocol, so Python can read the encoded frame without a copy. When the last Python reference is released and the frame is dropped, a pooled buffer is recycled back to the capture thread (see the Drop impl), keeping the steady-state emit path allocation-free.

Fields

data: Vec<u8>

pts: u64

pool: Option<Arc<BufferPool>>

Set when the buffer came from a capture’s BufferPool; recycled to it on drop.

Implementations

impl AudioFrame

pub(crate) fn __len__(&self) -> usize

pub(crate) fn pts(&self) -> u64

pub(crate) unsafe fn __getbuffer__( slf: PyRefMut<'_, Self>, view: *mut Py_buffer, flags: c_int, ) -> PyResult<()>

Expose the owned bytes to Python’s buffer protocol without a copy.

PyBuffer_FillInfo INCREFs slf into view->obj, pinning the Vec alive until every memoryview / slice over it is released. The view is readonly, so the consumer cannot mutate the encoded frame.

pub(crate) unsafe fn __releasebuffer__(&self, _view: *mut Py_buffer)

Trait Implementations

impl DerefToPyAny for AudioFrame

impl Drop for AudioFrame

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.

impl ExtractPyClassWithClone for AudioFrame

impl<'py> IntoPyObject<'py> for AudioFrame

type Target = AudioFrame

The Python output type

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

const NAME: &str = "AudioFrame"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AudioFrame

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 = c"Zero-copy buffer-protocol result type handed to the Python callback.\n\nOwns its `Vec<u8>` and exposes it read-only through the buffer protocol, so Python can\nread the encoded frame without a copy. When the last Python reference is released and\nthe frame is dropped, a pooled buffer is recycled back to the capture thread (see the\n`Drop` impl), keeping the steady-state emit path allocation-free.\x00"

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

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 = PyClassDummySlot

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyMethods<AudioFrame> for PyClassImplCollector<AudioFrame>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for AudioFrame

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.