com.cisco.jtapi.extensions
Interface CiscoMediaStreamEndedEv

All Superinterfaces:
javax.telephony.events.CallEv, javax.telephony.events.Ev, javax.telephony.events.TermConnEv

public interface CiscoMediaStreamEndedEv
extends javax.telephony.events.TermConnEv

Introduction

Applications receive CiscoMediaStreamStartedEv when an addMediaStream() request is made on a call, and the media has begun streaming to the call.

This is a TermConnEv.

Since:
8.5

Field Summary
static int ID
           
static int RESULT_FAILURE
          This constant signifies that the CiscoMediaStreamEndedEv was caused by some failure, and the media did not play properly.
static int RESULT_PRIMARY_CALL_DROPPED
          This constant signifies that the CiscoMediaStreamEndedEv was delivered because the primary call that the media call was attached to was dropped.
static int RESULT_SUCCESS
          This constant signifies that the CiscoMediaStreamEndedEv was caused by a successful request, and the media finished playing successfully.
 
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 getID()
           
 int getResult()
          Returns an integer representing if the media stream ended successfully, or if it was cut off because of some error.
 
Methods inherited from interface javax.telephony.events.TermConnEv
getTerminalConnection
 
Methods inherited from interface javax.telephony.events.CallEv
getCall
 
Methods inherited from interface javax.telephony.events.Ev
getCause, getMetaCode, getObserved, isNewMetaEvent
 

Field Detail

RESULT_FAILURE

static final int RESULT_FAILURE
This constant signifies that the CiscoMediaStreamEndedEv was caused by some failure, and the media did not play properly.

See Also:
Constant Field Values

RESULT_SUCCESS

static final int RESULT_SUCCESS
This constant signifies that the CiscoMediaStreamEndedEv was caused by a successful request, and the media finished playing successfully.

See Also:
Constant Field Values

RESULT_PRIMARY_CALL_DROPPED

static final int RESULT_PRIMARY_CALL_DROPPED
This constant signifies that the CiscoMediaStreamEndedEv was delivered because the primary call that the media call was attached to was dropped.

See Also:
Constant Field Values

ID

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

getID

int getID()
Specified by:
getID in interface javax.telephony.events.Ev

getResult

int getResult()
Returns an integer representing if the media stream ended successfully, or if it was cut off because of some error.

Returns:
RESULT_FAILURE on failure, RESULT_SUCCESS on success, RESULT_PRIMARY_CALL_DROPPED if the primary call was dropped.