Call (Cisco Webex Android SDK 2.8.0)

```
public interface 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

See Also:

Phone

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Call.AudioOutputMode` The options to switch audio output during a call.
`static class`	`Call.CallStatus` The status of a Call.
`static class`	`Call.Direction` The enumeration of directions of a call
`static class`	`Call.VideoRenderMode` The options to specify how the video adjusts its content to be render in a view.
`static class`	`Call.WaitReason` The reasons for the call is waiting.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acknowledge(CompletionHandler<java.lang.Void> callback)` Acknowledge (without answering) an incoming call.
`void`	`answer(MediaOption option, CompletionHandler<java.lang.Void> callback)` Answers this call.
`void`	`closeAuxStream(android.view.View view)` Close the indicated auxiliary stream.
`CallMembership`	`getActiveSpeaker()` Get the current active speaker
`AuxStream`	`getAuxStream(android.view.View view)` Get an indicated auxiliary stream.
`int`	`getAvailableAuxStreamCount()` Get the count of current available auxiliary streams
`Call.Direction`	`getDirection()`
`Phone.FacingMode`	`getFacingMode()`
`CallMembership`	`getFrom()`
`android.util.Size`	`getLocalVideoViewSize()`
`java.util.List<CallMembership>`	`getMemberships()`
`MultiStreamObserver`	`getMultiStreamObserver()` Get the observer for the events of multi-stream in this call
`CallObserver`	`getObserver()`
`int`	`getOpenedAuxStreamCount()` Get the count of already opened auxiliary streams
`android.util.Size`	`getRemoteVideoViewSize()`
`java.util.Set<CallSchedule>`	`getSchedules()` Returns the schedules of this call if this call has one or more schedules.
`android.view.View`	`getSharingRenderView()`
`android.util.Size`	`getSharingViewSize()`
`java.lang.String`	`getSpaceId()` Return the associated space of this call
`Call.CallStatus`	`getStatus()`
`CallMembership`	`getTo()`
`android.util.Pair<android.view.View,android.view.View>`	`getVideoRenderViews()`
`void`	`hangup(CompletionHandler<java.lang.Void> callback)` Disconnects this call.
`boolean`	`isReceivingAudio()`
`boolean`	`isReceivingSharing()`
`boolean`	`isReceivingVideo()`
`boolean`	`isRemoteSendingAudio()`
`boolean`	`isRemoteSendingSharing()`
`boolean`	`isRemoteSendingVideo()`
`boolean`	`isSendingAudio()`
`boolean`	`isSendingDTMFEnabled()`
`boolean`	`isSendingSharing()`
`boolean`	`isSendingVideo()`
`void`	`letIn(CallMembership membership)` Admit a CallMembership into the meeting from the lobby.
`void`	`letIn(java.util.List<CallMembership> memberships)` Admit CallMemberships into the meeting from the lobby.
`void`	`openAuxStream(android.view.View view)` Open a new auxiliary stream with a view.
`void`	`reject(CompletionHandler<java.lang.Void> callback)` Rejects this call.
`void`	`sendDTMF(java.lang.String dtmf, CompletionHandler<java.lang.Void> callback)` Sends DTMF events to the remote party.
`void`	`sendFeedback(int rating, java.lang.String comment)` Sends feedback for this call to Cisco Webex team.
`void`	`setCompositedVideoLayout(MediaOption.CompositedVideoLayout layout)` Specify the composited video layout for the active speaker and other attendees in the group video meeting.
`void`	`setCompositedVideoLayout(MediaOption.CompositedVideoLayout layout, CompletionHandler<java.lang.Void> callback)` Specify the composited video layout for the active speaker and other attendees in the group video meeting.
`void`	`setFacingMode(Phone.FacingMode facingMode)`
`void`	`setMultiStreamObserver(MultiStreamObserver observer)` Set the observer for the events of multi-stream in this call
`void`	`setObserver(CallObserver observer)`
`void`	`setReceivingAudio(boolean receiving)`
`void`	`setReceivingSharing(boolean receiving)`
`void`	`setReceivingVideo(boolean receiving)`
`void`	`setRemoteVideoRenderMode(Call.VideoRenderMode mode)` Specify how the remote video adjusts its content to be render in a view.
`void`	`setSendingAudio(boolean sending)`
`void`	`setSendingSharing(boolean sending)`
`void`	`setSendingVideo(boolean sending)`
`void`	`setSharingRenderView(android.view.View view)`
`void`	`setVideoLayout(MediaOption.CompositedVideoLayout layout)` Deprecated. please use `setCompositedVideoLayout(MediaOption.CompositedVideoLayout)`
`void`	`setVideoRenderViews(android.util.Pair<android.view.View,android.view.View> videoRenderViews)`
`void`	`startSharing(CompletionHandler<java.lang.Void> callback)` Deprecated.
`void`	`startSharing(android.app.Notification notification, int notificationId, CompletionHandler<java.lang.Void> callback)` Start content sharing.
`void`	`stopSharing(CompletionHandler<java.lang.Void> callback)` Stop content sharing.
`void`	`switchAudioOutput(Call.AudioOutputMode audioOutputMode)` Switch the audio play output mode during a call.

- Method Detail
  - getFacingMode
```
Phone.FacingMode getFacingMode()
```
    Returns:
    
    The camera facing mode selected for this call.
    
    Since:
    
    0.1
  - setFacingMode
```
void setFacingMode(Phone.FacingMode facingMode)
```
    Parameters:
    
    facingMode - The camera facing mode.
    
    Since:
    
    0.1
  - getDirection
```
Call.Direction getDirection()
```
    Returns:
    
    The direction of this call.
    
    Since:
    
    0.1
  - getStatus
```
Call.CallStatus getStatus()
```
    Returns:
    
    The status of this call.
    
    Since:
    
    0.1
  - setObserver
```
void setObserver(CallObserver observer)
```
    Parameters:
    
    observer - Observer for the events of this call
    
    Since:
    
    0.1
  - getObserver
```
CallObserver getObserver()
```
    Returns:
    
    Observer for the events of this call
    
    Since:
    
    0.1
  - getSpaceId
```
java.lang.String getSpaceId()
```
    Return the associated space of this call
    
    Since:
    
    2.6.0
  - getMemberships
```
java.util.List<CallMembership> getMemberships()
```
    Returns:
    
    Call Memberships represent participants in this call.
    
    Since:
    
    0.1
  - getFrom
```
CallMembership getFrom()
```
    Returns:
    
    The initiator of this call.
    
    Since:
    
    0.1
  - getTo
```
CallMembership getTo()
```
    Returns:
    
    The intended recipient of this call.
    
    Since:
    
    0.1
  - getSchedules
```
java.util.Set<CallSchedule> getSchedules()
```
    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.
    
    Since:
    
    2.6.0
  - setRemoteVideoRenderMode
```
void setRemoteVideoRenderMode(Call.VideoRenderMode mode)
```
    Specify how the remote video adjusts its content to be render in a view.
    
    Parameters:
    
    mode - the remote video render mode
    
    Since:
    
    2.6.0
  - setVideoLayout
```
void setVideoLayout(MediaOption.CompositedVideoLayout layout)
```
    Deprecated. please use setCompositedVideoLayout(MediaOption.CompositedVideoLayout)
    
    Specify the video layout for the active speaker and other attendees in the group video meeting.
    
    Parameters:
    
    layout - the video layout mode
    
    Since:
    
    2.6.0
  - setCompositedVideoLayout
```
void setCompositedVideoLayout(MediaOption.CompositedVideoLayout layout)
```
    Specify the composited video layout for the active speaker and other attendees in the group video meeting.
    
    Parameters:
    
    layout - the composited video layout mode
    
    Since:
    
    2.8.0
  - setCompositedVideoLayout
```
void setCompositedVideoLayout(MediaOption.CompositedVideoLayout layout,
                              @Nullable
                              CompletionHandler<java.lang.Void> callback)
```
    Specify the composited video layout for the active speaker and other attendees in the group video meeting.
    
    Parameters:
    
    layout - the composited video layout mode
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    2.8.0
  - getLocalVideoViewSize
```
android.util.Size getLocalVideoViewSize()
```
    Returns:
    
    The local video render view dimensions (points) of this call.
    
    Since:
    
    0.1
  - getRemoteVideoViewSize
```
android.util.Size getRemoteVideoViewSize()
```
    Returns:
    
    The remote video render view dimensions (points) of this call.
    
    Since:
    
    0.1
  - getSharingViewSize
```
android.util.Size getSharingViewSize()
```
    Returns:
    
    The content sharing render view dimensions (points) of this call.
    
    Since:
    
    1.3.0
  - isRemoteSendingVideo
```
boolean isRemoteSendingVideo()
```
    Returns:
    
    True if the remote party of this call is sending video. Otherwise, false.
    
    Since:
    
    0.1
  - isRemoteSendingAudio
```
boolean isRemoteSendingAudio()
```
    Returns:
    
    True if the remote party of this call is sending audio. Otherwise, false.
    
    Since:
    
    0.1
  - isRemoteSendingSharing
```
boolean isRemoteSendingSharing()
```
    Returns:
    
    True if the remote party of this call is sending content sharing. Otherwise, false.
    
    Since:
    
    1.3.0
  - isSendingVideo
```
boolean isSendingVideo()
```
    Returns:
    
    True if this call is sending video. Otherwise, false.
    
    Since:
    
    0.1
  - setSendingVideo
```
void setSendingVideo(boolean sending)
```
    Parameters:
    
    sending - True if this call is sending video. Otherwise, false.
    
    Since:
    
    0.1
  - isSendingAudio
```
boolean isSendingAudio()
```
    Returns:
    
    True if this call is sending audio. Otherwise, false.
    
    Since:
    
    0.1
  - setSendingAudio
```
void setSendingAudio(boolean sending)
```
    Parameters:
    
    sending - True if this call is sending audio. Otherwise, false.
    
    Since:
    
    0.1
  - isReceivingVideo
```
boolean isReceivingVideo()
```
    Returns:
    
    True if the local party of this call is receiving video. Otherwise, false.
    
    Since:
    
    0.1
  - setReceivingVideo
```
void setReceivingVideo(boolean receiving)
```
    Parameters:
    
    receiving - True if the local party of this *call* is receiving video. Otherwise, false.
    
    Since:
    
    0.1
  - isReceivingAudio
```
boolean isReceivingAudio()
```
    Returns:
    
    True if the local party of this *call* is receiving audio. Otherwise, false.
    
    Since:
    
    0.1
  - setReceivingAudio
```
void setReceivingAudio(boolean receiving)
```
    Parameters:
    
    receiving - True if the local party of this *call* is receiving audio. Otherwise, false.
    
    Since:
    
    0.1
  - isReceivingSharing
```
boolean isReceivingSharing()
```
    Returns:
    
    True if the local party of this call is receiving content sharing. Otherwise, false.
    
    Since:
    
    1.3.0
  - setReceivingSharing
```
void setReceivingSharing(boolean receiving)
```
    Parameters:
    
    receiving - True if the local party of this *call* is receiving content sharing. Otherwise, false.
    
    Since:
    
    1.3.0
  - getVideoRenderViews
```
android.util.Pair<android.view.View,android.view.View> getVideoRenderViews()
```
    Returns:
    
    The render views for local and remote video of this call.
    
    Since:
    
    1.3.0
  - setVideoRenderViews
```
void setVideoRenderViews(@Nullable
                         android.util.Pair<android.view.View,android.view.View> videoRenderViews)
```
    Parameters:
    
    videoRenderViews - render views for local and remote video of this call. If is nil, it will update the video state as inactive to the server side.
    
    Since:
    
    1.3.0
  - getSharingRenderView
```
android.view.View getSharingRenderView()
```
    Returns:
    
    The render view for the remote content sharing of this call.
    
    Since:
    
    1.3.0
  - setSharingRenderView
```
void setSharingRenderView(android.view.View view)
```
    Parameters:
    
    view - The render view for the remote content sharing of this call. If is nil, it will update the content sharing state as inactive to the server side.
    
    Since:
    
    1.3.0
  - acknowledge
```
void acknowledge(@NonNull
                 CompletionHandler<java.lang.Void> callback)
```
    Acknowledge (without answering) an incoming call. Will cause the initiator's Call instance to emit the ringing event.
    
    Parameters:
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    0.1
    
    See Also:
    
    Call.CallStatus
  - answer
```
void answer(@NonNull
            MediaOption option,
            @NonNull
            CompletionHandler<java.lang.Void> callback)
```
    Answers this call. This can only be invoked when this call is incoming and in ringing status.
    
    Parameters:
    
    option - Intended media options - audio only or audio and video - for the call.
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    0.1
    
    See Also:
    
    Call.CallStatus
  - reject
```
void reject(@NonNull
            CompletionHandler<java.lang.Void> callback)
```
    Rejects this call. This can only be invoked when this call is incoming and in ringing status.
    
    Parameters:
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    0.1
    
    See Also:
    
    Call.CallStatus
  - hangup
```
void hangup(@NonNull
            CompletionHandler<java.lang.Void> callback)
```
    Disconnects this call. This can only be invoked when this call is in answered status.
    
    Parameters:
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    0.1
    
    See Also:
    
    Call.CallStatus
  - isSendingDTMFEnabled
```
boolean isSendingDTMFEnabled()
```
    Returns:
    
    True if the DTMF keypad is enabled for this *call*. Otherwise, false.
    
    Since:
    
    0.1
  - sendDTMF
```
void sendDTMF(java.lang.String dtmf,
              @NonNull
              CompletionHandler<java.lang.Void> callback)
```
    Sends DTMF events to the remote party. Valid DTMF events are 0-9, *, #, a-d, and A-D.
    
    Parameters:
    
    dtmf - any combination of valid DTMF events matching regex mattern "^[0-9#\*abcdABCD]+$"
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    0.1
  - sendFeedback
```
void sendFeedback(int rating,
                  @Nullable
                  java.lang.String comment)
```
    Sends feedback for this call to Cisco Webex team.
    
    Parameters:
    
    rating - The rating of the quality of this call between 1 and 5 where 5 means excellent quality.
    
    comment - The comments for this call.
    
    Since:
    
    0.1
  - startSharing
```
void startSharing(@NonNull
                  CompletionHandler<java.lang.Void> callback)
```
    Deprecated.
    
    Start content sharing. Invalid if targetSdkVersion is 29 or higher, please use startSharing(Notification, int, CompletionHandler)
    
    Since:
    
    1.4
  - startSharing
```
void startSharing(@Nullable
                  android.app.Notification notification,
                  int notificationId,
                  @NonNull
                  CompletionHandler<java.lang.Void> callback)
```
    Start content sharing. The notification and it's id are only work for targetSdkVersion is 29 or higher.
    
    Parameters:
    
    notification - The foreground notification when sharing, take effect if targetSdkVersion is 29 or higher.
    
    notificationId - The id of this notification, take effect if targetSdkVersion is 29 or higher, must a positive number.
    
    callback - A closure to be executed when completed, with error if the invocation is illegal or failed, otherwise nil.
    
    Since:
    
    2.8.0
    
    See Also:
    
    Google Developers Page
  - stopSharing
```
void stopSharing(@NonNull
                 CompletionHandler<java.lang.Void> callback)
```
    Stop content sharing.
    
    Since:
    
    1.4
  - isSendingSharing
```
boolean isSendingSharing()
```
    Returns:
    
    True if the local party of this call is sharing content. Otherwise, false.
    
    Since:
    
    1.4
  - setSendingSharing
```
void setSendingSharing(boolean sending)
```
    Parameters:
    
    sending - True if this call is sharing content. Otherwise, false.
    
    Since:
    
    2.5.0
  - openAuxStream
```
void openAuxStream(@NonNull
                   android.view.View view)
```
    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
    
    Parameters:
    
    view - the view to be rendering upon an auxiliary stream
    
    Since:
    
    2.0.0
  - closeAuxStream
```
void closeAuxStream(@NonNull
                    android.view.View view)
```
    Close the indicated auxiliary stream. You can invoke this API instead of MultiStreamObserver.onAuxStreamUnavailable() to close an opened auxiliary stream
    
    Parameters:
    
    view - the view rendering upon an auxiliary stream
    
    Since:
    
    2.0.0
  - getAuxStream
```
AuxStream getAuxStream(@NonNull
                       android.view.View view)
```
    Get an indicated auxiliary stream.
    
    Parameters:
    
    view - the view rendering upon an auxiliary stream
    
    Since:
    
    2.0.0
  - getAvailableAuxStreamCount
```
int getAvailableAuxStreamCount()
```
    Get the count of current available auxiliary streams
    
    Since:
    
    2.0.0
  - getOpenedAuxStreamCount
```
int getOpenedAuxStreamCount()
```
    Get the count of already opened auxiliary streams
    
    Since:
    
    2.0.0
  - getActiveSpeaker
```
CallMembership getActiveSpeaker()
```
    Get the current active speaker
    
    Since:
    
    2.0.0
  - setMultiStreamObserver
```
void setMultiStreamObserver(MultiStreamObserver observer)
```
    Set the observer for the events of multi-stream in this call
    
    Since:
    
    2.0.0
  - getMultiStreamObserver
```
MultiStreamObserver getMultiStreamObserver()
```
    Get the observer for the events of multi-stream in this call
    
    Since:
    
    2.0.0
  - letIn
```
void letIn(@NonNull
           CallMembership membership)
```
    Admit a CallMembership into the meeting from the lobby. This should be called by moderator.
    
    Parameters:
    
    membership - the call membership that waiting in lobby.
    
    Since:
    
    2.4.0
  - letIn
```
void letIn(@NonNull
           java.util.List<CallMembership> memberships)
```
    Admit CallMemberships into the meeting from the lobby. This should be called by moderator.
    
    Parameters:
    
    memberships - the call memberships that waiting in lobby.
    
    Since:
    
    2.4.0
  - switchAudioOutput
```
void switchAudioOutput(Call.AudioOutputMode audioOutputMode)
```
    Switch the audio play output mode during a call.
    
    Parameters:
    
    audioOutputMode - the audio play output mode during a call.
    
    Since:
    
    2.7.0

Interface Call

Nested Class Summary

Method Summary

Method Detail

getFacingMode

setFacingMode

getDirection

getStatus

setObserver

getObserver

getSpaceId

getMemberships

getFrom

getTo

getSchedules

setRemoteVideoRenderMode

setVideoLayout

setCompositedVideoLayout

setCompositedVideoLayout

getLocalVideoViewSize

getRemoteVideoViewSize

getSharingViewSize

isRemoteSendingVideo

isRemoteSendingAudio

isRemoteSendingSharing

isSendingVideo

setSendingVideo

isSendingAudio

setSendingAudio

isReceivingVideo

setReceivingVideo

isReceivingAudio

setReceivingAudio

isReceivingSharing

setReceivingSharing

getVideoRenderViews

setVideoRenderViews

getSharingRenderView

setSharingRenderView

acknowledge

answer

reject

hangup

isSendingDTMFEnabled

sendDTMF

sendFeedback

startSharing

startSharing

stopSharing

isSendingSharing

setSendingSharing

openAuxStream

closeAuxStream

getAuxStream

getAvailableAuxStreamCount

getOpenedAuxStreamCount

getActiveSpeaker

setMultiStreamObserver

getMultiStreamObserver

letIn

letIn

switchAudioOutput