-
Notifications
You must be signed in to change notification settings - Fork 14
Usage and Configuration
#Usage The OHMComm-project can be used as a standalone application or as a library to be included in another application.
#Configuration Currently there are four ways to configure OHMComm:
This is the default configuration-mode for the standalone version.
If the user-input configuration-mode is selected, OHMComm will prompt the user via the command-line to input desired values (like port, ip-address, etc.) or select an option of available values (like audio-device, audio-procssor, etc.)
If the standalone version is run with command-line arguments or the library-version is called with Parameters, OHMComm will configure itself from the parameters passed.
For a list of all available parameters and their usage, type OHMComm -h or OHMComm --help in the command-line.
The library configuration-mode allows for the program to configure the OHMComm-library via configuration-methods.
This configuration-mode uses the Session Initiation Protocol to negotiate session-parameters. This configuration-mode will guarantee the audio-settings are compatible between both devices or fail if no such compatible settings could be found. Using SIP to negotiate configurations allows for communication with a variety of VoIP-clients. To start SIP-configuration, simply specify the local or remote port used to accept/sent SIP-packages.
When the file-based configuration-mode is set, OHMComm will read its configuration-values from the specified file. The configuration-file has the following format:
#This is a comment
key=value
#Any string-literal not containing the '='-sign can be used as key
#The value is everything from the '='-sign to the end of the line.
#If the value is surrounded by quotation-marks '"', they are discarded
some-key="This is a string value, obviously, and the surrounding '"' are not part of the value"
#To store an integer, the value must simply be a valid argument for *atoi()*
integer-key=12345
#Any whitespace before and after the '='-sign is skipped making following a valid configuration
some key with whitespaces = 1234