Authorizes the users to obtain the authentication tokens through the password or JWT flow.
Destroys the RcvEngine instance and releases all resources used by the client SDK.
Get the audio device manager
The AudioDeviceManager instance if success
Gets the meeting context controller.
The RcvMeetingContextController instance
Gets an active meeting controller with a specific meeting id.
The MeetingController instance if success
Gets the preference controller.
The PreferenceController instance.
Gets the preference controller.
The PreferenceController instance.
Get the video device manager.
The VideoDeviceManager instance if success
Joins a meeting with a specific meeting id.
The meeting short id
The user-level meeting options.
The MeetingController instance
Removes the specified listener from the listener array for the event named eventName.
Adds the listener function to the end of the listeners array for the event named eventName.
off function handler
Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
Registers and dynamically imports a module to facilitate code splitting in the final build product.
This function is used to register a module and load it dynamically when needed, enabling code splitting to optimize the final build by only including necessary modules.
Refreshes the auth token pair immediately.
The authentication refresh token string.
0 means the action succeeds or fails otherwise
Request permission for getting audio and video device.
The permission parameters.
0 means the action succeeds or fails otherwise
Sets the token pair string in the SDK.
The authentication access token and refresh token pair JSON string
Default value is TRUE. If it's TRUE, the access token will be refreshed automatically once it expired
0 means the action succeeds or fails otherwise
Sets the local audio processor. By implementing the local audio processor, the application can receive audio raw data from the client SDK and can apply processing algorithm on its own.
Sets the local video processor. By implementing the local video processor, the application can receive YUV raw data from the client SDK and can apply processing algorithm on its own.
Starts an instant meeting with customized meeting-level settings for the participants and user-level meeting options.
The custom meeting settings, the default settings will be applied if it's null.
The MeetingController instance
Unregisters a previously registered module, allowing for removal and cleanup.
This function is used to unregister a module that was previously registered with 'registerModule'. Unregistering a module is essential for code cleanup and resource management in dynamic module loading scenarios.
Creates an RcvEngine object and returns the instance.
download logs from rcvEngine
download log levels
Returns the RcvEngine singleton instance.
The engine instance if success or undefined otherwise
The RcvEngine class is the entry point of the RingCentral video client SDK that empowers the applications to easily and quickly build real-time audio and video communication.