Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
OSCPluginDescription.h
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 2 of the License, or
5  * (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU Library General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15  *
16  * OSCPluginDescription.h
17  * Contains the description for the osc plugin.
18  * Copyright (C) 2016 Florian Edelmann
19  *
20  * This file has been autogenerated by convert_README_to_header.sh, DO NOT EDIT.
21  */
22 #ifndef PLUGINS_OSC_OSCPLUGINDESCRIPTION_H_
23 #define PLUGINS_OSC_OSCPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace osc {
28 
29 const char plugin_description[] = "OSC (Open Sound Control) Plugin\n"
30 "===============================\n"
31 "\n"
32 "This plugin allows OLA to send and receive\n"
33 "[OSC](http://www.opensoundcontrol.org/) messages.\n"
34 "\n"
35 "OLA uses the blob type for transporting DMX data.\n"
36 "\n"
37 "\n"
38 "## Config file: `ola-osc.conf`\n"
39 "\n"
40 "`input_ports = <int>` \n"
41 "The number of input ports to create.\n"
42 "\n"
43 "`output_ports = <int>` \n"
44 "The number of output ports to create.\n"
45 "\n"
46 "`udp_listen_port = <int>`\n"
47 "The UDP Port to listen on for OSC messages.\n"
48 "\n"
49 "`port_N_address = /address` \n"
50 "The OSC address to listen on for port N. If the address contains `%d` it's\n"
51 "replaced by the universe number for port N.\n"
52 "\n"
53 "`port_N_targets = ip:port/address,ip:port/address,...`\n"
54 "For output port N, the list of targets to send OSC messages to. If the\n"
55 "targets contain `%d` it's replaced by the universe number for port N\n"
56 "\n"
57 "`port_N_output_format = <osc type>`\n"
58 "The format (OSC Type) to send the DMX data in:\n"
59 "\n"
60 "- `blob`: a OSC-blob\n"
61 "- `float_array`: an array of float values. 0.0 - 1.0\n"
62 "- `individual_float`: one float message for each slot (channel). 0.0 - 1.0\n"
63 "- `individual_int`: one int message for each slot (channel). 0 - 255.\n"
64 "- `int_array`: an array of int values. 0 - 255.";
65 
66 } // namespace osc
67 } // namespace plugin
68 } // namespace ola
69 
70 #endif // PLUGINS_OSC_OSCPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44