com.cisco.jtapi.extensions
Interface CiscoRTPInputKeyEv

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

public interface CiscoRTPInputKeyEv
extends CiscoTermEv

Introduction

The CiscoRTPInputKeyEv event interface gives the key information for the encrypted incoming media stream. Applications should set the filter by using CiscoTermEvFilter.setRTPKeyEventsEnabled(true) to get this event via the TerminalObserver.terminalChangedEvent().


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
 CiscoCallID getCallID()
          Returns a CiscoCallID object if there is already a CiscoCall present when this event is sent.
 CiscoMediaEncryptionKeyInfo getCiscoMediaEncryptionKeyInfo()
          Returns CiscoMediaEncryptionKeyInfo only if the provider is opened with the TLS link and SRTP enabled options set for the application in the Cisco Unified Communications Manager administration.
 int getCiscoMediaSecurityIndicator()
          Returns the media security indicator, one of the following constants: CiscoMediaSecurityIndicator.MEDIA_ENCRYPTED_KEYS_AVAILABLE CiscoMediaSecurityIndicator.MEDIA_ENCRYPT_USER_NOT_AUTHORIZED CiscoMediaSecurityIndicator.MEDIA_ENCRYPTED_KEYS_UNAVAILABLE
 CiscoRTPHandle getCiscoRTPHandle()
           Returns a CiscoRTPHandle object.
 
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

getCiscoMediaEncryptionKeyInfo

CiscoMediaEncryptionKeyInfo getCiscoMediaEncryptionKeyInfo()
Returns CiscoMediaEncryptionKeyInfo only if the provider is opened with the TLS link and SRTP enabled options set for the application in the Cisco Unified Communications Manager administration. Otherwise, it returns null.


getCiscoMediaSecurityIndicator

int getCiscoMediaSecurityIndicator()
Returns the media security indicator, one of the following constants:

See Also:
CiscoMediaSecurityIndicator

getCallID

CiscoCallID getCallID()
Returns a CiscoCallID object if there is already a CiscoCall present when this event is sent. If there is no CiscoCall present, this method returns null. getCallID().getCall() gives the call for which this key applies.


getCiscoRTPHandle

CiscoRTPHandle getCiscoRTPHandle()

Returns a CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall. If there is no call observer or there was no call observer when this event got delivered, CiscoProvider.getCall returns null.

Returns:
CiscoRTPHandle
See Also:
CiscoRTPParams