- Join Screen
- Camera Controls
- Mic Controls
- Redirect on Leave
- Share Your Screen
- Send Messages
- Record Meeting
- Go Live On Social Media
- Customize Branding
- Customize Permissions
- Pin Participants
- Layouts
-
Clone the repo
$ git clone https://github.com/MrSurana/videosdk-rtc-react-prebuilt-ui $ cd videosdk-rtc-react-prebuilt-ui -
Install NPM packages
$ npm install
-
Run the app
$ npm run start
Now your app will be running on http://localhost:3000, to customize the default options pass url parameters where app is running.
Example Url with parameters: http://localhost:3000?token=replaceWithYourMeetingToken&meetingId=yourMeetingId&webcamEnabled=true&micEnabled=true
| Parameter Name | Default Value | description |
|---|---|---|
token required |
- | meeting token |
| micEnabled | false | mic enabled by default |
| webcamEnabled | false | webcam enabled by default |
| name | - | participant name |
meetingId required |
- | meeting id |
| redirectOnLeave | - | URL where user will be redirected, after leaving the meeting |
| chatEnabled | false | chat panel visible or not |
| screenShareEnabled | false | can start screen sharing |
| pollEnabled | false | - |
| whiteBoardEnabled | false | - |
| participantCanToggleSelfWebcam | false | webcam toggle button visible or not |
| participantCanToggleSelfMic | false | mic toggle button visible or not |
| raiseHandEnabled | false | raise hand button visible or not |
| recordingEnabled | false | recording button visible or not |
| recordingWebhookUrl | - | calls webhook after recording completed |
| recordingEnabledByDefault | false | by default start recording on meeting joined |
| participantCanToggleRecording | false | can toggle recording |
| brandingEnabled | false | branding box visible or not |
| brandLogoURL | - | branding logo url |
| brandName | - | branch name |
| poweredBy | false | powered by videosdk.live text visible or not |
| participantCanLeave | true | meeting end button visible or not |
| liveStreamEnabled | false | live stream enabled or not |
| autoStartLiveStream | false | auto start live stream on meeting join |
| liveStreamOutputs | - | rtml outputs for live streaming the meeting |
| askJoin | false | ask host to join before joining the meeting |
| participantCanToggleOtherWebcam | - | participant can toggle webcam of other participant or not |
| participantCanToggleOtherMic | - | participant can toggle mic of other participant or not |
| joinScreenEnabled | true | join screen visible or not |
| joinScreenMeetingUrl | false | url where that meeting will be hosted |
| joinScreenTitle | false | title of join screen |
| notificationSoundEnabled | false | whether notification sound audible or not |
| layout | GRID | GRID or SPOTLIGHT or SIDEBAR |
| canPin | false | pin other participants |