Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QCoreAudioUtils Namespace Reference

Classes

struct  AudioUnitHandle
struct  AudioUnitHandleTraits
struct  QFreeDeleter

Functions

QAudioFormat toQAudioFormat (AudioStreamBasicDescription const &sf)
AudioStreamBasicDescription toAudioStreamBasicDescription (QAudioFormat const &audioFormat)
std::unique_ptr< AudioChannelLayout, QFreeDeletertoAudioChannelLayout (const QAudioFormat &format, UInt32 *size)
QAudioFormat::ChannelConfig fromAudioChannelLayout (const AudioChannelLayout *layout)
std::optional< AudioUnitHandlemakeAudioUnitForIO ()
bool audioUnitSetInputEnabled (AudioUnitHandle &audioUnit, bool enabled)
bool audioUnitSetOutputEnabled (AudioUnitHandle &audioUnit, bool enabled)
bool audioUnitSetInputStreamFormat (AudioUnitHandle &audioUnit, AudioUnitElement element, const AudioStreamBasicDescription &format)
bool audioUnitSetOutputStreamFormat (AudioUnitHandle &audioUnit, AudioUnitElement element, const AudioStreamBasicDescription &format)
bool audioUnitIsRunning (AudioUnitHandle &audioUnit)
bool audioUnitSetRenderCallback (AudioUnitHandle &audioUnit, AURenderCallbackStruct &callback)
std::optional< int > audioUnitGetFramesPerSlice (AudioUnitHandle &audioUnit)
std::optional< AudioStreamBasicDescription > audioUnitGetInputStreamFormat (AudioUnitHandle &audioUnit, AudioUnitElement element)
QStringView audioPropertySelectorToString (AudioObjectPropertySelector selector)
QStringView audioPropertyScopeToString (AudioObjectPropertyScope scope)
QStringView audioPropertyElementToString (AudioObjectPropertyElement element)
QByteArray readPersistentDeviceId (AudioDeviceID, QAudioDevice::Mode)
std::optional< AudioDeviceID > findAudioDeviceId (const QByteArray &id, QAudioDevice::Mode)
std::optional< AudioDeviceID > findAudioDeviceId (const QAudioDevice &device)
template<typename... Args>
void printUnableToReadWarning (AudioObjectID objectID, const AudioObjectPropertyAddress &address, Args &&...args)
AudioObjectPropertyAddress makePropertyAddress (AudioObjectPropertySelector selector, QAudioDevice::Mode mode, AudioObjectPropertyElement element=kAudioObjectPropertyElementMain)
bool getAudioPropertyRaw (AudioObjectID objectID, const AudioObjectPropertyAddress &address, QSpan< std::byte > destination, bool warnIfMissing=true)
template<typename T>
std::optional< std::vector< T > > getAudioPropertyList (AudioObjectID objectID, const AudioObjectPropertyAddress &address, bool warnIfMissing=true)
template<typename T>
std::optional< T > getAudioProperty (AudioObjectID objectID, const AudioObjectPropertyAddress &address, bool warnIfMissing=false)
template<typename T>
std::unique_ptr< T, QCoreAudioUtils::QFreeDeletergetAudioPropertyWithFlexibleArrayMember (AudioObjectID objectID, const AudioObjectPropertyAddress &address, bool warnIfMissing=false)

Variables

struct { 
   QAudioFormat::AudioChannelPosition   QCoreAudioUtils::pos 
   AudioChannelLabel   QCoreAudioUtils::label 
channelMap []
struct { 
   AudioChannelLayoutTag   QCoreAudioUtils::tag 
   QAudioFormat::ChannelConfig   QCoreAudioUtils::channelConfig 
layoutTagMap []

Function Documentation

◆ audioPropertyElementToString()

QStringView QCoreAudioUtils::audioPropertyElementToString ( AudioObjectPropertyElement element)

Definition at line 101 of file qmacosaudiodatautils.cpp.

◆ audioPropertyScopeToString()

QStringView QCoreAudioUtils::audioPropertyScopeToString ( AudioObjectPropertyScope scope)

Definition at line 88 of file qmacosaudiodatautils.cpp.

◆ audioPropertySelectorToString()

QStringView QCoreAudioUtils::audioPropertySelectorToString ( AudioObjectPropertySelector selector)

Definition at line 16 of file qmacosaudiodatautils.cpp.

◆ audioUnitGetFramesPerSlice()

std::optional< int > QCoreAudioUtils::audioUnitGetFramesPerSlice ( AudioUnitHandle & audioUnit)

Definition at line 517 of file qcoreaudioutils.cpp.

◆ audioUnitGetInputStreamFormat()

std::optional< AudioStreamBasicDescription > QCoreAudioUtils::audioUnitGetInputStreamFormat ( AudioUnitHandle & audioUnit,
AudioUnitElement element )

Definition at line 530 of file qcoreaudioutils.cpp.

◆ audioUnitIsRunning()

bool QCoreAudioUtils::audioUnitIsRunning ( AudioUnitHandle & audioUnit)

Definition at line 487 of file qcoreaudioutils.cpp.

◆ audioUnitSetInputEnabled()

bool QCoreAudioUtils::audioUnitSetInputEnabled ( AudioUnitHandle & audioUnit,
bool enabled )

Definition at line 344 of file qcoreaudioutils.cpp.

◆ audioUnitSetInputStreamFormat()

bool QCoreAudioUtils::audioUnitSetInputStreamFormat ( AudioUnitHandle & audioUnit,
AudioUnitElement element,
const AudioStreamBasicDescription & format )

Definition at line 382 of file qcoreaudioutils.cpp.

◆ audioUnitSetOutputEnabled()

bool QCoreAudioUtils::audioUnitSetOutputEnabled ( AudioUnitHandle & audioUnit,
bool enabled )

Definition at line 356 of file qcoreaudioutils.cpp.

◆ audioUnitSetOutputStreamFormat()

bool QCoreAudioUtils::audioUnitSetOutputStreamFormat ( AudioUnitHandle & audioUnit,
AudioUnitElement element,
const AudioStreamBasicDescription & format )

Definition at line 394 of file qcoreaudioutils.cpp.

◆ audioUnitSetRenderCallback()

bool QCoreAudioUtils::audioUnitSetRenderCallback ( AudioUnitHandle & audioUnit,
AURenderCallbackStruct & callback )

Definition at line 503 of file qcoreaudioutils.cpp.

◆ findAudioDeviceId() [1/2]

std::optional< AudioDeviceID > QCoreAudioUtils::findAudioDeviceId ( const QAudioDevice & device)
nodiscard

Definition at line 198 of file qmacosaudiodatautils.cpp.

◆ findAudioDeviceId() [2/2]

std::optional< AudioDeviceID > QCoreAudioUtils::findAudioDeviceId ( const QByteArray & id,
QAudioDevice::Mode mode )
nodiscard

Definition at line 164 of file qmacosaudiodatautils.cpp.

◆ fromAudioChannelLayout()

QAudioFormat::ChannelConfig QCoreAudioUtils::fromAudioChannelLayout ( const AudioChannelLayout * layout)

Definition at line 200 of file qcoreaudioutils.cpp.

◆ getAudioProperty()

template<typename T>
std::optional< T > QCoreAudioUtils::getAudioProperty ( AudioObjectID objectID,
const AudioObjectPropertyAddress & address,
bool warnIfMissing = false )

Definition at line 96 of file qmacosaudiodatautils_p.h.

◆ getAudioPropertyList()

template<typename T>
std::optional< std::vector< T > > QCoreAudioUtils::getAudioPropertyList ( AudioObjectID objectID,
const AudioObjectPropertyAddress & address,
bool warnIfMissing = true )

Definition at line 73 of file qmacosaudiodatautils_p.h.

◆ getAudioPropertyRaw()

bool QCoreAudioUtils::getAudioPropertyRaw ( AudioObjectID objectID,
const AudioObjectPropertyAddress & address,
QSpan< std::byte > destination,
bool warnIfMissing = true )
nodiscard

Definition at line 128 of file qmacosaudiodatautils.cpp.

◆ getAudioPropertyWithFlexibleArrayMember()

template<typename T>
std::unique_ptr< T, QCoreAudioUtils::QFreeDeleter > QCoreAudioUtils::getAudioPropertyWithFlexibleArrayMember ( AudioObjectID objectID,
const AudioObjectPropertyAddress & address,
bool warnIfMissing = false )

Definition at line 119 of file qmacosaudiodatautils_p.h.

◆ makeAudioUnitForIO()

std::optional< AudioUnitHandle > QCoreAudioUtils::makeAudioUnitForIO ( )

Definition at line 316 of file qcoreaudioutils.cpp.

◆ makePropertyAddress()

AudioObjectPropertyAddress QCoreAudioUtils::makePropertyAddress ( AudioObjectPropertySelector selector,
QAudioDevice::Mode mode,
AudioObjectPropertyElement element = kAudioObjectPropertyElementMain )
nodiscard

Definition at line 117 of file qmacosaudiodatautils.cpp.

◆ printUnableToReadWarning()

template<typename... Args>
void QCoreAudioUtils::printUnableToReadWarning ( AudioObjectID objectID,
const AudioObjectPropertyAddress & address,
Args &&... args )

Definition at line 50 of file qmacosaudiodatautils_p.h.

◆ readPersistentDeviceId()

QByteArray QCoreAudioUtils::readPersistentDeviceId ( AudioDeviceID device,
QAudioDevice::Mode mode )
nodiscard

Definition at line 149 of file qmacosaudiodatautils.cpp.

◆ toAudioChannelLayout()

std::unique_ptr< AudioChannelLayout, QFreeDeleter > QCoreAudioUtils::toAudioChannelLayout ( const QAudioFormat & format,
UInt32 * size )

Definition at line 113 of file qcoreaudioutils.cpp.

◆ toAudioStreamBasicDescription()

AudioStreamBasicDescription QCoreAudioUtils::toAudioStreamBasicDescription ( QAudioFormat const & audioFormat)

Definition at line 53 of file qcoreaudioutils.cpp.

◆ toQAudioFormat()

QAudioFormat QCoreAudioUtils::toQAudioFormat ( AudioStreamBasicDescription const & sf)

Definition at line 18 of file qcoreaudioutils.cpp.

Variable Documentation

◆ channelConfig

QAudioFormat::ChannelConfig QCoreAudioUtils::channelConfig

Definition at line 159 of file qcoreaudioutils.cpp.

◆ [struct]

constexpr struct { ... } QCoreAudioUtils::channelMap
Initial value:
= {
{ QAudioFormat::FrontLeft, kAudioChannelLabel_Left },
{ QAudioFormat::FrontRight, kAudioChannelLabel_Right },
{ QAudioFormat::FrontCenter, kAudioChannelLabel_Center },
{ QAudioFormat::LFE, kAudioChannelLabel_LFEScreen },
{ QAudioFormat::BackLeft, kAudioChannelLabel_LeftSurround },
{ QAudioFormat::BackRight, kAudioChannelLabel_RightSurround },
{ QAudioFormat::FrontLeftOfCenter, kAudioChannelLabel_LeftCenter },
{ QAudioFormat::FrontRightOfCenter, kAudioChannelLabel_RightCenter },
{ QAudioFormat::BackCenter, kAudioChannelLabel_CenterSurround },
{ QAudioFormat::LFE2, kAudioChannelLabel_LFE2 },
{ QAudioFormat::SideLeft, kAudioChannelLabel_LeftSurroundDirect },
{ QAudioFormat::SideRight, kAudioChannelLabel_RightSurroundDirect },
{ QAudioFormat::TopFrontLeft, kAudioChannelLabel_VerticalHeightLeft },
{ QAudioFormat::TopFrontRight, kAudioChannelLabel_VerticalHeightRight },
{ QAudioFormat::TopFrontCenter, kAudioChannelLabel_VerticalHeightCenter },
{ QAudioFormat::TopCenter, kAudioChannelLabel_CenterTopMiddle },
{ QAudioFormat::TopBackLeft, kAudioChannelLabel_TopBackLeft },
{ QAudioFormat::TopBackRight, kAudioChannelLabel_TopBackRight },
{ QAudioFormat::TopSideLeft, kAudioChannelLabel_LeftTopMiddle },
{ QAudioFormat::TopSideRight, kAudioChannelLabel_RightTopMiddle },
{ QAudioFormat::TopBackCenter, kAudioChannelLabel_TopBackCenter },
}

◆ label

AudioChannelLabel QCoreAudioUtils::label

Definition at line 87 of file qcoreaudioutils.cpp.

◆ [struct]

constexpr struct { ... } QCoreAudioUtils::layoutTagMap

◆ pos

QAudioFormat::AudioChannelPosition QCoreAudioUtils::pos

Definition at line 86 of file qcoreaudioutils.cpp.

◆ tag

AudioChannelLayoutTag QCoreAudioUtils::tag

Definition at line 158 of file qcoreaudioutils.cpp.