com.cisco.jtapi.extensions
Interface CiscoMediaOpenLogicalChannelEv

All Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv

public interface CiscoMediaOpenLogicalChannelEv
extends CiscoTermEv

Introduction

The system sends a CiscoMediaOpenLogicalChannelEv event each time that media gets established for a dynamically-registered CiscoMediaTerminal or CiscoRouteTerminal. Upon receiving this event, applications must invoke setRTPParams on CiscoMediaTerminal or CiscoRouteTerminal and pass in the IP address and port number where they want to terminate the media, along with the rtpHandle that this event delivers. Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). Applications must be aware that the far end and local end may not be able to invoke features unless the setRTPParams method is invoked. If applications fail to respond to this event within the specified time, the call may get disconnected.


Field Summary
static int ID
           
 
Fields inherited from interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
 
Method Summary
 int getAddressingModeForMedia()
           This interface return int Application could get following values for required IP Addressing Mode :- CiscoTerminal.IP_ADDRESSING_IPv4: Means application need to provide IPv4 format IP Address in set RTP Params request. CiscoTerminal.IP_ADDRESSING_IPv6: Means application need to provide IPv6 format IP Address in set RTP Params request.
 CiscoRTPHandle getCiscoRTPHandle()
           Returns CiscoRTPHandle object.
 int getMediaConnectionMode()
           Returns a CiscoMediaConnectionMode.
 int getPacketSize()
           Returns the packet size of the far end, in milliseconds.
 int getPayLoadType()
           Returns the payload format of the far end, one of the following constants:
 
Methods inherited from interface javax.telephony.events.TermEv
getTerminal
 
Methods inherited from interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
 

Field Detail

ID

static final int ID
See Also:
Constant Field Values
Method Detail

getPacketSize

int getPacketSize()

Returns the packet size of the far end, in milliseconds.

Returns:
The packet size, in milliseconds

getPayLoadType

int getPayLoadType()

Returns the payload format of the far end, one of the following constants:

Returns:
The payload type

getCiscoRTPHandle

CiscoRTPHandle getCiscoRTPHandle()

Returns CiscoRTPHandle object. Applications should pass this handle along with RTPParameters to CiscoMediaTerminal or CiscoRouteTerminal. Applications can get call reference using CiscoProvider.getCall If there is no callobserver or there was no callobserver when this event is delivered, then CiscoProvider.getCall may return null

Returns:
CiscoRTPHandle
See Also:
CiscoRTPParams

getMediaConnectionMode

int getMediaConnectionMode()

Returns a CiscoMediaConnectionMode. Applications could get one of the following values:

  • CiscoMediaConnectionMode.RECEIVE_ONLY: Means one-way media receive only.
  • CiscoMediaConnectionMode.TRANSMIT_AND_RECEIVE: Means two-way media.

Applications should never see a value of NONE; however, if that happens, applications should ignore the event and log an error.

Returns:
CiscoMediaConnectionMode
See Also:
CiscoRTPParams

getAddressingModeForMedia

int getAddressingModeForMedia()

This interface return int Application could get following values for required IP Addressing Mode :-

  • CiscoTerminal.IP_ADDRESSING_IPv4: Means application need to provide IPv4 format IP Address in set RTP Params request.
  • CiscoTerminal.IP_ADDRESSING_IPv6: Means application need to provide IPv6 format IP Address in set RTP Params request.
  • Returns:
    int
    Since:
    7.0