javax.telephony.media
Interface PlayerConstants

All Superinterfaces:

CoderConstants, MediaConstants, ResourceConstants

All Known Subinterfaces:

Async_Player, Async_PlayerEvent, Async_TTSPlayer, Player, PlayerEvent, TTSPlayer

public interface PlayerConstants

extends ResourceConstants, CoderConstants

Defines the Symbols used by the Player Resource.

Since:

JTAPI-1.3

Field Summary

static Symbol	a_Coder Attribute to request support for various coders.
static Symbol	a_DictionaryList Attribute to indicate have many TTS dictionaries may be loaded.
static Symbol	a_Jump Attribute to request capability to Jump forward and backward in a MDO.
static Symbol	a_LoadedDictionary Attribute to indicate which TTS dictionaries are supported.
static Symbol	a_Pause Attribute to request capability to Pause and Resume Play of MDO.
static Symbol	a_SapiOptions Attribute used to indicate which SAPI optional tags are supported.
static Symbol	a_Speed Attribute to request capability to adjust Speed during Play of a MDO.
static Symbol	a_Volume Attribute to request capability to adjust Volume during Play of a MDO.
static Symbol	e_Busy Returned when (p_IfBusy == v_Fail).
static Symbol	ev_ActivateDictionary Completion event for ActivateDictionary (TTS).
static Symbol	ev_AdjustSpeed Completion event for the adjustSpeed method.
static Symbol	ev_AdjustVolume Completion event for the adjustVolume method.
static Symbol	ev_Jump A jump has been caused by RTC or jumpPlayer.
static Symbol	ev_LoadDictionary Completion event for LoadDictionary (TTS).
static Symbol	ev_Marker Indicates a TTS Marker has been reached.
static Symbol	ev_Pause Play has been paused by RTC or pausePlayer.
static Symbol	ev_Play Completion event for the play method.
static Symbol	ev_Resume Play has been resumed by RTC or resumePlayer.
static Symbol	ev_Speed Playback speed has been changed due to RTC.
static Symbol	ev_Stop Play has been stopped by RTC or stopPlayer.
static Symbol	ev_UnloadDictionary Completion event for UnLoadDictionary (TTS).
static Symbol	ev_Volume Playback volume has been changed due to RTC.
static Symbol	p_CoderTypes Value is an array of Symbols identifying the coders actually supported by this Player.
static Symbol	p_EnabledEvents A Dictionary of Player event Symbols, indicating which events are generated and delivered to the application.
static Symbol	p_IfBusy Indicates the action to take if Player is busy when play() is invoked.
static Symbol	p_JumpMDO Integer number of MDOs to jump forward or backward in the MDO list, for either a rtca_JumpForwardMDO or rtca_JumpBackwardMDO.
static Symbol	p_JumpMDOIncrement p_JumpMDO.
static Symbol	p_JumpMSCIncrement p_JumpMDO.
static Symbol	p_JumpSentence Integer number of Sentences to jump forward or backward, for either a rtca_JumpForwardSentences or rtca_JumpBackwardSentences.
static Symbol	p_JumpTime Integer number of milliseconds by which the current MDO offset is changed by rtca_JumpForwardTime or rtca_JumpBackwardTime
static Symbol	p_JumpWord Integer number of Words to jump forward or backward, for either a rtca_JumpForwardWords or rtca_JumpBackwardWords.
static Symbol	p_MaxDuration Integer indicating maximum duration of this or subsequent play() in milleseconds.
static Symbol	p_SpeedChange Determines the amount the playback speed is changed by RTC actions rtca_SpeedUp or rtca_SpeedDown.
static Symbol	p_StartPaused Boolean indicating that this or subsequent play() should be started in the Paused state.
static Symbol	p_VolumeChange Determines the amount the volume parameter is changed by the RTC actions rtca_VolumeUp and rtca_VolumeDown.
static Symbol	q_Duration Play ended because the maximum play duration time has been reached.
static Symbol	q_EndOfData Indicate Play complete because all the streams played to completion.
static Symbol	rtca_JumpBackwardMDOs RTC Action to jump backward the number of MDOs indicated by p_JumpMDO.
static Symbol	rtca_JumpBackwardMSCs rtca_JumpBackwardMDOs.
static Symbol	rtca_JumpBackwardSentences RTC Action to jump backward the number of Sentences indicated by p_JumpSentence.
static Symbol	rtca_JumpBackwardTime RTC Action to jump backward the amount specified by p_JumpTime.
static Symbol	rtca_JumpBackwardWords RTC Action to jump backward the number of Words indicated by p_JumpWord.
static Symbol	rtca_JumpEndMDO RTC Action to jump to the end of the curent MDO.
static Symbol	rtca_JumpEndMDOList RTC Action to jump to the last MDO in the MDOList.
static Symbol	rtca_JumpEndMSC rtca_JumpEndMDO.
static Symbol	rtca_JumpEndMSCList rtca_JumpEndMDOList.
static Symbol	rtca_JumpEndSentence RTC Action to jump to the last Sentence in the MDO.
static Symbol	rtca_JumpForwardMDOs RTC Action to jump forward the number of MDOs indicated by p_JumpMDO.
static Symbol	rtca_JumpForwardMSCs rtca_JumpForwardMDOs @deprecated use rtca_JumpForwardMDOs.
static Symbol	rtca_JumpForwardSentences RTC Action to jump forward the number of Sentences indicated by p_JumpSentence.
static Symbol	rtca_JumpForwardTime RTC Action to jump forward the amount specified by p_JumpTime.
static Symbol	rtca_JumpForwardWords RTC Action to jump forward the number of Words indicated by p_JumpWord.
static Symbol	rtca_JumpStartMDO RTC Action to jump to the start of the curent MDO.
static Symbol	rtca_JumpStartMDOList RTC Action to jump to the first MDO in the MDO List.
static Symbol	rtca_JumpStartMSC rtca_JumpStartMDO.
static Symbol	rtca_JumpStartMSCList rtca_JumpStartMDOList @deprecated use rtca_JumpStartMDOList.
static Symbol	rtca_JumpStartSentence RTC Action to jump to the first Sentence in the MDO.
static Symbol	rtca_NormalSpeed RTC Action to set speed to normal.
static Symbol	rtca_NormalVolume RTC Action to set volume to normal.
static Symbol	rtca_Pause RTC Action to pause the current Play operation.
static Symbol	rtca_Resume RTC Action to resume the current Play operation if paused.
static Symbol	rtca_SpeedDown RTC Action to decrease speed by p_SpeedChange.
static Symbol	rtca_SpeedUp RTC Action to increase speed by p_SpeedChange.
static Symbol	rtca_Stop RTC Action to stop the current Play operation.
static Symbol	rtca_ToggleSpeed RTC Action to toggle speed between normal and previous adjusted value.
static Symbol	rtca_ToggleVolume RTC Action to toggle volume between normal and previous adjusted value.
static Symbol	rtca_VolumeDown RTC Action to decrease volume by p_VolumeChange.
static Symbol	rtca_VolumeUp RTC Action to increase volume by p_VolumeChange.
static Symbol	rtcc_PlayComplete RTC trigger when a Play is completed.
static Symbol	rtcc_PlayStarted RTC trigger when a Play is started.
static Symbol	v_Class Denotes the standard Player Resource Class in a ResourceSpec.
static Symbol	v_Fail value for p_IfBusy: signal an error, throw a MediaResourceException.
static Symbol	v_Queue value for p_IfBusy: wait for previous requests to complete.
static Symbol	v_Stop value for p_IfBusy: stop any previous play.

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.MediaConstants

e_OK, q_Standard, q_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

Field Detail

v_Class

public static final Symbol v_Class

Denotes the standard Player Resource Class in a ResourceSpec.

a_Coder

public static final Symbol a_Coder

Attribute to request support for various coders. Value is a Symbol or Symbol[] that identifies the required coder(s).

The Symbols that identify coders are in CoderConstants

a_Jump

public static final Symbol a_Jump

Attribute to request capability to Jump forward and backward in a MDO.

Value is a Boolean.

a_Pause

public static final Symbol a_Pause

Attribute to request capability to Pause and Resume Play of MDO. Value is a Boolean.

a_Speed

public static final Symbol a_Speed

Attribute to request capability to adjust Speed during Play of a MDO.

Value is an IntRange or a boolean.

a_Volume

public static final Symbol a_Volume

Attribute to request capability to adjust Volume during Play of a MDO.

Value is an IntRange or a boolean.

a_LoadedDictionary

public static final Symbol a_LoadedDictionary

Attribute to indicate which TTS dictionaries are supported.

Value is an Symbol[] of TTS Dictionary; or String[] ??

Used for TTS Player.

a_DictionaryList

public static final Symbol a_DictionaryList

Attribute to indicate have many TTS dictionaries may be loaded.

Value is an Integer.

Used for TTS Player.

a_SapiOptions

public static final Symbol a_SapiOptions

Attribute used to indicate which SAPI optional tags are supported.

Value is a Symbol[].

Used for TTS Player.

Note: the tags themselves are strings that are embedded in the input text stream and in TTS dictionaries. Each tag has a corresponding Symbol, whose presence in the value of this attribute indicates that the tag is supported.

e_Busy

public static final Symbol e_Busy

Returned when (p_IfBusy == v_Fail).

p_CoderTypes

public static final Symbol p_CoderTypes

Value is an array of Symbols identifying the coders actually supported by this Player.

Valid values: CoderConstants
Default value is implementation dependent.
Read-Only.

See Also:

a_Coder

p_IfBusy

public static final Symbol p_IfBusy

Indicates the action to take if Player is busy when play() is invoked.

Valid values: v_Queue, v_Stop, v_Fail.
Default value is v_Queue.

v_Queue

public static final Symbol v_Queue

value for p_IfBusy: wait for previous requests to complete.

See Also:

p_IfBusy

v_Stop

public static final Symbol v_Stop

value for p_IfBusy: stop any previous play.

See Also:

p_IfBusy

v_Fail

public static final Symbol v_Fail

value for p_IfBusy: signal an error, throw a MediaResourceException.

See Also:

p_IfBusy

p_MaxDuration

public static final Symbol p_MaxDuration

Integer indicating maximum duration of this or subsequent play() in milleseconds.

Value is an Integer (0 - 1,000,000) milliseconds, or v_Forever.

p_StartPaused

public static final Symbol p_StartPaused

Boolean indicating that this or subsequent play() should be started in the Paused state.

p_EnabledEvents

public static final Symbol p_EnabledEvents

A Dictionary of Player event Symbols, indicating which events are generated and delivered to the application. If a given eventID is not enabled, then no processing is expended to generate or distribute that kind of event.

Value is a Dictionary of non-transactional event Symbols.

Valid keys: ev_Pause, ev_Resume, ev_Speed, ev_Volume, ev_Marker
Valid values: Boolean.TRUE, Boolean.FALSE
Default value = no events.

For a PlayerListener to receive events, those events must be enabled by setting this parameter. This parameter can be set in a ConfigSpec or by setParameters.

Note: This parameter controls the generation of events. The events cannot be delivered unless a PlayerListener is added using addMediaListener.

See Also:

ev_Pause, ev_Resume, ev_Speed, ev_Volume, ev_Marker

p_JumpMDOIncrement

public static final Symbol p_JumpMDOIncrement

p_JumpMDO. @deprecated use p_JumpMDO

p_JumpMSCIncrement

public static final Symbol p_JumpMSCIncrement

p_JumpMDO. @deprecated use p_JumpMDO

p_JumpMDO

public static final Symbol p_JumpMDO

Integer number of MDOs to jump forward or backward in the MDO list, for either a rtca_JumpForwardMDO or rtca_JumpBackwardMDO.

Valid values: any positive Integer.
Default value = 1.

See Also:

rtca_JumpForwardMDOs, rtca_JumpBackwardMDOs

p_JumpTime

public static final Symbol p_JumpTime

Integer number of milliseconds by which the current MDO offset is changed by rtca_JumpForwardTime or rtca_JumpBackwardTime

Valid values: any positive Integer.
Default value = 1.

See Also:

rtca_JumpForwardTime, rtca_JumpBackwardTime

p_JumpWord

public static final Symbol p_JumpWord

Integer number of Words to jump forward or backward, for either a rtca_JumpForwardWords or rtca_JumpBackwardWords.

Valid values: any positive Integer.
Default value = 1.

See Also:

rtca_JumpForwardWords, rtca_JumpBackwardWords

p_JumpSentence

public static final Symbol p_JumpSentence

Integer number of Sentences to jump forward or backward, for either a rtca_JumpForwardSentences or rtca_JumpBackwardSentences.

Valid values: any positive Integer.
Default value = 1.

See Also:

rtca_JumpForwardSentences, rtca_JumpBackwardSentences

p_SpeedChange

public static final Symbol p_SpeedChange

Determines the amount the playback speed is changed by RTC actions rtca_SpeedUp or rtca_SpeedDown. Value is an Integer in the range [0..100] expressing percent from normal.

Valid values: Integer in the range [0..100]
Default value = 0.

Note: Whenever p_SpeedChange is altered, the player speed is reset to normal.

See Also:

rtca_SpeedUp, rtca_SpeedDown

p_VolumeChange

public static final Symbol p_VolumeChange

Determines the amount the volume parameter is changed by the RTC actions rtca_VolumeUp and rtca_VolumeDown. The value is an Integer in the range [0..30] expressing dB of change.

Valid values: an Integer in the range [0..30].
Default value is 0.

Note: Whenever p_VolumeChange is altered, the player volume is reset to normal.

See Also:

rtca_VolumeUp, rtca_VolumeDown

rtca_Stop

public static final Symbol rtca_Stop

RTC Action to stop the current Play operation.

rtca_Resume

public static final Symbol rtca_Resume

RTC Action to resume the current Play operation if paused.

rtca_Pause

public static final Symbol rtca_Pause

RTC Action to pause the current Play operation. Pause maintains the current position in the MDO List being played.

rtca_JumpForwardTime

public static final Symbol rtca_JumpForwardTime

RTC Action to jump forward the amount specified by p_JumpTime.

rtca_JumpBackwardTime

public static final Symbol rtca_JumpBackwardTime

RTC Action to jump backward the amount specified by p_JumpTime.

rtca_JumpStartMDO

public static final Symbol rtca_JumpStartMDO

RTC Action to jump to the start of the curent MDO.

rtca_JumpStartMSC

public static final Symbol rtca_JumpStartMSC

rtca_JumpStartMDO. @deprecated use rtca_JumpStartMDO.

rtca_JumpEndMDO

public static final Symbol rtca_JumpEndMDO

RTC Action to jump to the end of the curent MDO.

rtca_JumpEndMSC

public static final Symbol rtca_JumpEndMSC

rtca_JumpEndMDO. @deprecated use rtca_JumpEndMDO.

rtca_JumpForwardMDOs

public static final Symbol rtca_JumpForwardMDOs

RTC Action to jump forward the number of MDOs indicated by p_JumpMDO.

rtca_JumpForwardMSCs

public static final Symbol rtca_JumpForwardMSCs

rtca_JumpForwardMDOs @deprecated use rtca_JumpForwardMDOs.

rtca_JumpBackwardMDOs

public static final Symbol rtca_JumpBackwardMDOs

RTC Action to jump backward the number of MDOs indicated by p_JumpMDO.

rtca_JumpBackwardMSCs

public static final Symbol rtca_JumpBackwardMSCs

rtca_JumpBackwardMDOs. @deprecated use rtca_JumpBackwardMDOs.

rtca_JumpStartMDOList

public static final Symbol rtca_JumpStartMDOList

RTC Action to jump to the first MDO in the MDO List.

rtca_JumpStartMSCList

public static final Symbol rtca_JumpStartMSCList

rtca_JumpStartMDOList @deprecated use rtca_JumpStartMDOList.

rtca_JumpEndMDOList

public static final Symbol rtca_JumpEndMDOList

RTC Action to jump to the last MDO in the MDOList.

rtca_JumpEndMSCList

public static final Symbol rtca_JumpEndMSCList

rtca_JumpEndMDOList. @deprecated use rtca_JumpEndMDOList.

rtca_JumpForwardWords

public static final Symbol rtca_JumpForwardWords

RTC Action to jump forward the number of Words indicated by p_JumpWord.

rtca_JumpBackwardWords

public static final Symbol rtca_JumpBackwardWords

RTC Action to jump backward the number of Words indicated by p_JumpWord.

rtca_JumpStartSentence

public static final Symbol rtca_JumpStartSentence

RTC Action to jump to the first Sentence in the MDO.

rtca_JumpEndSentence

public static final Symbol rtca_JumpEndSentence

RTC Action to jump to the last Sentence in the MDO.

rtca_JumpForwardSentences

public static final Symbol rtca_JumpForwardSentences

RTC Action to jump forward the number of Sentences indicated by p_JumpSentence.

rtca_JumpBackwardSentences

public static final Symbol rtca_JumpBackwardSentences

RTC Action to jump backward the number of Sentences indicated by p_JumpSentence.

rtca_SpeedUp

public static final Symbol rtca_SpeedUp

RTC Action to increase speed by p_SpeedChange.

rtca_SpeedDown

public static final Symbol rtca_SpeedDown

RTC Action to decrease speed by p_SpeedChange.

rtca_NormalSpeed

public static final Symbol rtca_NormalSpeed

RTC Action to set speed to normal.

rtca_ToggleSpeed

public static final Symbol rtca_ToggleSpeed

RTC Action to toggle speed between normal and previous adjusted value.

rtca_VolumeUp

public static final Symbol rtca_VolumeUp

RTC Action to increase volume by p_VolumeChange.

rtca_VolumeDown

public static final Symbol rtca_VolumeDown

RTC Action to decrease volume by p_VolumeChange.

rtca_NormalVolume

public static final Symbol rtca_NormalVolume

RTC Action to set volume to normal.

rtca_ToggleVolume

public static final Symbol rtca_ToggleVolume

RTC Action to toggle volume between normal and previous adjusted value.

rtcc_PlayStarted

public static final Symbol rtcc_PlayStarted

RTC trigger when a Play is started.

rtcc_PlayComplete

public static final Symbol rtcc_PlayComplete

RTC trigger when a Play is completed.

ev_Play

public static final Symbol ev_Play

Completion event for the play method.

Possible qualifiers are:
q_RTC, q_Stop, q_Duration, q_Standard, q_EndOfData

See Also:

PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_AdjustSpeed

public static final Symbol ev_AdjustSpeed

Completion event for the adjustSpeed method.

ev_AdjustVolume

public static final Symbol ev_AdjustVolume

Completion event for the adjustVolume method.

ev_Stop

public static final Symbol ev_Stop

Play has been stopped by RTC or stopPlayer.

See Also:

PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_Pause

public static final Symbol ev_Pause

Play has been paused by RTC or pausePlayer.

See Also:

PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_Resume

public static final Symbol ev_Resume

Play has been resumed by RTC or resumePlayer.

See Also:

PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_Jump

public static final Symbol ev_Jump

A jump has been caused by RTC or jumpPlayer.

See Also:

PlayerEvent.getChangeType(), ResourceEvent.getRTCTrigger()

ev_Speed

public static final Symbol ev_Speed

Playback speed has been changed due to RTC.

See Also:

PlayerEvent.getChangeType(), ResourceEvent.getRTCTrigger()

ev_Volume

public static final Symbol ev_Volume

Playback volume has been changed due to RTC.

See Also:

PlayerEvent.getChangeType(), ResourceEvent.getRTCTrigger()

ev_Marker

public static final Symbol ev_Marker

Indicates a TTS Marker has been reached. (TTS)

ev_LoadDictionary

public static final Symbol ev_LoadDictionary

Completion event for LoadDictionary (TTS).

ev_UnloadDictionary

public static final Symbol ev_UnloadDictionary

Completion event for UnLoadDictionary (TTS).

ev_ActivateDictionary

public static final Symbol ev_ActivateDictionary

Completion event for ActivateDictionary (TTS).

q_EndOfData

public static final Symbol q_EndOfData

Indicate Play complete because all the streams played to completion.

q_Duration

public static final Symbol q_Duration

Play ended because the maximum play duration time has been reached.