Class RcvEngine

Hierarchy

EventEmitter<EngineEvent>
- RcvEngine

Index

Methods

authorizeJwt authorizePassword destroy getMeetingController joinMeeting off on setAuthToken startInstantMeeting create instance

Methods

authorizeJwt

authorizeJwt(tokenPair: string): Promise<void>
Set jwt pair string in the SDK. This method must be called after creating RcvEngine right away.
Parameters
- tokenPair: string
Returns Promise<void>

authorizePassword

authorizePassword(usernamePair: string, passwordPair: string): Promise<void>
Set password pair string in the SDK. This method must be called after creating RcvEngine right away.
Parameters
- usernamePair: string
- passwordPair: string
  
  the password json string
Returns Promise<void>

destroy

destroy(): Promise<void>
Destroy the SDK resources note: Once you call destroy to destroy the created RcvEngine instance, you cannot use any method or callback in the SDK any more.

Returns Promise<void>

getMeetingController

getMeetingController(meetingId: string): null | MeetingController
Get an active meeting controller with a particular meeting id.
Parameters
- meetingId: string
Returns null | MeetingController

joinMeeting

joinMeeting(meetingId: string, options?: MeetingOptions): Promise<void>
Join an existing meeting with meeting ID

See
MeetingOptions
Parameters
- meetingId: string
  
  The ID of the meeting we want to join
- options: MeetingOptions = {}
  
  Setting options for meeting
Returns Promise<void>

off

off(eventName: EngineEvent, listener: TEventCB): void
Parameters
- eventName: EngineEvent
- listener: TEventCB
Returns void

Inherited from EventEmitter.off

on

on(eventName: EngineEvent, listener: TEventCB): TUnsubscribeFunction
Parameters
- eventName: EngineEvent
- listener: TEventCB
Returns TUnsubscribeFunction

Inherited from EventEmitter.on

setAuthToken

setAuthToken(tokenPair: string, autoRefresh?: boolean): Promise<void>
Set token pair string in the SDK. This method must be called after creating RcvEngine right away, the access token and refresh token pair must be both included if autoRefresh parameter is true.
Parameters
- tokenPair: string
  
  the access token and refresh token pair json string
- autoRefresh: boolean = true
  
  default value is TRUE. If it's TRUE, the access token will be refreshed automatically once it expired and the new token pair will be returned by the onAuthTokenRenew callback, otherwise, an error will be returned by the corresponding API event callback.
Returns Promise<void>

startInstantMeeting

startInstantMeeting(settings?: InstantMeetingSettings, options?: MeetingOptions): Promise<void>
Starts an instant meeting with default meeting settings. A successful call of startInstantMeeting triggers the onMeetingJoin callback.
Parameters
- Optional settings: InstantMeetingSettings
- Optional options: MeetingOptions
Returns Promise<void>

`Static` create

create(clientId: string, clientSecret: string): Promise<RcvEngine>
Creates an RcvEngine object and returns the instance.
Parameters
- clientId: string
  
  the application account identity number
- clientSecret: string
  
  the application account identity secret
Returns Promise<RcvEngine>

`Static` instance

instance(): null | RcvEngine
Returns the RcvEngine singleton instance.

Returns null | RcvEngine

Class RcvEngine

Hierarchy

Index

Methods

Methods

authorizeJwt

Parameters

tokenPair: string

Returns Promise<void>

authorizePassword

Parameters

usernamePair: string

passwordPair: string

Returns Promise<void>

destroy

Returns Promise<void>

getMeetingController

Parameters

meetingId: string

Returns null | MeetingController

joinMeeting

See

Parameters

meetingId: string

options: MeetingOptions = {}

Returns Promise<void>

off

Parameters

eventName: EngineEvent

listener: TEventCB

Returns void

on

Parameters

eventName: EngineEvent

listener: TEventCB

Returns TUnsubscribeFunction

setAuthToken

Parameters

tokenPair: string

autoRefresh: boolean = true

Returns Promise<void>

startInstantMeeting

Parameters

Optional settings: InstantMeetingSettings

Optional options: MeetingOptions

Returns Promise<void>

Static create

Parameters

clientId: string

clientSecret: string

Returns Promise<RcvEngine>

Static instance

Returns null | RcvEngine

Settings

Member Visibility

Theme

`Optional` settings: InstantMeetingSettings

`Optional` options: MeetingOptions

`Static` create

`Static` instance