JSR-043: JTAPI-1.4

javax.telephony.media
Interface RecorderConstants

All Superinterfaces:
CoderConstants, MediaConstants, ResourceConstants
All Known Subinterfaces:
Async_Recorder, Async_RecorderEvent, Recorder, RecorderEvent

public interface RecorderConstants
extends ResourceConstants, CoderConstants

Defines the Symbols used by the Recorder Resource.

Since:
JTAPI-1.3

Field Summary
static Symbol a_Beep
          Boolean value indicates if Recorder supports the Beep features.
static Symbol a_CoderTypes
          Attribute to request support for various coders.
static Symbol a_FixedBeep
          a_FixedBeep indicates that Recorder supports p_StartBeep.
static Symbol a_Pause
          Recorder supports Pause and Resume operations.
static Symbol e_Coder
          If the Recorder does not support the indicated Coder, record() throws a MediaResourceException, indicating e_Coder.
static Symbol ev_Pause
          Indicates that recording has been paused by RTC or pauseRecorder.
static Symbol ev_Record
          Indicates that recording has been completed.
static Symbol ev_Resume
          Indicates that recording has been resumed by RTC or resumeRecorder.
static Symbol ev_Stop
          Indicates that recording has been stopped by RTC or stopRecorder.
static Symbol p_Append
          Indicates that recording should append to the end of an existing MDO rather than overwrite it.
static Symbol p_BeepFrequency
          The frequency of the start beep; iff attribute a_Beep.
static Symbol p_BeepLength
          Length of Beep preceeding recording; iff attribute a_Beep.
static Symbol p_Coder
          Symbol identifying the Coder used for a new recording.
static Symbol p_CoderTypes
          An array of Symbols identifying the Coders supported by this Recorder.
static Symbol p_EnabledEvents
          A Dictionary of Recorder event Symbols, indicating which events are generated and delivered to the application.
static Symbol p_MaxDuration
          Integer indicating the maximum duration (in milliseconds) for a record.
static Symbol p_MinDuration
          Integer indicating minimum duration (in milliseconds) that constitutes a valid recording.
static Symbol p_SilenceTerminationOn
          Boolean indicating whether silence termination is enabled.
static Symbol p_SilenceTerminationThreshold
          Integer threshold (in milliseconds) when silence termination is triggered.
static Symbol p_SilenceTruncationOn
          Boolean indicating whether silence truncation is enabled.
static Symbol p_SilenceTruncationThreshold
          Integer threshold (in milliseconds) for silence truncation.
static Symbol p_StartBeep
          Boolean indicating whether subsequent record will be preceded with a beep.
static Symbol p_StartPaused
          Boolean indicating whether subsequent record will start in PAUSE mode.
static Symbol q_Silence
          Record ended because Silence termination was enabled and a silence of greater that p_SilenceTerminationThreshold milliseconds was detected.
static Symbol rtca_Pause
          RTC Action to pause the current operation on a recorder.
static Symbol rtca_Resume
          RTC Action to resume the current operation on a recorder if paused.
static Symbol rtca_Stop
          RTC Action to stop the current operation on a recorder.
static Symbol rtcc_RecordComplete
          RTC trigger when a Record is completed.
static Symbol v_Class
          Denotes the standard Recorder Resource Class in a ResourceSpec.
 
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_Duration, 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 Recorder Resource Class in a ResourceSpec.

a_Beep

public static final Symbol a_Beep
Boolean value indicates if Recorder supports the Beep features.

a_FixedBeep

public static final Symbol a_FixedBeep
a_FixedBeep indicates that Recorder supports p_StartBeep.

a_Pause

public static final Symbol a_Pause
Recorder supports Pause and Resume operations. Including rtca_Pause, rtca_Resume, and p_StartPaused.

a_CoderTypes

public static final Symbol a_CoderTypes
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.


e_Coder

public static final Symbol e_Coder
If the Recorder does not support the indicated Coder, record() throws a MediaResourceException, indicating e_Coder.

ev_Record

public static final Symbol ev_Record
Indicates that recording has been completed. Possible qualifiers are: q_RTC, q_Stop, q_Duration, q_Silence

ev_Pause

public static final Symbol ev_Pause
Indicates that recording has been paused by RTC or pauseRecorder.

ev_Resume

public static final Symbol ev_Resume
Indicates that recording has been resumed by RTC or resumeRecorder.

ev_Stop

public static final Symbol ev_Stop
Indicates that recording has been stopped by RTC or stopRecorder.

p_Append

public static final Symbol p_Append
Indicates that recording should append to the end of an existing MDO rather than overwrite it.
Default: TRUE

p_BeepFrequency

public static final Symbol p_BeepFrequency
The frequency of the start beep; iff attribute a_Beep.
Default: 1500
Range: 0 to 5000

p_BeepLength

public static final Symbol p_BeepLength
Length of Beep preceeding recording; iff attribute a_Beep.
Default: 50
Range: 0 to 100

p_Coder

public static final Symbol p_Coder
Symbol identifying the Coder used for a new recording.
Default: implementation dependent.

For list of Coder type Symbols,

See Also:
CoderConstants

p_CoderTypes

public static final Symbol p_CoderTypes
An array of Symbols identifying the Coders supported by this Recorder.
Default: implementation dependent.
Read-only.

p_EnabledEvents

public static final Symbol p_EnabledEvents
A Dictionary of Recorder 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_Record
Valid values: Boolean.TRUE, Boolean.FALSE
Default value = no events.

For a RecorderListener 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 RecorderListener is added using addMediaListener.


p_MaxDuration

public static final Symbol p_MaxDuration
Integer indicating the maximum duration (in milliseconds) for a record.
Default: v_forever.

p_MinDuration

public static final Symbol p_MinDuration
Integer indicating minimum duration (in milliseconds) that constitutes a valid recording.
Default: 0

p_SilenceTruncationOn

public static final Symbol p_SilenceTruncationOn
Boolean indicating whether silence truncation is enabled.

p_SilenceTruncationThreshold

public static final Symbol p_SilenceTruncationThreshold
Integer threshold (in milliseconds) for silence truncation. Recorder will truncate segments of silence to this length if p_SilenceTruncationOn is True.

p_SilenceTerminationOn

public static final Symbol p_SilenceTerminationOn
Boolean indicating whether silence termination is enabled.

p_SilenceTerminationThreshold

public static final Symbol p_SilenceTerminationThreshold
Integer threshold (in milliseconds) when silence termination is triggered.

p_StartBeep

public static final Symbol p_StartBeep
Boolean indicating whether subsequent record will be preceded with a beep.

p_StartPaused

public static final Symbol p_StartPaused
Boolean indicating whether subsequent record will start in PAUSE mode.

q_Silence

public static final Symbol q_Silence
Record ended because Silence termination was enabled and a silence of greater that p_SilenceTerminationThreshold milliseconds was detected.

rtca_Stop

public static final Symbol rtca_Stop
RTC Action to stop the current operation on a recorder.

Used as the action for an RTC.


rtca_Resume

public static final Symbol rtca_Resume
RTC Action to resume the current operation on a recorder if paused.

Used as the action for an RTC.


rtca_Pause

public static final Symbol rtca_Pause
RTC Action to pause the current operation on a recorder. Pause maintains the current position in the Media DataObject being recorded.

Used as the action for an RTC.


rtcc_RecordComplete

public static final Symbol rtcc_RecordComplete
RTC trigger when a Record is completed.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org