ola::plugin::usbdmx::FadecandyAsyncUsbSender Class Reference

Inheritance diagram for ola::plugin::usbdmx::FadecandyAsyncUsbSender:

Collaboration diagram for ola::plugin::usbdmx::FadecandyAsyncUsbSender:

Public Member Functions
	FadecandyAsyncUsbSender (LibUsbAdaptor *adaptor, libusb_device *usb_device)
libusb_device_handle *	SetupHandle ()
	Open the device handle.
bool	PerformTransfer (const DmxBuffer &buffer)
	Perform the DMX transfer.
Public Member Functions inherited from ola::plugin::usbdmx::AsyncUsbSender
	AsyncUsbSender (class LibUsbAdaptor *const adaptor, libusb_device *usb_device)
	Create a new AsyncUsbSender.
virtual	~AsyncUsbSender ()
	Destructor.
bool	Init ()
	Initialize the sender.
bool	SendDMX (const DmxBuffer &buffer)
	Send one frame of DMX data.
void	TransferComplete (struct libusb_transfer *transfer)
	Called from the libusb callback when the asynchronous transfer completes.

Additional Inherited Members
Protected Member Functions inherited from ola::plugin::usbdmx::AsyncUsbSender
virtual void	PostTransferHook ()
	Called when the transfer completes.
void	CancelTransfer ()
	Cancel any pending transfers.
void	FillControlTransfer (unsigned char *buffer, unsigned int timeout)
	Fill a control transfer.
void	FillBulkTransfer (unsigned char endpoint, unsigned char *buffer, int length, unsigned int timeout)
	Fill a bulk transfer.
void	FillInterruptTransfer (unsigned char endpoint, unsigned char *buffer, int length, unsigned int timeout)
	Fill an interrupt transfer.
int	SubmitTransfer ()
	Submit the transfer for tx.
bool	TransferPending () const
	Check if there is a pending transfer.
Protected Attributes inherited from ola::plugin::usbdmx::AsyncUsbSender
class LibUsbAdaptor *const	m_adaptor
	The LibUsbAdaptor passed in the constructor.
libusb_device *const	m_usb_device
	The libusb_device passed in the constructor.

Member Function Documentation

bool ola::plugin::usbdmx::FadecandyAsyncUsbSender::PerformTransfer ( const DmxBuffer &  buffer )

virtual

Perform the DMX transfer.

Parameters

buffer

the DMX buffer to send.

Returns

true if the transfer was scheduled, false otherwise.

This method is implemented by the subclass. The subclass should call FillControlTransfer() / FillBulkTransfer() as appropriate and then call SubmitTransfer().

Implements ola::plugin::usbdmx::AsyncUsbSender.

libusb_device_handle * ola::plugin::usbdmx::FadecandyAsyncUsbSender::SetupHandle ( )

virtual

Open the device handle.

Returns

A valid libusb_device_handle or NULL if the device could not be opened.

Implements ola::plugin::usbdmx::AsyncUsbSender.

---

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

• plugins/usbdmx/ScanlimeFadecandy.cpp