Skip to main content

ConnectionProperty

Struct ConnectionProperty 

Source
pub struct ConnectionProperty {
    pub buffer: usize,
    pub valid_frame_count: u32,
    pub flags: BufferFlags,
    pub signature: u32,
}
Expand description

Audio buffer descriptor handed to / from APOProcess.

Cross-platform mirror of the Windows APO_CONNECTION_PROPERTY C struct. The framework’s COM harness translates one of these per input and per output connection when dispatching into crate::ProcessingObject::process.

buffer is a raw address (usize) to match Windows’s UINT_PTR pBuffer. Higher-level code that wraps the COM harness will turn this into a typed slice; doing so here is premature because the Format negotiated between the audio engine and the APO determines the element type and layout.

signature carries the 'APOC' magic the host stamps onto every connection (see CONNECTION_PROPERTY_SIGNATURE); the harness checks it before trusting the rest of the struct.

Fields§

§buffer: usize

Raw address of the audio buffer (pBuffer).

§valid_frame_count: u32

Number of audio frames containing valid data (u32ValidFrameCount).

§flags: BufferFlags

Buffer status flags (u32BufferFlags).

§signature: u32

'APOC' magic for tamper detection (u32Signature). The COM harness rejects buffers whose signature does not match CONNECTION_PROPERTY_SIGNATURE.

Implementations§

Source§

impl ConnectionProperty

Source

pub const fn empty() -> Self

Construct an empty descriptor: null buffer, zero frames, INVALID flags, and the correct signature.

Trait Implementations§

Source§

impl Clone for ConnectionProperty

Source§

fn clone(&self) -> ConnectionProperty

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionProperty

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ConnectionProperty

Source§

fn eq(&self, other: &ConnectionProperty) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ConnectionProperty

Source§

impl Eq for ConnectionProperty

Source§

impl StructuralPartialEq for ConnectionProperty

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.