Phone
Phone is a wrapper of the available calling related APIs
Since
0.1
Types
The enumeration of audio BNR mode choices, default is HP.
Represents Calling service type of logged in user
The enumeration of common bandwidth choices.
The enumeration of Camera facing modes.
The options for H.264 video codec license from Cisco Systems, Inc
The interface for a listener for incoming call
The enumeration of service url.
The enumeration of remote video stream.
Represents different types of modes for setting Virtual Background
Represents different Virtual Background types
Functions
adds a virtual background. It will resize the uploaded image if its larger than 1280x720
Applies the virtual background for a video preview/call based on the VirtualBackgroundMode
Builds the payload from FCM notification. This payload needs to be supplied to Phone.processPushNotification as first parameter
API for signing into phone services for CallingType.WebexCalling and CallingType.WebexForBroadworks. Result of connection status is notified in WebexUCLoginDelegate.onUCServerConnectionStateChanged.
Decrypts the payload received via PushREST for an incoming CUCM call
Makes a call to an intended recipient on behalf of the authenticated user
Dials the given phone number on behalf of the authenticated user
Prevents the SDK from popping up an Alert for the end user to approve the use of H.264 video codec license from Cisco Systems, Inc.
API for signing out of phone services for CallingType.WebexCalling and CallingType.WebexForBroadworks. Result of connection status is notified in WebexUCLoginDelegate.onUCServerConnectionStateChanged.
Toggle to enable or disable ask for android.Manifest.permission.READ_PHONE_STATE permission, true by default. When target SDK >= 30, this permission is required to check the network state, so SDK can auto-tuning performance during calls.
Enable audio background noise removal. Default is false
Turn on audio enhancement for the specified device models. By default, the audio enhancement is enable for Samsung S7/S7Edge/S8/S8+/S9/S9+/S10/S10+/S10e/Note8/Note9.
Set true to keep Webex server connection when minimize app. Default is false. When set to true, app will receive notifications in background, include incoming calls, messages, space updates, membership updates, etc.
Set true to keep video stream(include local and remote) when minimize app, else will stop. Default is false. Google recommend release camera when app goes background and resume after app foreground. When you use picture-in-picture mode in app should set this method to true before call.
API to Enable/Disable Speech Enhancement by default for all calls. Applicable for WebexCalling and CUCM calling.
Enables or disables all media streams on active calls.
This returns the list of virtual backgrounds
Returns value of the advanced setting that has been set.
Return the audio background noise removal mode.
Return the current maximum receiving bandwidth of audio stream.
A collection of Space which contains call history of One to One Spaces as well as Group type Spaces and UC Calls Note: The return type changed from Space to CallHistoryRecord to accommodate UC calls since 3.6.0
Returns the type of Calling supported for logged in user
Default camera facing mode of this phone, used as the default when dialing or answering a call. The default mode is the front camera.
The listener for incoming call
Returns the limit of number of custom virtual backgrounds, default limit is 3
Return the required service url, return null if unregistered.
Return the current maximum receiving bandwidth of content sharing stream.
Return the text of the H.264 codec license from Cisco Systems, Inc.
Return the URL of the H.264 codec license from Cisco Systems, Inc.
Return the current maximum receiving bandwidth of video stream.
Return the current maximum sending bandwidth of video stream.
Return the video stream mode.
True if audio background noise removal is open, otherwise false.
Indicates the status of H264 license prompt acceptance.
Return True if Google hardware media codec is turned on for video. Otherwise, false.
API that returns true if Speech Enhancement is enabled by default for all calls else returns false.
Returns true if the device is in restricted network
Returns true if virtual background is supported
API to process the payload received in FCM service for Webex calling. Use Phone.buildNotificationPayload API to create the payload first.
Refresh the Captcha object to get a new Captcha code
Removes the virtual background
Pops up an Alert for the end user to approve the use of H.264 codec license from Cisco Systems, Inc.
Set advanced settings for call. Only effective if set before the start of call.
Set the audio background noise removal mode, default value is AudioBRNMode.HP. This method only effective if set Phone.enableAudioBNR to true.
Set the max receiving bandwidth for audio in unit bps for the call. Only effective if set before the start of call. if 0, default value of 64 * 1000 is used.
Set default camera facing mode of this phone, used as the default when dialing or answering a call. The setting is not persistent.
Turn on/off Google hardware media codec for video. By doing hardware codec, android devices can do high definition (720p@30fps) video calls, but please note, since the hardware codec is high depend on android devices, some devices support hardware codec not very well.
Set the listener to listen to the incoming call to this Phone. This listener won't be fired when a 3rd incoming WxC or CUCM call is received. Max number of supported WxC or CUCM calls at a time is 2 (Applicable from 3.11 onwards)
The limit of number of custom virtual backgrounds, default limit is 3 Note: If background is uploaded after the limit is exhausted, older background will be deleted to make space for new ones.
Sets a listener to monitor restricted network status changes
Set parameters required for Push notifications of Webex calling
Set the max receiving bandwidth for content sharing in unit bps for the call. Only effective if set before the start of call. if 0, default value of 8000*1000 is used.
Set the max receiving bandwidth for video in unit bps for the call. Only effective if set before the start of call. if 0, default value of 2500*1000 is used.
Set the max sending bandwidth for video in unit bps for the call. Only effective if set before the start of call. if 0, default value of 2500*1000 is used.
Set the video stream mode, default value is VideoStreamMode.COMPOSITED.
Render a preview of the local party before the call is answered.
Stop rendering the preview of the local party.
API to enable legacy receiver side noise removal. This will disable the new receiver side speech enhancement. Disable this to use new receiver side speech enhancement. This will disable the legacy receiver side noise removal. By default useLegacy is false. This setting is not persisted.