dxd - dynax driver framework  2675
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin Struct Reference

#include <dx_stream.h>

Classes

struct  properties
 
struct  property_pair
 

Public Types

enum  format {
  format::pcm16 ='pcm\x10', format::pcm24 ='pcm\x18', format::pcm24in32hi ='pcmh', format::pcm24in32lo ='pcml',
  format::pcm32 ='pcm\x20', format::midi ='midi', format::invalid ='none', format::audio ='aud\0',
  format::any ='any\0'
}
 
enum  plug {
  plug::line ='line', plug::digital ='dgtl', plug::spdif ='spdf', plug::din ='din5',
  plug::synth ='snth', plug::keyboard ='keys', plug::dsp ='dsp\0', plug::control ='cntr'
}
 

Public Member Functions

std::string describe () const
 describes pin as channels*format/[in|out] #idx:plug More...
 
bool operator== (dx_enum_prefix format format) const
 
const struct propertiesproperty () const
 

Static Public Member Functions

static const struct propertiesproperty (dx_enum_prefix format format)
 

Public Attributes

unsigned int channels
 amount of channels in pin More...
 
unsigned int config
 config member class bit field More...
 
enum
dx::stream::desc::stream::pin::format 
format
 
bool hidden
 if hidden prevent audio client (CoreAudio, PortClass, ASIO) auto attach More...
 
unsigned int index
 MIDI:cable number; audio:channel array start. More...
 
char name [0x40]
 
enum
dx::stream::desc::stream::pin::plug 
plug
 

Member Enumeration Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::pin::format
strong
Enumerator
pcm16 

signed 16 bit integer little endian linear PCM

pcm24 

signed 24 bit compressed integer little endian linear PCM

pcm24in32hi 

signed 24 bit integer in 32bit frame hi aligned little endian linear PCM

pcm24in32lo 

signed 24 bit integer in 32bit frame lo aligned little endian linear PCM

pcm32 

signed 32 bit integer little endian linear PCM

midi 

USB MIDI.

invalid 
audio 

pseudo type: only for audio pin enumeration

any 

pseudo type: only for audio/MIDI pin enumeration

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::pin::plug
strong
Enumerator
line 

stereo line interface: kAudioStreamTerminalTypeLine

Todo:
use USB terminal ids and DEFINE_USB_TERMINAL_GUID
digital 

digital multi channel audio interface

spdif 

stereo SPDIF digital audio interface: kAudioStreamTerminalTypeDigitalAudioInterface

din 

device-external 5 pin DIN MIDI connector

synth 

device-internal MIDI synthesizer

keyboard 

MIDI keyboard.

dsp 

digital signal processor

control 

control device

Member Function Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
std::string dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::describe ( ) const
inline

describes pin as channels*format/[in|out] #idx:plug

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
bool dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::operator== ( dx_enum_prefix format  format) const
inline
template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
static const struct properties& dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::property ( dx_enum_prefix format  format)
inlinestatic
template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
const struct properties& dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::property ( ) const
inline

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::channels

amount of channels in pin

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::config

config member class bit field

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::pin::format dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::format
template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
bool dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::hidden

if hidden prevent audio client (CoreAudio, PortClass, ASIO) auto attach

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::index

MIDI:cable number; audio:channel array start.

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
char dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::name[0x40]
template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::pin::plug dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::pin::plug

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

(c) copyright 2009 dynamic acoustics e.U. generated on Tue Dec 4 2018

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.