Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

hp.telephony.media
Interface PlayerConstants

All Superinterfaces:
CoderConstants
All Known Subinterfaces:
FaxEvent, Player, PlayerEvent, SMSPlayerEvent, TTSPlayerEvent
All Known Implementing Classes:
AsyncMediaGroup
public interface PlayerConstants
extends CoderConstants

Defines the Symbols used by Player and PlayerEvent.

Since:
OCMP 2.0

Field Summary
static Symbol a_AutomaticGainControl
          Attribute to request capability to limit Volume during Play of a MSC.
static Symbol a_Coder
          Attribute to request support for various coders.
static Symbol a_Jump
          Attribute to request capability to Jump forward and backward in a MSC.
static Symbol a_Pause
          Attribute to request capability to Pause and Resume Play of MSC.
static Symbol a_Speed
          Attribute to request capability to adjust Speed during Play of a MSC.
static Symbol a_Volume
          Attribute to request capability to adjust Volume during Play of a MSC.
static Symbol ev_Pause
          Play has been paused by RTC.
static Symbol ev_Play
          Completion event for the play method.
static Symbol ev_Resume
          Play has been resumed by RTC.
static Symbol ev_Speed
          Playback speed has been changed due to RTC.
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_DisplayName
          String specifying the file name to display during a play.
static Symbol p_EnabledEvents
          An array of Player event Symbols, indicating which events are generated and delivered to the application.
static Symbol p_FileFormat
          A Symbol identifying the File Format used during a play.
static Symbol p_IfBusy
          Indicates the action to take if Player is busy when play() is invoked.
static Symbol p_JumpMSCIncrement
          Integer number of MSCs to jump forward or backward in the MSC list, for either a rtca_JumpForwardMSCs or rtca_JumpBackwardMSCs.
static Symbol p_JumpTime
          Integer number of milliseconds by which the current MSC offset is changed by rtca_JumpForward or rtca_JumpBackward.
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_JumpBackward
          Jump backward the amount specified by p_JumpTime.
static Symbol rtca_JumpBackwardMSCs
          Jump backward the number of MSCs indicated by p_JumpMSCIncrement.
static Symbol rtca_JumpEndMSC
          Jump to the end of the curent MSC.
static Symbol rtca_JumpEndMSCList
          Jump to the Last MSC in the MSC List.
static Symbol rtca_JumpForward
          Jump forward the amount specified by p_JumpTime.
static Symbol rtca_JumpForwardMSCs
          Jump forward the number of MSCs indicated by p_JumpMSCIncrement.
static Symbol rtca_JumpStartMSC
          Jump to the start of the curent MSC
static Symbol rtca_JumpStartMSCList
          Jump to the First MSC in the MSC List.
static Symbol rtca_NormalSpeed
          Set speed to normal.
static Symbol rtca_NormalVolume
          Set volume to normal.
static Symbol rtca_Pause
          Pause the current Play operation, maintaining the current position in the MSClist.
static Symbol rtca_Resume
          Resume the current Play operation if paused.
static Symbol rtca_SpeedDown
          Decrease speed by value of parameter p_SpeedChange.
static Symbol rtca_SpeedUp
          Increase speed by value of parameter p_SpeedChange.
static Symbol rtca_Stop
          Stop the current Play operation.
static Symbol rtca_StopAll
          Stop the current Play operation and all pending play operations in queue
static Symbol rtca_ToggleSpeed
          Toggle speed between normal and previous adjusted value.
static Symbol rtca_ToggleVolume
          Toggle volume between normal and previous adjusted value.
static Symbol rtca_VolumeDown
          Decrease volume by value of parameter p_VolumeChange.
static Symbol rtca_VolumeUp
          Increase volume by value of parameter p_VolumeChange.
static Symbol rtcc_PlayComplete
          Trigger when a Play is completed.
static Symbol rtcc_PlayStarted
          Trigger when a Play is started.
static Symbol v_Fail
          value for p_IfBusy: signal an error, throw a MediaResourceException.
static Symbol v_GSMFormat
          value for p_FileFormat: GSM file format.
static Symbol v_Queue
          value for p_IfBusy: wait for previous requests to complete.
static Symbol v_RawFormat
          value for p_FileFormat: basic file format without any header.
static Symbol v_Stop
          value for p_IfBusy: stop any previous play.
static Symbol v_WavFormat
          value for p_FileFormat: WAV file format.
 
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
 

Field Detail

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

Since:
Not supported

a_Jump

public static final Symbol a_Jump
Attribute to request capability to Jump forward and backward in a MSC.

Value is a boolean. OCMP Note: also set to true

Since:
OCMP 2.2

a_Pause

public static final Symbol a_Pause
Attribute to request capability to Pause and Resume Play of MSC. Value is a boolean. OCMP Note: also set to true

Since:
OCMP 2.2

a_Speed

public static final Symbol a_Speed
Attribute to request capability to adjust Speed during Play of a MSC.

Value is an IntRange or a boolean.

Since:
OCMP 2.2

a_Volume

public static final Symbol a_Volume
Attribute to request capability to adjust Volume during Play of a MSC.

Value is an IntRange or a boolean.

Since:
OCMP 2.2

a_AutomaticGainControl

public static final Symbol a_AutomaticGainControl
Attribute to request capability to limit Volume during Play of a MSC. or Send of DTMFs, or Text to Speech.

Value is Boolean.

Since:
2.3

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:
OCMP Note: This is a one element array. It is not read-only.

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.

Since:
Not supported QUESTION: What is the media group doing when busy?

v_Queue

public static final Symbol v_Queue
value for p_IfBusy: wait for previous requests to complete.

Since:
Not supported
See Also:
p_IfBusy

v_Stop

public static final Symbol v_Stop
value for p_IfBusy: stop any previous play.

Since:
Not supported
See Also:
p_IfBusy

v_Fail

public static final Symbol v_Fail
value for p_IfBusy: signal an error, throw a MediaResourceException.

Since:
Not supported
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.

Since:
OCMP 2.2

p_StartPaused

public static final Symbol p_StartPaused
Boolean indicating that this or subsequent play() should be started in the Paused state.

Since:
in OCMP 2.2

p_EnabledEvents

public static final Symbol p_EnabledEvents
An array 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.

Valid values: ev_Pause, ev_Resume, ev_Speed, ev_Volume
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. OCMP Note: These events cannot be delivered unless a ResourceEventListener is added

See Also:
ev_Pause, ev_Resume, ev_Speed, ev_Volume

p_JumpMSCIncrement

public static final Symbol p_JumpMSCIncrement
Integer number of MSCs to jump forward or backward in the MSC list, for either a rtca_JumpForwardMSCs or rtca_JumpBackwardMSCs.

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

Since:
OCMP 2.2
See Also:
rtca_JumpForwardMSCs, rtca_JumpBackwardMSCs

p_JumpTime

public static final Symbol p_JumpTime
Integer number of milliseconds by which the current MSC offset is changed by rtca_JumpForward or rtca_JumpBackward.

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

Since:
OCMP 2.2
See Also:
rtca_JumpForward, rtca_JumpBackward

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.

Since:
Not supported
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]. Note:

Note: Whenever p_VolumeChange is altered, the player volume is reset to normal. For OCMP 2.2, the only supported value is 3 expressing dB of change.
Default value is 3.

Since:
OCMP 2.2
See Also:
rtca_VolumeUp, rtca_VolumeDown

p_FileFormat

public static final Symbol p_FileFormat
A Symbol identifying the File Format used during a play.
Default value: v_RawFormat
Other values: v_WavFormat and v_GSMFormat

Note: When the v_WavFormat is specified, no p_CoderTypes value is required as encoding type is specified in the wav header

When the v_GSMFormat is required, the supported p_CoderTypes value is v_GSM

When the v_RawFormat is specified, the p_CoderTypes is required

Since:
OCMP 2.4
See Also:
p_CoderTypes

v_RawFormat

public static final Symbol v_RawFormat
value for p_FileFormat: basic file format without any header.

Since:
OCMP 2.4
See Also:
p_FileFormat

v_WavFormat

public static final Symbol v_WavFormat
value for p_FileFormat: WAV file format.

Since:
OCMP 2.4
See Also:
p_FileFormat, p_CoderTypes

v_GSMFormat

public static final Symbol v_GSMFormat
value for p_FileFormat: GSM file format.

When the v_GSMFormat is required, the supported p_CoderTypes value is v_GSM

Since:
OCMP 2.4
See Also:
p_FileFormat, p_CoderTypes

p_DisplayName

public static final Symbol p_DisplayName
String specifying the file name to display during a play. RESERVED for use by the OCMP VXML SDK.

Since:
OCMP 2.4

rtca_Stop

public static final Symbol rtca_Stop
Stop the current Play operation.

rtca_StopAll

public static final Symbol rtca_StopAll
Stop the current Play operation and all pending play operations in queue

rtca_Resume

public static final Symbol rtca_Resume
Resume the current Play operation if paused.

rtca_Pause

public static final Symbol rtca_Pause
Pause the current Play operation, maintaining the current position in the MSClist. (Media Stream)

rtca_JumpForward

public static final Symbol rtca_JumpForward
Jump forward the amount specified by p_JumpTime.

Since:
OCMP 2.2

rtca_JumpBackward

public static final Symbol rtca_JumpBackward
Jump backward the amount specified by p_JumpTime.

Since:
OCMP 2.2

rtca_JumpStartMSC

public static final Symbol rtca_JumpStartMSC
Jump to the start of the curent MSC

Since:
OCMP 2.2

rtca_JumpEndMSC

public static final Symbol rtca_JumpEndMSC
Jump to the end of the curent MSC.

Since:
OCMP 2.2

rtca_JumpForwardMSCs

public static final Symbol rtca_JumpForwardMSCs
Jump forward the number of MSCs indicated by p_JumpMSCIncrement.

Since:
OCMP 2.2

rtca_JumpBackwardMSCs

public static final Symbol rtca_JumpBackwardMSCs
Jump backward the number of MSCs indicated by p_JumpMSCIncrement.

Since:
OCMP 2.2

rtca_JumpStartMSCList

public static final Symbol rtca_JumpStartMSCList
Jump to the First MSC in the MSC List.

Since:
OCMP 2.2

rtca_JumpEndMSCList

public static final Symbol rtca_JumpEndMSCList
Jump to the Last MSC in the MSC List.

Since:
OCMP 2.2

rtca_SpeedUp

public static final Symbol rtca_SpeedUp
Increase speed by value of parameter p_SpeedChange.

Since:
OCMP 2.2

rtca_SpeedDown

public static final Symbol rtca_SpeedDown
Decrease speed by value of parameter p_SpeedChange.

Since:
OCMP 2.2

rtca_NormalSpeed

public static final Symbol rtca_NormalSpeed
Set speed to normal.

Since:
OCMP 2.2

rtca_ToggleSpeed

public static final Symbol rtca_ToggleSpeed
Toggle speed between normal and previous adjusted value.

Since:
Not supported

rtca_VolumeUp

public static final Symbol rtca_VolumeUp
Increase volume by value of parameter p_VolumeChange.

Since:
OCMP 2.2

rtca_VolumeDown

public static final Symbol rtca_VolumeDown
Decrease volume by value of parameter p_VolumeChange.

Since:
OCMP 2.2

rtca_NormalVolume

public static final Symbol rtca_NormalVolume
Set volume to normal.

Since:
OCMP 2.2

rtca_ToggleVolume

public static final Symbol rtca_ToggleVolume
Toggle volume between normal and previous adjusted value.

Since:
Not supported

rtcc_PlayStarted

public static final Symbol rtcc_PlayStarted
Trigger when a Play is started.

Since:
OCMP 2.2

rtcc_PlayComplete

public static final Symbol rtcc_PlayComplete
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_Pause

public static final Symbol ev_Pause
Play has been paused by RTC.

See Also:
PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_Resume

public static final Symbol ev_Resume
Play has been resumed by RTC.

See Also:
PlayerEvent.getIndex(), PlayerEvent.getOffset(), ResourceEvent.getRTCTrigger()

ev_Speed

public static final Symbol ev_Speed
Playback speed has been changed due to RTC.

Since:
OCMP 2.2
See Also:
PlayerEvent.getChangeType(), ResourceEvent.getRTCTrigger()

ev_Volume

public static final Symbol ev_Volume
Playback volume has been changed due to RTC.

Since:
OCMP 2.2
See Also:
PlayerEvent.getChangeType(), ResourceEvent.getRTCTrigger()

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.

Since:
OCMP 2.2
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD