Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::osc::OSCOutputPort:
Collaboration graph
[legend]

Public Member Functions

 OSCOutputPort (OSCDevice *device, unsigned int port_id, OSCNode *node, const std::vector< OSCTarget > &targets, OSCNode::DataFormat data_format)
 Create an OSCOutputPort. More...
 
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. More...
 
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
 Get the Port ID. This is the index within the device. More...
 
AbstractDeviceGetDevice () const
 Get the device which owns this Port. More...
 
bool SetUniverse (Universe *universe)
 Bind this port to a universe. More...
 
UniverseGetUniverse () const
 Fetch the universe this Port is bound to. More...
 
std::string UniqueId () const
 Return the globally unique id for a Port. More...
 
bool SetPriority (uint8_t priority)
 Set the Priority for this Port. More...
 
uint8_t GetPriority () const
 Get the numeric priority for this Port. More...
 
void SetPriorityMode (port_priority_mode mode)
 Set the Priority Mode for this Port. More...
 
port_priority_mode GetPriorityMode () const
 Get the Priority Mode for this Port. More...
 
virtual void UniverseNameChanged (const std::string &new_name)
 Called if the universe name changes.
 
port_priority_capability PriorityCapability () const
 Get the priority capabilities for this port. More...
 
virtual void SendRDMRequest (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
 Check if this Port supports RDM or not. More...
 

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
inlinevirtual

Return the description for this port

Implements ola::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: