Call (Oracle® Communications WebRTC Session Controller Android API Reference)

java.lang.Object
- oracle.wsc.android.session.SubSession
- - oracle.wsc.android.call.Call

```
public final class Call
extends SubSession
```
Represents a call which could have any combination of audio/video/dataChannel capabilities.
The capability of a Call is determined when it is created. This capability is configured in the CallConfig object and input as the second parameter in CallPackage.createCall(java.lang.String).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Call.Observer` Observer class that the application can implement to be informed of changes in the `Call`.
`static class`	`Call.TrickleIceMode` Trickle ICE modes.

Field Summary

Fields
Modifier and Type Field and Description

static String PROP_PEER_CONNECTION_FORCE_NEW
Compatibility flag to force a new peer connection on every SDP exchange.

Fields
Modifier and Type	Field and Description
`static String`	`PROP_PEER_CONNECTION_FORCE_NEW` Compatibility flag to force a new peer connection on every SDP exchange.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(CallConfig config, Map<String,?> extHeaders, org.webrtc.MediaStream... localStreams)` Accepts the received Call invitation.
`void`	`accept(CallConfig config, org.webrtc.MediaStream... localStreams)` Accepts the received Call invitation.
`void`	`decline(int code)` Decline the call with a reason code.
`void`	`decline(int code, Map<String,?> extHeaders)` Decline the call with a reason code.
`protected void`	`dispose()` Disposes of any resources allocated by the sub session.
`void`	`end()` End the current call.
`void`	`end(Map<String,?> extHeaders)` End the current call.
`CallConfig`	`getCallConfig()` Gets the CallConfig for the current call.
`String`	`getCallee()` Gets the callee of the current call.
`String`	`getCaller()` Gets the caller of the current call.
`CallState`	`getCallState()` Gets the current state of a call.
`CallPackage`	`getPackage()` Gets the package.
`org.webrtc.PeerConnection`	`getPeerConnection()` Gets the peerConnection of the current call. Note: The peerConnection may change.
`org.webrtc.PeerConnectionFactory`	`getPeerConnectionFactory()` Gets the Peer Connection Factory instance to create media streams while initiating or accepting a call.
`Call.TrickleIceMode`	`getTrickleIceMode()`
`protected void`	`onMessage(oracle.wsc.android.data.Frame frame)` Receive message.
`void`	`setObserver(Call.Observer observer)`
`void`	`setTrickleIceMode(Call.TrickleIceMode trickleIceMode)`
`void`	`start(CallConfig config, Map<String,?> extHeaders, org.webrtc.MediaStream... localStreams)` Starts the call represented by itself.
`void`	`start(CallConfig config, org.webrtc.MediaStream... localStreams)` Starts the call represented by itself.
`String`	`toString()`
`void`	`update(CallConfig config, Map<String,?> extHeaders, org.webrtc.MediaStream... localStreams)` Updates the call, for example, to add video, remove video, mute and unmute audio, or mute and unmute video and so on.
`void`	`update(CallConfig config, org.webrtc.MediaStream... localStreams)` Updates the call, for example, to add video, remove video, mute and unmute audio, or mute and unmute video and so on.

Methods inherited from class oracle.wsc.android.session.SubSession
getId, sendMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROP_PEER_CONNECTION_FORCE_NEW
```
public static final String PROP_PEER_CONNECTION_FORCE_NEW
```
    Compatibility flag to force a new peer connection on every SDP exchange. Default false.
    
    See Also:
    Constant Field Values
- Method Detail
  - getCaller
```
public String getCaller()
```
    Gets the caller of the current call.
    
    Returns:
    caller
  - getCallee
```
public String getCallee()
```
    Gets the callee of the current call.
    
    Returns:
    callee
  - getCallState
```
public CallState getCallState()
```
    Gets the current state of a call.
    
    Returns:
    the call state of current call
  - getCallConfig
```
public CallConfig getCallConfig()
```
    Gets the CallConfig for the current call.
    
    Returns:
    the CallConfig object of current call
  - getPeerConnection
```
public org.webrtc.PeerConnection getPeerConnection()
```
    Gets the peerConnection of the current call.
    Note: The peerConnection may change. When using it, execute call.getPeerConnection() each time.
    
    Returns:
    the PeerConnection of the current call
  - getPeerConnectionFactory
```
public org.webrtc.PeerConnectionFactory getPeerConnectionFactory()
```
    Gets the Peer Connection Factory instance to create media streams while initiating or accepting a call. The Application should use this method instead of creating a local version of PeerConnectionFactory.
    
    Returns:
    peerConnectionFactory the peer connection factory.
  - setObserver
```
public void setObserver(Call.Observer observer)
```
  - setTrickleIceMode
```
public void setTrickleIceMode(Call.TrickleIceMode trickleIceMode)
```
  - getTrickleIceMode
```
public Call.TrickleIceMode getTrickleIceMode()
```
  - accept
```
public void accept(CallConfig config,
          org.webrtc.MediaStream... localStreams)
            throws IllegalArgumentException
```
    Accepts the received Call invitation.
    
    Parameters:
    config - Local capability configuration of the Call.
    This callConfig must not conflict with rules of RFC 3264. For example, if the callConfig of call.onIncomingCall or call.onUpdate is (SENDONLY, NONE), this callConfig cannot be (SENDONLY, NONE), but it can be (RECVONLY, NONE) or (NONE, NONE).
    localStreams - pre-created local media streams array
    
    Throws:
    
    IllegalArgumentException - thrown if no local streams were created
  - accept
```
public void accept(CallConfig config,
          Map<String,?> extHeaders,
          org.webrtc.MediaStream... localStreams)
            throws IllegalArgumentException
```
    Accepts the received Call invitation.
    
    Parameters:
    config - Local capability configuration of the Call.
    This callConfig must not conflict with rules of RFC 3264. For example, if callConfig of call.onIncomingCall or call.onUpdate is (SENDONLY, NONE), this callConfig cannot be (SENDONLY, NONE), but it can be (RECVONLY, NONE) or (NONE, NONE).
    extHeaders - extension headers. If provided, they are inserted into the JSON message.
    For example an extHeaders formatted like this, {'customerKey1':'value1','customerKey2':'value2'}
    will be in the message formatted like this :
    { "control" : {}, "header" : {...,'customerKey1':'value1','customerKey2':'value2'}, "payload" : {}}
    localStreams - pre-created local media streams array
    
    Throws:
    
    IllegalArgumentException - thrown if no local streams were created
  - decline
```
public void decline(int code)
```
    Decline the call with a reason code. The default value is 603 decline.
    The available reason codes are:
    - 486: busy here
    - 603: decline
    - 600: busy everywhere
    Parameters:
    code - code The decline code reason
  - decline
```
public void decline(int code,
           Map<String,?> extHeaders)
```
    Decline the call with a reason code. The default value is 603 decline.
    The available reason codes are:
    - 486: busy here
    - 603: decline
    - 600: busy everywhere
    Parameters:
    code - code The decline code reason
    extHeaders - extension headers. If provided, they are inserted into the JSON message.
    For example an extHeaders formatted like this, {'customerKey1':'value1','customerKey2':'value2'}
    will be in the message formatted like this :
    { "control" : {}, "header" : {...,'customerKey1':'value1','customerKey2':'value2'}, "payload" : {}}
  - start
```
public void start(CallConfig config,
         org.webrtc.MediaStream... localStreams)
           throws IllegalArgumentException
```
    Starts the call represented by itself.
    
    Parameters:
    config - an instance of the CallConfig object that represents the capabilities of the call
    localStreams - pre-created local media streams array
    
    Throws:
    
    IllegalArgumentException - thrown if no local streams were created
  - start
```
public void start(CallConfig config,
         Map<String,?> extHeaders,
         org.webrtc.MediaStream... localStreams)
           throws IllegalArgumentException
```
    Starts the call represented by itself.
    
    Parameters:
    config - an instance of the CallConfig object that represents the capabilities of the call
    extHeaders - extension headers. If provided, they are inserted into the JSON message.
    For example an extHeaders formatted like this, {'customerKey1':'value1','customerKey2':'value2'}
    will be in the message formatted like this :
    { "control" : {}, "header" : {...,'customerKey1':'value1','customerKey2':'value2'}, "payload" : {}}
    localStreams - pre-created local media streams array
    
    Throws:
    
    IllegalArgumentException - thrown if no local streams were created
  - update
```
public void update(CallConfig config,
          org.webrtc.MediaStream... localStreams)
```
    Updates the call, for example, to add video, remove video, mute and unmute audio, or mute and unmute video and so on.
    
    Parameters:
    config - The call configuration used to update the current call.
    localStreams - pre-created local media streams array
  - update
```
public void update(CallConfig config,
          Map<String,?> extHeaders,
          org.webrtc.MediaStream... localStreams)
```
    Updates the call, for example, to add video, remove video, mute and unmute audio, or mute and unmute video and so on.
    
    Parameters:
    config - The call configuration used to update the current call.
    localStreams - pre-created local media streams array
    extHeaders - extension headers. If provided, they are inserted into the JSON message.
    For example an extHeaders formatted like this, {'customerKey1':'value1','customerKey2':'value2'}
    will be in the message formatted like this :
    { "control" : {}, "header" : {...,'customerKey1':'value1','customerKey2':'value2'}, "payload" : {}}
  - end
```
public void end()
```
    End the current call.
  - end
```
public void end(Map<String,?> extHeaders)
```
    End the current call.
    
    Parameters:
    extHeaders - extension headers. If provided, they are inserted into the JSON message.
    For example an extHeaders formatted like this, {'customerKey1':'value1','customerKey2':'value2'}
    will be in the message formatted like this :
    { "control" : {}, "header" : {...,'customerKey1':'value1','customerKey2':'value2'}, "payload" : {}}
  - getPackage
```
public CallPackage getPackage()
```
    Description copied from class: SubSession
    
    Gets the package.
    
    Overrides:
    
    getPackage in class SubSession
    
    Returns:
    the package
  - dispose
```
protected void dispose()
```
    Description copied from class: SubSession
    
    Disposes of any resources allocated by the sub session.
    
    Specified by:
    
    dispose in class SubSession
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - onMessage
```
protected void onMessage(oracle.wsc.android.data.Frame frame)
```
    Receive message.
    
    Specified by:
    
    onMessage in class SubSession
    
    Parameters:
    frame - Frame

Class Call

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class oracle.wsc.android.session.SubSession

Methods inherited from class java.lang.Object

Field Detail

PROP_PEER_CONNECTION_FORCE_NEW

Method Detail

getCaller

getCallee

getCallState

getCallConfig

getPeerConnection

getPeerConnectionFactory

setObserver

setTrickleIceMode

getTrickleIceMode

accept

accept

decline

decline

start

start

update

update

end

end

getPackage

dispose

toString

onMessage