com.ciscowebex.androidsdk.phone

Interface Phone

public interface Phone

Phone represents a Cisco Webex calling device.

The application can obtain a phone object from Webex object and use phone to call other Cisco Webex users or PSTN when enabled.

The phone must be registered before it can make or receive calls.

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Phone.AudioBRNMode The enumeration of audio BNR mode choices, default is HP.
static class	Phone.DefaultBandwidth The enumeration of common bandwidth choices.
static class	Phone.FacingMode The enumeration of Camera facing modes.
static class	Phone.H264LicenseAction The options for H.264 video codec license from Cisco Systems, Inc
static interface	Phone.IncomingCallListener The interface for a listener for incoming call
static class	Phone.ServiceUrlType The enumeration of service url.
static class	Phone.VideoStreamMode The enumeration of remote video stream.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the currently outgoing call that has not been connected.
void	deregister(CompletionHandler<java.lang.Void> callback) Removes this *phone* from Cisco Webex cloud on behalf of the authenticated user.
void	dial(java.lang.String dialString, MediaOption option, CompletionHandler<Call> callback) Makes a call to an intended recipient on behalf of the authenticated user.
void	disableVideoCodecActivation() Prevents the SDK from poping up an Alert for the end user to approve the use of H.264 video codec license from Cisco Systems, Inc.
void	enableAskingReadPhoneStatePermission(boolean enable) Toggle to enable or disable ask for Manifest.permission.READ_PHONE_STATE permission, true by default.
void	enableAudioBNR(boolean enable) Enable audio background noise removal.
void	enableAudioEnhancementForModels(java.util.List<java.lang.String> models) Turn on audio enhancement for the specified device models.
void	enableBackgroundConnection(boolean enable) Set true to keep Webex server connection when minimize app.
void	enableBackgroundStream(boolean enable) Set true to keep video stream(include local and remote) when minimize app, else will stop.
AdvancedSetting	getAdvancedSetting(java.lang.Class<? extends AdvancedSetting> clz) Returns value of the advanced seting that has been set.
Phone.AudioBRNMode	getAudioBNRMode() Return the audio background noise removal mode.
int	getAudioMaxBandwidth() Deprecated.
int	getAudioMaxRxBandwidth() Return the current maximum receivning bandwidth of audio stream.
Phone.FacingMode	getDefaultFacingMode() Default camera facing mode of this phone, used as the default when dialing or answering a call.
Phone.IncomingCallListener	getIncomingCallListener() The listener for incoming call
java.lang.String	getServiceUrl(Phone.ServiceUrlType serviceUrlType) Return the required service url, return null if unregistered.
int	getSharingMaxBandwidth() Deprecated.
int	getSharingMaxRxBandwidth() Return the current maximum receiving bandwidth of content sharing stream.
java.lang.String	getVideoCodecLicense() Return the text of the H.264 codec license from Cisco Systems, Inc.
java.lang.String	getVideoCodecLicenseURL() Return the URL of the H.264 codec license from Cisco Systems, Inc.
int	getVideoMaxBandwidth() Deprecated.
int	getVideoMaxRxBandwidth() Return the current maximum receiving bandwidth of video stream.
int	getVideoMaxTxBandwidth() Return the current maximum sending bandwidth of video stream.
Phone.VideoStreamMode	getVideoStreamMode() Return the video stream mode.
boolean	isAudioBNREnable() True if audio background noise removal is open, otherwise false.
boolean	isHardwareAccelerationEnabled() Return True if Google hardware media codec is turned on for video.
void	register(CompletionHandler<java.lang.Void> callback) Registers this phone to Cisco Webex cloud on behalf of the authenticated user.
void	requestVideoCodecActivation(android.app.AlertDialog.Builder builder, CompletionHandler<Phone.H264LicenseAction> callback) Pops up an Alert for the end user to approve the use of H.264 codec license from Cisco Systems, Inc.
void	setAdvancedSetting(AdvancedSetting setting) Set advanced setings for call.
void	setAudioBNRMode(Phone.AudioBRNMode mode) Set the audio background noise removal mode, default value is Phone.AudioBRNMode.HP.
void	setAudioMaxBandwidth(int bandwidth) Deprecated.
void	setAudioMaxRxBandwidth(int bandwidth) Set the max receivning bandwidth for audio in unit bps for the call.
void	setDefaultFacingMode(Phone.FacingMode mode) Set default camera facing mode of this phone, used as the default when dialing or answering a call.
void	setHardwareAccelerationEnabled(boolean enable) Turn on/off Google hardware media codec for video.
void	setIncomingCallListener(Phone.IncomingCallListener listener) Set the listener to listen to the incoming call to this Phone.
void	setSharingMaxBandwidth(int bandwidth) Deprecated.
void	setSharingMaxRxBandwidth(int bandwidth) Set the max receiving bandwidth for content sharing in unit bps for the call.
void	setVideoMaxBandwidth(int bandwidth) Deprecated.
void	setVideoMaxRxBandwidth(int bandwidth) Set the max receiving bandwidth for video in unit bps for the call.
void	setVideoMaxTxBandwidth(int bandwidth) Set the max sending bandwidth for video in unit bps for the call.
void	setVideoStreamMode(Phone.VideoStreamMode videoStreamMode) Set the video stream mode, default value is Phone.VideoStreamMode.COMPOSITED.
void	startPreview(android.view.View view) Render a preview of the local party before the call is answered.
void	stopPreview() Stop rendering the preview of the local party.

Method Detail

getIncomingCallListener

Phone.IncomingCallListener getIncomingCallListener()

The listener for incoming call

Since:

0.1

setIncomingCallListener

void setIncomingCallListener(Phone.IncomingCallListener listener)

Set the listener to listen to the incoming call to this Phone.

Since:

0.1

getDefaultFacingMode

Phone.FacingMode getDefaultFacingMode()

Default camera facing mode of this phone, used as the default when dialing or answering a call. The default mode is the front camera.

Since:

0.1

setDefaultFacingMode

void setDefaultFacingMode(Phone.FacingMode mode)

Set default camera facing mode of this phone, used as the default when dialing or answering a call. The setting is not persistent.

Since:

0.1

register

void register(@NonNull
              CompletionHandler<java.lang.Void> callback)

Registers this phone to Cisco Webex cloud on behalf of the authenticated user.

It also creates the websocket and connects to Cisco Webex cloud.

Subsequent invocations of this method refresh the registration.

Parameters:

callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.

Since:

0.1

deregister

void deregister(@NonNull
                CompletionHandler<java.lang.Void> callback)

Removes this *phone* from Cisco Webex cloud on behalf of the authenticated user.

It also disconnects the websocket from Cisco Webex cloud.

Subsequent invocations of this method behave as a no-op.

Parameters:

callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.

Since:

0.1

dial

void dial(@NonNull
          java.lang.String dialString,
          @NonNull
          MediaOption option,
          @NonNull
          CompletionHandler<Call> callback)

Makes a call to an intended recipient on behalf of the authenticated user.

Parameters:

dialString - Intended recipient address in one of the supported formats.

option - Intended media options - audio only or audio and video - for the call.

callback - A closure to be executed when completed.

Since:

0.1

startPreview

void startPreview(android.view.View view)

Render a preview of the local party before the call is answered.

Parameters:

view - an UI view for rendering video.

Since:

0.1

stopPreview

void stopPreview()

Stop rendering the preview of the local party.

Since:

0.1

requestVideoCodecActivation

void requestVideoCodecActivation(@NonNull
                                 android.app.AlertDialog.Builder builder,
                                 @Nullable
                                 CompletionHandler<Phone.H264LicenseAction> callback)

Pops up an Alert for the end user to approve the use of H.264 codec license from Cisco Systems, Inc.

Parameters:

builder - AlertDialog builder

callback - A closure to be executed when completed.

Since:

0.1

disableVideoCodecActivation

void disableVideoCodecActivation()

Prevents the SDK from poping up an Alert for the end user to approve the use of H.264 video codec license from Cisco Systems, Inc.

Since:

0.1

getVideoCodecLicense

java.lang.String getVideoCodecLicense()

Return the text of the H.264 codec license from Cisco Systems, Inc.

Since:

0.1

getVideoCodecLicenseURL

java.lang.String getVideoCodecLicenseURL()

Return the URL of the H.264 codec license from Cisco Systems, Inc.

Since:

0.1

setAudioMaxRxBandwidth

void setAudioMaxRxBandwidth(int bandwidth)

Set the max receivning 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.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_AUDIO.

Since:

2.6.0

getAudioMaxRxBandwidth

int getAudioMaxRxBandwidth()

Return the current maximum receivning bandwidth of audio stream.

Since:

2.6.0

setVideoMaxRxBandwidth

void setVideoMaxRxBandwidth(int bandwidth)

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 2000*1000 is used.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_90P, Phone.DefaultBandwidth.MAX_BANDWIDTH_180P, Phone.DefaultBandwidth.MAX_BANDWIDTH_360P, Phone.DefaultBandwidth.MAX_BANDWIDTH_720P, or Phone.DefaultBandwidth.MAX_BANDWIDTH_1080P.

Since:

2.6.0

getVideoMaxRxBandwidth

int getVideoMaxRxBandwidth()

Return the current maximum receiving bandwidth of video stream.

Since:

2.6.0

setVideoMaxTxBandwidth

void setVideoMaxTxBandwidth(int bandwidth)

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 2000*1000 is used.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_90P, Phone.DefaultBandwidth.MAX_BANDWIDTH_180P, Phone.DefaultBandwidth.MAX_BANDWIDTH_360P, Phone.DefaultBandwidth.MAX_BANDWIDTH_720P, or Phone.DefaultBandwidth.MAX_BANDWIDTH_1080P.

Since:

2.6.0

getVideoMaxTxBandwidth

int getVideoMaxTxBandwidth()

Return the current maximum sending bandwidth of video stream.

Since:

2.6.0

setSharingMaxRxBandwidth

void setSharingMaxRxBandwidth(int bandwidth)

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 4000*1000 is used.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_SESSION.

Since:

2.6.0

getSharingMaxRxBandwidth

int getSharingMaxRxBandwidth()

Return the current maximum receiving bandwidth of content sharing stream.

Since:

2.6.0

isHardwareAccelerationEnabled

boolean isHardwareAccelerationEnabled()

Return True if Google hardware media codec is turned on for video. Otherwise, false.

Since:

2.1.1

setHardwareAccelerationEnabled

void setHardwareAccelerationEnabled(boolean enable)

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.

Parameters:

enable - True to turn on Google hardware media codec. Otherwise, use OpenH264 software codec.

Since:

2.1.1

enableAudioEnhancementForModels

void enableAudioEnhancementForModels(java.util.List<java.lang.String> models)

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.

Parameters:

models - the list of device models, if the list is null or empty, turn off the audio enhancement.

Since:

2.3.0

setAudioMaxBandwidth

@Deprecated
void setAudioMaxBandwidth(int bandwidth)

Deprecated.

Set the max 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.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_AUDIO.

Since:

1.3.0

getAudioMaxBandwidth

@Deprecated
int getAudioMaxBandwidth()

Deprecated.

Return the current maximum bandwidth of audio stream.

Since:

1.3.0

setVideoMaxBandwidth

@Deprecated
void setVideoMaxBandwidth(int bandwidth)

Deprecated.

Set the max bandwidth for video in unit bps for the call. Only effective if set before the start of call. if 0, default value of 2000*1000 is used.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_90P, Phone.DefaultBandwidth.MAX_BANDWIDTH_180P, Phone.DefaultBandwidth.MAX_BANDWIDTH_360P, Phone.DefaultBandwidth.MAX_BANDWIDTH_720P, or Phone.DefaultBandwidth.MAX_BANDWIDTH_1080P.

Since:

1.3.0

getVideoMaxBandwidth

@Deprecated
int getVideoMaxBandwidth()

Deprecated.

Return the current maximum bandwidth of video stream.

Since:

1.3.0

setSharingMaxBandwidth

@Deprecated
void setSharingMaxBandwidth(int bandwidth)

Deprecated.

Set the max bandwidth for content sharing in unit bps for the call. Only effective if set before the start of call. if 0, default value of 4000*1000 is used.

Parameters:

bandwidth - the suggest value could be Phone.DefaultBandwidth.MAX_BANDWIDTH_SESSION.

Since:

1.3.0

getSharingMaxBandwidth

@Deprecated
int getSharingMaxBandwidth()

Deprecated.

Return the current maximum bandwidth of content sharing stream.

Since:

1.3.0

enableBackgroundStream

void enableBackgroundStream(boolean enable)

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.

Parameters:

enable - true to keep video stream when minimize app, else will stop. Default is false.

Since:

2.6.0

enableBackgroundConnection

void enableBackgroundConnection(boolean enable)

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.

Parameters:

enable -

Since:

2.8.0

setAdvancedSetting

void setAdvancedSetting(AdvancedSetting setting)

Set advanced setings for call. Only effective if set before the start of call.

For example, Phone.setAdvancedSetting(new VideoMaxTxFPS(30));

Since:

2.6.0

See Also:

AdvancedSetting

getAdvancedSetting

AdvancedSetting getAdvancedSetting(java.lang.Class<? extends AdvancedSetting> clz)

Returns value of the advanced seting that has been set.

For example, AdvancedSetting setting = Phone.getAdvancedSetting(VideoMaxTxFPS.class);

Since:

2.6.0

See Also:

AdvancedSetting

cancel

void cancel()

Cancel the currently outgoing call that has not been connected.

Since:

2.6.0

enableAudioBNR

void enableAudioBNR(boolean enable)

Enable audio background noise removal. Default is false

Parameters:

enable - true to open audio background noise removal, else will close. Default is false.

Since:

2.7.0

isAudioBNREnable

boolean isAudioBNREnable()

True if audio background noise removal is open, otherwise false.

Returns:

true if audio background noise removal is open, otherwise false.

Since:

2.7.0

setAudioBNRMode

void setAudioBNRMode(Phone.AudioBRNMode mode)

Set the audio background noise removal mode, default value is Phone.AudioBRNMode.HP. This method only effective if set enableAudioBNR(boolean) to true.

Parameters:

mode - the audio background noise removal mode.

Since:

2.7.0

getAudioBNRMode

Phone.AudioBRNMode getAudioBNRMode()

Return the audio background noise removal mode.

Returns:

the audio background noise removal mode.

Since:

2.7.0

See Also:

Phone.AudioBRNMode

setVideoStreamMode

void setVideoStreamMode(Phone.VideoStreamMode videoStreamMode)

Set the video stream mode, default value is Phone.VideoStreamMode.COMPOSITED.

Parameters:

videoStreamMode - the video stream mode.

Since:

2.8.0

getVideoStreamMode

Phone.VideoStreamMode getVideoStreamMode()

Return the video stream mode.

Returns:

the video stream mode.

Since:

2.8.0

See Also:

Phone.VideoStreamMode

getServiceUrl

java.lang.String getServiceUrl(Phone.ServiceUrlType serviceUrlType)

Return the required service url, return null if unregistered.

Parameters:

serviceUrlType - the type of service url.

Returns:

the required service url, null if unregistered.

Since:

2.8.0

See Also:

Phone.ServiceUrlType

enableAskingReadPhoneStatePermission

void enableAskingReadPhoneStatePermission(boolean enable)

Toggle to enable or disable ask for 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.

Parameters:

enable - toggle to enable or disable ask for Manifest.permission.READ_PHONE_STATE permission, true by default.

Since:

2.8.0