CallObserver

interface CallObserver

An observer interface for Call event

Since

0.1

Types

Link copied to clipboard
abstract class AbstractCallEvent(call: Call?)

Base class for the event of a call

Link copied to clipboard

Base class for the event of a CallMembershipEvent

Link copied to clipboard
class ActiveSpeakerChangedEvent(    call: Call,     from: CallMembership?,     to: CallMembership?) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

Active Speaker has changed.

Link copied to clipboard
interface CallDisconnectedEvent : CallObserver.CallEvent

This event is fired when the call is disconnected.

Link copied to clipboard

This event is fired when the resources of the call object gets cleared after disconnection.

Link copied to clipboard

This event is fired when the call to be disconnected due to an error.

Link copied to clipboard
interface CallEvent

Base class for the event of a call

Link copied to clipboard
interface CallMembershipChangedEvent : CallObserver.CallEvent

Call membership change event

Link copied to clipboard

Camera FacingMode on local device has switched.

Link copied to clipboard

This event is fired when the local party has cancelled the call. This is only applicable when the direction of the call is outgoing. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

This event is fired when the local party has declined the call. This is only applicable when the direction of the call is incoming. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

This event is fired when local party has left the call. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

Local video rendering view size has changed.

Link copied to clipboard

Local video rendering view size has changed.

Link copied to clipboard
interface MediaChangedEvent : CallObserver.CallEvent

Media change event

Link copied to clipboard
class MediaStreamAvailabilityEvent(    call: Call,     available: Boolean,     stream: MediaStream?) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This will be triggered when the media stream is available or unavailable. Media Stream available - as the participant joins the meeting. Media Stream unavailable - as the participant leaves the meeting.

Link copied to clipboard

This might be triggered when the person in the membership is muted by others in the meeting.

Link copied to clipboard

This might be triggered when the person in the membership declined this call.

Link copied to clipboard
class MembershipJoinedEvent(call: Call, membership: CallMembership) : CallObserver.AbstractCallMembershipChangedEvent

This might be triggered when the person in the membership joined this call.

Link copied to clipboard
class MembershipLeftEvent(call: Call, membership: CallMembership) : CallObserver.AbstractCallMembershipChangedEvent

This might be triggered when the person in the membership left this call.

Link copied to clipboard

This might be triggered when the person in the membership started sending audio this call.

Link copied to clipboard

This might be triggered when the person in the membership started sharing this call.

Link copied to clipboard

This might be triggered when the person in the membership started sending video this call.

Link copied to clipboard
class MembershipWaitingEvent(    call: Call,     membership: CallMembership,     waitReason: Call.WaitReason) : CallObserver.AbstractCallMembershipChangedEvent

This might be triggered when the person in the membership is waiting in the lobby.

Link copied to clipboard

This event is fired when one of the other phones of the authenticated user has answered the call or when the meeting is moved to another device. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

One of the other phones of the authenticated user has declined the call. This is only applicable when the direction of the call is incoming.

Link copied to clipboard
class ReceivingAudio(call: Call, receiving: Boolean) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This might be triggered when the local party muted or unmuted the audio.

Link copied to clipboard
class ReceivingSharing(call: Call, receiving: Boolean) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This might be triggered when the local party muted or unmuted the remote content sharing.

Link copied to clipboard
class ReceivingVideo(call: Call, receiving: Boolean) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This might be triggered when the local party muted or unmuted the video.

Link copied to clipboard

This event is fired when the remote party has cancelled the call. This is only applicable when the direction of the call is incoming. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

This event is fired when the remote party has declined the call. This is only applicable when the direction of the call is outgoing. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

This event is fired when the remote party has left the call. This event is not applicable for Phone.CallingType.WebexCalling or Phone.CallingType.CUCM calls

Link copied to clipboard

This might be triggered when the remote party muted or unmuted the audio.

Link copied to clipboard

This might be triggered when the remote party muted or unmuted the content sharing.

Link copied to clipboard

This might be triggered when the remote party muted or unmuted the video.

Link copied to clipboard

Remote sharing rendering view size has changed.

Link copied to clipboard

Remote video rendering view size has changed.

Link copied to clipboard
class SendingAudio(call: Call, sending: Boolean) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This might be triggered when the local party muted or unmuted the audio.

Link copied to clipboard

This might be triggered when the local party started or stopped the content sharing.

Link copied to clipboard
class SendingVideo(call: Call, sending: Boolean) : CallObserver.AbstractCallEvent, CallObserver.MediaChangedEvent

This might be triggered when the local party muted or unmuted the video.

Functions

Link copied to clipboard
open fun onBreakoutError(error: BreakoutSession.BreakoutSessionError)

This will notify when any breakout api returns error

Link copied to clipboard
open fun onBreakoutUpdated(breakout: Breakout)

This will notify when Breakout is updated

Link copied to clipboard
open fun onBroadcastMessageReceivedFromHost(message: String)

This will notify when host broadcast the message to the session

Link copied to clipboard
open fun onCallMembershipChanged(event: CallObserver.CallMembershipChangedEvent?)

Callback when the memberships of this call have changed.

Link copied to clipboard
open fun onClosedCaptionsArrived(closedCaptions: CaptionItem)

This will notify when a caption item object arrives for the call

Link copied to clipboard
open fun onClosedCaptionsInfoChanged(closedCaptionsInfo: ClosedCaptionsInfo)

This will notify when closed caption info object changes, for e.g. when spoken language is changed

Link copied to clipboard
open fun onConnected(call: Call?)

Callback when remote participant(s) answered and the call is connected.

Link copied to clipboard
open fun onCpuHitThreshold()

This callback is triggered when CPU reaches threshold while using virtual background.

Link copied to clipboard
open fun onDisconnected(event: CallObserver.CallDisconnectedEvent?)

Callback when the call is disconnected (hangup, cancelled, get declined or other self device pickup the call).

Link copied to clipboard
open fun onHostAskingReturnToMainSession()

This will notify when host is asking participants to return to main meeting

Link copied to clipboard
open fun onInfoChanged(call: Call?)

Callback whenever a call information is changed for example - a participant is added or removed from call or mute status is changed

Link copied to clipboard
open fun onJoinableSessionUpdated(breakoutSessions: List<BreakoutSession>)

This will notify when list of joinable breakout session changes

Link copied to clipboard
open fun onJoinedSessionUpdated(breakoutSession: BreakoutSession)

This will notify when joined Breakout session is updated

Link copied to clipboard
open fun onMediaChanged(event: CallObserver.MediaChangedEvent?)

Callback when the media types of the call have changed.

Link copied to clipboard
open fun onMediaQualityInfoChanged(mediaQualityInfo: Call.MediaQualityInfo)

This will notify app whenever a media quality is changed.

Link copied to clipboard
open fun onMoveMeetingFailed(call: Call?)

This will notify when an attempt to move meeting fails for the call

Link copied to clipboard
open fun onPhotoCaptured(imageData: ByteArray?)

This will notify app whenever a photo is captured

Link copied to clipboard
open fun onReceivingNoiseInfoChanged(info: ReceivingNoiseInfo)

This will notify when receiving noise info object changes, for e.g. when initial background noise is detected

Link copied to clipboard
open fun onReturnedToMainSession()

This will notify when returned to main session

Link copied to clipboard
open fun onRinging(call: Call?)

Callback when remote participant(s) is ringing.

Link copied to clipboard
open fun onScheduleChanged(call: Call?)

Callback when the Call is scheduled call and the schedules of the call has been changed.

Link copied to clipboard
open fun onSessionClosing()

This will notify when Breakout session is closing

Link copied to clipboard
open fun onSessionEnabled()

This will notify when Breakout session is enabled

Link copied to clipboard
open fun onSessionJoined(breakoutSession: BreakoutSession)

This will notify when Breakout session is joined

Link copied to clipboard
open fun onSessionStarted(breakout: Breakout)

This will notify when Breakout session is started

Link copied to clipboard
open fun onStartRinging(call: Call?, ringerType: Call.RingerType)

Callback when a ringer is to be started.

Link copied to clipboard
open fun onStopRinging(call: Call?, ringerType: Call.RingerType)

Callback when a ringer is to be stopped

Link copied to clipboard
open fun onWaiting(call: Call?, reason: Call.WaitReason?)

Callback when the call is waiting.