Meeting Provider - React Native
Meeting Provider simplifies configuration of meeting with by wrapping up core logic with react-context
.
Every Context object in react-js
comes with a Provider React component that allows consuming components to subscribe to context changes. To know more about context provider follow official document
Meeting Provider
<MeetingProvider
config={{
meetingId: "meeting-id",
micEnabled: true,
webcamEnabled: true,
name: "Participant Name",
notification: {
title: "Code Sample",
message: "Meeting is running.",
},
participantId: "xyz",
multiStream: true,
mode: "CONFERENCE", // "CONFERENCE" || "VIEWER"
defaultCamera: "back" // "front" || "back" // default : "front"
}}
token={"token"}
joinWithoutUserInteraction // Boolean
></MeetingProvider>
MeetingProvider Parameters
meetingId
Unique Id of the meeting where that participant will be joining.
- type :
String
REQUIRED
- type :
Please refer this documentation to create a room.
name
Name of the participant who will be joining the meeting, this name will be displayed to other participants in the same meeting.
- type : String
REQUIRED
micEnabled
Whether
mic
of the participant will be on while joining the meeting. If it is set tofalse
, then mic of that participant will bedisabled
by default, but can beenabled
ordisabled
later.- type:
Boolean
REQUIRED
- type:
webcamEnabled
Whether
webcam
of the participant will be on while joining the meeting. If it is set tofalse
, then webcam of that participant will bedisabled
by default, but can beenabled
ordisabled
later.- type:
Boolean
REQUIRED
- type:
token
The auth token generated from your server.
- type:
String
REQUIRED
- type:
Please refer this documentation to generate a token.
joinWithoutInteraction
If
joinWithoutInteraction
istrue
, participant will directly join the meeting with requring to explicitly callingjoin()
.If
joinWithoutInteraction
isfalse
, participant has to calljoin()
to join the meeting.- type:
Boolean
- default: false
OPTIONAL
- type:
notification
It contains the title and description for the notficiation that will be shown to user when they are in meeting.
type:
Object
OPTIONAL
title : String
- Represent the title fo the notification.
message : String
- Represent the Decription / message fo the notification.
participantId
You can specify your custom participantId here.
- type:
String
OPTIONAL
- type:
multiStream
Sets wheather to send multi resoultion streams while publishing video.
- type:
boolean
- defaultValue: true
OPTIONAL
- type:
customCameraVideoTrack
Set the initial custom video track using different encoding parameters, camera facing mode, and optimization mode.
- type:
MediaStream
OPTIONAL
- type:
customMicrophoneAudioTrack
Set the initial custom audio track using different encoding parameters and optimization mode.
- type:
MediaStream
OPTIONAL
- type:
mode
OPTIONAL
There are 2 types of modes:
CONFERENCE
: Both audio and video streams will be produced and consumed in this mode.VIEWER
: Audio and video streams will not be produced or consumed in this mode.defaultValue :
CONFERENCE
metaData
If you want to provide additional details about a user joining a meeting, such as their profile image, you can pass that information in this parameter.
- type:
Object
OPTIONAL
- type:
defaultCamera
This is an
OPTIONAL
parameter, it sets the initial camera.It will accept two values:
front
- Usefront
to initialize the camera with the front-facing (selfie) mode.back
- Useback
to initialize it with the rear-facing (main) mode.defaultValue:
front
debugMode
The
debugMode
parameter, when set to true, enables users to view detailed error logs generated by our SDK directly on the VideoSDK's dashboard. This feature facilitates efficient troubleshooting and debugging processes, providing users with valuable insights into the functioning of the SDK and aiding in the identification and resolution of potential issues.- type:
Boolean
- defaultValue : true
OPTIONAL
- type:
Got a Question? Ask us on discord