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
QtMultimediaPrivate Namespace Reference

Namespaces

namespace  Impl
namespace  QMediaMetaDataNamespaceForeign
namespace  QAudioDeviceNamespaceForeign
namespace  QCameraDeviceNamespaceForeign
namespace  QMediaFormatNamespaceForeign
namespace  QPlaybackOptionsNamespaceForeign
namespace  pmr
namespace  ranges

Classes

struct  GetSampleTypeImpl
struct  GetSampleTypeImpl< float >
struct  GetSampleTypeImpl< int32_t >
struct  GetSampleTypeImpl< int16_t >
struct  GetSampleTypeImpl< uint8_t >
struct  GetSampleTypeImpl< AudioSinkCallbackType< T > >
struct  GetSampleTypeImpl< AudioSourceCallbackType< T > >
class  QPlatformAudioIOStream
class  QPlatformAudioSinkStream
class  QPlatformAudioSourceStream
struct  QTlsfMemoryResource
class  QRtAudioEngineVoice
struct  QRtAudioEngineVoiceCompare
class  QRtAudioEngine
class  QSoundEffectVoice
class  QSoundEffectPrivateWithPlayer
class  PropertyStoreHelper
class  SleepTimeoutMonitor
struct  QMediaCaptureSessionForeign
struct  QCameraForeign
struct  QImageCaptureForeign
struct  QScreenCaptureForeign
struct  QMediaRecorderForeign
struct  QMediaMetaDataForeign
struct  QMediaMetaDataDerived
struct  QMediaDevicesForeign
struct  QAudioInputForeign
struct  QAudioOutputForeign
struct  QAudioDeviceForeign
struct  QAudioDeviceDerived
struct  QCameraDeviceForeign
struct  QCameraDeviceDerived
struct  QMediaFormatForeign
struct  QMediaFormatDerived
struct  QCameraFormatForeign
struct  QCapturableWindowForeign
struct  QWindowCaptureForeign
class  QPlaybackOptionsDerived
class  QPlatformAudioSinkImplementation
class  QPlatformAudioSourceImplementation
class  QPlatformAudioSourceImplementationWithCallback
struct  EnumName
struct  StringResolver

Typedefs

template<typename SampleTypeOrCallbackType>
using GetSampleType = typename GetSampleTypeImpl<SampleTypeOrCallbackType>::type
using AudioSinkCallback = QtAudioPrivate::AudioSinkCallback
using AudioSourceCallback = QtAudioPrivate::AudioSourceCallback
template<typename F>
using visitor_arg_t = typename Impl::visitor_arg<F>::type
template<typename SampleType>
using AudioSinkCallbackType
template<typename SampleType>
using AudioSourceCallbackType
using QAutoResetEvent

Enumerations

enum class  AudioEndpointRole : uint8_t { MediaPlayback , SoundEffect , Accessibility , Other }
enum class  VoiceId : uint64_t
enum class  VoicePlayResult : uint8_t { Playing , Finished }

Functions

template<typename SampleTypeOrCallbackType>
static constexpr QAudioFormat::SampleFormat getSampleFormat ()
template<typename Callback>
AudioSinkCallback asAudioSinkCallback (Callback &&cb)
template<typename Callback>
AudioSourceCallback asAudioSourceCallback (Callback &&cb)
template<typename AnyAudioCallback>
constexpr bool validateAudioCallbackImpl (const AnyAudioCallback &audioCallback, const QAudioFormat &format)
constexpr bool validateAudioCallback (const AudioSinkCallback &audioCallback, const QAudioFormat &format)
constexpr bool validateAudioCallback (const AudioSourceCallback &audioCallback, const QAudioFormat &format)
template<size_t limit = 1024 * 64, typename Functor>
auto withTemporaryBuffer (size_t bufferSize, Functor &&f) noexcept QT_MM_NONBLOCKING
template<bool IsSink>
void runAudioCallback (std::conditional_t< IsSink, AudioSinkCallback, AudioSourceCallback > &audioCallback, QSpan< std::conditional_t< IsSink, std::byte, const std::byte > > hostBuffer, const QAudioFormat &format)
void runAudioCallback (AudioSinkCallback &audioCallback, QSpan< std::byte > hostBuffer, const QAudioFormat &format, float volume)
void runAudioCallback (AudioSinkCallback &audioCallback, QSpan< std::byte > hostBuffer, const QAudioFormat &applicationFormat, float volume, const QAudioFormat &hostFormat)
void runAudioCallback (AudioSourceCallback &audioCallback, QSpan< const std::byte > hostBuffer, const QAudioFormat &format, float volume)
void runAudioCallback (AudioSourceCallback &audioCallback, QSpan< std::byte > hostBuffer, const QAudioFormat &format, float volume)
template<typename HostBufferType>
void runAudioCallback (AudioSourceCallback &audioCallback, QSpan< HostBufferType > hostBuffer, const QAudioFormat &applicationFormat, float volume, const QAudioFormat &hostFormat)
 DEFINE_GUID (GUID_SLEEP_TIMEOUT, 0x29f6c1db, 0x86da, 0x48c5, 0x9f, 0xdb, 0xf2, 0xb6, 0x7b, 0x1f, 0x44, 0xda)
void refreshWarmupClient ()
template<typename IntType>
constexpr bool isPowerOfTwo (IntType arg)
template<typename Type>
constexpr Type alignUp (Type arg, size_t alignment)
template<typename Type>
constexpr Type alignDown (Type arg, size_t alignment)
template<typename IntType>
constexpr bool isAligned (IntType arg, size_t alignment)
template<typename U>
QSpan< U > drop (QSpan< U > span, qsizetype n)
template<typename U>
QSpan< U > take (QSpan< U > span, qsizetype n)
template<typename T>
int findClosestSamplingRate (int rate, QSpan< const T > supportedRates)

Variables

static constexpr qsizetype scratchpadBufferSizeLimit = 512 * 1024
constexpr std::array allSupportedSampleRates
constexpr std::array allSupportedSampleFormats

Typedef Documentation

◆ AudioSinkCallback

◆ AudioSinkCallbackType

template<typename SampleType>
using QtAudioPrivate::AudioSinkCallbackType

Definition at line 25 of file qtaudio.h.

◆ AudioSourceCallback

◆ AudioSourceCallbackType

template<typename SampleType>
using QtAudioPrivate::AudioSourceCallbackType

Definition at line 28 of file qtaudio.h.

◆ GetSampleType

template<typename SampleTypeOrCallbackType>
using QtMultimediaPrivate::GetSampleType = typename GetSampleTypeImpl<SampleTypeOrCallbackType>::type

Definition at line 154 of file qaudiosystem_p.h.

◆ QAutoResetEvent

Definition at line 54 of file qautoresetevent_p.h.

◆ visitor_arg_t

template<typename F>
using QtMultimediaPrivate::visitor_arg_t = typename Impl::visitor_arg<F>::type

Definition at line 131 of file qrtaudioengine_p.h.

Enumeration Type Documentation

◆ AudioEndpointRole

enum class QtMultimediaPrivate::AudioEndpointRole : uint8_t
strong
Enumerator
MediaPlayback 
SoundEffect 
Accessibility 
Other 

Definition at line 89 of file qaudiosystem_p.h.

◆ VoiceId

enum class QtMultimediaPrivate::VoiceId : uint64_t
strong

Definition at line 42 of file qrtaudioengine_p.h.

◆ VoicePlayResult

enum class QtMultimediaPrivate::VoicePlayResult : uint8_t
strong
Enumerator
Playing 
Finished 

Definition at line 46 of file qrtaudioengine_p.h.

Function Documentation

◆ alignDown()

template<typename Type>
Type QtMultimediaPrivate::alignDown ( Type arg,
size_t alignment )
constexpr

Definition at line 42 of file qaudio_alignment_support_p.h.

◆ alignUp()

template<typename Type>
Type QtMultimediaPrivate::alignUp ( Type arg,
size_t alignment )
constexpr

Definition at line 31 of file qaudio_alignment_support_p.h.

◆ asAudioSinkCallback()

template<typename Callback>
AudioSinkCallback QtMultimediaPrivate::asAudioSinkCallback ( Callback && cb)
inline

Definition at line 173 of file qaudiosystem_p.h.

◆ asAudioSourceCallback()

template<typename Callback>
AudioSourceCallback QtMultimediaPrivate::asAudioSourceCallback ( Callback && cb)
inline

Definition at line 184 of file qaudiosystem_p.h.

◆ DEFINE_GUID()

QtMultimediaPrivate::DEFINE_GUID ( GUID_SLEEP_TIMEOUT ,
0x29f6c1db ,
0x86da ,
0x48c5 ,
0x9f ,
0xdb ,
0xf2 ,
0xb6 ,
0x7b ,
0x1f ,
0x44 ,
0xda  )

◆ drop()

template<typename U>
QSpan< U > QtMultimediaPrivate::drop ( QSpan< U > span,
qsizetype n )
inline

Definition at line 27 of file qaudio_qspan_support_p.h.

◆ findClosestSamplingRate()

template<typename T>
int QtMultimediaPrivate::findClosestSamplingRate ( int rate,
QSpan< const T > supportedRates )

Definition at line 40 of file qaudioformat_p.h.

◆ getSampleFormat()

template<typename SampleTypeOrCallbackType>
constexpr QAudioFormat::SampleFormat QtMultimediaPrivate::getSampleFormat ( )
staticconstexpr

Definition at line 157 of file qaudiosystem_p.h.

◆ isAligned()

template<typename IntType>
bool QtMultimediaPrivate::isAligned ( IntType arg,
size_t alignment )
constexpr

Definition at line 53 of file qaudio_alignment_support_p.h.

◆ isPowerOfTwo()

template<typename IntType>
bool QtMultimediaPrivate::isPowerOfTwo ( IntType arg)
inlineconstexpr

Definition at line 25 of file qaudio_alignment_support_p.h.

◆ refreshWarmupClient()

void QtMultimediaPrivate::refreshWarmupClient ( )

Definition at line 288 of file qwindows_wasapi_warmup_client.cpp.

◆ runAudioCallback() [1/6]

void QtMultimediaPrivate::runAudioCallback ( AudioSinkCallback & audioCallback,
QSpan< std::byte > hostBuffer,
const QAudioFormat & applicationFormat,
float volume,
const QAudioFormat & hostFormat )
inline

Definition at line 295 of file qaudiosystem_p.h.

◆ runAudioCallback() [2/6]

void QtMultimediaPrivate::runAudioCallback ( AudioSinkCallback & audioCallback,
QSpan< std::byte > hostBuffer,
const QAudioFormat & format,
float volume )
inline

Definition at line 288 of file qaudiosystem_p.h.

◆ runAudioCallback() [3/6]

void QtMultimediaPrivate::runAudioCallback ( AudioSourceCallback & audioCallback,
QSpan< const std::byte > hostBuffer,
const QAudioFormat & format,
float volume )
inline

Definition at line 313 of file qaudiosystem_p.h.

◆ runAudioCallback() [4/6]

template<typename HostBufferType>
void QtMultimediaPrivate::runAudioCallback ( AudioSourceCallback & audioCallback,
QSpan< HostBufferType > hostBuffer,
const QAudioFormat & applicationFormat,
float volume,
const QAudioFormat & hostFormat )
inline

Definition at line 334 of file qaudiosystem_p.h.

◆ runAudioCallback() [5/6]

void QtMultimediaPrivate::runAudioCallback ( AudioSourceCallback & audioCallback,
QSpan< std::byte > hostBuffer,
const QAudioFormat & format,
float volume )
inline

Definition at line 326 of file qaudiosystem_p.h.

◆ runAudioCallback() [6/6]

template<bool IsSink>
void QtMultimediaPrivate::runAudioCallback ( std::conditional_t< IsSink, AudioSinkCallback, AudioSourceCallback > & audioCallback,
QSpan< std::conditional_t< IsSink, std::byte, const std::byte > > hostBuffer,
const QAudioFormat & format )
inline

Definition at line 259 of file qaudiosystem_p.h.

◆ take()

template<typename U>
QSpan< U > QtMultimediaPrivate::take ( QSpan< U > span,
qsizetype n )
inline

Definition at line 36 of file qaudio_qspan_support_p.h.

◆ validateAudioCallback() [1/2]

bool QtMultimediaPrivate::validateAudioCallback ( const AudioSinkCallback & audioCallback,
const QAudioFormat & format )
constexpr

Definition at line 213 of file qaudiosystem_p.h.

◆ validateAudioCallback() [2/2]

bool QtMultimediaPrivate::validateAudioCallback ( const AudioSourceCallback & audioCallback,
const QAudioFormat & format )
constexpr

Definition at line 219 of file qaudiosystem_p.h.

◆ validateAudioCallbackImpl()

template<typename AnyAudioCallback>
bool QtMultimediaPrivate::validateAudioCallbackImpl ( const AnyAudioCallback & audioCallback,
const QAudioFormat & format )
constexpr

Definition at line 196 of file qaudiosystem_p.h.

◆ withTemporaryBuffer()

template<size_t limit = 1024 * 64, typename Functor>
auto QtMultimediaPrivate::withTemporaryBuffer ( size_t bufferSize,
Functor && f )
inlinenoexcept

Definition at line 229 of file qaudiosystem_p.h.

Variable Documentation

◆ allSupportedSampleFormats

std::array QtMultimediaPrivate::allSupportedSampleFormats
inlineconstexpr

◆ allSupportedSampleRates

std::array QtMultimediaPrivate::allSupportedSampleRates
inlineconstexpr
Initial value:
{
8'000, 11'025, 12'000, 16'000, 22'050, 24'000, 32'000, 44'100,
48'000, 64'000, 88'200, 96'000, 128'000, 176'400, 192'000,
}

Definition at line 27 of file qaudioformat_p.h.

◆ scratchpadBufferSizeLimit

constexpr qsizetype QtMultimediaPrivate::scratchpadBufferSizeLimit = 512 * 1024
staticconstexpr

Definition at line 297 of file qaudiosystem_platform_stream_support.cpp.