VoiceResource Properties

This is the required number of samples (each 10ms) that are required for the tone to be considered "off". Default = 4 samples

This is the required number of samples (each 10ms) that are required for the tone to be considered "on". Default = 4 samples

The highest frequency the Beep Detector will attempt to isolate. Default = 1800Hz.

The highest frequency the Beep Detector will attempt to isolate. Default = 600Hz.

This is the maximum time the system will listen for a beep. Beep Detection will stop after this interval. Default = 60000ms

When the server is recording Beep Detection, this allows you to add additional information to the filename that is created. Be sure to only use characters that are permissable within filenames.

The minimum required energy in decibels for a packet to be examined. Default = -38.0f Raising this value will eliminate quieter tones.

The percentage of energy that is contained within the frequency bin as compared to the overall energy. Default = 0.90f

The length of the shortest tone you wish to detect. For shorter tones, the tone must be immediately followed by silence. Default = 120ms.

The amount of required silence after a short tone goes to silence. Deafult = 40ms.

Cause an exception to be thrown when the BeepDetector senses a beep in the audio stream.

This is the total time the frequency must be registered before the system qualifies it as a beep. Default = 200ms.

The allowable deviation of the tone's loudness in decibels. If the tone starts at -15db it must stay at this level +/- this value. Default = 2.0 db.

The allowable deviation of the tone's frequency in hertz. If the tone starts at 600hz it must stay at this frequency +/- this value. Default = 25 Hz.

The number of bytes that were output on the last Play on this resource.

The number of bytes that were recorded on the last Record on this resource.

Gets or Sets the flag that tells the system whether or not to clear the digit buffer before executing the the next voice function, such as a Play or Record.

Gets or sets the audio codec for the Voice Resource.

Represents the Conference of which this resource is a member.

Represents the Conference Attributes of a Conference to which this resource is a member.

Gets or sets the audio Data Format The Default is Wave Format.

When set to true, files played will return a Termination Code of "BargeIn" if voice activity is detected during the Timeout. This only applies to CSP enabled voice resources.

The maximum amount of time you will allow a speech recognition barge-in to trigger the stopping of a Play function. This only applies to CSP enabled voice resources.

The unique name of this resource / device on the server. This is useful for following, logging a call or thread.

Holds the string of digits from the last Get Response or Get Digits.

Enables or disables Digit Events on this resource.

Cause an exception to be thrown when the voice resource senses a fax signal in the audio stream. Note the Fax tone 'F' must be defined on the voice elements server (GlobalTones config setting) When set to true, this turns on DigitEvents by default. If you set this to false and donot want DigitEvents enabled, you must manually turn them off.

The Format Spoken when playing numbers from a VAP File.

Gets or sets the inter digit time out in seconds (how long to wait for another digit after receiving one) to use for the next voice function, such as a Play or Record. This value is how long the system will wait between digits for the next one.

Gets or sets a value to determine when the Inter Digit Timer starts; either immediately or after the first digit is pressed.

A list of Routable Resources which are currently listening to this resource.

A Routable Resources to which this resource is currently listening.

Gets or sets the maximum number of digits that will be accepted as input on the next voice function. Default = 20.

Gets or sets the maximum silence in seconds that will be allowed until termination of the next voice function. Default = 20.

Gets or sets the maximum time in seconds that will be allowed until termination of the next voice function. Default = 20.

Sets the voice resource to play a short beep before it begins any subsequent Record.

Specifies the comfort file to use with the next speech recognition operation.

Specifies, in milliseconds, how soon to start the Comfort File after a barge in. A setting of 0 means to wait until the end of speech is detected.

When set to true, this causes all subsequent Play and Play TTS methods to perform speech recognition.

Sets the amount of time in seconds necessary to trigger end of speech detection.

Specifies the grammar file to use with the next speech recognition operation.

Specifies if speech recognition spans a single play or multiple plays.

Tells the speech engine whether or not to terminate any Plays or Play TTS's when speech is detected.

The word returned by the last speech operation. Essentially, what the engine thinks the caller said.

The score returned from the speech engine signifying how "confident" it is about the accuracy of the last speech operation. Ranges from 1-1000, 1000 being the most confident.

The starting byte position in the file from which the next Play will begin. This property is reset after each invocation.

The number of seconds of time in the last Record on this resource.

A Termination Code indicating how the last voice function (i.e. Play) ended. Typically, you will use this to determine what to do next.

Gets or Sets the termination digits to use for the next voice function such as a Play. "ANY" or "@" specifies to terminate on all digits.

Gets or sets the audio codec for the current VAP File.

Specifies the current VAP File.

Specifies the file which maps the segments of your VAP File.

When set to true, this causes all subsequent Play() and PlayTTS() methods to perform voice recognition.

Sets the amount of time necessary to trigger end of speech detection.

Specifies the grammar file to use with the voice recognition operation.

Allows BargeIn when using voice recognition.

The returned word from the last voice recognition operation.

UML Diagram:

The score returned from the engine that specifies how the last voice recognition operation was scored.