Open Lighting Architecture  0.9.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::plugin::osc::OSCOutputPort Class Reference

Detailed Description

The Output Port class, for sending DMX via OSC.

Inheritance diagram for ola::plugin::osc::OSCOutputPort:
ola::BasicOutputPort ola::OutputPort ola::Port ola::rdm::DiscoverableRDMControllerInterface

Public Member Functions

 OSCOutputPort (OSCDevice *device, unsigned int port_id, OSCNode *node, const std::vector< OSCTarget > &targets, OSCNode::DataFormat data_format)
 Create an OSCOutputPort.
bool PreSetUniverse (Universe *old_universe, Universe *new_universe)
bool WriteDMX (const DmxBuffer &buffer, uint8_t)
 Send this DMX buffer using OSC. The second argument (priority) is not used.
std::string Description () const
- Public Member Functions inherited from ola::BasicOutputPort
 BasicOutputPort (AbstractDevice *parent, unsigned int port_id, bool start_rdm_discovery_on_patch=false, bool supports_rdm=false)
 Create a new BasicOutputPort.
unsigned int PortId () const
AbstractDeviceGetDevice () const
bool SetUniverse (Universe *universe)
UniverseGetUniverse () const
std::string UniqueId () const
bool SetPriority (uint8_t priority)
uint8_t GetPriority () const
void SetPriorityMode (port_priority_mode mode)
port_priority_mode GetPriorityMode () const
virtual void UniverseNameChanged (const std::string &new_name)
 Called if the universe name changes.
port_priority_capability PriorityCapability () const
virtual void SendRDMRequest (const ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDMRequest, subclasses can implement this to support RDM.
virtual void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
virtual void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
virtual bool SupportsTimeCode () const
virtual bool SendTimeCode (const ola::timecode::TimeCode &)
 This is a noop for ports that don't support TimeCode.
virtual void PostSetUniverse (Universe *, Universe *)
virtual bool SupportsRDM () const

Additional Inherited Members

- Protected Member Functions inherited from ola::BasicOutputPort
virtual bool SupportsPriorities () const
void UpdateUIDs (const ola::rdm::UIDSet &uids)
 Called when the discovery triggered by patching completes.

Constructor & Destructor Documentation

ola::plugin::osc::OSCOutputPort::OSCOutputPort ( OSCDevice device,
unsigned int  port_id,
OSCNode node,
const std::vector< OSCTarget > &  targets,
OSCNode::DataFormat  data_format 
)

Create an OSCOutputPort.

Parameters
devicethe parent device
port_idthe id for this port
nodethe OSCNode object to use
targetsthe OSC targets to send to
data_formatthe format of OSC to send

Member Function Documentation

std::string ola::plugin::osc::OSCOutputPort::Description ( ) const
inline

Return the description for this port

bool ola::plugin::osc::OSCOutputPort::PreSetUniverse ( Universe old_universe,
Universe new_universe 
)
virtual

Called during the patch process, just before the Universe of this port changes.

Reimplemented from ola::BasicOutputPort.

bool ola::plugin::osc::OSCOutputPort::WriteDMX ( const DmxBuffer buffer,
uint8_t   
)
inlinevirtual

Send this DMX buffer using OSC. The second argument (priority) is not used.

Parameters
bufferthe DMX data

Implements ola::OutputPort.


The documentation for this class was generated from the following files: