hp.telephony.media
Interface TTSConstants

All Known Subinterfaces:

Player, TTSPlayerEvent

All Known Implementing Classes:

AsyncMediaGroup

public interface TTSConstants

Defines some Symbols used by Player.

Since:

OCMP 2.2 with ASR/TTS extensions

Field Summary

static Symbol	a_ASSessionAllocation Specify how long a session should be allocated to a particular call.
static Symbol	a_ASSessionCreation Specify the session creation/destruction policy.
static Symbol	a_AudioService Specify Audio Service name where a session has to be allocated (reserved).
static Symbol	e_ResourceUnavailable Error code for ev_Play when a streamID URL was bad or not able to be played due to a resource problem.
static Symbol	e_ServerError Error code for ev_Play when a server transaction produced a protocol error
static Symbol	e_ServerFailed Error code for ev_Play when a server failed during the play
static Symbol	ev_Tag Event received for each tag seen in the TTS text (if JSML formatted, and tag events have been enabled by p_EnableTagEvents in the play() call).
static Symbol	p_AudioData Deprecated. p_TTSData. Value: a MimePart object containing audio that is sent to the streamer via a RTSP packet
static Symbol	p_Language Define language to be used for the synthesis Value: a string identifying a language eg: en-us = US English fr = French
static Symbol	p_ServerURL Define audioserver URL to be used when performing a getParameters()/setParameters() call.
static Symbol	p_Speaker Define speaker voice to be used to speak data Value: a string identifying a registered speaker
static Symbol	p_SpeakerCategory Optional parameter (optArgs key) for TTS to specify the category of the speaker.
static Symbol	p_SpeakerGender Optional parameter (optArgs key) for TTS to specify the speaking voice's gender.
static Symbol	p_SpeakerPitch Optional parameter (optArgs key) for TTS to specify the pitch of the generated voice.
static Symbol	p_SpeakerRate Optional parameter (optArgs key) for TTS to specify the rate of the generated voice.
static Symbol	p_SpeakerVolume Optional parameter (optArgs key) for TTS to specify the volume of the generated voice.
static Symbol	p_StartMarkerMS Parameter to specify start point after beginning of stream in milliseconds
static Symbol	p_StartMarkerToken Parameter to specify start point after beginning of stream using a String token e.g., refering to a JSML marker
static Symbol	p_StopMarkerMS Parameter to specify where to stop playing after beginning of stream in milliseconds
static Symbol	p_StopMarkerToken Parameter to specify stop point using a token e.g., refering to a JSML marker
static Symbol	p_TextType Optional parameter (optArgs key) for TTS to specify the mime type of the text.
static Symbol	p_TTSData When the RTSP streaming device has TTS capabilities, this parameter sets the text content.
static Symbol	q_StartMarkerNotFound Indicate play complete because the start marker was not found inthe stream
static Symbol	q_StopMarkerReached play media complete because the end marker (either a time marker or a token marker) was found
static Symbol	rtca_ReleaseCurrentASSession Release current TTS operation's session (if any) at operation end.
static Symbol	v_ASStartTime a_ASSessionCreation possible value.
static Symbol	v_Call a_ASSessionAllocation possible value.
static Symbol	v_FromFirstOperation a_ASSessionAllocation possible value.
static Symbol	v_OnDemand a_ASSessionCreation possible value.
static Symbol	v_Operation a_ASSessionAllocation possible value.

Field Detail

rtca_ReleaseCurrentASSession

public static final Symbol rtca_ReleaseCurrentASSession

Release current TTS operation's session (if any) at operation end.

To be used through RTCs or through AsyncMediaGroup.triggerRTC(hp.telephony.media.Symbol).

See Also:

v_Call

v_Operation

public static final Symbol v_Operation

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the TTS operation - play("rtsp://TTSEnglishAS" ....) - and released at operation end - onPlayerEvent(PlayerEvent event).

v_FromFirstOperation

public static final Symbol v_FromFirstOperation

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the first TTS operation - play("rtsp://TTSEnglishAS" ....) - and released at call end or through rtca_ReleaseCurrentASSession RTC action.

v_Call

public static final Symbol v_Call

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the call - loopCP - and released at call end or through rtca_ReleaseCurrentASSession RTC action.

v_OnDemand

public static final Symbol v_OnDemand

a_ASSessionCreation possible value.

The session is created at TTS operation start - play("rtsp://TTSEnglishAS" ....) - and destroyed either at operation end - onPlayerEvent(PlayerEvent event) - or at call end depending on a_ASSessionAllocation's value.

v_ASStartTime

public static final Symbol v_ASStartTime

a_ASSessionCreation possible value.

The session is created at OCMP Audio Service Component startup and destroyed on server problem, on request timeout, on session timeout or at Audio Service Component shutdown ( platform shutdown time).

a_ASSessionCreation

public static final Symbol a_ASSessionCreation

Specify the session creation/destruction policy.

Possible values: v_OnDemand or v_ASStartTime Default value: v_ASStartTime

a_ASSessionAllocation

public static final Symbol a_ASSessionAllocation

Specify how long a session should be allocated to a particular call.

Possible values: v_Call, v_FromFirstOperation or v_Operation Default value: v_Call

NOTE: v_Call value should be associated with attribute a_AudioService.

a_AudioService

public static final Symbol a_AudioService

Specify Audio Service name where a session has to be allocated (reserved).

Possible values: String

q_StopMarkerReached

public static final Symbol q_StopMarkerReached

play media complete because the end marker (either a time marker or a token marker) was found

q_StartMarkerNotFound

public static final Symbol q_StartMarkerNotFound

Indicate play complete because the start marker was not found inthe stream

p_StartMarkerMS

public static final Symbol p_StartMarkerMS

Parameter to specify start point after beginning of stream in milliseconds

p_StartMarkerToken

public static final Symbol p_StartMarkerToken

Parameter to specify start point after beginning of stream using a String token e.g., refering to a JSML marker

p_StopMarkerMS

public static final Symbol p_StopMarkerMS

Parameter to specify where to stop playing after beginning of stream in milliseconds

p_StopMarkerToken

public static final Symbol p_StopMarkerToken

Parameter to specify stop point using a token e.g., refering to a JSML marker

p_TTSData

public static final Symbol p_TTSData

When the RTSP streaming device has TTS capabilities, this parameter sets the text content. Value: A String object or a byte array (byte[]) that is sent to the TTS engine for synthesis

p_AudioData

public static final Symbol p_AudioData

Deprecated. p_TTSData. Value: a MimePart object containing audio that is sent to the streamer via a RTSP packet

Passes audio content that is to be streamed to the telephony port.

p_Speaker

public static final Symbol p_Speaker

Define speaker voice to be used to speak data Value: a string identifying a registered speaker

p_Language

public static final Symbol p_Language

Define language to be used for the synthesis Value: a string identifying a language eg: en-us = US English fr = French

p_ServerURL

public static final Symbol p_ServerURL

Define audioserver URL to be used when performing a getParameters()/setParameters() call. This value must be set before a getParameters() call by a specific setParameters() call. Value : a String object containing the server's audioService name

ev_Tag

public static final Symbol ev_Tag

Event received for each tag seen in the TTS text (if JSML formatted, and tag events have been enabled by p_EnableTagEvents in the play() call). The getMarker() call is used to obtain the tag reached.

e_ResourceUnavailable

public static final Symbol e_ResourceUnavailable

Error code for ev_Play when a streamID URL was bad or not able to be played due to a resource problem.

e_ServerFailed

public static final Symbol e_ServerFailed

Error code for ev_Play when a server failed during the play

e_ServerError

public static final Symbol e_ServerError

Error code for ev_Play when a server transaction produced a protocol error

p_TextType

public static final Symbol p_TextType

Optional parameter (optArgs key) for TTS to specify the mime type of the text. Currently acceptable values are "text/plain", "application/synthesis+ssml"

p_SpeakerGender

public static final Symbol p_SpeakerGender

Optional parameter (optArgs key) for TTS to specify the speaking voice's gender. Acceptable values depend on the server, but are likely to include "male", "female", "neuter". Defined by the W3C SSML as Voice-Gender.

p_SpeakerCategory

public static final Symbol p_SpeakerCategory

Optional parameter (optArgs key) for TTS to specify the category of the speaker. Acceptable value depend on the server,but are likely to include "adult", "teenager", "child". Defined by W3C SSML as Voice-Category.

p_SpeakerVolume

public static final Symbol p_SpeakerVolume

Optional parameter (optArgs key) for TTS to specify the volume of the generated voice. Acceptable values depend on the server,but are likely to include "high", "medium" and "low". Defined by W3C SSML as Prosody-Volume.

p_SpeakerRate

public static final Symbol p_SpeakerRate

Optional parameter (optArgs key) for TTS to specify the rate of the generated voice. Acceptable values depend on the server,but are likely to include "high", "medium" and "low" as well as delta values such as "+20%". Defined by W3C SSML as Prosody-Rate.

p_SpeakerPitch

public static final Symbol p_SpeakerPitch

Optional parameter (optArgs key) for TTS to specify the pitch of the generated voice. Acceptable values depend on the server,but are likely to include "high", "medium" and "low" as well as delta values such as "+20%". Defined by W3C SSML as Prosody-Pitch.