PlayOptions
Defined in: src/structures/Types/Player.ts:115
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
clientTrack? | | UnresolvedTrack | Track | Adds track on queue and skips to it | - | src/structures/Types/Player.ts:119 |
endTime? | number | The position to end the track. | LavalinkPlayOptions.endTime | src/structures/Types/Player.ts:92 |
filters? | Partial<LavalinkFilterData> | The Lavalink Filters to use | only with the new REST API | LavalinkPlayOptions.filters |
noReplace? | boolean | Whether to not replace the track if a play payload is sent. | - | src/structures/Types/Player.ts:117 |
paused? | boolean | If to start “paused” | LavalinkPlayOptions.paused | src/structures/Types/Player.ts:94 |
position? | number | The position to start the track. | LavalinkPlayOptions.position | src/structures/Types/Player.ts:90 |
track? | object | Which Track to play | don’t provide, if it should pick from the Queue | LavalinkPlayOptions.track |
track.encoded? | string | The track encoded base64 string to use instead of the one from the queue system | - | src/structures/Types/Player.ts:106 |
track.identifier? | string | The identifier of the track to use | - | src/structures/Types/Player.ts:108 |
track.requester? | unknown | The Track requester for when u provide encodedTrack / identifer | - | src/structures/Types/Player.ts:112 |
track.userData? | anyObject | Custom User Data for the track to provide, will then be on the userData object from the track | - | src/structures/Types/Player.ts:110 |
voice? | LavalinkPlayerVoiceOptions | Voice Update for Lavalink | LavalinkPlayOptions.voice | src/structures/Types/Player.ts:100 |
volume? | number | The Volume to start with | LavalinkPlayOptions.volume | src/structures/Types/Player.ts:96 |