Call
A Call represents a media call on Cisco Webex. The application can create an outgoing call by calling Phone.dial function: The application can receive an incoming call on Phone.IncomingCallListener:
Since
0.1
Types
The options to switch audio output during a call.
The status of a Call.
The enumeration of directions of a call
The enumeration to enable, disable and auto enable camera flash
The enumeration to the media quality info types
The enumeration for a ringerType to denote the type of tone to be played / stopped
Enum representing the OptimizeType of Share
The enumeration to enable, disable and auto enable camera torch
The options to specify how the video adjusts its content to be render in a view.
The reasons for the call is waiting.
Properties
Functions
Answers this call. This can only be invoked when this call is incoming and in ringing status.
To check if the audio dump can be recorded for ongoing meeting/call.
Close the indicated auxiliary stream. You can invoke this API instead of MultiStreamObserver.onAuxStreamUnavailable to close an opened auxiliary stream
Transfers the active call to the given number. Current call immediately disconnects after transfering
Enable or Disable the Speech Enhancement for the call. Applicable for WebexCalling and CUCM calling.
Enable or Disable receiving noise removal functionality. If enabled, the noise present in incoming PSTN calls will be reduced. Applicable for WebexCalling and CUCM calling. Enable this using Phone.useLegacyReceiverNoiseRemoval(useLegacy: true) before making a call. Enabling it will disable the new speech enhancement. CallObserver.onReceivingNoiseInfoChanged will be fired with the result of this operation
To force landscape video transfer of local video view. Default value is false
Get the current active speaker
Get an indicated auxiliary stream.
Get the count of current available auxiliary streams
Get the exposure duration of the camera.
Get the exposure ISO of the camera.
Get the exposure target bias of the camera.
Get the camera flash mode.
Get the camera Torch mode.
Invoke this function to retrieve all closed captions generated from the beginning of this call.
Returns the closedCaptionInfo associated with this call
Returns the video layout of the active speaker and other attendees for the group video call.
Return the correlationId for this call.
Get the current audio output mode for the call.
Return the external tracking id for this call. This is applicable for WxC calls only and is empty for other type of calls.
Provides an instance of LiveAnnotations (if supported) that can be used to control and manage live annotations during a screen sharing session in a specific call. This instance allows developers to access all the functionality related to live annotations, including starting and stopping live annotations, setting the live annotations policy, and responding to live annotation requests.
Get the media Streams List - MediaStream. This list will return the streams which are available - the participants who joined the meeting.
Return the meeting id for this call
Get the observer for the events of multi-stream in this call
Get the count of already opened auxiliary streams
Returns the ReceivingNoiseInfo object for this call
Will returns the schedules of this call if this call has one or more schedules. If the call isn't a scheduled call, the method will returns null.
Return title for ScreenShare.
Indicates the Sharing optimization type of the call.
Return the associated space of this call
Get the local camera zoom factor.
Disconnects this call. This can only be invoked when this call is in answered status.
This invites a participant to the call. This is not applicable for WebexCalling and CUCM calls. Only a host or cohost can invite a participant.
Indicates whether add participant is supported for the active call.
Returns true if the closed captions is allowed for this call, otherwise false.
Returns true if Speech Enhancement is enabled else returns false.
To check if the audio dump is being recorded for ongoing meeting/call.
Indicates whether transfer is supported for the active call.
Indicates whether video calling is enabled for the user.
Join the Breakout Session manually by passing the `BreakoutSession` if host has enabled allow join session later.
Admit a CallMembership into the meeting from the lobby. This should be called by moderator.
Admit CallMemberships into the meeting from the lobby. This should be called by moderator.
Assign the host role to a participant. Only a host can assign the host role to another participant.
Merges a call. This method needs to be called after startAssociatedCall()
Mutes all other participants who are on call, also un-mutes the others if isMuted is true
This method is used to mute particular participant
Open a new auxiliary stream with a view. The Maximum of auxiliary streams can be opened is 4 currently. You can invoke this API instead of MultiStreamObserver.onAuxStreamAvailable to open an available auxiliary stream
Reclaim the host role using host key. If the user is self-owner of the meeting, then hostkey is not required.
Rejects this call. This can only be invoked when this call is incoming and in ringing status.
Remove the Active Speaker stream. To add the active stream back, use setMediaStreamCategoryA().
Remove the stream of pinned participant.
Remove all Category-B streams. To change the number of B streams, use setMediaStreamsCategoryB().
To return to main session
Sends DTMF events to the remote party. Valid DTMF events are 0-9, *, #, a-d, and A-D.
Sends feedback for this call to Cisco Webex team.
Set the camera auto exposure value using camera exposure target bias.
Set the camera custom exposure value using camera exposure duration and ISO.
Set the camera flash mode.
Set the camera focus at given coordinate.
Set the camera Torch mode.
Specify the composited video layout for the active speaker and other attendees in the group video meeting.
Add the Active Speaker stream with the specified params if it does not already exist. Otherwise, update the Active Speaker stream with the specified parameters.
If a pinned stream for the participant with participantId already exists, update the stream with the specified params. Otherwise, add a pinned stream for this participantId.
Set all Category-B streams to the specified params. If the number of existing B streams is less than numStreams, it will add B streams as necessary. If the number of existing B streams is more than numStreams, it will remove the extra B streams.
Set the observer for the events of multi-stream in this call
Observes the call events
Specify how the remote video adjusts its content to be render in a view.
This sets the spoken language for the call. Only host of this call can change spoken language.
This sets the translation language for this call.
Set the Zoom IN/OUT factor for the local camera.
This associates a new call with 3rd person. transferCall() needs to be called to transfer a call when a new call association is done, Returns a new call id after associating a call
To start recording the audio dump for ongoing meeting/call.
Start content sharing.
Start content sharing. The notification and it's id are only work for targetSdkVersion is 29 or higher.
To stop recording the audio dump.
Stop content sharing.
Switch the audio output mode during a call. When a call is connected and if the application is already connected to a bluetooth device, then audio will be routed via the bluetooth device. If bluetooth is not connected, then the audio will be routed to device earpiece. To change this default behaviour, you can use this API with the desired AudioOutputMode
To switch the current Webex Calling call to audio call.
To switch the current Webex Calling call to video call
Call this function to enable or disable closed captions for this call.
Transfers a call. This method needs to be called after startAssociatedCall()