Open Lighting Architecture: include/ola/client/Module.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Module.h
Go to the documentation of this file.
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library 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 GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * Module.h
17 * Contains the information required to load the StreamingClient as a plugin.
18 * Copyright (C) 2014 Simon Newton
19 */
40
41#ifndef INCLUDE_OLA_CLIENT_MODULE_H_
42#define INCLUDE_OLA_CLIENT_MODULE_H_
43
44#include <ola/client/StreamingClient.h>
45
46namespace ola {
47
48namespace client { class StreamingClientInterface; }
49class DmxBuffer;
50
51} // namespace ola
52
56#define OLA_NEW_STREAMING_CLIENT "ola_new_streaming_client"
57
61#define OLA_DELETE_STREAMING_CLIENT "ola_delete_streaming_client"
62
66 typedef ola::client::StreamingClientInterface *ola_new_streaming_client_t(
67 const ola::client::StreamingClient::Options &options);
68
72 typedef void ola_delete_streaming_client_t(
73 ola::client::StreamingClientInterface *client);
74
75extern "C" {
76 ola::client::StreamingClientInterface *ola_new_streaming_client(
77 const ola::client::StreamingClient::Options &options);
78 void ola_delete_streaming_client(
79 ola::client::StreamingClientInterface *client);
80}
81
85#define OLA_NEW_DMXBUFFER "ola_new_dmxbuffer"
86
90#define OLA_DELETE_DMXBUFFER "ola_delete_dmxbuffer"
91
95#define OLA_SET_DMXBUFFER "ola_set_dmxbuffer"
96
100 typedef ola::DmxBuffer *ola_new_dmxbuffer_t();
101
105 typedef void ola_delete_dmxbuffer_t(ola::DmxBuffer *buffer);
106
113 typedef void ola_set_dmxbuffer_t(ola::DmxBuffer *buffer, const uint8_t *data,
114 unsigned int size);
115
116extern "C" {
117 ola::DmxBuffer *ola_new_dmxbuffer();
118 void ola_delete_dmxbuffer(ola::DmxBuffer *buffer);
119 void ola_set_dmxbuffer(ola::DmxBuffer *buffer, const uint8_t *data,
120 unsigned int size);
121}
122
123#endif // INCLUDE_OLA_CLIENT_MODULE_H_
ola_new_dmxbuffer_t
ola::DmxBuffer * ola_new_dmxbuffer_t()
A function pointer to create a new DmxBuffer.
Definition Module.h:100
ola_new_streaming_client_t
ola::client::StreamingClientInterface * ola_new_streaming_client_t(const ola::client::StreamingClient::Options &options)
A function pointer to create a new StreamingClient.
Definition Module.h:66
ola_delete_streaming_client_t
void ola_delete_streaming_client_t(ola::client::StreamingClientInterface *client)
A function pointer to delete a StreamingClient.
Definition Module.h:72
ola_delete_dmxbuffer_t
void ola_delete_dmxbuffer_t(ola::DmxBuffer *buffer)
A function pointer to delete a DmxBuffer.
Definition Module.h:105
ola_set_dmxbuffer_t
void ola_set_dmxbuffer_t(ola::DmxBuffer *buffer, const uint8_t *data, unsigned int size)
A function pointer to set the contents of a DmxBuffer.
Definition Module.h:113
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
ola::client::StreamingClient::Options
Definition StreamingClient.h:94
ola::client::StreamingClientInterface
The interface for the StreamingClient class.
Definition StreamingClient.h:49
StreamingClient.h
A client for sending DMX512 data to olad.
ola::client
OLA C++ API.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44