Constructor
new GuildAudioPlayer(guild)
Instantiates a new audio player.
Parameters:
Name | Type | Description |
---|---|---|
guild |
object | Discordie guild object. |
- Source:
Members
currentEncoder
Current encoder object
- Source:
encoderStream
Current encoder stream
- Source:
guild
Associated guild
- Source:
timestamp :number
Current playback timestamp.
Type:
- number
- Source:
voiceConnection
Current voice connection
- Source:
Methods
clean(disconnect)
Cleans resources and (optionally) disconnects from the voice channel.
Parameters:
Name | Type | Description |
---|---|---|
disconnect |
boolean | Set to true to disconnect |
- Source:
join(audioChannel) → {Promise.<Object>}
Joins a voice channel.
Parameters:
Name | Type | Description |
---|---|---|
audioChannel |
object | Discordie voice channel object |
- Source:
Returns:
Discordie voice connection object
- Type
- Promise.<Object>
play(audioChannel, path, flags) → {Promise.<Object>}
Plays an audio stream.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
audioChannel |
object | Discordie VoiceChannel object | |||||||||
path |
String | Stream path or URL | |||||||||
flags |
object | Flags to append to the FFMpeg command
Properties
|
- Source:
Returns:
Discordie encoder object
- Type
- Promise.<Object>
stop(disconnect)
Attempts to stop playback.
Parameters:
Name | Type | Description |
---|---|---|
disconnect |
boolean | Set to true to also disconnect from the voice channel |
- Source: