Click or drag to resize

VoiceResource Methods

The VoiceResource type exposes the following members.

Methods
  NameDescription
Public methodBeepDetectionRestart
Restarts the Beep Detector. This feature greatly improve call progress accuracy.
Public methodBeepDetectionStart
Starts the Beep Detector. This feature greatly improves call progress accuracy.
Public methodBeepDetectionStop
Stops the Beep Detector. This feature greatly improves call progress accuracy.
Public methodBotEngage
Protected methodDispose
This method forces a dispose of the Voice Resource object.
(Overrides ClientObject.Dispose(Boolean).)
Public methodCode exampleGetDigits
Waits for a user input as Digit(s) using all current settings for the Voice Resource, and therefore has no parameters.
Public methodCode exampleGetDigits(Int32, Int32, String)
Waits for a user input as Digit(s) specifying three current settings for the Voice Resource: Maximum Digits, Maximum Time and Termination Digit.
Public methodCode exampleGetDigits(Int32, Int32, String, Int32)
Waits for a user input as Digit(s) specifying four settings for the Voice Resource: Maximum Digits, Maximum Time, Termination Digit and Inter Digit Timeout.
Public methodCode exampleGetDigits(Int32, Int32, String, Int32, Boolean)
Waits for a user input as Digit(s) specifying all settings for the Voice Resource: Maximum Digits, Maximum Time, Termination Digit, Inter Digit Timeout and Clear Digit Buffer Flag.
Public methodCode exampleGetResponse
Waits for a user response as Digit(s) or Speech using all current settings for the Voice Resource, and therefore has no parameters.
Public methodCode exampleGetResponse(Int32, Int32, String)
Waits for a user response as Digit(s) or Speech specifying three current settings for the Voice Resource: Maximum Digits, Maximum Time and Termination Digit.
Public methodCode exampleGetResponse(Int32, Int32, String, Int32)
Waits for a user response as Digit(s) or Speech specifying four settings for the Voice Resource: Maximum Digits, Maximum Time, Termination Digit and Inter Digit Timeout.
Public methodCode exampleGetResponse(Int32, Int32, String, Int32, Boolean)
Waits for a user response as Digit(s) or Speech specifying all settings for the Voice Resource: Maximum Digits, Maximum Time, Termination Digit, Inter Digit Timeout and Clear Digit Buffer Flag.
Public methodGetSilence
Waits for a specified period of silence before returning to your code. This is useful when waiting for an answering machine to finish playing it's greeting.
Public methodGetToneDigit
Gets the first occurance of any registered tone that has been triggered and is in the digit buffer. If no tones have been triggered, this function returns -1.
Public methodIcecastStream
Public methodIsToneComplete
Returns 1 if the specified Tone is Off. Otherwise a 0. This function also returns -1 if the tone is not found.
Public methodCode examplePlay(Byte)
Plays the specified byte array of audio using the current Audio Codec of the Voice Resource.
Public methodCode examplePlay(String)
Plays the specified file path and name.
Public methodCode examplePlay(String)
Plays a sequence of files, provided each file plays to completion.
Public methodCode examplePlayDate
Plays a Date using the voice resource's specified VAP file.
Public methodCode examplePlayNumber
Plays the specified string as a number using the specified Format Spoken and the voice resource's VAP file.
Public methodCode examplePlayTone(Int32, Int32, Int32)
Plays a single tone at the desired frequency and amplitude for the requested duration.
Public methodCode examplePlayTone(Int32, Int32, Int32, Int32, Int32)
Plays two mixed tones at the two specified frequencies and amplitudes for the requested duration.
Public methodCode examplePlayTouchTones
Plays DTMF or touch tones corresponding to the string specified.
Public methodCode examplePlayTTS(String)
Plays the text specified using the Text-To-Speech engine using the default voice.
Public methodCode examplePlayTTS(String, String)
Plays the text specified using the Text-To-Speech engine and using the voice selected.
Public methodPlayVap(Int32)
Plays a single segment of the current VAP File.
Public methodPlayVap(Int32)
Plays an array of segments of the current VAP File.
Public methodPlayVap(String)
Plays a single segment of the current VAP File using the Vap Map entry specified.
Public methodPlayVap(String)
Plays multiple segments of the current VAP File using the VapMap entries specified.
Public methodRecord(String)
Records audio on the Voice Resource to the given file name and path.
Public methodRecord(Int32, Byte)
Records to a memory buffer.
Public methodRecordAndFollowConversation(String, RoutableResource)
Follows a resource's route and records both the resource and what it is routed to.
Public methodRecordAndFollowConversation(Int32, Byte, RoutableResource)
Follows a resource's route and records both the resource and what it is routed to.
Public methodRecordConversation(String, RoutableResource, RoutableResource)
Records two routable resources, summing them together into the same file. You can specify channels and/or a voice resources.
Public methodRecordConversation(Int32, Byte, RoutableResource, RoutableResource)
Records two routable resources, summing them together into a buffer. You can specify channels and/or a voice resources.
Public methodRecordConverstation(String, RoutableResource, RoutableResource) Obsolete.
Records two Routable Resources, summing their audio together into the designated file. You can specify Channels and/or Voice Resources.
Public methodRecordConverstation(Int32, Byte, RoutableResource, RoutableResource) Obsolete.
Records two Routable Resources, summing their audio together into a buffer. You can specify Channels and/or Voice Resources.
Public methodRouteFull(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Full Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteFull(RoutableResource)
Completes a full route between two Routable Resources. Both channels then listen to each other.
(Inherited from RoutableResource.)
Public methodRouteHalf(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Half Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteHalf(RoutableResource)
Completes a half route between two Routable Resources. The channel calling this method listens to the one in the parameter, the second cannot hear.
(Inherited from RoutableResource.)
Public methodSetConferenceAGCLevels
Sets the levels for the AGC in conferencing. If all values are set to negatives, then the system wide AGC applies.
(Inherited from RoutableResource.)
Public methodSetConferenceECTailDelay
Sets the Echo Tail Delay in conferencing.
(Inherited from RoutableResource.)
Public methodSetConferenceFEGLevel
Sets the front end gain in conferencing. If set to 0, front end gain is turned off.
(Inherited from RoutableResource.)
Public methodSetMonitorStream
Public methodStop
Stops any current activity on the Voice Resource, such as a Play or Record.
Public methodStopAllListeners
Forces all Routable Resources currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodStopListener
Forces a apecific Routable Resource currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodStopListening
Forces this resource to stop listening to all Routable Resources.
(Inherited from RoutableResource.)
Public methodTddDetectionStart
Starts the detection of a TDD device for the hearing impaired.
Public methodTddDetectionStop
Starts the detection of a TDD device for the hearing impaired.
Public methodTerminationCodeFlag
A Termination Code flag indicating how the last voice function (i.e. Play) ended. Typically, you will use this to determine what to do next.
Public methodWipeDigitBuffer
Forcibly clears all digits in the buffer from previous inputs. This is useful to ensure the buffer is clean before doing a Get Response or Get Digits.
Top
See Also