Technical Reference

This is the list of parameters that you can configure in the code snippet of a Video Conference. You can add these as parameters of the SignalWire.AppKit.VideoConference function, for example:

SignalWire.AppKit.VideoConference({
  token: "vpt_6b96b7da83c56...",
  userName: "your-custom-name",
});

token:
The Video Conference token to access the room. Starts with vpt_.

userName:
A custom user name for the user joining the room. Default: undefined.

theme:
To force a specific color scheme. Allowed values are 'light' | 'dark' | 'auto'.

audio:
Audio constraints to use for the devices. Set to false if you don't want to use audio devices. Default: true

video:
Video constraints to use for the devices. Set to false if you don't want to use video devices. Default: true

memberList:
Set to false if you do not want to display the participant list. Default: true

chat:
Set to false if you do not want to display the chat. Default: true

layouts:
Set to false if you do not want to display the layout selection. Default: true

devicePicker:
Set to false if you do not want the user to be able to change devices (e.g. camera device). If false, this will hide the prejoin screen for device selection too. Default: true

setupRoomSession:
A callback which will be invoked when a RoomSession object is ready. Please refer to the documentation for the JavaScript SDK to get information on the available RoomSession methods. Example:

SignalWire.AppKit.VideoConference({
  token: "vpt_6b96b7da83c56...",
  setupRoomSession: (roomSession) => {
    console.log("roomSession ready");
  },
});