This is intended to be a quick configuration how-to for KoalaSan. KoalaSan is rather easy to setup, we show here the few steps needed and an overview of each configuration parameter.
KoalaSan shows three tabs. The first one is the “Stream!” tab, the second is the “Settings” tab and the last is the “Recordings” tab.
To add a configuration you must go to the second tab, “Settings”. This tutorial assumes you already have an Icecast server configured and you know how to install and configure it. This how-to covers only KoalaSan usage, not Icecast.
Tap on the “Settings” tab menu. You will be taken to a list of stored configurations. The first time this tab will be clearly empty, it will populated after you start saving configurations.
- On this view click on the “+” button on the top right
- A new view will open showing all the parameter fields available. According if you enabled broadcast and/or dump some fields are mandatory
- Once all parameters are set, tap on the “Save” button on the top-right of the screen. If for some reason you want to go back without saving, you can tap the “Cancel” button on the top-left. An overview of the single fields and how to fill them is given below on this page.
- After tapping “Save” you will be taken again to the list of stored configuration. Tap on a row to activate the configuration. A green checkmark will appear next to the active configuration, on the left. When we say “active” we mean that particular configuration will be used once you start broadcasting/recording. Only one configuration at time can be active.
Once you activated your configuration, you’re ready to go to the “Stream!” tab and press the start button. KoalaSan will try to connect to the server specified in the active configuration and/or record. If for some reason it won’t be able to connect, an error dialog will notify this to you.
This is an overview of the parameters that you can setup in a configuration, listed in the same order they appear in the application.
- Name: this is a commodity name for the configuration. Set it up at a value you like (mandatory field)
- Server: this must be filled with the server name. Both FQDN and dotted quad notations are accepted (e.g “radio.shift-left.net” or “22.214.171.124”). Please don’t prepend and “http://” to the server name and do not append a “:xxxx” port statement. (mandatory when broadcasting is enabled)
- Port: numeric value for the port number. Icecast default configuration is set on port 8000. (mandatory when broadcasting is enabled)
- Mountpoint: the mountpoint name (e.g. “podtest”). Please, do not prepend a “/” (slash) before the mountpoint name. There is no need for it. Mountpoint must not contain spaces or strange symbols. Some players for some reason like mountpoint with the “.ogg” or “.opus” suffix (e.g. “podtest.ogg”, “podtest.opus”). (mandatory if broadcasting is enabled)
- Stream name: the name of the stream. This is a meta-data that will be passed to the server and will be shown to your listeners.
- Description: a brief description. This is a meta-data that will be passed to the server and will be shown to your listeners.
- Genre: the genre of the stream. This is a meta-data that will be passed to the server and will be shown to your listeners.
- Username: your username. This field is mandatory. Please, note that Icecast always expects an username. Many users observes that they never used an username. This is due to the fact that many applications send to the server login auth the default username, which is “source”, without explicitly telling them about it. Please, remember, the default username is “source”. (this field is mandatory if broadcasting is enabled)
- Password: your password. (this field is mandatory if broadcasting is enabled)
- Codec: the codec you want your stream encoded with. Please, note that the moment (May 2013) the stable Icecast release, version 2.3.3, supports Vorbis. Opus support is production ready but still in beta version (2.4beta). (mandatory field)
- Bitrate/Quality: this field sets the bitrate/quality of the stream. For Ogg Vorbis quality is a number between in [-1, 10]. You can find a quality/bitrate conversion table here. (mandatory field)
- Protocol: the only protocol available at the moment is Icecast 2. (mandatory field if broadcasting is enabled)
- Stereo: set the switch to “ON” if you want the output stream to be stereo. Set it to “OFF” if you want mono output.
- AudioBus: set the switch to “ON” if you are adding KoalaSan in an AudioBus chain.
- Dump: set the switch to “ON” if you want to record your stream in a local file. The recording will be then available in the “Recordings” tab.
- Broadcast: set the swith to “ON” if you want to enable broadcasting and send the stream to the Icecast server.