@ringcentral/video-sdk

RingCentral Video Client SDK for Web Browser

Overview

By RingCentral video SDK, you could use less efforts to create a web application with real-time audio/video communications.

With the video client SDK you can:

• Joins or starts a meeting with a valid access token.
• Joins the meeting as a guest. (The app needs to get the authorization of the guest type first)
• Starts the audio/video communication with participants.
• Mutes and unmutes the local audio.
• Starts and stops the local video.
• Sharing the device screen or application.
• Sends in-meeting private and public chat messages.
• Starts an stops the local audio and video device test.
• Receives meeting and media event callback, such as participant joined/leave, audio/video muted/unmuted.
• Host or moderator privileges:
  • Mutes and unmutes a specific participant' audio or video.
  • Mutes and unmutes all meeting users' audio or video.
  • Locks/unlocks the meeting.
  • Starts and pauses the recording.
  • Assigns and revokes the moderator role with meeting users.
  • Puts in-meeting users into the waiting room.
  • Admits/denies a user from the waiting room.
  • Admits all users from the waiting room.
  • Stops remote users' sharing.
  • Locks and unlocks the meeting sharing function.
  • Removes the meeting user from the active meeting.
• Starts and pauses recording.
• Starts and pauses close captions.
• Starts and pauses live transcription.

More changes refers to Release notes.

Prerequisites

• RingCentral Video Account (free - https://app.ringcentral.com/signup)
• Access to RingCentral Video Documentation

Installation

yarn add @ringcentral/video-sdk

or

npm install @ringcentral/video-sdk

or

pnpm install @ringcentral/video-sdk

Getting Started

Step 1: Init SDK by clientId and clientSecret

const engine = RcvEngine.create({clientId, clientSecret});

More init properties refer to Interface EngineInitConfig.

Step 2: Finish authorization

// if config jwt, initialize SDK with jwt, else initialize SDK with password
await engine.authorize({
      grantType: jwt ? GrantType.JWT : GrantType.PASSWORD,
      jwt,
      username: userName,
      password,
})    
// or inject auth token
engine.setAuthToken(token);        

For more details refer to Class RcvEngine.

Step 3: Start or join a meeting

It recommends listening to basic meeting events.

// add listeners
rcv.on(EngineEvent.MEETING_JOINED, (meetingId, errorCode) => {})
rcv.on(EngineEvent.MEETING_LEFT, () => {})
// join a meeting
rcv.joinMeeting(meetingId, { password })
// or start a meeting
rcv.startInstantMeeting()

Reporting usage data

We have included in the SDK the ability to send important usage data back to RingCentral systems to help product teams improve the product, monitor for issues, and better understand how developers and users are engaging with the products this SDK powers. This is enabled by default.

We understand that some may prefer this information not be transmitted to RingCentral via the SDK. To opt-out of this reporting, please make the following code change(s):

RcvEngine.create({
    clientId,
    clientSecret,
    isShareUsageData: false
})

What information do we transmit

When enabled, our reporting system transmits data when certain events are triggered. Accompanying each event is the following metadata:

• Client ID
• Anonymized account ID
• SDK user-agent (name and version)
• Event performed
• Other event-specific meta data as needed

We do not transmit any personal data or personally identifiable information.

Load E2EE and VBG modules on demand

We will not load E2EE and VBG module by default, for reducing Client SDK packet size. If you need open E2EE or apply VBG (virtual background) to video, please register those modules as below:

import E2EE from '@ringcentral/video-sdk/e2ee';
import VBG from '@ringcentral/video-sdk/vbg';

rcvEngine.registerModule({
    e2ee: E2EE,
    vbg: VBG,
});

Contact Us

Dev Support & Feedback: For feedback, questions, or suggestions around SDK please email [e-mail] or [e-mail].