Struct Player

pub struct Player { /* private fields */ }

A player for a guild connected to a node.

This can be used to send events over a node and to read the details of a player for a guild.

Implementations

impl Player

pub fn send( &self, event: impl Into<OutgoingEvent>, ) -> Result<(), NodeSenderError>

Send an event to the player’s node.

Returns a futures_channel TrySendError if the node has been removed.

Examples

Send a Play and Pause event:

use twilight_lavalink::{
    model::{Pause, Play},
    Lavalink,
};

let lavalink = Lavalink::new(user_id, 10);
let players = lavalink.players();

if let Some(player) = players.get(&guild_id) {
    player.send(Play::from((guild_id, track)))?;
    player.send(Pause::from((guild_id, true)))?;
}

Errors

Returns a NodeSenderErrorType::Sending error type if node is no longer connected.

pub const fn node(&self) -> &Arc<Node>

Return an immutable reference to the node linked to the player.

pub fn channel_id(&self) -> Option<Id<ChannelMarker>>

Return the player’s channel ID.

pub const fn guild_id(&self) -> Id<GuildMarker>

Return the player’s guild ID.

pub fn paused(&self) -> bool

Return whether the player is paused.

pub fn position(&self) -> i64

Return the player’s position.

pub fn time(&mut self) -> i64

Return the player’s time.

pub fn volume(&self) -> i64

Return the player’s volume.

Trait Implementations

impl Debug for Player

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

Formats the value using the given formatter.