DisTubeVoice
One guild’s voice connection and the settings that outlive its queues: volume, filters, self-deaf and self-mute.
Playback controls live on DisTubeQueue. The voice stays until leave, dispose or the platform ends it.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Target |
VoiceChannelTarget |
Properties
Section titled “Properties”| Property | Type |
|---|---|
filters |
FilterManager |
Accessors
Section titled “Accessors”channelId
Section titled “channelId”Get Signature
Section titled “Get Signature”get channelId():
string
The last channel the platform acknowledged.
Returns
Section titled “Returns”string
guildId
Section titled “guildId”Get Signature
Section titled “Get Signature”get guildId():
string
Returns
Section titled “Returns”string
selfDeaf
Section titled “selfDeaf”Get Signature
Section titled “Get Signature”get selfDeaf():
boolean
Returns
Section titled “Returns”boolean
selfMute
Section titled “selfMute”Get Signature
Section titled “Get Signature”get selfMute():
boolean
Returns
Section titled “Returns”boolean
volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
number
Returns
Section titled “Returns”number
Methods
Section titled “Methods”leave()
Section titled “leave()”leave():
Promise<void>
Deletes the guild queue, then releases the Player and the session.
Returns
Section titled “Returns”Promise<void>
move()
Section titled “move()”move(
channel):Promise<void>
Moves in call order; each move compares its target with the channel acknowledged when it runs.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
channel |
Target |
Returns
Section titled “Returns”Promise<void>
setSelfDeaf()
Section titled “setSelfDeaf()”setSelfDeaf(
enabled):Promise<void>
Runs after any pending move and writes to the channel acknowledged by then.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
enabled |
boolean |
Returns
Section titled “Returns”Promise<void>
setSelfMute()
Section titled “setSelfMute()”setSelfMute(
enabled):Promise<void>
Runs after any pending move and writes to the channel acknowledged by then.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
enabled |
boolean |
Returns
Section titled “Returns”Promise<void>
setVolume()
Section titled “setVolume()”setVolume(
percent):Promise<void>
Percentage from 0 to 1000; committed once the Player applies it. The built-in engine clips above 100.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
percent |
number |
Returns
Section titled “Returns”Promise<void>