Inherited by com.cisco.jabber.guest.jcf.JcfJabberGuestCall.
|
| abstract boolean | canSwitchCamera () |
| | Determine if the device supports the ability to switch among more than one input cameras. More...
|
| |
| abstract void | switchCamera () |
| | Switch to the next available input camera. More...
|
| |
| void | setCaptureOrientation (CaptureOrientation orientation) |
| | Set the camera capture orientation. More...
|
| |
|
abstract boolean | isFrontCamera () |
| | Returns true if the currently selected camera is the front camera on the device.
|
| |
|
abstract void | preview () |
| | Indicate the Call Preview screen is being displayed.
|
| |
| abstract boolean | start () |
| | Initiate the call to the toUri specified in the createInstance method. More...
|
| |
| abstract void | end () |
| | End this call and release all resources associated with this instance. More...
|
| |
| void | setSelfTextureView (TextureView textureView) |
| | Use the given texture view to draw the local device video, for display in a PreviewView or SelfView. More...
|
| |
| abstract void | setSelfTextureView (TextureView textureView, RenderCallbacks callbacks) |
| | Use the given texture view to draw the local device video, for display in a PreviewView or SelfView. More...
|
| |
| void | setRemoteTextureView (TextureView textureView) |
| | Use the given context and texture view to draw the called party video, for display in a RemoteView. More...
|
| |
| abstract void | setRemoteTextureView (TextureView textureView, RenderCallbacks callbacks) |
| | Use the given context and texture view to draw the called party video, for display in a RemoteView. More...
|
| |
| JabberGuestCall.State | getState () |
| | Retrieve the current state of this JabberGuestCall instance. More...
|
| |
| Uri | getToUri () |
| | Retrieve the uri that this JabberGuestCall instance will dial when a call is initiated. More...
|
| |
| abstract boolean | isLocalVideoActive () |
| | Determine if the local device's video is actively streaming during a call. More...
|
| |
| abstract boolean | isRemoteVideoActive () |
| | Determine if the called party is streaming video during a call. More...
|
| |
| abstract boolean | isVideoMuted () |
| | Determine if the local device's video is currently stopped. More...
|
| |
| abstract void | muteVideo () |
| | Stop the local device video from being sent. More...
|
| |
| abstract void | unmuteVideo () |
| | Start sending the local device video. More...
|
| |
| abstract boolean | isAudioMuted () |
| | Determine if the local device's audio is currently stopped. More...
|
| |
| abstract void | muteAudio () |
| | Stop the local device audio from being sent. More...
|
| |
| abstract void | unmuteAudio () |
| | Start sending the local device audio. More...
|
| |
| abstract void | sendDigits (String digits) |
| | Sends the given string of DTMF digits to the called party. More...
|
| |
synchronized
JabberGuestCall.CallStatistics | getStatistics () |
| | Returns a JabberGuestCall.Statistics instance. More...
|
| |
| String | getToDisplayName () |
| | Get the address or display name of the called party. More...
|
| |
| void | audioRouteUpdated (AudioRouteType route) |
| | This method should be called whenever an activity or fragment has determined that the audio routing has changed or needs to change due to some condition. More...
|
| |
| abstract void | acceptInvalidCertificate (String referenceID, String subjectCertificateData) |
| | In the event that a JabberGuestCall instance informs an application of an invalid certificate error via the InvalidCertificateCallback, the application can call this method to inform the JabberGuestCall instance to accept the invalid certificate as-is, and continue any pending calls. More...
|
| |
| abstract void | rejectInvalidCertificate () |
| | In the event that a JabberGuestCall instance informs an application of an invalid certificate error via the InvalidCertificateCallback, the application can call this method to inform the JabberGuestCall instance to reject the invalid certificate and immediately terminate any pending calls. More...
|
| |
| abstract void | registerContext (Context context) |
| | Call this to register the most recent active view Context for displaying dialog from the JabberGuestCall object. More...
|
| |
|
|
static final String | ACTION_INSTANCE_AVAILABLE = "jgsdkInstanceAvailable" |
| | Name of Intent sent to registered BroadcastReceivers when a new instance of JabberGuestCall has been created.
|
| |
|
static final String | ACTION_CALL_STATE_CHANGED = "jgsdkCallStateChanged" |
| | Name of Intent sent to registered BroadcastReceivers when a state change occurs in a JabberGuestCall instance.
|
| |
|
static final String | ACTION_CALL_CONTROL_EVENT = "jgsdkCallControlEvent" |
| | Name of Intent sent to registered BroadcastReceivers when a new call control event is generated in a JabberGuestCall instance.
|
| |
|
static final String | ACTION_CALL_ERROR_EVENT = "jgsdkCallErrorEvent" |
| | Name of Intent sent to registered BroadcastReceivers when an error event occurs in a JabberGuestCall instance.
|
| |
| static final String | ARG_CALL_STATE_VALUE = "jgsdkCallStateValue" |
| | When a call state changes for a JabberGuestCall instance, an ACTION_CALL_STATE_CHANGED intent will be broadcast to all registered BroadcastReceivers for that intent. More...
|
| |
| static final String | ARG_CALL_CONTROL_EVENT_VALUE = "jgsdkCallControlEventValue" |
| | When a call control event is generated for a JabberGuestCall instance, an ACTION_CALL_CONTROL_EVENT intent will be broadcast to all registered BroadcastReceivers for that intent. More...
|
| |
|
static final String | ARG_DTMF_SENT = "dtmf-sent" |
| | When a dtmfSent call control event is published, the value of the sent DTMF digit will be included in the bundle using this key.
|
| |
| static final String | ARG_CATEGORY_LABEL = "category" |
| | When a call error event is published, the numeric category of the failure (as returned from the Cisco Jabber Guest Server) will be included in the bundle using this key. More...
|
| |
| static final String | ARG_CODE_LABEL = "code" |
| | When a call error event is published, if the error was specifically related to the SIP protocol, the numeric value of the SIP error will be included in the bundle using this key. More...
|
| |
| static final String | ARG_INTERNAL_MESSAGE_LABEL = "message" |
| | When a call error event is published, the string value describing the nature of the error (returned from the Cisco Jabber Guest Server) will be included in the bundle using this key. More...
|
| |
| static final String | ARG_USER_MESSAGE_LABEL = "userMessage" |
| | When a call error event is published, the string value describing the nature of the error (returned from the SDK, mapped based on error returned from the Cisco Jabber Guest Server) will be included in the bundle using this key. More...
|
| |
| static final String | ARG_USER_TITLE_LABEL = "userTitle" |
| | When a call error event is published, the string value containing the suggested title for the error dialog box (returned from the SDK, mapped based on error returned from the Cisco Jabber Guest Server) will be included in the bundle using this key. More...
|
| |
| static final String | ARG_AUDIO_ROUTE_UPDATE_LABEL = "AudioRoute" |
| | When a change in the audio routing has occurred, the value of the new destination for the audio routing will be included in the bundle using this key. More...
|
| |
|
static final int | AUDIO_STREAM = AudioManager.STREAM_VOICE_CALL |
| | The AudioManager stream used by JabberGuestCall for all audio output.
|
| |
This is the main class of the Jabber Guest Android SDK.
JabberGuestCall represents the lifecycle of a single entire call. Only one instance of this class exists at any moment in time, and that instance is created with the createInstance factory method.
JabberGuestCall will also send out notifications via LocalBroadcastManager whenever specific events occur, like a new instance of JabberGuestCall is made available, or a call state change has occurred, or a call control event has been generated. Any component interested in responding to these notifications can register for them via the registerReceiver and unregisterReceiver methods.
All methods should be called from the main thread. An IllegalStateException will be thrown when calling JabberGuestCall methods on other threads.
Statistics relevant to an active call are also provided by JabberGuestCall via the CallStatistics class, and can be acquired via the getStatistics function.
| abstract void com.cisco.jabber.guest.JabberGuestCall.acceptInvalidCertificate |
( |
String |
referenceID, |
|
|
String |
subjectCertificateData |
|
) |
| |
|
pure virtual |
In the event that a JabberGuestCall instance informs an application of an invalid certificate error via the InvalidCertificateCallback, the application can call this method to inform the JabberGuestCall instance to accept the invalid certificate as-is, and continue any pending calls.
Note that if you have not received a certificate error and this function is called, nothing happens.
If the application provides the certificate's referenceID and subjectCertificateData to this function when called, the information will be stored so that in the future if this certificate generates another error, it will automatically be accepted without requiring the application to intervene in the future. If the application does not want to store this certificate data in this manner, or the application wants to be asked each time this certificate is encountered, regardless of previous choices, the input parameters should be passed as null strings.
- Parameters
-
| referenceID | A string representing the identity that provides the certificate. |
| subjectCertificateData | A string representing the invalid subject certificate in PEM format (last element in a chain) |
| static synchronized JabberGuestCall com.cisco.jabber.guest.JabberGuestCall.createInstance |
( |
Context |
context, |
|
|
Uri |
toUri |
|
) |
| |
|
inlinestatic |
Create and return an instance of JabberGuestCall.
Only one instance of this object is allowed at a time and you must use this factory method to create the instance. CallFragment and PreviewFragment are always associated with an instance of this class.
If an existing instance of JabberGuestCall is present, and the state of that existing instance is either starting, started, or ending, an IllegalStateException will be thrown, and you will not get a new JabberGuestCall instance. You will first have to end the existing JabberGuestCall instance's call before trying to create a new instance.
- Parameters
-
- Returns
- A new JabberGuestCall instance
| static void com.cisco.jabber.guest.JabberGuestCall.registerReceiver |
( |
Context |
context, |
|
|
BroadcastReceiver |
receiver, |
|
|
IntentFilter |
filter |
|
) |
| |
|
inlinestatic |
Register a given BroadcastReceiver with JabberGuestCall so that it can be notified whenever any specified events in the given IntentFilter are encountered.
Use this method signature if you would like to specify some subset of the supported JabberGuestCall notifications (ACTION_INSTANCE_AVAILABLE, ACTION_CALL_STATE_CHANGED, ACTION_CALL_CONTROL_EVENT) instead of registering to receive notifications for all supported events.
If the given IntentFilter contains actions that are not supported by the JabberGuestCall class, an IllegalArgumentException will be thrown.
- Parameters
-
| context | Application context used to construct the internal LocalBroadcastManager |
| receiver | BroadcastReceiver that will handle listed intent actions from passed filter |
| filter | IntentFilter listing which actions to register for. Must only include one or more of the following supported actions: ACTION_INSTANCE_AVAILALBLE, ACTION_CALL_STATE_CHANGED, ACTION_CALL_CONTROL_EVENT, or ACTION_CALL_ERROR_EVENT |
| final String com.cisco.jabber.guest.JabberGuestCall.ARG_CALL_STATE_VALUE = "jgsdkCallStateValue" |
|
static |
When a call state changes for a JabberGuestCall instance, an ACTION_CALL_STATE_CHANGED intent will be broadcast to all registered BroadcastReceivers for that intent.
The new state value for the JabberGuestCall instance will be included in the intent using this key.
This extra is also included when an ACTION_CALL_ERROR_EVENT is broadcast. Often, the state of the call transitions immediately after an error so the value set using this key represents the state the JabberGuestCall was in at the time of the error.
To get this value from the notification's returned intent, use (JabberGuestCall.State) intent.getSerializableExtra(JabberGuestCall.ARG_CALL_STATE_VALUE)
| final String com.cisco.jabber.guest.JabberGuestCall.ARG_USER_MESSAGE_LABEL = "userMessage" |
|
static |
When a call error event is published, the string value describing the nature of the error (returned from the SDK, mapped based on error returned from the Cisco Jabber Guest Server) will be included in the bundle using this key.
It is recommended that if an error dialog is displayed by an implementing application for this SDK, this is the string that should be used in such a dialog for its message contents.
| final String com.cisco.jabber.guest.JabberGuestCall.ARG_USER_TITLE_LABEL = "userTitle" |
|
static |
When a call error event is published, the string value containing the suggested title for the error dialog box (returned from the SDK, mapped based on error returned from the Cisco Jabber Guest Server) will be included in the bundle using this key.
It is recommended that if an error dialog is displayed by an implementing application for this SDK, this is the string that should be used in such a dialog for its title contents.