Engine
The active playback backend: the Adapter’s built-in engine, or the one engine plugin’s.
Properties
Section titled “Properties”| Property | Type |
|---|---|
filters |
ReadonlyMap<string, FilterDefinitionInfo> |
Methods
Section titled “Methods”createPlayer()
Section titled “createPlayer()”createPlayer(
session,options):Promise<Player>
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
session |
VoiceSession |
options |
PlayerOptions |
Returns
Section titled “Returns”Promise<Player>
createVoiceSession()?
Section titled “createVoiceSession()?”
optionalcreateVoiceSession(target,options):Promise<VoiceSession>
For an engine that owns its voice connection: opens the voice through it, so the connection sends the join and
receives the platform’s credentials as they arrive. When present, core calls it instead of
Adapter.createVoiceSession.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
VoiceTarget |
options |
VoiceSessionOptions |
Returns
Section titled “Returns”Promise<VoiceSession>
playbackRate()?
Section titled “playbackRate()?”
optionalplaybackRate(entries):number
Source seconds the ordered selection plays per wall second, as this engine composes it; finite and above 0. Core calls it with the next selection before each filter change’s Player command. Without it every selection plays at 1.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entries |
readonly FilterEntry[] |
Returns
Section titled “Returns”number
prepare()?
Section titled “prepare()?”
optionalprepare(song,options):Promise<PlaybackResource>
When present, prepares every Song; core then calls no plugin’s stream and runs no search fallback.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
song |
Song |
options |
{ signal: AbortSignal; } |
options.signal |
AbortSignal |
Returns
Section titled “Returns”Promise<PlaybackResource>