Catalyst Docs

Parameters

Catalyst provides a wide variety of required and optional parameters to customize your instance. Below is a table for your use. For more details on each specific prop, view the relevant documentation pages.

Prop	Description	Type	Example Value	Required
`room`	Unique session identifier (peers with the same `room` are connected)	`string`	`ROOM_NAME`	Required
`appId`	Unique project identifier, obtained from the API keys tab of our management portal	`string`	`YOUR_CATALYST_PROJECT_ID`	Required
`name`	Display name of member joining the call	`string`	`MEMBER_NAME`	Optional
`fade`	Milliseconds of no user interaction before fading out controls. Disabled when set to `0`	`number`	`600`	Optional
`audioOnDefault`	Is microphone enabled by default	`boolean`	`true`	Optional
`videoOnDefault`	Is webcam enabled by default	`boolean`	`true`	Optional
`theme`	Color scheme. Includes: primary (main color), secondary (background color), tertiary (button color), quaternary (button hover color), quinary (text color)	`string`	`{ primary?: string; secondary?: string; tertiary?: string; quaternary?: string; quinary?: string; }`	`default`
`simulcast`	Publish multiple levels of quality for video streams	`boolean`	`true`	Optional
`bgRemoval`	Set video background removal options, including blur or custom background image path	`string`	`blur`, `https://img.png`	Optional
`disableChat`	Hide text chat functionality	`boolean`	`true`	Optional
`disableSelfieMode`	Stop auto-correction of uncanny-valley effect that flips portrait camera	`boolean`	`true`	Optional
`disableSetupView`	Skip setup view	`boolean`	`true`	Optional
`disableNameField`	Hide user name input field in setup view	`boolean`	`true`	Optional
`cstmSetupBg`	Gradient or hex-code background for setup view	`string`	`#fff`	Optional
`disableRefreshBtn`	Hide refresh button in top settings bar	`boolean`	`true`	Optional
`cstmWelcomeMsg`	Message displayed when you are the only member in room	`string`, `HTMLElement`	`Welcome!`	Optional
`cstmSupportUrl`	Url for all help/support messages. When set to an empty string hides support icon.	`string`	`https://catalyst.chat/contact.html`	Optional
`arbData`	Data passed to all other members of room	`Uint8Array`	`TextEncoder().encode('str')`	Optional
`handleReceiveArbData`	Function triggered whenever arbitrary data is received	`Function`	`(arbData: Uint8Array) => void`	Optional
`handleUserData`	Function passed all user metadata after token is generated	`Function`	`(userData: CatalystUserData) => void`	Optional
`onJoinCall`	Function triggered when user joins the call	`Function`	`() => void`	Optional
`onMemberJoin`	Function triggered when a member joins the call	`Function`	`() => void`	Optional
`onMemberLeave`	Function triggered when a member leaves the call	`Function`	`() => void`	Optional
`onLeaveCall`	Function triggered when user leaves call	`Function`	`() => void`	Optional