Struct songbird::driver::Driver

pub struct Driver { /* private fields */ }

Available on crate feature driver only.

The control object for a Discord voice connection, handling connection, mixing, encoding, en/decryption, and event generation.

When compiled with the "builtin-queue" feature, each driver includes a track queue as a convenience to prevent the additional overhead of per-guild state management.

Implementations

impl Driver

pub fn new(config: Config) -> Self

Creates a new voice driver.

This will create the core voice tasks in the background.

pub fn connect(&mut self, info: ConnectionInfo) -> Connect

Connects to a voice channel using the specified server.

This method instantly contacts the driver tasks, and its does not need to be awaited to start the actual connection.

pub fn leave(&mut self)

Leaves the current voice channel, disconnecting from it.

This does not forget settings, like whether to be self-deafened or self-muted.

pub fn mute(&mut self, mute: bool)

Sets whether the current connection is to be muted.

If there is no live voice connection, then this only acts as a settings update for future connections.

pub fn is_mute(&self) -> bool

Returns whether the driver is muted (i.e., processes audio internally but submits none).

pub fn play_input(&mut self, input: Input) -> TrackHandle

Plays audio from an input, returning a handle for further control.

pub fn play_only_input(&mut self, input: Input) -> TrackHandle

Plays audio from an input, returning a handle for further control.

Unlike Self::play_input, this stops all other inputs attached to the channel.

pub fn play(&mut self, track: Track) -> TrackHandle

Plays audio from a Track object.

The main difference between this function and Self::play_input is that this allows for direct manipulation of the Track object before it is passed over to the voice and mixing contexts.

pub fn play_only(&mut self, track: Track) -> TrackHandle

Exclusively plays audio from a Track object.

As in Self::play_only_input, this stops all other sources attached to the channel. Like Self::play, however, this allows for direct manipulation of the Track object before it is passed over to the voice and mixing contexts.

pub fn set_bitrate(&mut self, bitrate: Bitrate)

Sets the bitrate for encoding Opus packets sent along the channel being managed.

The default rate is 128 kbps. Sensible values range between Bits(512) and Bits(512_000) bits per second. Alternatively, Auto and Max remain available.

pub fn stop(&mut self)

Stops playing audio from all sources, if any are set.

pub fn set_config(&mut self, config: Config)

Sets the configuration for this driver (and parent Call, if applicable).

pub fn config(&self) -> &Config

Returns a view of this driver’s configuration.

pub fn add_global_event<F: EventHandler + 'static>( &mut self, event: Event, action: F )

Attach a global event handler to an audio context. Global events may receive any EventContext.

Global timing events will tick regardless of whether audio is playing, so long as the bot is connected to a voice channel, and have no tracks. TrackEvents will respond to all relevant tracks, giving some audio elements.

Users must ensure that no costly work or blocking occurs within the supplied function or closure. Taking excess time could prevent timely sending of packets, causing audio glitches and delays.

pub fn remove_all_global_events(&mut self)

Removes all global event handlers from an audio context.

impl Driver

pub fn queue(&self) -> &TrackQueue

Available on crate feature builtin-queue only.

Returns a reference to this driver’s built-in queue.

Requires the "builtin-queue" feature. Queue additions should be made via Driver::enqueue and Driver::enqueue_input.

pub async fn enqueue_input(&mut self, input: Input) -> TrackHandle

Available on crate feature builtin-queue only.

Adds an audio Input to this driver’s built-in queue.

Requires the "builtin-queue" feature.

pub async fn enqueue(&mut self, track: Track) -> TrackHandle

Available on crate feature builtin-queue only.

Adds an existing Track to this driver’s built-in queue.

Requires the "builtin-queue" feature.

pub fn enqueue_with_preload( &mut self, track: Track, preload_time: Option<Duration> ) -> TrackHandle

Available on crate feature builtin-queue only.

Add an existing Track to the queue, using a known time to preload the next track.

See TrackQueue::add_with_preload for how preload_time is used.

Requires the "builtin-queue" feature.

Trait Implementations

impl Clone for Driver

fn clone(&self) -> Driver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Driver

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

Formats the value using the given formatter.

impl Default for Driver

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Driver

fn drop(&mut self)

Leaves the current connected voice channel, if connected to one, and forgets all configurations relevant to this Handler.