RingCentral Video Client SDK for Android 0.14.4
 
Loading...
Searching...
No Matches
RingCentral Video Client SDK For Android

Overview

RingCentral video client SDK empowers you to easily and quickly starts your development efforts to create an Android app with real-time audio/video communications.

With the video client SDK you can:

  • Join or start a meeting with a valid access token.
  • Join the meeting as a guest. (The app needs to get the authorization of the guest type first)
  • Start audio/video communication with participants.
  • Mute and unmute local audio.
  • Start and stop the local video.
  • Sharing the device screen or camera.
  • Sends in-meeting private and public chat messages.
  • Receive 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.

More changes refers to Release notes.

Prerequisites

How To Use Video SDK With Android

  1. Add it in your root build.gradle at the end of repositories.

    allprojects {
    repositories {
    ...
    maven { url 'https://s01.oss.sonatype.org/content/repositories/releases' }
    }
    }

  2. Add the following lines under dependencies of your app build.gradle file.

    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.5.20"
    implementation "com.pubnub:pubnub-gson:4.29.2"
    implementation "com.ringcentral.video:ringcentral-video-sdk:version"

Getting Started

  1. Use your client ID and client secret to initial the RCV client SDK engine as code below, the client ID and client secret are required, the isShareUsageData to allow reporting usage data or not.

    RcvEngine.create(this.getApplicationContext(), <#client ID#>, <#client secret#>, <#isShareUsageData#>);

  2. If you intend to host a meeting or access your extension information, such as the meeting list or the recording list, etc, follow the steps in our RingCentral Video client SDK Dev Guide (https://ringcentral-ringcentral-video-api-docs.readthedocs-hosted.com/en/latest/client-sdk/authentication/) to procure the RingCentral authorization tokens and invoke the API method as code below.

    /*
    * There are two options to do the authentication.
    * (1) Using the JWT or password OAuth flow,
    * the client SDK will take care the authorization process.
    */
    RcvEngine.instance().authorize(<#OauthOption#>)
    /*
    * (2) You already have the auth token pair, pass it to the SDK as below.
    */
    RcvEngine.instance().setAuthToken(<#authorization token string#>, true);


  3. Next, follow the dev guide and API documentation or the sample projects to build your video application, enjoy programming!

Known Issues

  • Some interfaces are not supported yet in the current beta version, they are being actively developed. For example, the breakout room, etc.

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, so the default value of <#isShareUsageData#> is FALSE. To opt-out of this reporting, please make the following code change(s):

RcvEngine.create(this.getApplicationContext(), <#client ID#>, <#client secret#>, 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.

Contact Us