VoiceManager
The connected guild voices, usable with or without a queue.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Target |
VoiceChannelTarget |
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Returns
Section titled “Returns”number
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<DisTubeVoice<Target>>
Returns
Section titled “Returns”IterableIterator<DisTubeVoice<Target>>
get(
guildId):DisTubeVoice<Target> |undefined
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
guildId |
string |
Returns
Section titled “Returns”DisTubeVoice<Target> | undefined
has(
guildId):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
guildId |
string |
Returns
Section titled “Returns”boolean
join()
Section titled “join()”join(
channel,options?):Promise<DisTubeVoice<Target>>
Connects to channel, or moves the guild’s existing voice there.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
channel |
Target |
options? |
VoiceJoinOptions |
Returns
Section titled “Returns”Promise<DisTubeVoice<Target>>
leave()
Section titled “leave()”leave(
guildId):Promise<void>
Deletes the guild queue, then releases its voice or waits out a pending join. Concurrent calls share one cleanup.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
guildId |
string |
Returns
Section titled “Returns”Promise<void>