Enum songbird::CoreEvent

#[non_exhaustive]pub enum CoreEvent {
    SpeakingStateUpdate,
    SpeakingUpdate,
    VoicePacket,
    RtcpPacket,
    ClientConnect,
    ClientDisconnect,
    DriverConnect,
    DriverReconnect,
    DriverConnectFailed,
    DriverReconnectFailed,
    SsrcKnown,
}

Voice core events occur on receipt of voice packets and telemetry.

Core events persist while the action in EventData returns None.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SpeakingStateUpdate

Fired on receipt of a speaking state update from another host.

Note: this will fire when a user starts speaking for the first time, or changes their capabilities.

SpeakingUpdate

Fires when a source starts speaking, or stops speaking (i.e., 5 consecutive silent frames).

VoicePacket

Fires on receipt of a voice packet from another stream in the voice call.

As RTP packets do not map to Discord’s notion of users, SSRCs must be mapped back using the user IDs seen through client connection, disconnection, or speaking state update.

RtcpPacket

Fires on receipt of an RTCP packet, containing various call stats such as latency reports.

ClientConnect

Fires whenever a user connects to the same stream as the bot.

ClientDisconnect

Fires whenever a user disconnects from the same stream as the bot.

DriverConnect

Fires when this driver successfully connects to a voice channel.

DriverReconnect

Fires when this driver successfully reconnects after a network error.

DriverConnectFailed

Fires when this driver fails to connect to a voice channel.

DriverReconnectFailed

Fires when this driver fails to reconnect to a voice channel after a network error.

Users will need to manually reconnect on receipt of this error.

SsrcKnown

Fires whenever the driver is assigned a new RTP SSRC by the voice server.

This typically fires alongside a DriverConnect, or a full DriverReconnect.

Trait Implementations

impl Clone for CoreEvent

fn clone(&self) -> CoreEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CoreEvent

impl Debug for CoreEvent

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

Formats the value using the given formatter.

impl Eq for CoreEvent

impl From<CoreEvent> for UntimedEvent

fn from(evt: CoreEvent) -> Self

Performs the conversion.

impl From<CoreEvent> for Event

fn from(evt: CoreEvent) -> Self

Performs the conversion.

impl Hash for CoreEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<CoreEvent> for CoreEvent

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for CoreEvent

impl StructuralPartialEq for CoreEvent