WebRTC

interface WebRTC

Functions

activateSimulcast

abstract fun activateSimulcast(activate: Boolean)

Activate simulcast.

addVideo

abstract fun addVideo(call: WebRTCCall?, front: Boolean): Boolean

this method is used to add video when the call is only in audio mode

dropVideo

abstract fun dropVideo(call: WebRTCCall?): Boolean

this method is used to drop video when the call is in video mode

getActiveSpeakerVideoTrack

abstract fun getActiveSpeakerVideoTrack(): VideoTrack?

Get the video track of the active speaker if available.

getCallByConferenceId

abstract fun getCallByConferenceId(confId: String?): WebRTCCall?

this method is used to get the current call matching the given conferenceId

getCallByContact

abstract fun getCallByContact(contact: IRainbowContact?): WebRTCCall?

this method is used to get the current call matching the given contact

getCallBySid

abstract fun getCallBySid(sid: String?): WebRTCCall?

this method is used to get the current call matching the given sid

getCalls

abstract fun getCalls(): List<WebRTCCall>

this method is used to get the current calls

getDistantVideoTracks

abstract fun getDistantVideoTracks(type: PeerSession.PeerSessionType): List<VideoTrack>

get distant video tracks by peer session type

abstract fun getDistantVideoTracks(publisherId: String?): List<VideoTrack>

get distant video tracks by publisher id

hangupCall

abstract fun hangupCall(call: WebRTCCall?)

This method is used to hangup a call when a call is established

hasExternalCamera

abstract fun hasExternalCamera(): Boolean

this method is used to determine if there is an available UBS camera plugged in

hasStreams

abstract fun hasStreams(): Boolean

Let you know if the current WebRTCCall has already audio or video streams.

holdVideo

abstract fun holdVideo(call: WebRTCCall?, publisherId: String?)

Hold the subscribed video from the given participant id in order to reduce data consumption (can be useful when a video is not displayed any more).

isMuted

abstract fun isMuted(): Boolean

is muted?

isServerPlayingRingBackTone

abstract fun isServerPlayingRingBackTone(): Boolean

Let you know if the server is playing ring back tone for outgoing PBX calls.

makeCall

abstract fun makeCall(contact: IRainbowContact, video: Boolean, front: Boolean, subject: String?)

Make a call using web rtc stack.

makeConferenceCall

abstract fun makeConferenceCall(conferenceId: String, jingleJid: String)

Let you establish a call within a conference that has previously been joined through the Bubbles module.

mute

abstract fun mute(mute: Boolean, distant: Boolean)

this method is used to mute me or a distant contact

muteOnlyDistant

abstract fun muteOnlyDistant(mute: Boolean)

this method is used to mute a distant contact

registerTelephonyListener

abstract fun registerTelephonyListener(listener: ITelephonyListener)

this method is used to register to web rtc events

registerTelephonyMgrListener

abstract fun registerTelephonyMgrListener(listener: TelephonyMgr.ITelephonyMgrListener)

this method is used to register to telephony events

rejectCall

abstract fun rejectCall(call: WebRTCCall?)

This method is used when user does not answer of an incoming call

requestExternalCameraPermission

abstract fun requestExternalCameraPermission(listener: IPermissionRequestListener)

this method is used to request permission access to the USB camera

retrieveVideo

abstract fun retrieveVideo(call: WebRTCCall?, publisherId: String?)

Retrieve the subscribed video from the given participant id in order to get back stream (can be useful when a video is displayed again).

switchCamera

abstract fun switchCamera(call: WebRTCCall?)

this method is used to switch camera

takeCall

abstract fun takeCall(call: WebRTCCall?, withVideo: Boolean, front: Boolean)

This method is used when incoming call event is detected

transferCall

abstract fun transferCall(call: WebRTCCall?, contact: IRainbowContact?, listener: RainbowListener<Unit, TransferRoutingError?>?)

Transfer the current P2P call to the given contact.

unregisterTelephonyListener

abstract fun unregisterTelephonyListener(listener: ITelephonyListener)

this method is used to unregister to web rtc events

unregisterTelephonyMgrListener

abstract fun unregisterTelephonyMgrListener(listener: TelephonyMgr.ITelephonyMgrListener)

this method is used to unregister to telephony events

Properties

callStatistics

abstract val callStatistics: IStatistics?

Get an object on the metrics and call's quality See IStatistics

eglBaseContext

abstract val eglBaseContext: EglBase.Context

this method is used to get the Egl Context needed to render videos

localVideoTrack

abstract val localVideoTrack: VideoTrack?

Get the video track of your current sent video if available