voicechat.getstatus Synchronous

Read a snapshot of playback, capture, and audio-format status.

Syntax

Luau

voicechat.getstatus() -> VoiceStatus

Parameters

This function takes no arguments.

Returns

VoiceStatus

A VoiceStatus record. Use state and error to inspect playback, and position and duration for progress. The remaining fields describe the source and submitted audio formats and processing counters.

VoiceStatus fields

Luau

VoiceStatus = {
  state: string, path: string, error: string,
  position: number, duration: number, speed: number, volume: number,
  micmuted: boolean, available: boolean, capturing: boolean,
  capturerate: number, capturechannels: number, captureblocks: number,
  unsupportedblocks: number, mode: string,
  sourcerate: number, sourcechannels: number, sourcebitdepth: number,
  sourceencoding: string, formatorigin: string,
  submittedrate: number, submittedchannels: number, submittedbitdepth: number,
  submittedencoding: string, submissionresult: number, submissionfailures: number,
  sourceblocks: number, transportbitdepth: number, capturehook: string,
  fileprocessing: string, processedblocks: number, fileblocks: number,
  enginemuted: boolean
}

Usage notes

This returns status at the time of the call. Read it again to observe later playback changes.