dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable > Class Template Reference

coreaudio::promoted::property More...

#include <dx_coreaudio_property.h>

Inheritance diagram for dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >:

Collaboration diagram for dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >:

Public Types
typedef std::vector<::AudioObjectPropertyAddress >	addresses
typedef std::map<::AudioObjectPropertySelector, ::CFStringRef >	dictionary
typedef std::unique_lock< mutex_t >	lock_t
typedef std::mutex	mutex_t

Public Member Functions
	catch (...)
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
void	commit (lock_t &lock, const value_t &value) try
template<typename data_t >
const property &	get (data_t &data) const try
dx_coreaudio_property_catchall_rethrow	operator bool () const noexcept
	operator const value_t & () try
template<typename data_t >
dx_coreaudio_property_catchall_rethrow	operator data_t () const try
template<typename data_t >
	operator std::set< data_t > () const
dx_coreaudio_property_catchall_rethrow	operator std::string () const
	return std::string from C-string property
template<typename data_t >
	operator std::vector< data_t > () const try
template<typename data_t >
dx_coreaudio_property_catchall_rethrow property &	operator<< (const data_t &data) try
bool	operator== (const value_t &value) noexcept
virtual dx_coreaudio_property_catchall_rethrow property &	set (const void *data=nullptr, uint32_t size=0) try
dx_coreaudio_property_catchall_rethrow uint32_t	size () const try

Public Attributes
bool	initialized {}
std::function< void(lock_t &, const value_t &)	server ) {}
	\ indicate the value is in transition - does not have the new value yet
bool	transient {}
	\ indicate the value has been initialized

Protected Attributes
const ::AudioObjectID	id
struct dx::coreaudio::property::qualifier	qualifier
value_t	value

Detailed Description

template<typename value_t, typename coreaudio_value_t = value_t, bool settable = true>
class dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >

coreaudio::promoted::property

see promoted<value_t> in dx_value.h

usage:

dx::promoted<value_t> promoted\_value;
promoted\_value= new value assignment;
// * get current value from coreaudio::property if initial assignment
// * commits new value to coreaudio::property if new assignment is different from current value
// * returns current value - updated from coreaudio::property if value has changed
current value= promoted\_value;
// * get current value from coreaudio::property if initial assignment
// * returns current value

Member Typedef Documentation

addresses

typedef std::vector<::AudioObjectPropertyAddress> dx::coreaudio::property::addresses

inherited

dictionary

typedef std::map<::AudioObjectPropertySelector, ::CFStringRef> dx::coreaudio::property::dictionary

inherited

lock_t

template<typename value_t >

typedef std::unique_lock<mutex_t> dx::promoted< value_t >::lock_t

inherited

mutex_t

template<typename value_t >

typedef std::mutex dx::promoted< value_t >::mutex_t

inherited

Member Function Documentation

catch() [1/9]

template<typename value_t >

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [2/9]

template<typename value_t >

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [3/9]

template<typename value_t >

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [4/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [5/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [6/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [7/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [8/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [9/9]

template<typename value_t >

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

commit()

template<typename value_t >

void dx::promoted< value_t >::commit ( lock_t & lock, const value_t & value )

inlineinherited

Here is the caller graph for this function:

get()

template<typename data_t >

const property & dx::coreaudio::property::get ( data_t & data ) const

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

operator bool()

dx_coreaudio_property_catchall_rethrow dx::coreaudio::property::operator bool ( ) const

inlinenoexceptinherited

operator const value_t &()

template<typename value_t >

dx::promoted< value_t >::operator const value_t & ( )

inlineinherited

operator data_t()

template<typename data_t >

dx_coreaudio_property_catchall_rethrow dx::coreaudio::property::operator data_t ( ) const

inlineinherited

Here is the call graph for this function:

operator std::set< data_t >()

template<typename data_t >

dx::coreaudio::property::operator std::set< data_t > ( ) const

inlineinherited

operator std::string()

dx_coreaudio_property_catchall_rethrow dx::coreaudio::property::operator std::string ( ) const

inlineinherited

return std::string from C-string property

operator std::vector< data_t >()

template<typename data_t >

dx::coreaudio::property::operator std::vector< data_t > ( ) const

inlineinherited

Here is the call graph for this function:

operator<<()

template<typename data_t >

dx_coreaudio_property_catchall_rethrow property & dx::coreaudio::property::operator<< ( const data_t & data )

inlineinherited

Here is the call graph for this function:

operator==()

template<typename value_t >

bool dx::promoted< value_t >::operator== ( const value_t & value )

inlinenoexceptinherited

set()

virtual dx_coreaudio_property_catchall_rethrow property & dx::coreaudio::property::set ( const void * data = nullptr, uint32_t size = 0 )

inlinevirtualinherited

Reimplemented in dx::coreaudio::property::listen.

Here is the call graph for this function:

Here is the caller graph for this function:

size()

dx_coreaudio_property_catchall_rethrow uint32_t dx::coreaudio::property::size ( ) const

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

id

const ::AudioObjectID dx::coreaudio::property::id

protectedinherited

initialized

template<typename value_t >

bool dx::promoted< value_t >::initialized {}

inherited

qualifier

struct dx::coreaudio::property::qualifier dx::coreaudio::property::qualifier

protectedinherited

server

template<typename value_t >

std::function<void(lock_t&, const value_t&) dx::promoted< value_t >::server) {}

inherited

\ indicate the value is in transition - does not have the new value yet

server: handle synchronous and asynchronous value updates and initialization it needs to handle these case: not initialized and not in transation: initialze and commit the value not initialized and in transation: if dependent on external settings initialize a temporary and compare it with the new value and update the external setting if required make sure to commit the new value so listeners get notified either synchronously or asynchronously by external notification initialized and in transition: update external settings if any and make sure to commit the new value so listeners get notified either synchronously or asynchronousl by external notification

server will not be called with this state: initialized and not in transation

transient

template<typename value_t >

bool dx::promoted< value_t >::transient {}

inherited

\ indicate the value has been initialized

value

template<typename value_t >

value_t dx::promoted< value_t >::value

protectedinherited

---

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

• dx_coreaudio_property.h