React functional component for overriding the default video placeholder
Set to true to enable active speaker callback, switches the pinned video to active speaker if you're using the pinned layout. (default: false)
Agora App ID - used to authenticate the request
Once set to true, the UI Kit attempts to join the channel. Can be set to false to initialise the SDK and wait before joining the channel. (default: true)
Channel name to join - users in the same channel can communicate with each other
Pass in a custom RTC client, to use your own implementation of the AgoraRTCClient.
Enable dual stream mode with selected fallback option. (default: disabled)
Enable the mic before joining the call. (default: true)
Enables dual stream mode. (default: false)
Enable the camera before joining the call. Only use for initiak(default: true)
Choose between grid layout and pinned layout. (default: pinned layout)
Set local user's role between audience and host. Use with mode set to livestreaming. (default: host)
(optional) Token used to join a channel when using secured mode (default: null)
(optional) URL for token server, manages fetching and updating tokens automatically. Must follow the schema here - https://github.com/AgoraIO-Community/agora-token-service/
(optional) UID for local user to join the channel (default: 0)
Generated using TypeDoc
Props object for customising the UI Kit functionality