ardour
Public Attributes | List of all members
ARDOUR::AudioBackendInfo Struct Reference

#include <audio_backend.h>

Public Attributes

const char * name
 
int(* instantiate )(const std::string &arg1, const std::string &arg2)
 
int(* deinstantiate )(void)
 
boost::shared_ptr< AudioBackend >(* factory )(AudioEngine &)
 
bool(* already_configured )()
 
bool(* available )()
 

Detailed Description

Definition at line 45 of file audio_backend.h.

Member Data Documentation

bool(* ARDOUR::AudioBackendInfo::already_configured)()

Return true if the underlying mechanism/API has been configured and does not need (re)configuration in order to be usable. Return false otherwise.

Note that this may return true if (re)configuration, even though not currently required, is still possible.

Definition at line 72 of file audio_backend.h.

bool(* ARDOUR::AudioBackendInfo::available)()

Return true if the underlying mechanism/API can be used on the given system.

If this function returns false, the backend is not listed in the engine dialog.

Definition at line 80 of file audio_backend.h.

int(* ARDOUR::AudioBackendInfo::deinstantiate)(void)

Release all resources associated with this audiobackend

Definition at line 56 of file audio_backend.h.

boost::shared_ptr<AudioBackend>(* ARDOUR::AudioBackendInfo::factory)(AudioEngine &)

Factory method to create an AudioBackend-derived class.

Returns a valid shared_ptr to the object if successfull, or a "null" shared_ptr otherwise.

Definition at line 63 of file audio_backend.h.

int(* ARDOUR::AudioBackendInfo::instantiate)(const std::string &arg1, const std::string &arg2)

Using arg1 and arg2, initialize this audiobackend.

Returns zero on success, non-zero otherwise.

Definition at line 52 of file audio_backend.h.

const char* ARDOUR::AudioBackendInfo::name

Definition at line 46 of file audio_backend.h.


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