Open Ephys GUI
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes
AudioComponent Class Reference

Interfaces with system audio hardware. More...

#include <AudioComponent.h>

List of all members.

Public Member Functions

 AudioComponent ()
 Constructor.
 ~AudioComponent ()
void beginCallbacks ()
 Begins the audio callbacks that drive data acquisition.
void endCallbacks ()
 Stops the audio callbacks that drive data acquisition.
void connectToProcessorGraph (AudioProcessorGraph *processorGraph)
 
Connects the AudioComponent to the ProcessorGraph (crucial for any sort of

data acquisition; done at startup).

void disconnectProcessorGraph ()
 
Disconnects the AudioComponent to the ProcessorGraph (only done when the application

is about to close).

bool callbacksAreActive ()
 Returns true if the audio callbacks are active, false otherwise.
void restartDevice ()
 
Restarts communication with the audio device in order to update settings

or just prior the start of data acquisition callbacks.

void stopDevice ()
 
Stops communication with the selected audio device (to conserve CPU load

when callbacks are not active).

Public Attributes

AudioDeviceManager deviceManager

Detailed Description

Interfaces with system audio hardware.

Uses the audio card to generate the callbacks to run the ProcessorGraph during data acquisition.

Sends output to the audio card for audio monitoring.

Determines the initial size of the sample buffer (crucial for real-time feedback latency).

See also:
MainWindow, ProcessorGraph

Constructor & Destructor Documentation

AudioComponent::AudioComponent ( )

Constructor.

Finds the audio component (if there is one), and sets the default sample rate and buffer size.

AudioComponent::~AudioComponent ( )

Member Function Documentation

void AudioComponent::beginCallbacks ( )

Begins the audio callbacks that drive data acquisition.

void AudioComponent::endCallbacks ( )

Stops the audio callbacks that drive data acquisition.

void AudioComponent::connectToProcessorGraph ( AudioProcessorGraph *  processorGraph)

Connects the AudioComponent to the ProcessorGraph (crucial for any sort of

data acquisition; done at startup).

void AudioComponent::disconnectProcessorGraph ( )

Disconnects the AudioComponent to the ProcessorGraph (only done when the application

is about to close).

bool AudioComponent::callbacksAreActive ( )

Returns true if the audio callbacks are active, false otherwise.

void AudioComponent::restartDevice ( )

Restarts communication with the audio device in order to update settings

or just prior the start of data acquisition callbacks.

void AudioComponent::stopDevice ( )

Stops communication with the selected audio device (to conserve CPU load

when callbacks are not active).


Member Data Documentation

AudioDeviceManager AudioComponent::deviceManager

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