Choose your operating system:
Windows
macOS
Linux
|
Module |
|
|
Header |
/Engine/Source/Runtime/Engine/Public/Audio.h |
|
Include |
#include "Audio.h" |
class FSoundSource
| Name | Description | ||
|---|---|---|---|
|
|
FAudioDevice &#... |
AudioDevice |
Owning audio device. |
|
|
uint8: 1 |
bInitialized |
Whether or not the sound source is initialized. |
|
|
uint8: 1 |
bIsManuallyPaused |
Whether or not we were paused manually. |
|
|
uint8: 1 |
bIsPausedByGame |
Whether we are paused by game state or not. |
|
|
uint8: 1 |
bIsPreviewSound |
Whether or not the sound is a preview sound. |
|
|
uint32: 1 |
bIsVirtual |
True if this isn't a real hardware voice |
|
|
uint8: 1 |
bReverbApplied |
Cached sound mode value used to detect when to switch outputs. |
|
|
FSoundBuffer &#... |
Buffer |
Cached sound buffer associated with currently bound wave instance. |
|
|
TSharedPtr< FDe... |
DebugInfo |
|
|
|
float |
HPFFrequency |
What frequency to set the HPF filter to. this could be caused by HPF distance attenuation. |
|
|
LastHeardUpdate |
Last tick when this source was active and had a hearable volume |
|
|
|
float |
LastHPFFrequency |
The last HPF frequency set. Used to avoid making API calls when parameter doesn't changing. |
|
|
float |
LastLPFFrequency |
The last LPF frequency set. Used to avoid making API calls when parameter doesn't changing. |
|
|
LastUpdate |
Last tick when this source was active |
|
|
|
LeftChannelSourceLocation |
The location of the left-channel source for stereo spatialization. |
|
|
|
float |
LFEBleed |
The amount of a sound to bleed to the LFE speaker |
|
|
float |
LPFFrequency |
What frequency to set the LPF filter to. |
|
|
NumFramesPlayed |
The number of frames (Samples / NumChannels) played by the sound source. |
|
|
|
NumTotalFrames |
The total number of frames of audio for the sound wave |
|
|
|
uint8: 1 |
Paused |
Whether or not we are actually paused. |
|
|
float |
Pitch |
The pitch of the sound source. |
|
|
float |
PlaybackTime |
The virtual current playback time. Used to trigger notifications when finished. |
|
|
Playing |
Whether we are playing or not. |
|
|
|
RightChannelSourceLocation |
The location of the right-channel source for stereo spatialization. |
|
|
|
StartFrame |
The frame we started on. |
|
|
|
TickCount |
Update tick count. Used to stop oldest stopping sound source. |
|
|
|
VoiceId |
Effect ID of this sound source in the audio device sound source array. |
|
|
|
FWaveInstance &... |
WaveInstance |
Contained wave instance. |
| Name | Description | |
|---|---|---|
|
|
FSoundSource ( |
Constructor |
| Name | Description | |
|---|---|---|
|
|
~FSoundSource() |
Destructor |
| Name | Description | ||
|---|---|---|---|
|
|
Describe ( |
Returns a string describing the source (subclass can override, but it should call the base and append). |
|
|
|
const FSound... |
GetBuffer() |
Returns the contained sound buffer object. |
|
|
GetChannelLocations |
||
|
|
float |
GetDebugVolume ( |
Returns the volume of the sound source after evaluating debug commands |
|
|
float |
GetEnvelopeValue() |
Returns the source's envelope at the callback block rate. Only implemented in audio mixer. |
|
|
float |
GetPlaybackPercent() |
Returns the source's playback percent. |
|
|
FSpatializat... |
GetSpatializationParams() |
Gets parameters necessary for computing 3d spatialization of sources. |
|
|
const FWaveI... |
GetWaveInstance() |
Returns the wave instance of the sound source. |
|
|
Init ( |
Initializes the sound source. |
|
|
|
InitCommon() |
Initializes common data for all sound source types. |
|
|
|
InitializeSourceEffects ( |
Initializes any source effects for this sound source. |
|
|
|
IsFinished() |
Returns true if the sound source has finished playing. |
|
|
|
IsGameOnly() |
Returns source is an in-game only. Will pause when in UI. |
|
|
|
IsInitialized() |
Returns whether or not the sound source has initialized. |
|
|
|
IsPaused() |
Returns true if the sound is paused. |
|
|
|
IsPausedByGame() |
Returns true if the sound is paused. |
|
|
|
IsPausedManually() |
||
|
|
IsPlaying() |
Returns whether or not the sound source is playing. |
|
|
|
IsPreparedToInit() |
Returns if the source voice is prepared to initialize. |
|
|
|
IsReverbApplied() |
Returns true if reverb should be applied. |
|
|
|
IsStopping() |
Whether or not the source is stopping. Only implemented in audio mixer. |
|
|
|
NotifyPlaybackData() |
||
|
|
Pause() |
Pauses the sound source. |
|
|
|
Play() |
Plays the sound source. |
|
|
|
PrepareForInitialization ( |
Prepares the source voice for initialization. |
|
|
|
SetFilterFrequency() |
Updates the FilterFrequency value. |
|
|
|
float |
SetLFEBleed() |
Updates and sets the LFEBleed variable. |
|
|
SetPauseByGame ( |
Pause the source from game pause |
|
|
|
SetPauseManually ( |
Pause the source manually |
|
|
|
SetReverbApplied ( |
Set the bReverbApplied variable. |
|
|
|
SetVirtual() |
Sets if this voice is virtual. |
|
|
|
Stop() |
Stops the sound source. |
|
|
|
StopNow() |
||
|
|
Update() |
Updates the sound source. |
|
|
|
UpdateCommon() |
Updates common data for all sound source types. |
|
|
|
UpdatePause() |
Updates this source's pause state |
|
|
|
UpdateStereoEmitterPositions() |
Updates the stereo emitter positions of this voice. |
|
Name |
Description |
|
|---|---|---|
|
|
FDebugInfo |
Struct containing the debug state of a SoundSource |
