dxd - dynax driver framework  2979
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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config Struct Reference

stream interface descriptor More...

#include <dx_stream.h>

Public Member Functions

std::string describe () const
 describes config as channels*format/[in|out] #idx:plug More...
 
unsigned int line_size () const
 total length of the samples of all channels More...
 

Public Attributes

unsigned int channels
 amount of channels in interface (forms the lines size together with word_length) More...
 
struct {
   unsigned int   domain
 clock domain bitmap: identify the clock domain to which this stream belongs, More...
 
clock
 
unsigned int word_length
 total length of one sample in the stream More...
 

Detailed Description

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

stream interface descriptor

A stream can have various configuration with varying supported samples rates, number of channels and data formats.

Member Function Documentation

template<typename target_t, int max_clocks = 2, 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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::describe ( ) const
inline

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

template<typename target_t, int max_clocks = 2, 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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::line_size ( ) const
inline

total length of the samples of all channels

Member Data Documentation

template<typename target_t, int max_clocks = 2, 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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::channels

amount of channels in interface (forms the lines size together with word_length)

struct { ... } dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::clock
template<typename target_t, int max_clocks = 2, 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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::domain

clock domain bitmap: identify the clock domain to which this stream belongs,

template<typename target_t, int max_clocks = 2, 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_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config::word_length

total length of one sample in the stream


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

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Nov 8 2019

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.