javax.telephony.media.provider
Class S200_PlayerEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.telephony.media.provider.EventObject
              |
              +--javax.telephony.media.provider.Base.Event
                    |
                    +--javax.telephony.media.provider.Base.MediaServiceEvent
                          |
                          +--javax.telephony.media.provider.Base.ResourceEvent
                                |
                                +--javax.telephony.media.provider.Base_PlayerEvent
                                      |
                                      +--javax.telephony.media.provider.S200_PlayerEvent

All Implemented Interfaces:

Async_PlayerEvent, Async.Event, Async.MediaServiceEvent, Async.ResourceEvent, CoderConstants, Dispatcher.DispatchableEvent, MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent, PlayerConstants, PlayerEvent, ResourceConstants, ResourceEvent, java.io.Serializable

public class S200_PlayerEvent

extends Base_PlayerEvent

implements Async_PlayerEvent

Base_PlayerEvent defines the methods used by Player Events.

Since:

JTAPI-1.4

See Also:

Serialized Form

Inner classes inherited from class javax.telephony.media.provider.Base.Event

Base.Event.SyncInterruptedException

Fields inherited from interface javax.telephony.media.MediaServiceConstants

ev_BindAndConnect, ev_BindToCall, ev_BindToServiceName, ev_BindToTerminal, ev_BindToTerminalName, ev_Configure, ev_Connected, ev_DelegateToService, ev_Disconnected, ev_GetConfigSpec, ev_GetConfiguration, ev_GetParameters, ev_GetTerminal, ev_GetTerminalName, ev_GetUserValues, ev_GroupStop, ev_Release, ev_ReleaseDelegated, ev_ReleaseToDestroy, ev_ReleaseToService, ev_ReleaseToTag, ev_Retrieve, ev_Retrieved, ev_SetParameters, ev_SetUserDictionary, ev_SetUserValues, ev_TerminalIdle, ev_TriggerRTC

Fields inherited from interface javax.telephony.media.MediaConstants

e_OK, q_Duration, q_Standard, q_Stop

Fields inherited from interface javax.telephony.media.ResourceConstants

e_Disconnected, FOREVER, q_Disconnected, q_RTC, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever

Fields inherited from interface javax.telephony.media.PlayerConstants

a_Coder, a_DictionaryList, a_Jump, a_LoadedDictionary, a_Pause, a_SapiOptions, a_Speed, a_Volume, e_Busy, ev_ActivateDictionary, ev_AdjustSpeed, ev_AdjustVolume, ev_Jump, ev_LoadDictionary, ev_Marker, ev_Pause, ev_Play, ev_Resume, ev_Speed, ev_Stop, ev_UnloadDictionary, ev_Volume, p_CoderTypes, p_EnabledEvents, p_IfBusy, p_JumpMDO, p_JumpMDOIncrement, p_JumpMSCIncrement, p_JumpSentence, p_JumpTime, p_JumpWord, p_MaxDuration, p_SpeedChange, p_StartPaused, p_VolumeChange, q_Duration, q_EndOfData, rtca_JumpBackwardMDOs, rtca_JumpBackwardMSCs, rtca_JumpBackwardSentences, rtca_JumpBackwardTime, rtca_JumpBackwardWords, rtca_JumpEndMDO, rtca_JumpEndMDOList, rtca_JumpEndMSC, rtca_JumpEndMSCList, rtca_JumpEndSentence, rtca_JumpForwardMDOs, rtca_JumpForwardMSCs, rtca_JumpForwardSentences, rtca_JumpForwardTime, rtca_JumpForwardWords, rtca_JumpStartMDO, rtca_JumpStartMDOList, rtca_JumpStartMSC, rtca_JumpStartMSCList, rtca_JumpStartSentence, rtca_NormalSpeed, rtca_NormalVolume, rtca_Pause, rtca_Resume, rtca_SpeedDown, rtca_SpeedUp, rtca_Stop, rtca_ToggleSpeed, rtca_ToggleVolume, rtca_VolumeDown, rtca_VolumeUp, rtcc_PlayComplete, rtcc_PlayStarted, v_Class, v_Fail, v_Queue, v_Stop

Fields inherited from interface javax.telephony.media.CoderConstants

v_24kADPCM, v_32kADPCM, v_44kADPCM, v_48k8BitLinear, v_48kALawPCM, v_48kMuLawPCM, v_64k8BitLinear, v_64kALawPCM, v_64kMuLawPCM, v_88k8BitLinear, v_88kALawPCM, v_88kMuLawPCM, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_44k, v_ADSI, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_ASCII, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k, v_TDD

Constructor Summary

S200_PlayerEvent(java.lang.Object source, Symbol eventID)
Create specific completion or non-transaction event from Player.

S200_PlayerEvent(java.lang.Object source, Symbol eventID, boolean isNonTrans)
Constructor for non-trans vesion

Method Summary

Symbol	getChangeType() Return the RTC action Symbol that caused this change.
int	getIndex() Return index (zero based) into TVMList of last TVM played.
static Symbol	getJumpRTC(Symbol type, Symbol unit) Return the RTC Action Symbol corresponding to the given type/unit values.
static Symbol	getJumpType(Symbol rtca)
static Symbol	getJumpUnit(Symbol rtca)
int	getOffset() Return index into a TVM phrase where play stopped.

Methods inherited from class javax.telephony.media.provider.Base_PlayerEvent

dispatch

Methods inherited from class javax.telephony.media.provider.Base.ResourceEvent

getRTCTrigger, throwIfMediaResourceException

Methods inherited from class javax.telephony.media.provider.Base.MediaServiceEvent

getMediaService

Methods inherited from class javax.telephony.media.provider.Base.Event

done, getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning, isDone, setError, setFields, setFields, setPayload, setQualifier, setSubError, throwIfRuntimeException, toString, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.telephony.media.async.Async.ResourceEvent

throwIfMediaResourceException

Methods inherited from interface javax.telephony.media.async.Async.Event

isDone, throwIfRuntimeException, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from interface javax.telephony.media.MediaEvent

getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Methods inherited from interface javax.telephony.media.ResourceEvent

getRTCTrigger

Constructor Detail

S200_PlayerEvent

public S200_PlayerEvent(java.lang.Object source,
                        Symbol eventID)

Create specific completion or non-transaction event from Player.

Parameters:

source - the Object that created this EventObject.

eventID - a Symbol that identifies this event: ev_Play

S200_PlayerEvent

public S200_PlayerEvent(java.lang.Object source,
                        Symbol eventID,
                        boolean isNonTrans)

Constructor for non-trans vesion

Method Detail

getIndex

public int getIndex()

Return index (zero based) into TVMList of last TVM played.

Specified by:

getIndex in interface PlayerEvent

Overrides:

getIndex in class Base_PlayerEvent

Returns:

the index of the TVM that stopped.

getOffset

public int getOffset()

Return index into a TVM phrase where play stopped.

Specified by:

getOffset in interface PlayerEvent

Overrides:

getOffset in class Base_PlayerEvent

Returns:

the index into a TVM phrase where play stopped, paused, etc.

getChangeType

public Symbol getChangeType()

Return the RTC action Symbol that caused this change. Valid in non-trans Speed/Volume/Jump events.

Specified by:

getChangeType in interface PlayerEvent

Overrides:

getChangeType in class Base_PlayerEvent

Returns:

one of the rtca_ Symbols.

getJumpRTC

public static Symbol getJumpRTC(Symbol type,
                                Symbol unit)

Return the RTC Action Symbol corresponding to the given type/unit values. Returns null for invalid type/unit combinations.

Background: S.200 wants to split the rtca_Jump commands into two Symbols: JumpType (for,back,start,end) and JumpUnit (Time, MDO, MDOList, Sentence) This routine to reconstruct the single Symbol.

getJumpType

public static Symbol getJumpType(Symbol rtca)

getJumpUnit

public static Symbol getJumpUnit(Symbol rtca)