21#ifndef INCLUDE_OLA_CLIENT_OLACLIENT_H_
22#define INCLUDE_OLA_CLIENT_OLACLIENT_H_
30#include <ola/plugin_id.h>
33#include <ola/timecode/TimeCode.h>
149 const std::string &msg,
199 const std::string &name,
209 OlaUniverse::merge_mode mode,
221 void Patch(
unsigned int device_alias,
225 unsigned int universe,
247 void SendDMX(
unsigned int universe,
285 void RDMGet(
unsigned int universe,
290 unsigned int data_length,
303 void RDMSet(
unsigned int universe,
308 unsigned int data_length,
320 std::auto_ptr<class OlaClientCore> m_core;
The various callbacks used with the OLA Client.
Types used as arguments for the OLA Client.
Types used as return values from the OLA Client.
A class used to hold a single universe of DMX data.
A RDM unique identifier (UID).
A 2 argument callback which can be called multiple times.
Definition Callback.h:1895
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
A 0 argument callback which deletes itself after it's run.
Definition Callback.h:141
A 1 argument callback which deletes itself after it's run.
Definition Callback.h:1004
A 2 argument callback which deletes itself after it's run.
Definition Callback.h:1907
A 3 argument callback which deletes itself after it's run.
Definition Callback.h:2850
The callback based C++ client for OLA.
Definition OlaClient.h:45
void SendTimeCode(const ola::timecode::TimeCode &timecode, SetCallback *callback)
Send TimeCode data.
Definition OlaClient.cpp:182
void ReloadPlugins(SetCallback *callback)
Trigger a plugin reload.
Definition OlaClient.cpp:65
void FetchDMX(unsigned int universe, DMXCallback *callback)
Fetch the latest DMX data for a universe.
Definition OlaClient.cpp:167
void FetchDeviceInfo(ola_plugin_id plugin_filter, DeviceInfoCallback *callback)
Request a list of the available devices.
Definition OlaClient.cpp:83
void FetchPluginList(PluginListCallback *callback)
Fetch the list of plugins loaded.
Definition OlaClient.cpp:69
void SetPluginState(ola_plugin_id plugin_id, bool state, SetCallback *callback)
Set the state of a plugin.
Definition OlaClient.cpp:103
void FetchCandidatePorts(CandidatePortsCallback *callback)
Request a list of ports that could be patched to new universe.
Definition OlaClient.cpp:88
void ConfigureDevice(unsigned int device_alias, const std::string &msg, ConfigureDeviceCallback *callback)
Send a device config request.
Definition OlaClient.cpp:97
void FetchUniverseList(UniverseListCallback *callback)
Request a list of universes.
Definition OlaClient.cpp:125
void SendDMX(unsigned int universe, const DmxBuffer &data, const SendDMXArgs &args)
Send DMX data.
Definition OlaClient.cpp:161
void RunDiscovery(unsigned int universe, DiscoveryType discovery_type, DiscoveryCallback *callback)
Trigger discovery for a universe.
Definition OlaClient.cpp:171
void SetPortPriorityOverride(unsigned int device_alias, unsigned int port, PortDirection port_direction, uint8_t value, SetCallback *callback)
Set the priority for a port to override mode.
Definition OlaClient.cpp:116
void SetCloseHandler(ola::SingleUseCallback0< void > *callback)
Set the close handler.
Definition OlaClient.cpp:57
void FetchPluginState(ola_plugin_id plugin_id, PluginStateCallback *callback)
Fetch the state of a plugin.
Definition OlaClient.cpp:78
void RegisterUniverse(unsigned int universe, RegisterAction register_action, SetCallback *callback)
Register our interest in a universe.
Definition OlaClient.cpp:155
void RDMSet(unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length, const SendRDMArgs &args)
Send an RDM Set Command.
Definition OlaClient.cpp:197
void Patch(unsigned int device_alias, unsigned int port, PortDirection port_direction, PatchAction action, unsigned int universe, SetCallback *callback)
Patch or unpatch a port from a universe.
Definition OlaClient.cpp:146
void RDMGet(unsigned int universe, const ola::rdm::UID &uid, uint16_t sub_device, uint16_t pid, const uint8_t *data, unsigned int data_length, const SendRDMArgs &args)
Send an RDM Get Command.
Definition OlaClient.cpp:187
void SetSourceUID(const ola::rdm::UID &uid, SetCallback *callback)
Set the source UID for this client.
Definition OlaClient.cpp:177
void FetchPluginDescription(ola_plugin_id plugin_id, PluginDescriptionCallback *callback)
Fetch the description for a plugin.
Definition OlaClient.cpp:73
void SetDMXCallback(RepeatableDMXCallback *callback)
Set the callback to be run when new DMX data arrives.
Definition OlaClient.cpp:61
void SetUniverseName(unsigned int universe, const std::string &name, SetCallback *callback)
Set the name of a universe.
Definition OlaClient.cpp:134
void SetUniverseMergeMode(unsigned int universe, OlaUniverse::merge_mode mode, SetCallback *callback)
Set the merge mode of a universe.
Definition OlaClient.cpp:140
void SetPortPriorityInherit(unsigned int device_alias, unsigned int port, PortDirection port_direction, SetCallback *callback)
Set the priority for a port to inherit mode.
Definition OlaClient.cpp:109
void FetchUniverseInfo(unsigned int universe, UniverseInfoCallback *callback)
Fetch the information for a given universe.
Definition OlaClient.cpp:129
A BidirectionalFileDescriptor that also generates notifications when closed.
Definition Descriptor.h:283
Represents a RDM UID.
Definition UID.h:57
DiscoveryType
The type of discovery to run with OlaClient::RunDiscovery().
Definition ClientArgs.h:62
PatchAction
The patch action, used with OlaClient::Patch()
Definition ClientArgs.h:38
PortDirection
The port direction.
Definition ClientArgs.h:54
RegisterAction
The register action, used with OlaClient::RegisterUniverse()
Definition ClientArgs.h:46
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
Arguments passed to the SendDMX() method.
Definition ClientArgs.h:71
Arguments used with OlaClient::RDMGet() and OlaClient::RDMSet() methods.
Definition ClientArgs.h:103