Mumble provides a pretty neat online experience to its users as it is – still, people often look for some kind of an interface to query the server for status information over the web. The most common use for such an interface is an embedded channel viewer on a team’s web site, but it could be used for monitoring or other kinds of status notifications as well – the limit being your imagination.
If you take a look at the 3rd party applications Wiki page, you will see that quite a few apps around Mumble have emerged recently, and probably a lot more are currently in development. This is great, as it makes the Mumble ecosystem a lot more vivid. The downside is that if you want to use these applications, you will soon run into problems if each application uses its own protocol to expose information, because using this method will require the server side component and the channel viewer application to match.
Needing to install a specific server-side component for each individual app would cause a lot of unneccessary work for both installation and maintenance, so being able to use a single server-side component for all apps would be preferable – especially if your favorite web interface already implemented the server side component.
From a client’s perspective, being able to use your favorite app with a certain server would require the server admin to configure an interface for the client to use. Being able to simply use an existing interface would mean a lot less work, especially since web interface applications usually provide the server side for all servers that they manage.
The ultimate goal is that each channel viewer is compatible with each server side implementation, no matter which one the respective administrators choose to install, while still being easily maintainable for each server admin.
However, this can only be achieved when the components use the same data format, because otherwise they simply would not understand each other. To achieve this, the Channel Viewer Protocol has been agreed upon. If you want to create a new web application, you are highly encouraged to use the JSON or XML data format defined in the Protocol.
The Channel Viewer Protocol is aimed to be extendable, lightweight and easy to implement on both the server and client side. By using it, you will enable your users to freely choose which applications they prefer to use, and thereby support the idea of software freedom, because giving the user a choice is what this is all about.
Note by staff: Svedrin, the author of this article, is a Mumble community member and developer of the 3rd party Web-Interface Mumble-Django. We thank him very much for contributing this article. We would love to be able to publish articles written by our community on a regular basis, so if you have an idea you think is worth getting into this blog, please contact us.