Call (Cisco Spark Android SDK 1.4.0)

```
public interface Call
```
A Call represents a media call on Cisco Spark.
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.CallStatus
The status of a Call.

static class Call.Direction
The enumeration of directions of a call

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Call.CallStatus` The status of a Call.
`static class`	`Call.Direction` The enumeration of directions of a call

Method Summary

All Methods Instance Methods Abstract 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.
`Call.Direction`	`getDirection()`
`Phone.FacingMode`	`getFacingMode()`
`CallMembership`	`getFrom()`
`android.graphics.Rect`	`getLocalVideoViewSize()`
`java.util.List<CallMembership>`	`getMemberships()`
`CallObserver`	`getObserver()`
`android.graphics.Rect`	`getRemoteVideoViewSize()`
`android.view.View`	`getSharingRenderView()`
`android.graphics.Rect`	`getSharingViewSize()`
`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`	`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 Spark team.
`void`	`setFacingMode(Phone.FacingMode facingMode)`
`void`	`setObserver(CallObserver observer)`
`void`	`setReceivingAudio(boolean receiving)`
`void`	`setReceivingSharing(boolean receiving)`
`void`	`setReceivingVideo(boolean receiving)`
`void`	`setSendingAudio(boolean sending)`
`void`	`setSendingVideo(boolean sending)`
`void`	`setSharingRenderView(android.view.View view)`
`void`	`setVideoRenderViews(android.util.Pair<android.view.View,android.view.View> videoRenderViews)`
`void`	`startSharing(CompletionHandler<java.lang.Void> callback)`
`void`	`stopSharing(CompletionHandler<java.lang.Void> callback)`

- 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
  - 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
  - getLocalVideoViewSize
```
android.graphics.Rect getLocalVideoViewSize()
```
    Returns:
    
    The local video render view dimensions (points) of this call.
    
    Since:
    
    0.1
  - getRemoteVideoViewSize
```
android.graphics.Rect getRemoteVideoViewSize()
```
    Returns:
    
    The remote video render view dimensions (points) of this call.
    
    Since:
    
    0.1
  - getSharingViewSize
```
android.graphics.Rect 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 Spark 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)
```
    Since:
    
    1.4
  - stopSharing
```
void stopSharing(@NonNull
                 CompletionHandler<java.lang.Void> callback)
```
    Since:
    
    1.4
  - isSendingSharing
```
boolean isSendingSharing()
```
    Returns:
    
    True if the local party of this call is sharing content. Otherwise, false.
    
    Since:
    
    1.4

Interface Call

Nested Class Summary

Method Summary

Method Detail

getFacingMode

setFacingMode

getDirection

getStatus

setObserver

getObserver

getMemberships

getFrom

getTo

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

stopSharing

isSendingSharing