VoiceState

@vimp-mp/types 2.0.1

Interface · Client API

Snapshot of the local voice subsystem state.

interface VoiceState

Members

activeChannelId

activeChannelId: number | null

Selected channel ID, or null when no channel is selected.

degradedAec

degradedAec: boolean

Whether acoustic echo cancellation is running in degraded mode.

enabled

enabled: boolean

Whether voice is enabled for this client.

error

error: string | null

Current user-facing voice error, or null.

errorCode

errorCode?: string | null

Stable source code for the current error. Added fields may be absent on older runtimes.

errorReason

errorReason?: VoiceErrorReason | null

Stable reason suitable for localized UI. Added fields may be absent on older runtimes.

inputAvailable

inputAvailable: boolean

Whether a usable audio input device is available.

inputLevel

inputLevel: number

Current microphone input level.

isTalking

isTalking: boolean

Whether the local player is transmitting voice audio.

outputAvailable

outputAvailable: boolean

Whether a usable audio output device is available.

serverDeafened

serverDeafened: boolean

Whether the server prevents the local player from receiving audio.

serverMuted

serverMuted: boolean

Whether the server prevents the local player from transmitting.