Live Audio Room
Configuration reference
Every VoxeraAudioRoom parameter and the main VoxeraAudioRoomConfig fields.
VoxeraAudioRoom
| Parameter | Required | Description |
|---|---|---|
appId | Yes | Your App ID |
appKey | Yes | Your publishable App Key |
userId | Yes | The local user's identity |
userName | Yes | The local user's display name |
roomId | Yes | The room to join or create |
roomOwnerId | Yes | The owner's identity, used to detect the host and for owner-only actions |
layoutMode | No | The layout to use. The default, '3', has 9 seats. See layout modes. |
modes | No | Custom VoxeraRoomModes to register |
config | No | A VoxeraAudioRoomConfig |
controller | No | An existing VoxeraRoomController, for example after minimizing |
tokenProvider | No | A function returning a prefetched token. See Fast first join. |
onControllerReady | No | Receives the controller |
onConnectionChanged | No | Receives bool isConnected |
onSeatTap | No | Replaces the built-in seat sheet |
onSeatChanged | No | Receives List<SeatState> seats |
onConnectError | No | Replaces the built-in connect error view |
tokenBaseUrl, engineBaseUrl | No | Only for a different deployment |
adminIds still exists for older code, but it's deprecated. Use controller.assignAdmin.
VoxeraAudioRoomConfig
Behavior
| Field | Default | Description |
|---|---|---|
showControlsBar | true | Shows the controls bar |
showSeatNames | true | Shows names under seats |
enableMinimize | true | Allows minimizing |
turnOnMicrophoneWhenJoining | false | Joins with the microphone on |
useSpeakerWhenJoining | true | Starts on the loudspeaker |
hostSeatIndex | 0 | The seat the host takes |
autoHostMic | true | A host or admin joins with the microphone on |
autoSeatHost | true | The host takes hostSeatIndex if it's empty |
useDefaultBackground | true | Paints theme.background when there's no backgroundWidget |
roomMusicMode | track | See Room music |
userInRoomAttributes | none | Attributes shared with others, such as name and avatar |
Look and feel
| Field | Description |
|---|---|
theme, strings | See Theming and strings |
headerWidget, messagesWidget, controlsBarWidget, backgroundWidget, foregroundWidget, pkWidget | Section overrides |
seatBuilder, avatarBuilder, emptySeatBuilder, lockedSeatBuilder | Seat builders |