1. Epic GamesDeveloper
  3. UTakeRecorderMicrophoneAudioSource

UTakeRecorderMicrophoneAudioSource

A recording source that records microphone audio

API > API/Plugins > API/Plugins/TakeRecorderSources

A recording source that records microphone audio

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

Syntax

UCLASS (MinimalAPI, Category="Audio", Config=EditorSettings)  
class UTakeRecorderMicrophoneAudioSource : public UTakeRecorderMicrophoneAudioSourceSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTakeRecorderMicrophoneAudioSource ( const FObjectInitializer& ObjInit
)

   TakeRecorderMicrophoneAudioSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioChannel FAudioInputDeviceChannelProperty The audio device to use for this microphone source TakeRecorderMicrophoneAudioSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Source"
  • Meta=(ShowOnlyInnerProperties)
AudioGain float Gain in decibels to apply to recorded audio TakeRecorderMicrophoneAudioSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Source"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="20.0", ClampMax="40.0")
bReplaceRecordedAudio bool Replace existing recorded audio with any newly recorded audio TakeRecorderMicrophoneAudioSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Source"

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetFileName FString The name of the UsoundWave asset. TakeRecorderMicrophoneAudioSource.h  
AudioDirectory FDirectoryPath The user specified directory to store recorded audio assets in. TakeRecorderMicrophoneAudioSource.h  
bHaveDoneAudioSetup bool Have we initialized our source. TakeRecorderMicrophoneAudioSource.h  
CachedAudioTrack TWeakObjectPtr< class UMovieSceneAudioTrack > Holds the Sequencer audio track for this source. TakeRecorderMicrophoneAudioSource.h  
RecordedSoundWave TWeakObjectPtr< USoundWave > Holds the USoundWave asset for a given take. TakeRecorderMicrophoneAudioSource.h  
StartTimecode FTimecode Caches the starting timecode for this take so it can be referenced when creating USoundWave assets. TakeRecorderMicrophoneAudioSource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddContentsToFolder ( UMovieSceneFolder* InFolder
)

   TakeRecorderMicrophoneAudioSource.h  

virtual bool CanAddSource ( UTakeRecorderSources* InSources
) const

   TakeRecorderMicrophoneAudioSource.h  

virtual void FinalizeRecording()

   TakeRecorderMicrophoneAudioSource.h  

virtual FText GetAddSourceDisplayTextImpl()

   TakeRecorderMicrophoneAudioSource.h  

FString GetAudioAssetName ( ULevelSequence* InSequence
) const

 Returns the fully expanded asset name TakeRecorderMicrophoneAudioSource.h  

FString GetAudioTrackName ( ULevelSequence* InSequence
) const

 Returns track display name, replacing any tokens if needed TakeRecorderMicrophoneAudioSource.h  

virtual FText GetDisplayTextImpl()

   TakeRecorderMicrophoneAudioSource.h  

virtual void Initialize()

 UTakeRecorderSource. TakeRecorderMicrophoneAudioSource.h  

void OnNotifySourcesOfDeviceChange ( int32 InChannelCount
)

 Delegate which receives notifications when the audio input device changes. TakeRecorderMicrophoneAudioSource.h  

virtual TArray< UTakeRecorderSource * > PostRecording ( ULevelSequence* InSequence,
ULevelSequence* InRootSequence,
const bool bCancelled
)

   TakeRecorderMicrophoneAudioSource.h  

virtual TArray< UTakeRecorderSource * > PreRecording ( ULevelSequence* InSequence,
FMovieSceneSequenceID InSequenceID,
ULevelSequence* InRootSequence,
FManifestSerializer* InManifestSerializer
)

   TakeRecorderMicrophoneAudioSource.h  

void SetAudioDeviceChannelCount ( int32 InChannelCount
)

 Sets the channel count supported by the currently selected audio device. TakeRecorderMicrophoneAudioSource.h  

virtual void StartRecording ( const FTimecode& InSectionStartTimecode,
const FFrameNumber& InSectionFirstFrame,
ULevelSequence* InSequence
)

   TakeRecorderMicrophoneAudioSource.h  

virtual void StopRecording ( ULevelSequence* InSequence
)

   TakeRecorderMicrophoneAudioSource.h  

virtual void TickRecording ( const FQualifiedFrameTime& CurrentTime
)

   TakeRecorderMicrophoneAudioSource.h  

Overridden from UTakeRecorderMicrophoneAudioSourceSettings

Name Remarks Include Path Unreal Specifiers

virtual FString GetSubsceneAssetName ( ULevelSequence* InSequence
) const

   TakeRecorderMicrophoneAudioSource.h  

virtual FString GetSubsceneTrackName ( ULevelSequence* InSequence
) const

   TakeRecorderMicrophoneAudioSource.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   TakeRecorderMicrophoneAudioSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString CreateUniqueAudioAssetName ( ULevelSequence* InSequence,
UTakeRecorderSources* InSources,
const FString& InAssetName,
const int32 InChannelNumber
)

 Static, parameterized helper function for buidling unique asset names TakeRecorderMicrophoneAudioSource.h  

static UTakeRecorderMicrophoneAudioManager * GetAudioInputManager()

 Helper function for getting a pointer to the AudioInputManger object. TakeRecorderMicrophoneAudioSource.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bSplitAudioChannelsIntoSeparateTracks_DEPRECATED bool Whether or not to split mic channels into separate audio tracks. TakeRecorderMicrophoneAudioSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="SplitAudioChannelsIntoSeparateTracks is deprecated.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page