Skip to content

Commit

Permalink
updated react native sdk dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Calinteodor authored and saghul committed Aug 1, 2023
1 parent cc36264 commit 5a726ba
Showing 1 changed file with 33 additions and 19 deletions.
52 changes: 33 additions & 19 deletions docs/dev-guide/react-native-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ module.exports = (async () => {

Our JitsiMeeting component renders the full meeting experience. This has some customizable properties:


### config
`Object` - Updates [configuration](https://github.com/jitsi/jitsi-meet/blob/master/config.js).


### flags
`Object` - Add different feature [flags](https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts)
that your meeting experience would like to have.
Expand All @@ -89,36 +94,45 @@ that your meeting experience would like to have.
'invite.enabled': true }} />
```

### meetingOptions
`Object` - Options that personalize your meeting experience:

- domain
`string` - Address where you would like to have your meeting experiences.

- roomName
`string` - Name of the room where the conference takes place.

- onReadyToClose
`Function` - Takes a function that gets triggered when ```READY_TO_CLOSE``` action is dispatched, more exactly when one exits a conference.
### eventListeners
`Object` - Options that personalize your meeting experience:

- onConferenceJoined
`Function` - Takes a function that gets triggered when ```CONFERENCE_JOINED``` action is dispatched, more exactly when a conference was joined.

- onConferenceLeft
`Function` - Takes a function that gets triggered when ```CONFERENCE_LEFT``` action is dispatched, more exactly when a conference was left.

- onConferenceWillJoin
`Function` - Takes a function that gets triggered when ```CONFERENCE_WILL_JOIN``` action is dispatched, more exactly when a conference will be joined.

- onConferenceLeft
`Function` - Takes a function that gets triggered when ```CONFERENCE_LEFT``` action is dispatched, more exactly when a conference was left.

- onParticipantJoined
`Function` - Takes a function that gets triggered when ```PARTICIPANT_JOINED``` action is dispatched, more exactly when a specific participant joined a conference.

- settings
`Object` - Accepts different ways to start a conference:
- onReadyToClose
`Function` - Takes a function that gets triggered when ```READY_TO_CLOSE``` action is dispatched, more exactly when one exits a conference.


### room
`string` - Name of the room where the conference takes place.

- `boolean` - startWithAudioMuted - Enables or disables starting a conference with audio muted.
- `boolean` - startAudioOnly - Enables or disables starting a conference with audio only.
- `boolean` - startWithVideoMuted - Enables or disables starting a conference with video muted.
### serverURL
`string` - Server where the conference should take place.

- style
### style
`Object` - CSS your meeting experience.

### token
`string` - JWT token used for authentication.

### userInfo

- avatarUrl
`string` - Path to participant's avatar.

- displayName
`string` - Default participant name to be displayed.

- email
`string` - Default email for participant.

0 comments on commit 5a726ba

Please sign in to comment.