the bus's device as a product composes it: the endpoints of one Windows audio device, driven as any WASAPI application drives them More...

#include <dx_wasapi_client_device.h>

Inheritance diagram for dx::wasapi::client::device< desc_t, preference_t, stream_t, group_t >:

Collaboration diagram for dx::wasapi::client::device< desc_t, preference_t, stream_t, group_t >:

Public Types
typedef desc	desc_t
typedef event	event_t
typedef std::conditional_t< std::is_void_v< group< device< desc, preference, stream, group > > >, dx::stream::group< device >, group< device< desc, preference, stream, group > > >	group_t
	bus devices driving their groups' tick pass their own group type
typedef promoted< uint32_t >::template preference< decltype(dx::stream::control< dx::device< std::string, preference > >::preference)>	source_t
typedef desc	value_t

Public Member Functions
struct stream *	align (struct stream *sync_reference)
	the given stream where it may be the sync reference, else the first one that may - what a stored reference is aligned to when the desc changed under it
uint32_t	align (uint32_t sync_reference) const
void	attach (channel_t **io[dx::stream::direction::directions][2], const std::vector< bool >(&channel_map)[2])
void	conclude () noexcept override
	ends every group's session before the device's resources go; the start counts stay with their holders
uint32_t	enumerate (const format &format=any) const
	enumerate typified pins
void	exception (const dx::exception &exception, bool filtered=false) const noexcept override
struct stream *	find (const decltype(stream::target.idx())&target)
struct stream *	find (const format &format=any, enum direction::direction direction=direction::any)
struct stream *	find (const target_t &target)
struct stream *	find (uint32_t &pin, const format &format=any, enum direction::direction direction=direction::any)
	finds and returns the stream description and pin idx into this stream
virtual uint64_t	frame () const
virtual bool	hw_clock () const noexcept
virtual void	hw_clock (abstract::event *hw_clock, uint32_t iosize)
	registers a consumer with the device's clock: it is signalled every iosize samples of the clock's own advance. A bus whose driver owns the clock hands the registration on instead
void	info (std::ostream &os) noexcept override
std::shared_ptr< stream_t >	open (const typename desc::stream::desc &descdesc)
	the desc's stream: the registered one, else created, registered and launched
std::shared_ptr< stream< device< desc, preference, stream, group > > >	open (const typename desc::stream::desc &descdesc)
	the desc's stream: the registered one, else created, registered and launched
bool	operator== (const descdesc &descdesc) const
virtual device &	operator>> (std::ostream &) const
	the device's own diagnostics, beyond dx::object::info
group_t &	operator[] (const typename desc::stream::desc &stream)
	the stream's group, created on first use
group< device< desc, preference, stream, group > > &	operator[] (const typename desc::stream::desc &stream)
	the stream's group, created on first use
_device &	reset ()
virtual void	sleep ()
	notify system will sleep stub
virtual std::pair< source_t &, bool >	source (const struct desc::stream &stream)
	the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources
virtual std::pair< source_t &, bool >	source (const struct desc::stream &stream)
	the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources
std::string	string (uint8_t)
uint32_t	sync_reference (struct stream *sync_reference)
struct stream *	sync_reference (uint32_t sync_reference)
	the n-th stream qualifying as sync reference, and the twin below the index of a given one - the two directions of the preference's value
bool	try_conclude () noexcept
	atomically conclude()s if currently launched; returns whether this call did it
bool	try_launch ()
	atomically launch()es if not already launched; returns whether this call did it. A launch() that throws is concluded before the exception leaves: the object never claims a launch it did not finish
void	wake () override

Public Attributes
dx::stream::bus::bus	bus {}
	the bus this device hangs on
struct dx::stream::desc::clock	clock [max_clocks]
uint32_t	clocks {}
promoted< uint32_t >::preference< decltype(super::preference)>	clocksource
bool	dflt {}
	can be selected as default (OS audio) device
dx::driver< decltype(id), preference > &	driver
bool	editable {}
	can be edited
struct dx::stream::desc::firmware	firmware
std::map< decltype(desc::stream::group), group< device< desc, preference, stream, group > > >	group
	streaming groups by desc::stream::group id: every stream of this device is registered with its group - behind the settings its groups listen to, so they go first
bool	hidden {}
	hide device
struct dx::stream::device:: { ... }	hw
promoted< std::string >::preference< decltype(super::preference)>	icon
const std::string	id
promoted< uint32_t >::preference< decltype(super::preference)>	iosize
std::atomic< bool >	launched
struct dx::stream::desc::name_id	model
dx::stream::device::monitor	monitor
bool	persistence {}
	device has capability to store persistent settings (i.e. sample rate; clock source; etc.)
preference	preference
std::string	puid
	persistent UID - system unique - could change with location
std::string	puuid
	persistent universal UID - universally unique ID (i.e. serial number)
promoted< uint32_t >::preference< decltype(super::preference)>	samplerate
std::map< decltype(desc::stream::target.idx()), source_t >	sources
promoted< uint32_t >	start
direction::direction	start_stop_order {direction::any}
promoted< bool >	started
struct dx::stream::desc::stream	stream [max_streams]
promoted< structdesc_t::stream * >::template preference< decltype(super::preference), uint32_t >	sync_reference
struct dx::stream::desc::name_id	vendor
dx::stream::device::monitor	version

Static Public Attributes
static constexpr bool	hosted
	the transport's settings belong to another process' device: a hosted device mirrors them through its chains, it keeps no store of them

Protected Member Functions
virtual void	grouped (group_t &)
	operator[](): a group just came into existence, a host wires its per-group transports here
virtual void	grouped (group< device< desc, preference, stream, group > > &)
	operator[](): a group just came into existence, a host wires its per-group transports here
virtual void	launch ()
	launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.

Protected Attributes
std::function< void()>	flush_hook
std::function< void()>	halt_hook
std::function< void()>	run_hook
decltype(super::samplerate) ::chain	samplerate_server
	exclusive: every stream's client is recreated at the aligned rate, paused across it; shared: the engine's mix format rate is the only one

Detailed Description

template<typename desc_t = desc, typename preference_t = preference, template< typename ... > typename stream_t = stream, template< typename ... > typename group_t = group>
class dx::wasapi::client::device< desc_t, preference_t, stream_t, group_t >

the bus's device as a product composes it: the endpoints of one Windows audio device, driven as any WASAPI application drives them

Member Typedef Documentation

◆ desc_t

typedef desc dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::desc

inherited

◆ event_t

typedef event dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::event_t

inherited

◆ group_t

typedef std::conditional_t<std::is_void_v<group< device< desc, preference, stream, group > >>, dx::stream::group<device>, group< device< desc, preference, stream, group > >> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::group< device< desc, preference, stream, group > >

inherited

bus devices driving their groups' tick pass their own group type

◆ source_t

typedef promoted<uint32_t>::template preference<decltype(dx::stream::control< dx::device< std::string, preference > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::source_t

inherited

◆ value_t

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

typedef desc dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::value_t

inherited

Member Function Documentation

◆ align() [1/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::align ( struct stream * sync_reference )

inlineinherited

the given stream where it may be the sync reference, else the first one that may - what a stored reference is aligned to when the desc changed under it

◆ align() [2/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::align ( uint32_t sync_reference ) const

inlineinherited

◆ attach()

void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::attach	(	channel_t **	io[dx::stream::direction::directions][2],
		const std::vector< bool >(&)	channel_map[2] )

inlineinherited

◆ conclude()

void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::conclude ( )

inlineoverridenoexceptinherited

ends every group's session before the device's resources go; the start counts stay with their holders

◆ enumerate()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::enumerate ( const format & format = any ) const

inlineinherited

enumerate typified pins

◆ exception()

void dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::exception	(	const dx::exception &	exception,
		bool	filtered = false ) const

inlineoverridevirtualnoexceptinherited

Reimplemented from dx::device< std::string, preference >.

◆ find() [1/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::find ( const decltype(stream::target.idx())& target )

inlineinherited

◆ find() [2/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::find	(	const format &	format = any,
		enum direction::direction	direction = direction::any )

inlineinherited

Parameters

format	search stream format filter
direction	search stream direction filter

◆ find() [3/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::find ( const target_t & target )

inlineinherited

◆ find() [4/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::find	(	uint32_t &	pin,
		const format &	format = any,
		enum direction::direction	direction = direction::any )

inlineinherited

finds and returns the stream description and pin idx into this stream

Returns: stream description of indexed pin, pin idx will be altered on return!

Parameters

pin	in: global pin index, out: pin index into returned stream description
format	search stream format filter
direction	search stream direction filter

Here is the caller graph for this function:

◆ frame()

virtual uint64_t dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::frame ( ) const

inlinevirtualinherited

◆ grouped() [1/2]

virtual void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::grouped ( group_t & )

inlineprotectedvirtualinherited

operator[](): a group just came into existence, a host wires its per-group transports here

◆ grouped() [2/2]

virtual void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::grouped ( group< device< desc, preference, stream, group > > & )

inlineprotectedvirtualinherited

operator[](): a group just came into existence, a host wires its per-group transports here

◆ hw_clock() [1/2]

virtual bool dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::hw_clock ( ) const

inlinevirtualnoexceptinherited

◆ hw_clock() [2/2]

virtual void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::hw_clock	(	abstract::event *	hw_clock,
		uint32_t	iosize )

inlinevirtualinherited

registers a consumer with the device's clock: it is signalled every iosize samples of the clock's own advance. A bus whose driver owns the clock hands the registration on instead

◆ info()

void dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::info ( std::ostream & os )

inlineoverridevirtualnoexceptinherited

Reimplemented from dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >.

◆ launch()

virtual void dx::object::launch ( )

inlineprotectedvirtualinherited

launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.

◆ open() [1/2]

std::shared_ptr< stream_t > dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::open ( const typename desc::stream::desc & desc )

inlineinherited

the desc's stream: the registered one, else created, registered and launched

◆ open() [2/2]

std::shared_ptr< stream< device< desc, preference, stream, group > > > dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::open ( const typename desc::stream::desc & desc )

inlineinherited

the desc's stream: the registered one, else created, registered and launched

◆ operator==()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::operator== ( const desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources > & desc ) const

inlineinherited

◆ operator>>()

virtual device & dx::device< std::string, preference >::operator>> ( std::ostream & ) const

inlinevirtualinherited

the device's own diagnostics, beyond dx::object::info

◆ operator[]() [1/2]

group_t & dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::operator[] ( const typename desc::stream::desc & stream )

inlineinherited

the stream's group, created on first use

◆ operator[]() [2/2]

group< device< desc, preference, stream, group > > & dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::operator[] ( const typename desc::stream::desc & stream )

inlineinherited

the stream's group, created on first use

◆ reset()

_device & dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::reset ( )

inlineinherited

◆ sleep()

virtual void dx::device< std::string, preference >::sleep ( )

inlinevirtualinherited

notify system will sleep stub

◆ source() [1/2]

virtual std::pair< source_t &, bool > dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::source ( const struct desc::stream & stream )

inlinevirtualinherited

the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources

◆ source() [2/2]

virtual std::pair< source_t &, bool > dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::source ( const struct desc::stream & stream )

inlinevirtualinherited

the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources

◆ string()

std::string dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::string ( uint8_t )

inlineinherited

◆ sync_reference() [1/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::sync_reference ( struct stream * sync_reference )

inlineinherited

◆ sync_reference() [2/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::sync_reference ( uint32_t sync_reference )

inlineinherited

the n-th stream qualifying as sync reference, and the twin below the index of a given one - the two directions of the preference's value

Here is the caller graph for this function:

◆ try_conclude()

bool dx::object::try_conclude ( )

inlinenoexceptinherited

atomically conclude()s if currently launched; returns whether this call did it

◆ try_launch()

bool dx::object::try_launch ( )

inlineinherited

atomically launch()es if not already launched; returns whether this call did it. A launch() that throws is concluded before the exception leaves: the object never claims a launch it did not finish

◆ wake()

void dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::wake ( )

inlineoverrideinherited

Member Data Documentation

◆ bus

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

dx::stream::bus::bus dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::bus {}

inherited

the bus this device hangs on

◆ clock

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::clock dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::clock[max_clocks]

inherited

◆ clocks

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::clocks {}

inherited

number of independent clocks [currenlty only single clock support]

◆ clocksource

promoted<uint32_t>::preference<decltype(super::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::clocksource

inherited

◆ dflt

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::dflt {}

inherited

can be selected as default (OS audio) device

◆ driver

dx::driver<decltype(id), preference>& dx::device< std::string, preference >::driver

inherited

◆ editable

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::editable {}

inherited

can be edited

◆ firmware

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::firmware dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::firmware

inherited

◆ flush_hook

std::function<void()> dx::stream::control< object_t >::flush_hook

protectedinherited

◆ group

std::map<decltype(desc::stream::group), group< device< desc, preference, stream, group > >> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::group

inherited

streaming groups by desc::stream::group id: every stream of this device is registered with its group - behind the settings its groups listen to, so they go first

◆ halt_hook

std::function<void()> dx::stream::control< object_t >::halt_hook

protectedinherited

◆ hidden

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::hidden {}

inherited

hide device

◆ hosted

bool dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::hosted

staticconstexprinherited

the transport's settings belong to another process' device: a hosted device mirrors them through its chains, it keeps no store of them

◆ hw

struct { ... } dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::hw

◆ icon

promoted<std::string>::preference<decltype(super::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::icon

inherited

◆ id

const std::string dx::device< std::string, preference >::id

inherited

◆ iosize

promoted<uint32_t>::preference<decltype(super::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::iosize

inherited

◆ launched

std::atomic<bool> dx::object::launched

inherited

◆ model

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::name_id dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::model

inherited

◆ monitor

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::monitor

inherited

◆ persistence

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::persistence {}

inherited

device has capability to store persistent settings (i.e. sample rate; clock source; etc.)

◆ preference

preference dx::device< std::string, preference >::preference

inherited

◆ puid

std::string dx::device< std::string, preference >::puid

inherited

persistent UID - system unique - could change with location

◆ puuid

std::string dx::device< std::string, preference >::puuid

inherited

persistent universal UID - universally unique ID (i.e. serial number)

◆ run_hook

std::function<void()> dx::stream::control< object_t >::run_hook

protectedinherited

◆ samplerate

promoted<uint32_t>::preference<decltype(super::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::samplerate

inherited

◆ samplerate_server

decltype(super::samplerate) ::chain dx::wasapi::client::_device< desc, preference, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::samplerate_server

protectedinherited

exclusive: every stream's client is recreated at the aligned rate, paused across it; shared: the engine's mix format rate is the only one

◆ sources

std::map<decltype(desc::stream::target.idx()), source_t> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::sources

inherited

source selectors by stream target: a stream with sources gets its own on first use

◆ start

promoted<uint32_t> dx::stream::control< object_t >::start

inherited

◆ start_stop_order

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

direction::direction dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::start_stop_order {direction::any}

inherited

◆ started

promoted<bool> dx::stream::control< object_t >::started

inherited

◆ stream

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::stream dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream[max_streams]

inherited

◆ sync_reference

promoted<structdesc_t::stream*>::template preference<decltype(super::preference), uint32_t> dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::sync_reference

inherited

◆ vendor

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::name_id dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::vendor

inherited

◆ version

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, preference > >, desc, stream< device< desc, preference, stream, group > >, group< device< desc, preference, stream, group > > >::version

inherited

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

dx_wasapi_client_device.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ desc_t

◆ event_t

◆ group_t

◆ source_t

◆ value_t

Member Function Documentation

◆ align() [1/2]

◆ align() [2/2]

◆ attach()

◆ conclude()

◆ enumerate()

◆ exception()

◆ find() [1/4]

◆ find() [2/4]

◆ find() [3/4]

◆ find() [4/4]

◆ frame()

◆ grouped() [1/2]

◆ grouped() [2/2]

◆ hw_clock() [1/2]

◆ hw_clock() [2/2]

◆ info()

◆ launch()

◆ open() [1/2]

◆ open() [2/2]

◆ operator==()

◆ operator>>()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ reset()

◆ sleep()

◆ source() [1/2]

◆ source() [2/2]

◆ string()

◆ sync_reference() [1/2]

◆ sync_reference() [2/2]

◆ try_conclude()

◆ try_launch()

◆ wake()

Member Data Documentation

◆ bus

◆ clock

◆ clocks

◆ clocksource

◆ dflt

◆ driver

◆ editable

◆ firmware

◆ flush_hook

◆ group

◆ halt_hook

◆ hidden

◆ hosted

◆ hw

◆ icon

◆ id

◆ iosize

◆ launched

◆ model

◆ monitor

◆ persistence

◆ preference

◆ puid

◆ puuid

◆ run_hook

◆ samplerate

◆ samplerate_server

◆ sources

◆ start

◆ start_stop_order

◆ started

◆ stream