hp.telephony.media
Interface RecorderConstants

All Superinterfaces:

CoderConstants

All Known Subinterfaces:

ASRRecorderEvent, FaxEvent, Recorder, RecorderEvent, SMSRecorderEvent

All Known Implementing Classes:

AsyncMediaGroup

public interface RecorderConstants

extends CoderConstants

The Symbols used in Recorder and RecorderEvent.

Since:

OCMP 2.0

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	a_SilenceTruncation Boolean value indicates if Recorder supports the SignalTruncation features.
static Symbol	ev_Pause Indicates that recording has been paused by RTC.
static Symbol	ev_Record Indicates that recording has been completed.
static Symbol	ev_Resume Indicates that recording has been resumed by RTC.
static Symbol	p_Append Indicates that recording should append to the end of an existing TVM 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 indicating which events are generated by this Recorder.
static Symbol	p_FileFormat A Symbol identifying the File Format used during recording.
static Symbol	p_FinalTimeoutBehaviour A Symbol identifying the Behaviour of the end of recording wrt SpeechDetector.
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_SignalTruncationOn Boolean indicating whether signal(DTMF) truncation is enabled.
static Symbol	p_SilenceEnergyThreshold Integer indicating above which threshold activity is recognized (under, silence).
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 Deprecated. OCMP 2.4, use nVAD to remove silence
static Symbol	p_SilenceTruncationThreshold Deprecated. OCMP 2.4, use nVAD to remove silence
static Symbol	p_SpeechDetectionMode A Symbol identifying the Speech detection mode.
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_SilenceThreshold milliseconds was detected.
static Symbol	rtca_Pause Pause the current operation on a recorder, maintaining the current position in the Media Stream being recorded.
static Symbol	rtca_Resume Resume the current operation on a recorder if paused
static Symbol	rtca_Stop Stop the current operation on a recorder
static Symbol	rtcc_RecordComplete Trigger when a Record is completed.
static Symbol	v_DetectAllOccurences value for p_SpeechDetectionMode.
static Symbol	v_DetectFirstOccurence value for p_SpeechDetectionMode.
static Symbol	v_GSMFormat value for p_FileFormat: GSM file format.
static Symbol	v_Inactive value for p_SpeechDetectionMode.
static Symbol	v_RawFormat value for p_FileFormat: basic file format without any header.
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_Beep

public static final Symbol a_Beep

Boolean value indicates if Recorder supports the Beep features.

• p_StartBeep
• p_BeepLength
• p_BeepFreq

Since:

Not supported

a_SilenceTruncation

public static final Symbol a_SilenceTruncation

Boolean value indicates if Recorder supports the SignalTruncation features.

Since:

Not supported

a_FixedBeep

public static final Symbol a_FixedBeep

a_FixedBeep indicates that Recorder supports p_StartBeep.

Since:

Not supported

a_Pause

public static final Symbol a_Pause

Recorder supports Pause and Resume operations. Including rtca_Pause, rtca_Resume, and p_StartPaused.

Since:

Not supported

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.

Since:

Not supported

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, q_Standard (specific to ASR part)

ev_Pause

public static final Symbol ev_Pause

Indicates that recording has been paused by RTC.

Since:

OCMP 2.2

ev_Resume

public static final Symbol ev_Resume

Indicates that recording has been resumed by RTC.

Since:

OCMP 2.2

p_Append

public static final Symbol p_Append

Indicates that recording should append to the end of an existing TVM rather than overwrite it.
Default: TRUE

Since:

OCMP2.2

p_BeepFrequency

public static final Symbol p_BeepFrequency

The frequency of the start beep; iff attribute a_Beep.
Default: 1500
Range: 0 to 5000

Since:

Not supported

p_BeepLength

public static final Symbol p_BeepLength

Length of Beep preceeding recording; iff attribute a_Beep.
Default: 50
Range: 0 to 100

Since:

Not supported

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,

Since:

Not supported

See Also:

CoderConstants

p_CoderTypes

public static final Symbol p_CoderTypes

An array of Symbols identifying the Coders supported by this Recorder.

Valid values: CoderConstants
Default: implementation dependent.

p_EnabledEvents

public static final Symbol p_EnabledEvents

A Dictionary indicating which events are generated by this Recorder.

Value is an Dictionary mapping from a Symbol (EventID) to a Boolean value. If the value for an EventID is True, then that event is enabled. Otherwise, that event will not be generated by the MediaService.

Valid values: ev_Pause, ev_Resume, ev_Record
Default: no event enabled

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 ResourceEventListener is added using addResourceEventListener.

p_MaxDuration

public static final Symbol p_MaxDuration

Integer indicating the maximum duration (in milliseconds) for a record.
Default: ResourceConstants.v_Forever a name for ResourceConstants.FOREVER. Note: If you plan recording a Conference session, please read carefully :

Our world is finite, at least our computer disks are. So FOREVER stands for a long time compared to the average phone communication. OC MP enforces a physical limitation of 150MB of 16bit linear media, approx. 2 1/2 hours. Compressed media files would hold up to 4 times more actual time (10H in ADPCMs).

Since:

OCMP 2.2

p_MinDuration

public static final Symbol p_MinDuration

Integer indicating minimum duration (in milliseconds) that constitutes a valid recording.
Default: 0

Since:

OCMP 2.2

p_SignalTruncationOn

public static final Symbol p_SignalTruncationOn

Boolean indicating whether signal(DTMF) truncation is enabled.
WARNING: This parameter is vendor specific.
Default: True

Since:

OCMP 2.2

p_SilenceEnergyThreshold

public static final Symbol p_SilenceEnergyThreshold

Integer indicating above which threshold activity is recognized (under, silence).
WARNING: This parameter is vendor specific.
Default: 1000000 (Property softdsp.activity.energy)

Since:

OCMP 2.4

p_SilenceTruncationOn

public static final Symbol p_SilenceTruncationOn

Deprecated. OCMP 2.4, use nVAD to remove silence

Boolean indicating whether silence truncation is enabled.

p_SilenceTruncationThreshold

public static final Symbol p_SilenceTruncationThreshold

Deprecated. OCMP 2.4, use nVAD to remove silence

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.

Since:

OCMP 2.2

p_SilenceTerminationThreshold

public static final Symbol p_SilenceTerminationThreshold

Integer threshold (in milliseconds) when silence termination is triggered.

Since:

OCMP 2.2

p_StartBeep

public static final Symbol p_StartBeep

Boolean indicating whether subsequent record will be preceded with a beep.
Default: True

Since:

OCMP 2.2

p_StartPaused

public static final Symbol p_StartPaused

Boolean indicating whether subsequent record will start in PAUSE mode.

Since:

OCMP 2.2

p_FileFormat

public static final Symbol p_FileFormat

A Symbol identifying the File Format used during recording.
Default value: v_RawFormat
Other value: v_WavFormat and v_GSMFormat

Note: When the v_WavFormat is required, the supported p_CoderTypes values are v_ALawPCM_64k, v_MuLawPCM_64k, v_Linear16Bit_64k v_ADPCM_32k, v_ADPCM_32kOKI, v_G723_1b, v_G729a

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

When the v_RawFormat is required, the supported p_CoderTypes values are v_ALawPCM_64k, v_MuLawPCM_64k, v_Linear16Bit_64k v_ADPCM_32k, v_ADPCM_32kOKI, v_ADPCM_16kG726, v_ADPCM_32kG726

Since:

OCMP 2.4

See Also:

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_FinalTimeoutBehaviour

public static final Symbol p_FinalTimeoutBehaviour

A Symbol identifying the Behaviour of the end of recording wrt SpeechDetector.

NOTE: a voice activity detector resource spec should be defined in the ConfigSpec for that parameter to operate!
Default: Boolean.FALSE.
Boolean valued.

Since:

OCMP 2.4C2

p_SpeechDetectionMode

public static final Symbol p_SpeechDetectionMode

A Symbol identifying the Speech detection mode.

NOTE: a voice activity detector resource spec should be defined in the ConfigSpec for that parameter to operate!
Default: v_Inactive.
Possible values: v_Inactive, v_DetectFirstOccurence & v_DetectAllOccurences.

Since:

OCMP 2.4

v_Inactive

public static final Symbol v_Inactive

value for p_SpeechDetectionMode.

If a voice activity detector resource spec is defined in the ConfigSpec, it won't operate (bypass mode).

Since:

OCMP 2.4

See Also:

p_SpeechDetectionMode

v_DetectFirstOccurence

public static final Symbol v_DetectFirstOccurence

value for p_SpeechDetectionMode.

If a voice activity detector resource spec is defined in the ConfigSpec, it will detect the first occurence of speech (cf. SpeechDetectorConstants to tune the speech detection).

Since:

OCMP 2.4

See Also:

p_SpeechDetectionMode, SpeechDetectorConstants.p_InitialTimeout, SpeechDetectorConstants.p_FinalTimeout

v_DetectAllOccurences

public static final Symbol v_DetectAllOccurences

value for p_SpeechDetectionMode.

If a voice activity detector resource spec is defined in the ConfigSpec, it will detect all speech occurences (cf. SpeechDetectorConstants to tune the speech detection).

Since:

OCMP 2.4

See Also:

p_SpeechDetectionMode, SpeechDetectorConstants.p_InitialTimeout, SpeechDetectorConstants.p_FinalTimeout

v_RawFormat

public static final Symbol v_RawFormat

value for p_FileFormat: basic file format without any header.

When the v_RawFormat is required, the supported p_CoderTypes values are v_ALawPCM_64k, v_MuLawPCM_64k, v_Linear16Bit_64k, v_ADPCM_32k, v_ADPCM_32kOKI, v_ADPCM_16kG726, v_ADPCM_32kG726

Since:

OCMP 2.4

See Also:

p_FileFormat

v_WavFormat

public static final Symbol v_WavFormat

value for p_FileFormat: WAV file format.

When the v_WavFormat is required, the supported p_CoderTypes values are v_ALawPCM_64k, v_MuLawPCM_64k, v_Linear16Bit_64k, v_ADPCM_32k, v_ADPCM_32kOKI, v_G723_1b, v_G729a

Since:

OCMP 2.4

See Also:

p_FileFormat, p_CoderTypes

q_Silence

public static final Symbol q_Silence

Record ended because Silence termination was enabled and a silence of greater that p_SilenceThreshold milliseconds was detected.

Since:

OCMP 2.2

rtca_Stop

public static final Symbol rtca_Stop

Stop the current operation on a recorder

rtca_Resume

public static final Symbol rtca_Resume

Resume the current operation on a recorder if paused

Since:

OCMP 2.2

rtca_Pause

public static final Symbol rtca_Pause

Pause the current operation on a recorder, maintaining the current position in the Media Stream being recorded.

Since:

OCMP 2.2

rtcc_RecordComplete

public static final Symbol rtcc_RecordComplete

Trigger when a Record is completed.