VoiceResourcePlay Method (String)
Plays the specified file path and name.
VoiceElementsClient (in VoiceElementsClient.dll) Version: 220.127.116.11
public TerminationCode Play(
- Type: SystemString
The path and file name you would like to play.
A Termination Code
indicating how the play ended. Typically, you will use this to determine what to do next.
Remarks Supported File Types
Voice Elements supports a wide range of audio file types and formats, for a detailed list of these formats, see Supported Audio Codecs
. Most of these formats that we recommend
are Wave Files
. You may need to convert your audio into one of these formats, depending on the source.Telephony Sound Processing: Audio Quality
Before discussing converting your audio files, we need to point out that all audio transmitted over a telephony carrier is typically converted down to 8khz 8bit Mulaw (aka G711) quality in transmission (some countries use ALaw, and in addition to G711, G729 is also another codec that can be used). Therefore, higher quality files will not result in
a better sounding connection. We also recommend converting your files to this codec to save conversion before tranmission every time. To play files of a different type, you may change the Voice Resource Codec Property
to any of the supported codecs.Converting Your Audio Files
There are several applications available that you can easily use to convert to 8khz 8bit Mulaw format from almost any other format. We have had good results with GoldWave
and Open Source Audacity
. If you need to convert your files in real time (i.e. during a call), we recommend Open Source SOX
.FAQ: Audio Doesn't Sound Clear?
This is usually a codec mismatch. Either convert your files or change the Voice Resource Codec Property
to the one in which your files were encoded.FAQ: Can I Use MP3 Files?
Voice Elements does not support MP3 files, which are usually in a far higher quality than needed for telephony. See above on ways to convert your files to 8khz 8bit Mulaw.
The following sample code sets up a Channel Resource
, Dials a Call
, retrieves a Voice Resource
sets the Audio Codec
to the recommended and plays two files.
public void DialOutAndPlay()
TelephonyServer m_TelephonyServer = new TelephonyServer();
ChannelResource m_ChannelResource = m_TelephonyServer.GetChannel();
string phoneNumber = "2135551212";
VoiceResource m_VoiceResource = m_ChannelResource.VoiceResource;
m_VoiceResource.Codec = Codec.MULAW_8Khz_8Bit;
TerminationCode terminationCode = m_VoiceResource.GetDigits();
string m_Digits = m_VoiceResource.DigitBuffer;