FMediaIOAudioCapture | Unreal Engine 5.6 Documentation

Handles capturing audio samples rendered by the engine and dispatching them to outputs.


Name	FMediaIOAudioCapture
Type	class
Header File	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreAudioOutput.h
Include Path	#include "MediaIOCoreAudioOutput.h"

Syntax

class FMediaIOAudioCapture : public ISubmixBufferListener

Name	Remarks	Include Path	Unreal Specifiers
FMediaIOAudioCapture()		MediaIOCoreAudioOutput.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FMediaIOAudioCapture()		MediaIOCoreAudioOutput.h

Name	Remarks
FSubmixBufferListenerProxy	Implementation of ISubmixBufferListener.

Name	Type	Remarks	Include Path
FOnAudioCaptured	TBaseDelegate_TwoParams< void, float *, int32 >		MediaIOCoreAudioOutput.h

Name	Type	Remarks	Include Path
AudioCapturedDelegate	FOnAudioCaptured	Callback for a audio rendered event.	MediaIOCoreAudioOutput.h
AudioSplitter	Audio::FPatchSplitter	Utility that allows pushing audio samples to multiple outputs.	MediaIOCoreAudioOutput.h
NumChannels	int32	Number of channels on the engine side.	MediaIOCoreAudioOutput.h
PrimarySubmixName	FName	Used to make sure we only accumulate audio from the primary submix.	MediaIOCoreAudioOutput.h
RegisteredDeviceId	Audio::FDeviceId	Audio device Id this buffer listener is registered to.	MediaIOCoreAudioOutput.h
SampleRate	uint32	Sample rate on the engine side.	MediaIOCoreAudioOutput.h
SubmixBufferListenerProxy	TSharedPtr< ISubmixBufferListener >	We need to proxy the submit buffer listener to be able to unregister it in the destructor.	MediaIOCoreAudioOutput.h

Name	Remarks	Include Path
TSharedPtr< FMediaIOAudioOutput > CreateAudioOutput ( int32 InNumOutputChannels, FFrameRate InTargetFrameRate, uint32 InMaxSampleLatency, uint32 InOutputSampleRate )	Create an audio output that will receive audio samples.	MediaIOCoreAudioOutput.h
int32 GetNumInputChannels()	Returns the number of channels from the audio mixer device (engine side).	MediaIOCoreAudioOutput.h
void Initialize ( const FAudioDeviceHandle& InAudioDeviceHandle )		MediaIOCoreAudioOutput.h
void Initialize ( const FAudioDeviceHandle& InAudioDeviceHandle, const FOnAudioCaptured& InAudioCapturedDelegate )	Initializes audio capture for the given audio device The audio capture delegate can't be changed post Initialize.	MediaIOCoreAudioOutput.h
FOnAudioCaptured & OnAudioCaptured_RenderThread()		MediaIOCoreAudioOutput.h

Name	Remarks	Include Path	Unreal Specifiers
virtual const FString & GetListenerName()		MediaIOCoreAudioOutput.h
virtual void OnNewSubmixBuffer ( const USoundSubmix* InOwningSubmix, float* InAudioData, int32 InNumSamples, int32 InNumChannels, const int32 InSampleRate, double InAudioClock )		MediaIOCoreAudioOutput.h

Name	Remarks	Include Path
void RegisterAudioDevice ( const FAudioDeviceHandle& InAudioDeviceHandle )		MediaIOCoreAudioOutput.h
void RegisterBufferListener ( FAudioDevice* AudioDevice )		MediaIOCoreAudioOutput.h
void SetAudioCapturedDelegate ( const FOnAudioCaptured& InAudioCapturedDelegate )	This must be called in Initialize only, and before calling RegisterBufferListener.	MediaIOCoreAudioOutput.h
void UnregisterAudioDevice()		MediaIOCoreAudioOutput.h
void UnregisterBufferListener ( FAudioDevice* AudioDevice )		MediaIOCoreAudioOutput.h