VCV Rack API v2
rack::audio::Driver Struct Reference

Wraps an audio driver API containing any number of audio devices. More...

#include <audio.hpp>

Public Member Functions

virtual ~Driver ()
 
virtual std::string getName ()
 Returns the name of the driver. More...
 
virtual std::vector< int > getDeviceIds ()
 Returns a list of all device IDs that can be subscribed to. More...
 
virtual int getDefaultDeviceId ()
 Returns the default device to use when the driver is selected, or -1 for none. More...
 
virtual std::string getDeviceName (int deviceId)
 Returns the name of a device without obtaining it. More...
 
virtual int getDeviceNumInputs (int deviceId)
 Returns the number of inputs of a device without obtaining it. More...
 
virtual int getDeviceNumOutputs (int deviceId)
 Returns the number of output of a device without obtaining it. More...
 
virtual Devicesubscribe (int deviceId, Port *port)
 Adds the given port as a reference holder of a device and returns the it. More...
 
virtual void unsubscribe (int deviceId, Port *port)
 Removes the give port as a reference holder of a device. More...
 

Detailed Description

Wraps an audio driver API containing any number of audio devices.

Constructor & Destructor Documentation

◆ ~Driver()

virtual rack::audio::Driver::~Driver ( )
inlinevirtual

Member Function Documentation

◆ getName()

virtual std::string rack::audio::Driver::getName ( )
inlinevirtual

Returns the name of the driver.

E.g. "ALSA".

◆ getDeviceIds()

virtual std::vector< int > rack::audio::Driver::getDeviceIds ( )
inlinevirtual

Returns a list of all device IDs that can be subscribed to.

◆ getDefaultDeviceId()

virtual int rack::audio::Driver::getDefaultDeviceId ( )
inlinevirtual

Returns the default device to use when the driver is selected, or -1 for none.

◆ getDeviceName()

virtual std::string rack::audio::Driver::getDeviceName ( int  deviceId)
inlinevirtual

Returns the name of a device without obtaining it.

◆ getDeviceNumInputs()

virtual int rack::audio::Driver::getDeviceNumInputs ( int  deviceId)
inlinevirtual

Returns the number of inputs of a device without obtaining it.

◆ getDeviceNumOutputs()

virtual int rack::audio::Driver::getDeviceNumOutputs ( int  deviceId)
inlinevirtual

Returns the number of output of a device without obtaining it.

◆ subscribe()

virtual Device * rack::audio::Driver::subscribe ( int  deviceId,
Port port 
)
inlinevirtual

Adds the given port as a reference holder of a device and returns the it.

Creates the Device if no ports are subscribed before calling.

◆ unsubscribe()

virtual void rack::audio::Driver::unsubscribe ( int  deviceId,
Port port 
)
inlinevirtual

Removes the give port as a reference holder of a device.

Deletes the Device if no ports are subscribed after calling.


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