Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

VoiceState

Property Type Description
armed boolean Whether she has pressed her talk key under push to talk in this session: from then her microphone stays captured, sending nothing until she holds the key, so the key sends at once.
microphone boolean Whether the room takes her microphone, muted or not: false before the room opens voice, and when the browser or the room refuses it.
muted boolean Whether her microphone is off: true at the start of every session, in every room, until a tap on the microphone button, or with open mic a press of her talk key, turns it on. While it is off and she holds no talk key, the room gets nothing of her. Nothing keeps it across a reload.
pushing boolean Whether she holds her talk key under push to talk, which sends her while it is down.