EHS
ehs::BaseAudioDevice Class Reference

#include <BaseAudioDevice.h>

Inheritance diagram for ehs::BaseAudioDevice:
ehs::AudioDevice ehs::AudioDevice

Public Member Functions

virtual ~BaseAudioDevice ()=default
 
 BaseAudioDevice ()
 
 BaseAudioDevice (const BaseAudioDevice &device)
 
BaseAudioDeviceoperator= (const BaseAudioDevice &device)
 
virtual void OpenStream ()
 
virtual void CloseStream ()
 
virtual UInt_64 SendStream (const void *data, UInt_64 size)
 
virtual UInt_64 ReceiveStream (void *data, UInt_64 size)
 
void BridgeStreams (BaseAudioDevice *input, UInt_64 frameBufferSize)
 
void BridgeStreams (UInt_64 frameBufferSize)
 
AudioDeviceType GetType () const
 
void SetDataType (DataType newDataType)
 
DataType GetDataType () const
 
UInt_8 GetByteDepth () const
 
UInt_16 GetBitDepth () const
 
void SetSampleRate (UInt_32 newSampleRate)
 
UInt_32 GetSampleRate () const
 
void SetChannels (UInt_32 newChannels)
 
UInt_16 GetChannels () const
 
UInt_32 GetFrameSize () const
 
void SetPeriod (UInt_32 newPeriod)
 
UInt_32 GetPeriod () const
 
void SetLatency (UInt_32 newLatency)
 
UInt_32 GetLatency () const
 
UInt_64 GetMaxFrames () const
 
virtual bool IsStreaming () const
 
virtual bool IsValid () const
 

Static Public Member Functions

static BaseAudioDevice GetDefault (AudioDeviceType type)
 
static Array< BaseAudioDeviceGet (AudioDeviceType type, AudioDeviceState state)
 

Protected Attributes

AudioDeviceType type
 
DataType dataType
 
UInt_16 byteDepth
 
UInt_32 sampleRate
 
UInt_32 channels
 
UInt_32 period
 
UInt_32 latency
 
UInt_64 maxFrames
 

Constructor & Destructor Documentation

◆ ~BaseAudioDevice()

virtual ehs::BaseAudioDevice::~BaseAudioDevice ( )
virtualdefault

◆ BaseAudioDevice() [1/2]

ehs::BaseAudioDevice::BaseAudioDevice ( )

◆ BaseAudioDevice() [2/2]

ehs::BaseAudioDevice::BaseAudioDevice ( const BaseAudioDevice device)

Member Function Documentation

◆ BridgeStreams() [1/2]

void ehs::BaseAudioDevice::BridgeStreams ( BaseAudioDevice input,
UInt_64  frameBufferSize 
)

◆ BridgeStreams() [2/2]

void ehs::BaseAudioDevice::BridgeStreams ( UInt_64  frameBufferSize)

◆ CloseStream()

void ehs::BaseAudioDevice::CloseStream ( )
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ Get()

Array< BaseAudioDevice > ehs::BaseAudioDevice::Get ( AudioDeviceType  type,
AudioDeviceState  state 
)
static

Retrieves a list of audio input/output devices.

Parameters
[in]typeThe audio device type to retrieve.
[in]stateThe audio device state to retrieve.
[out]devicesThe list of audio devices.

◆ GetBitDepth()

UInt_16 ehs::BaseAudioDevice::GetBitDepth ( ) const

◆ GetByteDepth()

UInt_8 ehs::BaseAudioDevice::GetByteDepth ( ) const

◆ GetChannels()

UInt_16 ehs::BaseAudioDevice::GetChannels ( ) const

◆ GetDataType()

DataType ehs::BaseAudioDevice::GetDataType ( ) const

◆ GetDefault()

BaseAudioDevice ehs::BaseAudioDevice::GetDefault ( AudioDeviceType  type)
static

Retrieves the default audio input/output device.

Parameters
[in]typeThe audio device type to retrieve.
[out]deviceThe default audio device.

◆ GetFrameSize()

UInt_32 ehs::BaseAudioDevice::GetFrameSize ( ) const

◆ GetLatency()

UInt_32 ehs::BaseAudioDevice::GetLatency ( ) const

◆ GetMaxFrames()

UInt_64 ehs::BaseAudioDevice::GetMaxFrames ( ) const

◆ GetPeriod()

UInt_32 ehs::BaseAudioDevice::GetPeriod ( ) const

◆ GetSampleRate()

UInt_32 ehs::BaseAudioDevice::GetSampleRate ( ) const

◆ GetType()

AudioDeviceType ehs::BaseAudioDevice::GetType ( ) const

◆ IsStreaming()

bool ehs::BaseAudioDevice::IsStreaming ( ) const
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ IsValid()

bool ehs::BaseAudioDevice::IsValid ( ) const
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ OpenStream()

void ehs::BaseAudioDevice::OpenStream ( )
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ operator=()

BaseAudioDevice & ehs::BaseAudioDevice::operator= ( const BaseAudioDevice device)

◆ ReceiveStream()

UInt_64 ehs::BaseAudioDevice::ReceiveStream ( void *  data,
UInt_64  size 
)
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ SendStream()

UInt_64 ehs::BaseAudioDevice::SendStream ( const void *  data,
UInt_64  size 
)
virtual

Reimplemented in ehs::AudioDevice, and ehs::AudioDevice.

◆ SetChannels()

void ehs::BaseAudioDevice::SetChannels ( UInt_32  newChannels)

◆ SetDataType()

void ehs::BaseAudioDevice::SetDataType ( DataType  newDataType)

◆ SetLatency()

void ehs::BaseAudioDevice::SetLatency ( UInt_32  newLatency)

◆ SetPeriod()

void ehs::BaseAudioDevice::SetPeriod ( UInt_32  newPeriod)

◆ SetSampleRate()

void ehs::BaseAudioDevice::SetSampleRate ( UInt_32  newSampleRate)

Member Data Documentation

◆ byteDepth

UInt_16 ehs::BaseAudioDevice::byteDepth
protected

◆ channels

UInt_32 ehs::BaseAudioDevice::channels
protected

◆ dataType

DataType ehs::BaseAudioDevice::dataType
protected

◆ latency

UInt_32 ehs::BaseAudioDevice::latency
protected

◆ maxFrames

UInt_64 ehs::BaseAudioDevice::maxFrames
protected

◆ period

UInt_32 ehs::BaseAudioDevice::period
protected

◆ sampleRate

UInt_32 ehs::BaseAudioDevice::sampleRate
protected

◆ type

AudioDeviceType ehs::BaseAudioDevice::type
protected

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