Struct Audio 

pub struct Audio {
    pub sender_session: u32,
    pub frame_number: u64,
    pub opus_data: Vec<u8>,
    pub positional_data: Vec<f32>,
    pub volume_adjustment: f32,
    pub is_terminator: bool,
    pub header: Option<Header>,
}

Fields

sender_session: u32

The session of the client (sender) this audio was originally sent from. This field is not required when sending audio to the server, but will always be set when receiving audio from the server.

frame_number: u64

The number of the first contained audio frame (indicating the position of that frame in the overall audio stream)

opus_data: Vec<u8>

The actual voice data payload in the Opus format.

positional_data: Vec<f32>

Optional positional data indicating the speaker’s position in a virtual world (in meters). This “list” is really expected to be an array of size 3 containing the X, Y and Z coordinates of the position (in that order).

volume_adjustment: f32

A volume adjustment determined by the server for this audio packet. It is up to the client to apply this adjustment to the resulting audio (or not). Note: A value of 0 means that this field is unset.

is_terminator: bool

A flag indicating whether this audio packet represents the end of transmission for the current audio stream

header: Option<Header>

Trait Implementations

impl Clone for Audio

fn clone(&self) -> Audio

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Audio

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

Formats the value using the given formatter.

impl Default for Audio

fn default() -> Self

Returns the “default value” for a type.

impl Message for Audio

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Audio

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Audio