Skip to main content

Interface: VoiceSessionHandle

Handle returned by BaseEngine.startVoiceSession to control an active session.

Properties

channelId

channelId: string;

Voice channel identifier associated with the session.


commitInput()?

optional commitInput: () => Promise<void>;

Requests that buffered audio be committed for processing.

Returns

Promise<void>


guildId

guildId: string;

Guild identifier for the session.


id

id: string;

Unique identifier assigned to the session.


pump()?

optional pump: (frame) => Promise<void>;

Pump additional audio frames into the session.

Parameters

ParameterType
frameVoiceInputFrame

Returns

Promise<void>


stop()?

optional stop: (reason?) => Promise<void>;

Stop the session and optionally provide a reason.

Parameters

ParameterType
reason?string

Returns

Promise<void>


textChannelId?

optional textChannelId: null | string;

Related text channel identifier, when applicable.