Skip to content

Engine

The active playback backend: the Adapter’s built-in engine, or the one engine plugin’s.

Property Type
filters ReadonlyMap<string, FilterDefinitionInfo>

createPlayer(session, options): Promise<Player>

Parameter Type
session VoiceSession
options PlayerOptions

Promise<Player>


optional createVoiceSession(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.

Parameter Type
target VoiceTarget
options VoiceSessionOptions

Promise<VoiceSession>


optional playbackRate(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.

Parameter Type
entries readonly FilterEntry[]

number


optional prepare(song, options): Promise<PlaybackResource>

When present, prepares every Song; core then calls no plugin’s stream and runs no search fallback.

Parameter Type
song Song
options { signal: AbortSignal; }
options.signal AbortSignal

Promise<PlaybackResource>