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>
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>