tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
tracktion::engine::HostedAudioDeviceInterface Class Reference

The HostedAudioDeviceInterface allows an application or plugin to pass audio and midi buffers to the engine, rather than the engine directly opening the audio devices. More...

#include "tracktion_HostedAudioDevice.h"

Classes

struct  Parameters
 Holds the parameters being used by an HostedAudioDeviceInterface. More...
 

Public Member Functions

 HostedAudioDeviceInterface (Engine &)
 
void initialise (const Parameters &)
 
void prepareToPlay (double sampleRate, int blockSize)
 
void processBlock (juce::AudioBuffer< float > &buffer, juce::MidiBuffer &)
 

Static Public Member Functions

static bool isHostedMidiInputDevice (const MidiInputDevice &)
 Returns true if the MidiInput device is a HostedMidiInputDevice.
 

Friends

class HostedAudioDevice
 
class HostedAudioDeviceType
 
class HostedMidiInputDevice
 
class HostedMidiOutputDevice
 

Detailed Description

The HostedAudioDeviceInterface allows an application or plugin to pass audio and midi buffers to the engine, rather than the engine directly opening the audio devices.

This may be required for plugins or applications that run multiple copies of the engine.

Don't create this class directly, it can be optained from the DeviceManager via getHostedAudioDeviceInterface()

Definition at line 25 of file tracktion_HostedAudioDevice.h.


Class Documentation

◆ tracktion::engine::HostedAudioDeviceInterface::Parameters

struct tracktion::engine::HostedAudioDeviceInterface::Parameters

Holds the parameters being used by an HostedAudioDeviceInterface.

Definition at line 32 of file tracktion_HostedAudioDevice.h.

Class Members
int blockSize Expected block size.

This can be changed later with prepareToPlay

int inputChannels Number of audio input channels.
StringArray inputNames Names of your audio channels.

If left empty, names will automatically be generated

int outputChannels Number of audio output channels.
StringArray outputNames
double sampleRate Expected sample rate.

This can be changed later with prepareToPlay

bool useMidiDevices If true, the system midi devices will be avaliable to the engine, if false, just a single midi input and output will be avaliable, which will be fed from the midi buffer provided to processBlock.

Constructor & Destructor Documentation

◆ HostedAudioDeviceInterface()

tracktion::engine::HostedAudioDeviceInterface::HostedAudioDeviceInterface ( Engine e)

Definition at line 320 of file tracktion_HostedAudioDevice.cpp.

Member Function Documentation

◆ initialise()

void tracktion::engine::HostedAudioDeviceInterface::initialise ( const Parameters p)

Definition at line 325 of file tracktion_HostedAudioDevice.cpp.

◆ isHostedMidiInputDevice()

bool tracktion::engine::HostedAudioDeviceInterface::isHostedMidiInputDevice ( const MidiInputDevice d)
static

Returns true if the MidiInput device is a HostedMidiInputDevice.

Definition at line 401 of file tracktion_HostedAudioDevice.cpp.

◆ prepareToPlay()

void tracktion::engine::HostedAudioDeviceInterface::prepareToPlay ( double  sampleRate,
int  blockSize 
)

Definition at line 367 of file tracktion_HostedAudioDevice.cpp.

◆ processBlock()

void tracktion::engine::HostedAudioDeviceInterface::processBlock ( juce::AudioBuffer< float > &  buffer,
juce::MidiBuffer midi 
)

Definition at line 385 of file tracktion_HostedAudioDevice.cpp.

Friends And Related Symbol Documentation

◆ HostedAudioDevice

friend class HostedAudioDevice
friend

Definition at line 68 of file tracktion_HostedAudioDevice.h.

◆ HostedAudioDeviceType

friend class HostedAudioDeviceType
friend

Definition at line 69 of file tracktion_HostedAudioDevice.h.

◆ HostedMidiInputDevice

friend class HostedMidiInputDevice
friend

Definition at line 70 of file tracktion_HostedAudioDevice.h.

◆ HostedMidiOutputDevice

friend class HostedMidiOutputDevice
friend

Definition at line 71 of file tracktion_HostedAudioDevice.h.


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