dx::coreaudio::driver< device_t > Class Template Reference

#include <dx_coreaudio.h>

Inheritance diagram for dx::coreaudio::driver< device_t >:

Collaboration diagram for dx::coreaudio::driver< device_t >:

Public Types
typedef decltype(matching_ids)	match

Public Member Functions
void	add (const device_id_t &device_id) override try
	adds a new device to the device list
void	add (const std::string &id, const typename device_t::desc &desc)
	driver (const match &matching_ids, const char *product_id, dx::log log=dx::log{{ .bus={ .setup=log::level::dflt,.operation=log::level::dflt,},.interface={ .setup=log::level::dflt,.operation=log::level::dflt}}})
	the driver interface class constructor
void	exception (const class exception &exception, bool filtered=false) const noexcept override try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
void	info (std::ostream &os) noexcept override
	log object class information
void	launch () override
	launch notification: object mounted and ready to use
void	remove (const device_id_t &device_id) override try
	finds and removes a device from the device list
void	remove (const std::string &id)

Public Attributes
T	elements
	STL member.
K	keys
	STL member.
bool	launched {}
log	log
::AudioObjectID	plugin = 0
const char *	product_id
uint32_t	version

Protected Member Functions
virtual void	arrived ()
	notify device arrivals completed stub
virtual void	arrived (device_t &)
	notify specific device arrival stub
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
void	clear () noexcept try
	replaces std::map::clear to call virtual notification methods
void	conclude () noexcept override try
	conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
virtual void	removed () noexcept
	notify device removals completed stub
virtual void	removed (device_t &) noexcept
	notify specific device removal stub
virtual void	scan ()

Protected Attributes
std::vector< property::dictionary >	matching_ids

Member Typedef Documentation

match

template<class device_t >

typedef decltype(matching_ids) dx::coreaudio::driver< device_t >::match

Constructor & Destructor Documentation

driver()

template<class device_t >

dx::coreaudio::driver< device_t >::driver ( const match & matching_ids, const char * product_id, dx::log log = dx::log{{ .bus={ .setup= log::level::dflt, .operation= log::level::dflt,}, .interface={ .setup= log::level::dflt, .operation= log::level::dflt}}} )

inline

the driver interface class constructor

Todo

handle kext blocking https://developer.apple.com/library/content/technotes/tn2459/_index.html

Parameters

matching_ids	the matching dictionaries identifying the driver interface
product_id	drivers bundle ID

Member Function Documentation

add() [1/2]

template<class device_t >

void dx::map::driver< device_t >::add ( const device_id_t & device_id )

inlineoverridevirtual

adds a new device to the device list

Exceptions

dx::exception

Implements dx::driver< decltype(device_t::id)>.

add() [2/2]

template<class device_t >

void dx::coreaudio::driver< device_t >::add ( const std::string & id, const typename device_t::desc & desc )

inline

Here is the caller graph for this function:

arrived() [1/2]

template<typename device_t >

virtual void dx::driver< device_id_t >::arrived ( )

inlineprotectedvirtualinherited

notify device arrivals completed stub

Reimplemented from dx::driver< decltype(device_t::id)>.

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >, dx::stream::engine< device< typename audio_pin_t::circular_t, super_device_t >, audio_pin_t, dx::proxy::driver< device< typename audio_pin_t::circular_t, super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< typename audio_pin_t::circular_t, super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< typename audio_pin_t::circular_t, super_device_t > >, int32_t >, and dx::stream::engine< dx::test::midi::device< typename audio_pin_t::circular_t, super_device_t, typename midi_pin_t::circular_t >, audio_pin_t, dx::proxy::driver< dx::test::midi::device< typename audio_pin_t::circular_t, super_device_t, typename midi_pin_t::circular_t > >, int32_t >.

Here is the caller graph for this function:

arrived() [2/2]

template<typename device_t >

virtual void dx::map::driver< device_t >::arrived ( device_t & )

inlineprotectedvirtualinherited

notify specific device arrival stub

Reimplemented in dx::coreaudio::server::plugin< pin_t, device_t, driver_t >.

catch() [1/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [2/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [3/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [4/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [5/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

catch() [6/6]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

clear()

template<typename device_t >

void dx::map::driver< device_t >::clear ( )

inlineprotectednoexceptinherited

replaces std::map::clear to call virtual notification methods

Here is the call graph for this function:

Here is the caller graph for this function:

conclude()

template<typename device_t >

void dx::map::driver< device_t >::conclude ( )

inlineoverrideprotectedvirtualnoexceptinherited

conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.

Reimplemented from dx::object.

Here is the call graph for this function:

Here is the caller graph for this function:

exception() [1/2]

void dx::driver< decltype(device_t::id) >::exception ( const class exception & exception, bool filtered = false ) const

inlineoverridenoexceptinherited

notification exception handler

exception() [2/2]

virtual void dx::object::exception ( const exception & exception, bool filtered = false ) const

pure virtualnoexceptinherited

notification exception handler

Implemented in dx::device< std::string >, dx::device<::AudioObjectID >, dx::device<::io_service_t >, dx::device< id_t >, dx::proxy::device, dx::usb::platform::device, and dx::proxy::device.

info()

template<class device_t >

void dx::coreaudio::driver< device_t >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

Reimplemented from dx::object.

Here is the call graph for this function:

launch()

template<class device_t >

void dx::coreaudio::driver< device_t >::launch ( )

inlineoverridevirtual

launch notification: object mounted and ready to use

Reimplemented from dx::object.

Here is the call graph for this function:

remove() [1/2]

template<class device_t >

void dx::map::driver< device_t >::remove ( const device_id_t & device_id )

inlineoverridevirtual

finds and removes a device from the device list

Exceptions

dx::exception

Implements dx::driver< decltype(device_t::id)>.

remove() [2/2]

template<class device_t >

void dx::coreaudio::driver< device_t >::remove ( const std::string & id )

inline

Here is the caller graph for this function:

removed() [1/2]

template<typename device_t >

virtual void dx::driver< device_id_t >::removed ( )

inlineprotectedvirtualnoexceptinherited

notify device removals completed stub

Reimplemented from dx::driver< decltype(device_t::id)>.

Here is the caller graph for this function:

removed() [2/2]

template<typename device_t >

virtual void dx::map::driver< device_t >::removed ( device_t & )

inlineprotectedvirtualnoexceptinherited

notify specific device removal stub

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >.

scan()

template<class device_t >

virtual void dx::coreaudio::driver< device_t >::scan ( )

inlineprotectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

elements

T std::map< K, T >::elements

inherited

STL member.

keys

K std::map< K, T >::keys

inherited

STL member.

launched

bool dx::object::launched {}

inherited

log

log dx::driver< decltype(device_t::id) >::log

inherited

matching_ids

template<class device_t >

std::vector<property::dictionary> dx::coreaudio::driver< device_t >::matching_ids

protected

plugin

template<class device_t >

::AudioObjectID dx::coreaudio::driver< device_t >::plugin = 0

product_id

const char* dx::driver< decltype(device_t::id) >::product_id

inherited

version

uint32_t dx::driver< decltype(device_t::id) >::version

inherited

---

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

• dx_coreaudio.h