Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


com.oracle.sft.api
Interface Conversation

All Superinterfaces:
Communication, Interaction

public interface Conversation
extends Interaction

Represents a two party call. It extends an Interaction.


Nested Class Summary

 

Nested classes/interfaces inherited from interface com.oracle.sft.api.Communication
Communication.State

 

Method Summary
 void enableChangeBandwidth(boolean enable)
          3GPP 24.610 (Communication HOLD) defines the AS of the UE should change some band width attributes for each media stream marked "recvonly".
 int[] getBandWidth()
          Get the band width values of AS, RS and RR
 Participant getCallee()
          Return the callee in the call.
 Participant getCaller()
          Return the caller who initiated the call..
 MediaPartner getMediaPartner()
          Return the MediaPartner in this Conversation if exist.
 Participant getOtherParty(Participant p)
          Get the other party of the specified participant in this Conversation.
 void indicateCallWaiting()
          Forward or resend the INVITE with callwaiting indication.
 void indicateCallWaiting(int cwTimer)
          Forward or resend the INVITE with callwaiting indication and an Expires header field set to the value of cwTimer The value of cwTimer should be between 30 and 120 second.
 boolean isCallWaitingSet()
          Indicate whether the call is set to waiting state.
 boolean isEnableChangeBandwidth()
          By this method, application can get whether Changing Bandwidth is enable.
 void setBandWidth(int totalBandwidth, int bandwidthForActiveDataSenders, int bandwidthForOtherParticipants)
          3GPP 24.610 Communication HOLD: As a network option, the AS of the invoking UE shall for each media stream marked "recvonly" lower the bandwidth by setting the "b=AS:" parameter to a small value, e.g.

 

Methods inherited from interface com.oracle.sft.api.Interaction
addParticipant, addParticipant, addParticipant, addParticipant, getParticipant, getParticipant, removeParticipant, removeParticipant, replaceParticipant, replaceParticipant

 

Methods inherited from interface com.oracle.sft.api.Communication
addAgent, end, getAgent, getAgents, getInitiator, getName, getState, removeAgent

 

Method Detail

getCaller

Participant getCaller()
Return the caller who initiated the call..
Returns:
The caller Participant.

getCallee

Participant getCallee()
Return the callee in the call.
Returns:
Callee participant

getOtherParty

Participant getOtherParty(Participant p)
Get the other party of the specified participant in this Conversation.
Parameters:
p - The caller or callee of current Conversation.
Returns:
if p is caller, then callee is returned; if p is callee, caller is returned; otherwise, return null.

setBandWidth

void setBandWidth(int totalBandwidth,
                  int bandwidthForActiveDataSenders,
                  int bandwidthForOtherParticipants)
3GPP 24.610 Communication HOLD: As a network option, the AS of the invoking UE shall for each media stream marked "recvonly" lower the bandwidth by setting the "b=AS:" parameter to a small value, e.g. "b=AS:0". The "b=RR:" and "b=RS:" parameters shall be set to values large enough to enable continuation of the RTCP flow, e.g. "b=RR:800" and "b=RS:800". Set the band width values of AS, RS and RR

getBandWidth

int[] getBandWidth()
Get the band width values of AS, RS and RR

enableChangeBandwidth

void enableChangeBandwidth(boolean enable)
3GPP 24.610 (Communication HOLD) defines the AS of the UE should change some band width attributes for each media stream marked "recvonly". By this method, application can disable this feature. The default behavior is enable.

isEnableChangeBandwidth

boolean isEnableChangeBandwidth()
By this method, application can get whether Changing Bandwidth is enable.
Returns:
is Enable Change RecvOnly Bandwidth

indicateCallWaiting

void indicateCallWaiting()
Forward or resend the INVITE with callwaiting indication.

indicateCallWaiting

void indicateCallWaiting(int cwTimer)
Forward or resend the INVITE with callwaiting indication and an Expires header field set to the value of cwTimer The value of cwTimer should be between 30 and 120 second. If the value of cwTimer is bigger than 120 or smaller than 30, an IllegalArgumentException will be thrown.

isCallWaitingSet

boolean isCallWaitingSet()
Indicate whether the call is set to waiting state.

getMediaPartner

MediaPartner getMediaPartner()
Return the MediaPartner in this Conversation if exist.
Returns:
null if it isn't existed.

Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


Copyright © 2012 Oracle Corporation. All Rights Reserved.