hp.telephony.media
Interface TTSPlayerEvent

All Superinterfaces:
CoderConstants, MediaEvent, PlayerConstants, PlayerEvent, ResourceConstants, ResourceEvent, TTSConstants

public interface TTSPlayerEvent
extends PlayerEvent, TTSConstants

This class extends the PlayerEvent interface in order to cover the RTSP and TTS based specific events. The provided method getMarker() allows to retrieve the tag marker information (in case of stop-on-tag).

A new event type ev_Tag is defined to provide information on tags seen in the synthesized text at the point when they are synthesized. This event is received each time a marked point in the text is reached (marked with the SSML tag) (*** this feature is not yet supported***).

As for other play resources, the ev_Play event indicates the end of the operation. The error and qualifier fields indicate the reason for the end of the play operation.

TTS operations allow several new error values, such as e_ResourceUnavailable or e_ServerFailure. See TTSConstants for details.

If the error field is e_OK, then the qualifier will indicate either a "normal" play end (q_EndOfData), a RTC interruption (q_RTC) or a stop (q_Stop).

Since:
OCMP 2.2 with ASR/TTS extensions

Field Summary
 
Fields inherited from interface hp.telephony.media.MediaEvent
ev_Disconnected, ev_TerminalIdle
 
Fields inherited from interface hp.telephony.media.ResourceConstants
e_Disconnected, e_OK, FOREVER, q_Duration, q_RTC, q_Standard, q_Stop, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever
 
Fields inherited from interface hp.telephony.media.PlayerConstants
a_AutomaticGainControl, a_Coder, a_Jump, a_Pause, a_Speed, a_Volume, ev_Pause, ev_Play, ev_Resume, ev_Speed, ev_Volume, p_CoderTypes, p_DisplayName, p_EnabledEvents, p_FileFormat, p_IfBusy, p_JumpMSCIncrement, p_JumpTime, p_MaxDuration, p_SpeedChange, p_StartPaused, p_VolumeChange, q_Duration, q_EndOfData, rtca_JumpBackward, rtca_JumpBackwardMSCs, rtca_JumpEndMSC, rtca_JumpEndMSCList, rtca_JumpForward, rtca_JumpForwardMSCs, rtca_JumpStartMSC, rtca_JumpStartMSCList, rtca_NormalSpeed, rtca_NormalVolume, rtca_Pause, rtca_Resume, rtca_SpeedDown, rtca_SpeedUp, rtca_Stop, rtca_StopAll, rtca_ToggleSpeed, rtca_ToggleVolume, rtca_VolumeDown, rtca_VolumeUp, rtcc_PlayComplete, rtcc_PlayStarted, v_Fail, v_GSMFormat, v_Queue, v_RawFormat, v_Stop, v_WavFormat
 
Fields inherited from interface hp.telephony.media.CoderConstants
p_AMR_SDPelement, p_channels, p_crc, p_G723_annexa, p_G723_bitrate, p_G729_annexb, p_interleaving, p_maxptime, p_modechangeneighbor, p_modechangeperiod, p_modeset, p_octetalign, p_ptime, p_robustsorting, v_ADPCM_16kG726, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_32kG726, v_ADPCM_32kOKI, v_ADPCM_44k, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_AMR, v_AMR_WB, v_G723_1b, v_G723_53, v_G723_63, v_G723_no_vad, v_G723_yes, v_G729_no_vad, v_G729_yes, v_G729a, v_GSM, v_Linear16Bit_64k, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k
 
Fields inherited from interface hp.telephony.media.TTSConstants
a_ASSessionAllocation, a_ASSessionCreation, a_AudioService, e_ResourceUnavailable, e_ServerError, e_ServerFailed, ev_Tag, p_AudioData, p_Language, p_ServerURL, p_Speaker, p_SpeakerCategory, p_SpeakerGender, p_SpeakerPitch, p_SpeakerRate, p_SpeakerVolume, p_StartMarkerMS, p_StartMarkerToken, p_StopMarkerMS, p_StopMarkerToken, p_TextType, p_TTSData, q_StartMarkerNotFound, q_StopMarkerReached, rtca_ReleaseCurrentASSession, v_ASStartTime, v_Call, v_FromFirstOperation, v_OnDemand, v_Operation
 
Method Summary
 String getMarker()
          Returns the marker at which the play stopped return null if not applicable.
 
Methods inherited from interface hp.telephony.media.PlayerEvent
getChangeType, getIndex, getOffset
 
Methods inherited from interface hp.telephony.media.ResourceEvent
getError, getQualifier, getRTCTrigger
 
Methods inherited from interface hp.telephony.media.MediaEvent
getEventID
 

Method Detail

getMarker

public String getMarker()
Returns the marker at which the play stopped return null if not applicable.