UTakeRecorderMicrophoneAudioManager

This class exposes the audio input device list via the project settings details.

API > API/Plugins > API/Plugins/TakeRecorderSources

This class exposes the audio input device list via the project settings details. It does this in conjunction with FAudioInputDevicePropertyCustomization. It also manages the IAudioCaptureEditor object which handles the low level audio device recording.

   
Name UTakeRecorderMicrophoneAudioManager
Type class
Header File /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorderSources/Public/TakeRecorderMicrophoneAudioManager.h
Include Path #include "TakeRecorderMicrophoneAudioManager.h"

Syntax

UCLASS (MinimalAPI, Config=EditorPerProjectUserSettings, PerObjectConfig,  
       DisplayName="Audio Input Device")  
class UTakeRecorderMicrophoneAudioManager : public UTakeRecorderAudioInputSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTakeRecorderMicrophoneAudioManager ( const FObjectInitializer& ObjInit
)

   TakeRecorderMicrophoneAudioManager.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Category   The audio device to use for this microphone source TakeRecorderMicrophoneAudioManager.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintGetter=GetAudioInputDevice
  • BlueprintSetter=SetAudioInputDevice
  • Category="Take Recorder|Microphone Audio"
  • Meta=(ShowOnlyInnerProperties)
meta     TakeRecorderMicrophoneAudioManager.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintGetter=GetAudioInputDevice
  • BlueprintSetter=SetAudioInputDevice
  • Category="Take Recorder|Microphone Audio"
  • Meta=(ShowOnlyInnerProperties)
OnAudioInputDevicePropertyChanged FOnAudioInputDevicePropertyChanged Fires after AudioInputDevice is modified — via editor edit or SetAudioInputDevice. TakeRecorderMicrophoneAudioManager.h
  • BlueprintAssignable
  • Category="Take Recorder|Microphone Audio"

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioRecorder TUniquePtr< IAudioCaptureEditor > The audio recorder object which manages low level recording of audio data TakeRecorderMicrophoneAudioManager.h  
OnNotifySourcesOfDeviceChange FOnNotifySourcesOfDeviceChange Multicast delegate which notifies clients when the currently selected audio device changes. TakeRecorderMicrophoneAudioManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Calls FinalizeRecording on the AudioRecorder object. TakeRecorderMicrophoneAudioManager.h  

FAudioInputDeviceProperty GetAudioInputDevice()

 Returns the currently configured audio input device settings (device id, buffer size, default-device flag, cached device list). TakeRecorderMicrophoneAudioManager.h
  • BlueprintPure
  • Category="Take Recorder|Microphone Audio"

FOnNotifySourcesOfDeviceChange & GetOnNotifySourcesOfDeviceChange()

 Accessor for the OnNotifySourcesOfDeviceChange delegate list TakeRecorderMicrophoneAudioManager.h  

TObjectPtr< class USoundWave > GetRecordedSoundWave ( const FTakeRecorderAudioSourceSettings& InSourceSettings
)

 Fetches the USoundWave for this source after a Take has been recorded TakeRecorderMicrophoneAudioManager.h  

void SetAudioInputDevice ( const FAudioInputDeviceProperty& InAudioInputDevice
)

 Sets the audio input device settings and notifies dependents — broadcasts OnNotifySourcesOfDeviceChange (so every microphone source re-evaluates its channel) and OnAudioInputDeviceChanged (so UI customizations refresh). TakeRecorderMicrophoneAudioManager.h
  • BlueprintCallable
  • Category="Take Recorder|Microphone Audio"

void StartRecording ( int32 InChannelCount
)

 Calls StartRecording on the AudioRecorder object. TakeRecorderMicrophoneAudioManager.h  

void StopRecording ()

 Calls StopRecording on the AudioRecorder object. TakeRecorderMicrophoneAudioManager.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void EnumerateAudioDevices ( bool InForceRefresh
)

 Enumerates the audio devices present on the current machine TakeRecorderMicrophoneAudioManager.h
  • BlueprintCallable
  • Category="Take Recorder|Microphone Audio"

virtual int32 GetDeviceChannelCount()

 Returns input channel count for currently selected audio device TakeRecorderMicrophoneAudioManager.h
  • BlueprintPure
  • Category="Take Recorder|Microphone Audio"

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   TakeRecorderMicrophoneAudioManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page