openshot-audio  0.1.2
Public Member Functions | Public Attributes | List of all members
juce::AudioDeviceManager::AudioDeviceSetup Struct Reference

#include <juce_audio_devices.h>

Public Member Functions

 AudioDeviceSetup ()
 
bool operator== (const AudioDeviceSetup &other) const
 

Public Attributes

String outputDeviceName
 
String inputDeviceName
 
double sampleRate
 
int bufferSize
 
BigInteger inputChannels
 
bool useDefaultInputChannels
 
BigInteger outputChannels
 
bool useDefaultOutputChannels
 

Detailed Description

This structure holds a set of properties describing the current audio setup.

An AudioDeviceManager uses this class to save/load its current settings, and to specify your preferred options when opening a device.

See also
AudioDeviceManager::setAudioDeviceSetup(), AudioDeviceManager::initialise()

Constructor & Destructor Documentation

◆ AudioDeviceSetup()

AudioDeviceManager::AudioDeviceSetup::AudioDeviceSetup ( )

Creates an AudioDeviceSetup object.

The default constructor sets all the member variables to indicate default values. You can then fill-in any values you want to before passing the object to AudioDeviceManager::initialise().

Member Function Documentation

◆ operator==()

bool AudioDeviceManager::AudioDeviceSetup::operator== ( const AudioDeviceSetup other) const

Member Data Documentation

◆ bufferSize

int juce::AudioDeviceManager::AudioDeviceSetup::bufferSize

The buffer size, in samples. This buffer size is used for both the input and output devices. A value of 0 indicates the default buffer size.

◆ inputChannels

BigInteger juce::AudioDeviceManager::AudioDeviceSetup::inputChannels

The set of active input channels. The bits that are set in this array indicate the channels of the input device that are active. If useDefaultInputChannels is true, this value is ignored.

◆ inputDeviceName

String juce::AudioDeviceManager::AudioDeviceSetup::inputDeviceName

The name of the audio device used for input. This may be the same as the output device. An empty string indicates the default device.

◆ outputChannels

BigInteger juce::AudioDeviceManager::AudioDeviceSetup::outputChannels

The set of active output channels. The bits that are set in this array indicate the channels of the input device that are active. If useDefaultOutputChannels is true, this value is ignored.

◆ outputDeviceName

String juce::AudioDeviceManager::AudioDeviceSetup::outputDeviceName

The name of the audio device used for output. The name has to be one of the ones listed by the AudioDeviceManager's currently selected device type. This may be the same as the input device. An empty string indicates the default device.

◆ sampleRate

double juce::AudioDeviceManager::AudioDeviceSetup::sampleRate

The current sample rate. This rate is used for both the input and output devices. A value of 0 indicates that you don't care what rate is used, and the device will choose a sensible rate for you.

◆ useDefaultInputChannels

bool juce::AudioDeviceManager::AudioDeviceSetup::useDefaultInputChannels

If this is true, it indicates that the inputChannels array should be ignored, and instead, the device's default channels should be used.

◆ useDefaultOutputChannels

bool juce::AudioDeviceManager::AudioDeviceSetup::useDefaultOutputChannels

If this is true, it indicates that the outputChannels array should be ignored, and instead, the device's default channels should be used.


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