javax.telephony.media
Interface PlayerEvent

All Superinterfaces:

CoderConstants, MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent, PlayerConstants, ResourceConstants, ResourceEvent

All Known Subinterfaces:

Async_PlayerEvent

public interface PlayerEvent

extends ResourceEvent, PlayerConstants

Defines the methods for Player Events. May be the completion of a Player Resouce operation, or may signal the occurence of a non-transaction event.

Since:

JTAPI-1.3

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

Method Summary

Symbol	getChangeType() Returns the RTC action Symbol that caused this change in the Player.
int	getIndex() Return index in to MDO List, indicating which MDO was stopped.
int	getOffset() Return index into a MDO where play stopped.

Methods inherited from interface javax.telephony.media.ResourceEvent

getRTCTrigger

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Methods inherited from interface javax.telephony.media.MediaEvent

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

Method Detail

getIndex

public int getIndex()

Return index in to MDO List, indicating which MDO was stopped.

Returns:

the int index into the MDO List, indicating which MDO was stopped, paused, etc.

getOffset

public int getOffset()

Return index into a MDO where play stopped. Typically this is milliseconds into an audio MDO.

Returns:

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

getChangeType

public Symbol getChangeType()

Returns the RTC action Symbol that caused this change in the Player.

The return value is non-null only for non-transactional events as delivered to onSpeedChange(), onVolumeChange(), onJump(). The return value indicates the type of change in Speed, Volume or Position.

Valid return values are the RTC action Symbols:

rtca_SpeedUp	rtca_SpeedDown	rtca_ToggleSpeed	rtca_NormalSpeed
rtca_VolumeUp	rtca_VolumeDown	rtca_ToggleVolume	rtca_NormalVolume
rtca_JumpForwardTime	rtca_JumpBackwardTime
rtca_JumpForwardMDOs	rtca_JumpBackwardMDOs	rtca_JumpStartMDO	rtca_JumpEndMDO
		rtca_JumpStartMDOList	rtca_JumpEndMDOList
rtca_JumpForwardSentences	rtca_JumpBackwardSentences	rtca_JumpStartSentence	rtca_JumpEndSentence
rtca_JumpForwardWords	rtca_JumpBackwardWords

Returns:

one of the rtca_ Symbols.

See Also:

PlayerConstants.rtca_SpeedDown