openshot-audio  0.1.4
Classes | Public Member Functions | List of all members
iOSAudioIODevice Class Reference
Inheritance diagram for iOSAudioIODevice:
AudioIODevice

Public Member Functions

 iOSAudioIODevice (const String &deviceName)
 
 ~iOSAudioIODevice ()
 
StringArray getOutputChannelNames () override
 
StringArray getInputChannelNames () override
 
Array< double > getAvailableSampleRates () override
 
Array< int > getAvailableBufferSizes () override
 
int getDefaultBufferSize () override
 
String open (const BigInteger &inputChannelsWanted, const BigInteger &outputChannelsWanted, double targetSampleRate, int bufferSize) override
 
void close () override
 
bool isOpen () override
 
int getCurrentBufferSizeSamples () override
 
double getCurrentSampleRate () override
 
int getCurrentBitDepth () override
 
BigInteger getActiveOutputChannels () const override
 
BigInteger getActiveInputChannels () const override
 
int getOutputLatencyInSamples () override
 
int getInputLatencyInSamples () override
 
int getLatency (AudioSessionPropertyID propID)
 
void start (AudioIODeviceCallback *newCallback) override
 
void stop () override
 
bool isPlaying () override
 
String getLastError () override
 
bool setAudioPreprocessingEnabled (bool enable) override
 
- Public Member Functions inherited from AudioIODevice
virtual ~AudioIODevice ()
 
const StringgetName () const noexcept
 
const StringgetTypeName () const noexcept
 
virtual bool hasControlPanel () const
 
virtual bool showControlPanel ()
 

Additional Inherited Members

- Protected Member Functions inherited from AudioIODevice
 AudioIODevice (const String &deviceName, const String &typeName)
 
- Protected Attributes inherited from AudioIODevice
String name
 
String typeName
 

Constructor & Destructor Documentation

◆ iOSAudioIODevice()

iOSAudioIODevice::iOSAudioIODevice ( const String deviceName)
inline

◆ ~iOSAudioIODevice()

iOSAudioIODevice::~iOSAudioIODevice ( )
inline

Member Function Documentation

◆ close()

void iOSAudioIODevice::close ( )
inlineoverridevirtual

Closes and releases the device if it's open.

Implements AudioIODevice.

◆ getActiveInputChannels()

BigInteger iOSAudioIODevice::getActiveInputChannels ( ) const
inlineoverridevirtual

Returns a mask showing which of the available input channels are currently enabled.

See also
getInputChannelNames

Implements AudioIODevice.

◆ getActiveOutputChannels()

BigInteger iOSAudioIODevice::getActiveOutputChannels ( ) const
inlineoverridevirtual

Returns a mask showing which of the available output channels are currently enabled.

See also
getOutputChannelNames

Implements AudioIODevice.

◆ getAvailableBufferSizes()

Array<int> iOSAudioIODevice::getAvailableBufferSizes ( )
inlineoverridevirtual

Returns the set of buffer sizes that are available.

See also
getCurrentBufferSizeSamples, getDefaultBufferSize

Implements AudioIODevice.

◆ getAvailableSampleRates()

Array<double> iOSAudioIODevice::getAvailableSampleRates ( )
inlineoverridevirtual

Returns the set of sample-rates this device supports.

See also
getCurrentSampleRate

Implements AudioIODevice.

◆ getCurrentBitDepth()

int iOSAudioIODevice::getCurrentBitDepth ( )
inlineoverridevirtual

Returns the device's current physical bit-depth.

If the device isn't actually open, this value doesn't really mean much.

Implements AudioIODevice.

◆ getCurrentBufferSizeSamples()

int iOSAudioIODevice::getCurrentBufferSizeSamples ( )
inlineoverridevirtual

Returns the buffer size that the device is currently using.

If the device isn't actually open, this value doesn't really mean much.

Implements AudioIODevice.

◆ getCurrentSampleRate()

double iOSAudioIODevice::getCurrentSampleRate ( )
inlineoverridevirtual

Returns the sample rate that the device is currently using.

If the device isn't actually open, this value doesn't really mean much.

Implements AudioIODevice.

◆ getDefaultBufferSize()

int iOSAudioIODevice::getDefaultBufferSize ( )
inlineoverridevirtual

Returns the default buffer-size to use.

Returns
a number of samples
See also
getAvailableBufferSizes

Implements AudioIODevice.

◆ getInputChannelNames()

StringArray iOSAudioIODevice::getInputChannelNames ( )
inlineoverridevirtual

Returns the names of all the available input channels on this device. To find out which of these are currently in use, call getActiveInputChannels().

Implements AudioIODevice.

◆ getInputLatencyInSamples()

int iOSAudioIODevice::getInputLatencyInSamples ( )
inlineoverridevirtual

Returns the device's input latency.

This is the delay in samples between some audio actually arriving at the soundcard, and the callback getting passed this block of data.

Implements AudioIODevice.

◆ getLastError()

String iOSAudioIODevice::getLastError ( )
inlineoverridevirtual

Returns the last error that happened if anything went wrong.

Implements AudioIODevice.

◆ getLatency()

int iOSAudioIODevice::getLatency ( AudioSessionPropertyID  propID)
inline

◆ getOutputChannelNames()

StringArray iOSAudioIODevice::getOutputChannelNames ( )
inlineoverridevirtual

Returns the names of all the available output channels on this device. To find out which of these are currently in use, call getActiveOutputChannels().

Implements AudioIODevice.

◆ getOutputLatencyInSamples()

int iOSAudioIODevice::getOutputLatencyInSamples ( )
inlineoverridevirtual

Returns the device's output latency.

This is the delay in samples between a callback getting a block of data, and that data actually getting played.

Implements AudioIODevice.

◆ isOpen()

bool iOSAudioIODevice::isOpen ( )
inlineoverridevirtual

Returns true if the device is still open.

A device might spontaneously close itself if something goes wrong, so this checks if it's still open.

Implements AudioIODevice.

◆ isPlaying()

bool iOSAudioIODevice::isPlaying ( )
inlineoverridevirtual

Returns true if the device is still calling back.

The device might mysteriously stop, so this checks whether it's still playing.

Implements AudioIODevice.

◆ open()

String iOSAudioIODevice::open ( const BigInteger inputChannels,
const BigInteger outputChannels,
double  sampleRate,
int  bufferSizeSamples 
)
inlineoverridevirtual

Tries to open the device ready to play.

Parameters
inputChannelsa BigInteger in which a set bit indicates that the corresponding input channel should be enabled
outputChannelsa BigInteger in which a set bit indicates that the corresponding output channel should be enabled
sampleRatethe sample rate to try to use - to find out which rates are available, see getAvailableSampleRates()
bufferSizeSamplesthe size of i/o buffer to use - to find out the available buffer sizes, see getAvailableBufferSizes()
Returns
an error description if there's a problem, or an empty string if it succeeds in opening the device
See also
close

Implements AudioIODevice.

◆ setAudioPreprocessingEnabled()

bool iOSAudioIODevice::setAudioPreprocessingEnabled ( bool  shouldBeEnabled)
inlineoverridevirtual

On devices which support it, this allows automatic gain control or other mic processing to be disabled. If the device doesn't support this operation, it'll return false.

Reimplemented from AudioIODevice.

◆ start()

void iOSAudioIODevice::start ( AudioIODeviceCallback callback)
inlineoverridevirtual

Starts the device actually playing.

This must be called after the device has been opened.

Parameters
callbackthe callback to use for streaming the data.
See also
AudioIODeviceCallback, open

Implements AudioIODevice.

◆ stop()

void iOSAudioIODevice::stop ( )
inlineoverridevirtual

Stops the device playing.

Once a device has been started, this will stop it. Any pending calls to the callback class will be flushed before this method returns.

Implements AudioIODevice.


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