Struct PlayerObject 

pub struct PlayerObject { /* private fields */ }

Represents an instance in a voice channel

Implementations

impl PlayerObject

pub async fn register_event_handler( &mut self, event_handler: impl CharcoalEventHandler + Send + 'static, )

Register an error callback that will be called if an error occurs on this PlayerObject

impl PlayerObject

pub async fn new( guild_id: String, com_tx: Sender<IPCData>, ) -> Result<Self, CreateJobError>

Creates a new Player Object that can then be joined to channel and used to playback audio

Trait Implementations

impl ChannelManager for PlayerObject

fn join_channel<'life0, 'async_trait>( &'life0 mut self, voice_channel_id: String, create_job: bool, ) -> Pin<Box<dyn Future<Output = Result<(), CreateJobError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create job on Hearth server for this PlayerObject

fn exit_channel<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), ChannelManagerError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Exit voice channel

impl Player for PlayerObject

fn play_from_http<'life0, 'async_trait>( &'life0 mut self, url: String, ) -> Pin<Box<dyn Future<Output = Result<(), PlayerActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Play from an HTTP URL

fn play_from_youtube<'life0, 'async_trait>( &'life0 mut self, url: String, ) -> Pin<Box<dyn Future<Output = Result<(), PlayerActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Play from a Youtube URL

impl TrackManager for PlayerObject

fn set_playback_volume<'life0, 'async_trait>( &'life0 self, playback_volume: f32, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set playback volume

fn force_stop_loop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop looping

fn loop_indefinitely<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Loop forever

fn loop_x_times<'life0, 'async_trait>( &'life0 self, times: usize, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Loop X amount of times

fn seek_to_position<'life0, 'async_trait>( &'life0 self, position: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Seek to position on track from start

fn resume_playback<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Resume playback

fn pause_playback<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Pause playback

fn get_metadata<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), TrackActionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get metadata for track currently being played