Using the SimpleMRCPClient

Capacity Private Cloud provides a useful testing utility called the SimpleMRCPClient to help you quickly validate your Media Server (MRCP) installation and confirm that everything is working as expected. The project files are available on GitHub:

https://github.com/lumenvox/mrcp-client

The SimpleMRCPClient is a Media Resource Control Protocol (MRCP) test client application designed for light testing of MRCP requests against the MRCP-API server, covering both ASR and TTS operations. MRCPv1 (RTSP) and MRCPv2 (SIP) connectivity are both supported.

This utility is distributed in binary form only and is intended for testing purposes. It is not suitable for production use, as it includes only basic error checking and may introduce unnecessary latency.

Installing the Application

To install the application, download and extract the binary into your /usr/local/bin/ folder:

curl -L https://github.com/lumenvox/mrcp-client/releases/download/v5.2.0/simple_mrcp_client-5.2.0.tar.gz -o simple_mrcp_client.tar.gz
sudo tar -xvzf simple_mrcp_client.tar.gz -C /usr/local/bin/
sudo chmod +x /usr/local/bin/simple_mrcp_client

Or, using a single command:

curl -Lp https://github.com/lumenvox/mrcp-client/releases/download/v5.2.0/simple_mrcp_client-5.2.0.tar.gz | sudo tar -xvzf - -C /usr/local/bin/ && sudo chmod +x /usr/local/bin/simple_mrcp_client

Note: This application runs on 64-bit Linux systems only. It has been tested on CentOS 7, CentOS 8, RockyLinux 8, and Ubuntu 20.04 LTS. Other Linux variants (such as RHEL-based distributions) should also work given the minimal dependencies. OpenSSL is required if encrypted traffic is needed. Check https://github.com/lumenvox/mrcp-client/releases for the latest version.

Running the Application

The application supports many optional parameters. To see the full list of options and usage examples, run the executable without any arguments:

simple_mrcp_client

This displays all available options along with example invocations

Note: If running this utility on a machine remote from the MRCP-API server, you may need to open firewall access and specify both the target MRCP-API server's IP address and the local machine's IP address to establish full connectivity.

Running With Docker

To run the application in a container rather than installing the binary directly, use the docker-compose.yaml found at the root of the project. With Docker installed, start the container from the project root:

docker-compose up -d

This starts a container named simple_mrcp_client containing the application binary. To open a shell inside the container:

docker exec -it simple_mrcp_client bash

The application is already on the PATH inside the container. Run it with:

simple_mrcp_client

Running without arguments displays the full usage guide. To stop and remove the container when finished, run from the project root:

docker-compose down

Mapped Folders

The docker-compose.yaml mounts several host folders into the container. Create these folders at the project root before starting the container:

./grammars
./ssml
./audio

These folders are mounted at the container's root (/). The mounts are dynamic—files added on either side are immediately reflected on the other.

Connecting to Your MRCP Server

For details on configuring your MRCP server and connecting the SimpleMRCPClient to the platform cluster, see the mrcp-api project on GitHub.

Was this article helpful?