Enum mumble_protocol::voice::VoicePacket

pub enum VoicePacket<Dst: VoicePacketDst> {
    Ping {
        timestamp: u64,
    },
    Audio {
        _dst: PhantomData<Dst>,
        target: u8,
        session_id: Dst::SessionId,
        seq_num: u64,
        payload: VoicePacketPayload,
        position_info: Option<Bytes>,
    },
}

A packet transmitted via Mumble's voice channel.

Variants

Ping

Ping packets contain opaque timestamp-like values which should simply be echoed back.

Fields of Ping

timestamp: u64

Opaque timestamp-like value. Unless this is the echo, no assumptions about it should be made.

Audio

Packet containing audio data.

Fields of Audio

_dst: PhantomData<Dst>

Destination. Required due to encoding differences depending on packet flow direction.

target: u8

The target.

Only values 0-31 are valid (when serialized, this field is 5-bits long).

session_id: Dst::SessionId

Session ID. Absent when packet is Serverbound.

seq_num: u64

Sequence number of the first audio frame in this packet.

Packets may contain multiple frames, so this may increase by more than one per packet.

payload: VoicePacketPayload

The actual audio data

position_info: Option<Bytes>

Positional audio information.

Usually [f32; 3] but may contain additional or different data if all clients receiving this packet can deal with such values (e.g. games with builtin Mumble client may use this field to transmit additional data to other game clients).

Trait Implementations

impl<Dst: Clone + VoicePacketDst> Clone for VoicePacket<Dst> where
    Dst::SessionId: Clone, 

pub fn clone(&self) -> VoicePacket<Dst>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Dst: Debug + VoicePacketDst> Debug for VoicePacket<Dst> where
    Dst::SessionId: Debug, 

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

Formats the value using the given formatter.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Encoder<VoicePacket<EncodeDst>> for CryptState<EncodeDst, DecodeDst>

type Error = Error

The type of encoding errors.

pub fn encode(
    &mut self,
    item: VoicePacket<EncodeDst>,
    dst: &mut BytesMut
) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Encoder<VoicePacket<EncodeDst>> for VoiceCodec<EncodeDst, DecodeDst>

type Error = Error

The type of encoding errors.

pub fn encode(
    &mut self,
    item: VoicePacket<EncodeDst>,
    dst: &mut BytesMut
) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl<Dst: VoicePacketDst> From<VoicePacket<Dst>> for RawControlPacket

pub fn from(msg: VoicePacket<Dst>) -> Self

Performs the conversion.

impl<Dst: VoicePacketDst> From<VoicePacket<Dst>> for ControlPacket<Dst>

pub fn from(inner: VoicePacket<Dst>) -> Self

Performs the conversion.

impl<Dst: PartialEq + VoicePacketDst> PartialEq<VoicePacket<Dst>> for VoicePacket<Dst> where
    Dst::SessionId: PartialEq, 

pub fn eq(&self, other: &VoicePacket<Dst>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &VoicePacket<Dst>) -> bool

This method tests for !=.

impl<Dst: VoicePacketDst> StructuralPartialEq for VoicePacket<Dst>

impl<Dst: VoicePacketDst> TryFrom<Bytes> for VoicePacket<Dst>

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(bytes: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<Dst: VoicePacketDst> TryFrom<RawControlPacket> for VoicePacket<Dst>

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(packet: RawControlPacket) -> Result<Self, Self::Error>

Performs the conversion.