Audio::FWasapiAudioFormat Class Reference

#include <WasapiAudioFormat.h>

Public Member Functions
UE_API	FWasapiAudioFormat ()
UE_API	FWasapiAudioFormat (WAVEFORMATEX *InFormat)
UE_API	FWasapiAudioFormat (uint16 InChannels, uint32 InSampleRate, EWasapiAudioEncoding InEncoding)
UE_API EWasapiAudioEncoding	GetEncoding () const
UE_API uint32	GetNumChannels () const
UE_API uint32	GetSampleRate () const
UE_API uint32	GetBitsPerSample () const
UE_API uint32	GetBytesPerSample () const
UE_API uint32	GetFrameSizeInBytes () const
UE_API FString	GetEncodingString () const
UE_API const WAVEFORMATEX *	GetWaveFormat () const

Detailed Description

FWasapiAudioFormat - Wrapper class for Windows WAVEFORMATEX and WAVEFORMATEXTENSIBLE structs.

Constructor & Destructor Documentation

FWasapiAudioFormat() [1/3]

Audio::FWasapiAudioFormat::FWasapiAudioFormat

(

)

FWasapiAudioFormat - Constructs underlying WAVEFORMATEX with default values.

FWasapiAudioFormat() [2/3]

Audio::FWasapiAudioFormat::FWasapiAudioFormat ( WAVEFORMATEX *  InFormat )

explicit

FWasapiAudioFormat - Constructs underlying data structure with given WAVEFORMATEX parameter.

Parameters

InFormat

- Pointer to a WAVEFORMATEX struct from which to construct this object. Correctly handles the extended form, WAVEFORMATEXTENSIBLE.

FWasapiAudioFormat() [3/3]

Audio::FWasapiAudioFormat::FWasapiAudioFormat	(	uint16	InChannels,
		uint32	InSampleRate,
		EWasapiAudioEncoding	InEncoding
	)

FWasapiAudioFormat - Constructs underlying data structure using given parameters.

Parameters

InChannels	- Number of audio channels.
InSampleRate	- Samples per second (Hz).
InEncoding	- For PCM data, this is the bit depth of data (e.g. 16-bit integer, 32-bit float, etc.)

Member Function Documentation

GetBitsPerSample()

uint32 Audio::FWasapiAudioFormat::GetBitsPerSample

(

)

const

GetBitsPerSample - Returns the bit depth for the audio data as an integer value.

GetBytesPerSample()

uint32 Audio::FWasapiAudioFormat::GetBytesPerSample

(

)

const

GetBytesPerSample - Returns the number of bytes needed to store a single sample of audio data.

GetEncoding()

EWasapiAudioEncoding Audio::FWasapiAudioFormat::GetEncoding

(

)

const

GetEncoding - Returns the encoding for this audio format.

GetEncodingString()

FString Audio::FWasapiAudioFormat::GetEncodingString

(

)

const

GetEncodingString - Returns string form of encoding. Suitable for logging.

GetFrameSizeInBytes()

uint32 Audio::FWasapiAudioFormat::GetFrameSizeInBytes

(

)

const

GetFrameSizeInBytes - Returns the number of bytes needed to store a singe frame of audio data.

GetNumChannels()

uint32 Audio::FWasapiAudioFormat::GetNumChannels

(

)

const

GetNumChannels - Returns the number of audio channels present in this format.

GetSampleRate()

uint32 Audio::FWasapiAudioFormat::GetSampleRate

(

)

const

GetSampleRate - Returns the audio sample rate for this format.

GetWaveFormat()

const WAVEFORMATEX * Audio::FWasapiAudioFormat::GetWaveFormat

(

)

const

GetWaveFormat - Returns pointer to raw WAVEFORMATEX struct. Use this for specific OS API calls which require it. Otherwise use the accessors above.

---

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

• Engine/Source/Runtime/AudioPlatformSupport/Windows/WASAPI/Public/WasapiAudioFormat.h
• Engine/Source/Runtime/AudioPlatformSupport/Windows/WASAPI/Private/WasapiAudioFormat.cpp