UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RtAudioWrapper.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
6
7class RtAudio; // Forward declare;
8
9namespace Audio
10{
11 // FRtAudioInputWrapper wraps RtAudio implementation and provides a way to
12 // capture input audio from an hardware audio device.
13 class AUDIOCAPTURERTAUDIO_API UE_DEPRECATED(5.3, "FRtAudioInputWrapper is deprecated, please use FAudioCapture instead.") FRtAudioInputWrapper
14 {
15 public:
16 static constexpr uint32 InvalidDeviceID = INDEX_NONE;
17
18 // Callback function for receiving audio from RtAudio
19 using FAudioCallback = int (*)(void *OutputBuffer, void *InputBuffer, unsigned int NumFrames, double StreamTime, uint32 StreamStatus, void *UserData);
20
21 // Parameters used for opening streams
23 {
24 uint32 DeviceID = 0;
25 uint32 NumChannels = 0;
26 };
27
28 // Parameters describing audio input device.
29 struct FDeviceInfo
30 {
31 float PreferredSampleRate = 0.f;
32 uint32 NumChannels = 0;
33 };
34
36
37 // Returns ID of default input device
38 uint32 GetDefaultInputDevice();
39
40 // Returns info about device.
41 FDeviceInfo GetDeviceInfo(uint32 InDeviceID);
42
43 // Opens an audio stream. Returns true on success, false on error.
45
46 // Returns true if the stream is open.
47 bool IsStreamOpen();
48
49 // Starts an open stream
50 void StartStream();
51
52 // Stops stream, discarding any remaining samples
53 void AbortStream();
54
55 // Stops stream, allowing any remaining samples to be played.
56 void StopStream();
57
58 // Close stream and free associated memory.
59 void CloseStream();
60
61 private:
62
64 };
65}
66
@ INDEX_NONE
Definition CoreMiscDefines.h:150
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
char const * InputBuffer
Definition binka_ue_decode_test.cpp:29
uint32_t uint32
Definition binka_ue_file_header.h:6
NO_LOGGING.
Definition AudioMixerPlatformAndroid.cpp:53
uint32 DeviceID
Definition IAudioParameterTransmitter.h:18
Definition ExpressionParserTypes.h:21
Definition WasapiDeviceEnumeration.h:33
Definition PimplPtr.h:50