AudioRouting

Struct AudioRouting 

Source
pub struct AudioRouting { /* private fields */ }
Expand description

The compiled table the voice plane reads.

Replaced whole, never mutated in place: the voice plane loads it without a lock, and mutating it would put a lock on the audio path.

The transport half of the guide’s Delivery - the live UDP address, the OCB2 state, the output queue - is deliberately absent. Binding sessions to live transports is the voice plane’s job (guide 9.7, build step 8); what a shard owes it is who may hear whom, and from which version.

Implementations§

Source§

impl AudioRouting

Source

pub fn receivers(&self, sender: SessionId) -> &[SessionId]

The sessions that may hear sender, or an empty slice.

Source

pub fn since(&self, session: SessionId) -> Option<u64>

The shard version at which session became visible.

The voice plane gates on this: a receiver whose cursor has not reached the sender’s since does not get the packet, because it has not been told the sender exists yet and would discard the audio anyway.

It is per participant rather than per pair, which is what keeps the table O(N) instead of O(N squared).

Source

pub fn may_hear(&self, sender: SessionId, receiver: SessionId) -> bool

Whether receiver may hear sender at all, ignoring the cursor gate.

Source

pub fn may_speak(&self, sender: SessionId) -> bool

Whether this session’s voice may leave the server at all.

Every route already answers it - a muted sender has no receivers - so this exists for the one delivery that goes through no route: the server loopback. A muted microphone that still echoes back would tell its owner the line is open when nobody else can hear a thing.

Source

pub fn senders(&self) -> impl Iterator<Item = SessionId> + '_

Every sender that has at least one receiver.

Trait Implementations§

Source§

impl Clone for AudioRouting

Source§

fn clone(&self) -> AudioRouting

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioRouting

Source§

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

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

impl Default for AudioRouting

Source§

fn default() -> AudioRouting

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AudioRouting

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for AudioRouting

Source§

impl StructuralPartialEq for AudioRouting

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.