Key Features of the AMS CSharp Client API

Oct 13, 2025 by pynkocean.com 6 views

Introduction

The Aculab Media System (AMS) CSharp Client API is a powerful tool for developers to create custom applications that interact with the Aculab Media System. This API is designed to provide a comprehensive set of classes and methods that allow developers to control individual SIP calls and associated media processes. In this article, we will explore the features and functionality of the AMS CSharp Client API and provide a detailed guide on how to use it in your applications.

What is the AMS CSharp Client API?

The AMS CSharp Client API is a .NET assembly that is fully Common Language Specification (CLS) compliant. This means that it can be used by developers who are familiar with the .NET framework and can be easily integrated into existing applications. The API is supplied as a strong-named assembly, which ensures that it can be trusted by the .NET runtime environment.

Key Features of the AMS CSharp Client API

The AMS CSharp Client API provides a wide range of features and functionality that allow developers to control individual SIP calls and associated media processes. Some of the key features of the API include:

SIP Call Control: The API provides a set of classes and methods that allow developers to control individual SIP calls. This includes the ability to make and receive calls, as well as to control the call state (e.g. hold, transfer, etc.).
Media Processing: The API provides a set of classes and methods that allow developers to interact with the media streams associated with a call. This includes the ability to play and record audio files, as well as to detect and play DTMF digits.
DTMF Detection and Playback: The API provides a set of classes and methods that allow developers to detect and play DTMF digits. This includes the ability to detect incoming DTMF digits and to play DTMF digits to the call.
Audio File Playback and Recording: The API provides a set of classes and methods that allow developers to play and record audio files. This includes the ability to play WAV files to the call and to record the call to a file.

Using the AMS CSharp Client API

To use the AMS CSharp Client API, you will need to add a reference to the AMSClassLibrary namespace in your project. This namespace contains all of the types and classes that are used by the API.

Step 1: Add a Reference to the AMSClassLibrary Namespace

To add a reference to the AMSClassLibrary namespace, follow these steps:

Open your project in Visual Studio.
Right-click on your project in the Solution Explorer and select "Add Reference".
In the Reference Manager, select the "Browse" tab and navigate to the location of the AMSClassLibrary.dll file.
Select the AMSClassLibrary.dll file and click "Add".

Step 2: Import the AMSClassLibrary Namespace

To import the AMSClassLibrary namespace, follow these steps:

Open your code file and add the following line of code at the top of the file:

using AMSClassLibrary;

Save the file and rebuild your project.

Step 3: Create an Instance of the AMSClient Class

To create an instance of the AMSClient class, follow these steps:

Create a new instance of the AMSClient class:

AMSClient client = new AMSClient();

Set the properties of the client instance as needed:

client.Username = "your_username";
client.Password = "your_password";
client.Hostname = "your_hostname";

Step 4: Make a Call

To make a call, follow these steps:

Create a new instance of the Call class:

Call call = new Call();

Set the properties of the call instance as needed:

call.From = "your_from_number";
call.To = "your_to_number";

Use the MakeCall method to make the call:

client.MakeCall(call);

Step 5: Play a WAV File to the Call

To play a WAV file to the call, follow these steps:

Create a new instance of the WAVPlayer class:

WAVPlayer player = new WAVPlayer();

Set the properties of the player instance as needed:

player.FilePath = "path_to_your_wav_file.wav";

Use the Play method to play the WAV file to the call:

player.Play(client.GetCall());

Step 6: Record the Call to a File

To record the call to a file, follow these steps:

Create a new instance of the WAVRecorder class:

WAVRecorder recorder = new WAVRecorder();

Set the properties of the recorder instance as needed:

recorder.FilePath = "path_to_your_recording_file.wav";

Use the Start method to start recording the call:

recorder.Start(client.GetCall());

Use the Stop method to stop recording the call:

recorder.Stop();

Step 7: Detect Incoming DTMF Digits

To detect incoming DTMF digits, follow these steps:

Create a new instance of the DTMFDetector class:

DTMFDetector detector = new DTMFDetector();

Set the properties of the detector instance as needed:

detector.DigitTimeout = 1000; // 1 second

Use the Start method to start detecting DTMF digits:

detector.Start(client.GetCall());

Use the GetDigits method to get the detected DTMF digits:

string digits = detector.GetDigits();

Step 8: Play DTMF Digits to the Call

To play DTMF digits to the call, follow these steps:

Create a new instance of the DTMFPlayer class:

DTMFPlayer player = new DTMFPlayer();

Set the properties of the player instance as needed:

player.Digits = "1234";

Use the Play method to play the DTMF digits to the call:

player.Play(client.GetCall());

Conclusion

Frequently Asked Questions

In this article, we will answer some of the most frequently asked questions about the Aculab Media System (AMS) CSharp Client API.

Q: What is the Aculab Media System (AMS) CSharp Client API?

A: The Aculab Media System (AMS) CSharp Client API is a .NET assembly that provides a comprehensive set of classes and methods for controlling individual SIP calls and associated media processes.

Q: What are the key features of the AMS CSharp Client API?

A: The key features of the AMS CSharp Client API include:

SIP call control
Media processing
DTMF detection and playback
Audio file playback and recording

Q: How do I add a reference to the AMSClassLibrary namespace in my project?

A: To add a reference to the AMSClassLibrary namespace in your project, follow these steps:

Open your project in Visual Studio.
Right-click on your project in the Solution Explorer and select "Add Reference".
In the Reference Manager, select the "Browse" tab and navigate to the location of the AMSClassLibrary.dll file.
Select the AMSClassLibrary.dll file and click "Add".

Q: How do I import the AMSClassLibrary namespace in my code file?

A: To import the AMSClassLibrary namespace in your code file, add the following line of code at the top of the file:

using AMSClassLibrary;

Q: How do I create an instance of the AMSClient class?

A: To create an instance of the AMSClient class, follow these steps:

Create a new instance of the AMSClient class:

AMSClient client = new AMSClient();

Set the properties of the client instance as needed:

client.Username = "your_username";
client.Password = "your_password";
client.Hostname = "your_hostname";

Q: How do I make a call using the AMS CSharp Client API?

A: To make a call using the AMS CSharp Client API, follow these steps:

Create a new instance of the Call class:

Call call = new Call();

Set the properties of the call instance as needed:

call.From = "your_from_number";
call.To = "your_to_number";

Use the MakeCall method to make the call:

client.MakeCall(call);

Q: How do I play a WAV file to the call using the AMS CSharp Client API?

A: To play a WAV file to the call using the AMS CSharp Client API, follow these steps:

Create a new instance of the WAVPlayer class:

WAVPlayer player = new WAVPlayer();

Set the properties of the player instance as needed:

player.FilePath = "path_to_your_wav_file.wav";

Use the Play method to play the WAV file to the call:

player.Play(client.GetCall());

Q: How do I record the call to a file using the AMS CSharp Client API?

A: To record the call to a file using the AMS CSharp Client API, follow these steps:

Create a new instance of the WAVRecorder class:

WAVRecorder recorder = new WAVRecorder();

Set the properties of the recorder instance as needed:

recorder.FilePath = "path_to_your_recording_file.wav";

Use the Start method to start recording the call:

recorder.Start(client.GetCall());

Use the Stop method to stop recording the call:

recorder.Stop();

Q: How do I detect incoming DTMF digits using the AMS CSharp Client API?

A: To detect incoming DTMF digits using the AMS CSharp Client API, follow these steps:

Create a new instance of the DTMFDetector class:

DTMFDetector detector = new DTMFDetector();

Set the properties of the detector instance as needed:

detector.DigitTimeout = 1000; // 1 second

Use the Start method to start detecting DTMF digits:

detector.Start(client.GetCall());

Use the GetDigits method to get the detected DTMF digits:

string digits = detector.GetDigits();

Q: How do I play DTMF digits to the call using the AMS CSharp Client API?

A: To play DTMF digits to the call using the AMS CSharp Client API, follow these steps:

Create a new instance of the DTMFPlayer class:

DTMFPlayer player = new DTMFPlayer();

Set the properties of the player instance as needed:

player.Digits = "1234";

Use the Play method to play the DTMF digits to the call:

player.Play(client.GetCall());

Conclusion

In this article, we have answered some of the most frequently asked questions about the Aculab Media System (AMS) CSharp Client API. We hope that this information has been helpful in understanding the features and functionality of the API. If you have any further questions or need additional assistance, please don't hesitate to contact us.