Live Streaming
Configuration reference
The main VoxeraLiveRoomConfig fields.
VoxeraLiveRoom
| 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. Only the owner joins as host. |
config | No | A VoxeraLiveRoomConfig |
controller | No | An existing VoxeraRoomController |
tokenProvider | No | A function returning a prefetched token |
tokenBaseUrl, engineBaseUrl | No | Only for a different deployment |
adminIds is an older way to name moderators, which the owner promotes after they join. Use controller.assignAdmin instead. See Moderators.
VoxeraLiveRoomConfig
Stage and camera
| Field | Default | Description |
|---|---|---|
maxGuestTiles | 3 | How many co-publisher tiles to draw. It's a UI limit, and the stage itself is uncapped. |
autoHostCamera | false | Publishes on connect, instead of showing a preview and Go Live |
showGoLiveButton | true | Shows the built-in button. Turn it off to call VoxeraMediaController.goLive yourself. |
frontCameraOnJoin | Starts on the front camera | |
mirrorLocalVideo | Mirrors the local preview | |
hostFit, guestFit | How video fits its tile | |
videoQuality | hd | See Video quality |
roomMusicMode | track | See Room music |
PK
| Field | Description |
|---|---|
pkConfig | The PK layout, start sheet and slot builders. null turns PK off. See PK battles. |
Overrides
headerWidget, messagesWidget, controlsBarWidget, foregroundWidget, hostTileBuilder, guestTileBuilder, guestTileFooterBuilder and onStageTap each replace one part of the UI.