GuildQueueEvents
No description provided
GuildQueueEvents
| Property | Type | Value | Description |
|---|---|---|---|
| audioFiltersUpdate | ( queue: GuildQueue<Meta>, oldFilters: Array<keyof QueueFilters>, newFilters: Array<keyof QueueFilters> ) => unknown | N/A | Emitted when ffmpeg audio filters is updated |
| audioTrackAdd | ( queue: GuildQueue<Meta>, track: Track<unknown> ) => unknown | N/A | Emitted when audio track is added to the queue |
| audioTrackRemove | ( queue: GuildQueue<Meta>, track: Track<unknown> ) => unknown | N/A | Emitted when audio track is removed from the queue |
| audioTracksAdd | ( queue: GuildQueue<Meta>, track: Array<Track<unknown>> ) => unknown | N/A | Emitted when audio tracks were added to the queue |
| audioTracksRemove | ( queue: GuildQueue<Meta>, track: Array<Track<unknown>> ) => unknown | N/A | Emitted when audio tracks are removed from the queue |
| biquadFiltersUpdate | ( queue: GuildQueue<Meta>, oldFilters: null | BiquadFilters, newFilters: null | BiquadFilters ) => unknown | N/A | Emitted when biquad filters is updated |
| channelPopulate | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when a voice channel is populated |
| connection | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when a connection is created |
| connectionDestroyed | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when a connection is destroyed |
| debug | ( queue: GuildQueue<Meta>, message: string ) => unknown | N/A | Emitted when the queue sends a debug info |
| disconnect | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when the bot is disconnected from the channel |
| dspUpdate | ( queue: GuildQueue<Meta>, oldFilters: Array<'8D' | 'Tremolo' | 'Vibrato'>, newFilters: Array<'8D' | 'Tremolo' | 'Vibrato'> ) => unknown | N/A | Emitted when dsp filters is updated |
| emptyChannel | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when the voice channel is empty |
| emptyQueue | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when the queue is empty |
| equalizerUpdate | ( queue: GuildQueue<Meta>, oldFilters: Array<EqualizerBand>, newFilters: Array<EqualizerBand> ) => unknown | N/A | Emitted when equalizer config is updated |
| error | ( queue: GuildQueue<Meta>, error: Error ) => unknown | N/A | Emitted when the queue encounters error |
| playerError | ( queue: GuildQueue<Meta>, error: Error, track: Track<unknown> ) => unknown | N/A | Emitted when the audio player errors while streaming audio track |
| playerFinish | ( queue: GuildQueue<Meta>, track: Track<unknown> ) => unknown | N/A | Emitted when the audio player finishes streaming audio track |
| playerPause | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when audio player is paused |
| playerResume | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when audio player is resumed |
| playerSkip | ( queue: GuildQueue<Meta>, track: Track<unknown>, reason: TrackSkipReason, description: string ) => unknown | N/A | Emitted when the audio player skips current track |
| playerStart | ( queue: GuildQueue<Meta>, track: Track<unknown> ) => unknown | N/A | Emitted when the audio player starts streaming audio track |
| playerTrigger | ( queue: GuildQueue<Meta>, track: Track<unknown>, reason: PlayerTriggeredReason ) => unknown | N/A | Emitted when the audio player is triggered |
| queueCreate | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when a queue is successfully created |
| queueDelete | ( queue: GuildQueue<Meta> ) => unknown | N/A | Emitted when a queue is successfully deleted |
| voiceStateUpdate | ( queue: GuildQueue<Meta>, oldState: VoiceState, newState: VoiceState ) => unknown | N/A | Emitted when the voice state is updated. Consuming this event may disable default voice state update handler if Player.isVoiceStateHandlerLocked() returns false. |
| volumeChange | ( queue: GuildQueue<Meta>, oldVolume: number, newVolume: number ) => unknown | N/A | Emitted when audio player's volume is changed |
| willAutoPlay | ( queue: GuildQueue<Meta>, tracks: Array<Track<unknown>>, done: ( track: null | Track<unknown> ) => void ) => unknown | N/A | Emitted when a queue is trying to add similar track for autoplay |
| willPlayTrack | ( queue: GuildQueue<Meta>, track: Track<unknown>, config: StreamConfig, done: ( ...args: unknown[] ) => void ) => unknown | N/A | Emitted before streaming an audio track. This event can be used to modify stream config before playing a track. Listening to this event will pause the execution of audio player until done() is invoked. |