FIOSAudioSoundSource Class Reference

#include <IOSAudioDevice.h>

Inheritance diagram for FIOSAudioSoundSource:

Public Member Functions
	FIOSAudioSoundSource (FIOSAudioDevice *InAudioDevice, uint32 InBusNumber)
	~FIOSAudioSoundSource (void)
virtual bool	Init (FWaveInstance *WaveInstance) override
virtual void	Update (void) override
virtual void	Play (void) override
virtual void	Stop (void) override
virtual void	Pause (void) override
virtual bool	IsFinished (void) override
AudioUnitElement	GetAudioUnitElement (int32 Channel)
Public Member Functions inherited from FSoundSource
	FSoundSource (FAudioDevice *InAudioDevice)
virtual ENGINE_API	~FSoundSource ()
virtual bool	PrepareForInitialization (FWaveInstance *InWaveInstance)
virtual bool	IsPreparedToInit ()
virtual bool	IsInitialized () const
virtual void	StopNow ()
virtual bool	IsStopping ()
void	SetPauseByGame (bool bInIsPauseByGame)
void	SetPauseManually (bool bInIsPauseManually)
virtual ENGINE_API FString	Describe (bool bUseLongName)
bool	IsGameOnly () const
const FWaveInstance *	GetWaveInstance () const
bool	IsPlaying () const
bool	IsPaused () const
bool	IsPausedByGame () const
bool	IsPausedManually () const
bool	IsReverbApplied () const
ENGINE_API bool	SetReverbApplied (bool bHardwareAvailable)
ENGINE_API float	SetLFEBleed ()
ENGINE_API void	SetFilterFrequency ()
ENGINE_API void	UpdateStereoEmitterPositions ()
ENGINE_API FSpatializationParams	GetSpatializationParams ()
virtual const FSoundBuffer *	GetBuffer () const
int32	GetNumChannels () const
virtual void	InitializeSourceEffects (uint32 InEffectVoiceId)
void	SetVirtual ()
virtual ENGINE_API float	GetPlaybackPercent () const
virtual ENGINE_API float	GetSourceSampleRate () const
virtual ENGINE_API int64	GetNumFramesPlayed () const
virtual ENGINE_API int32	GetNumTotalFrames () const
virtual ENGINE_API int32	GetStartFrame () const
virtual float	GetEnvelopeValue () const
virtual float	GetRelativeRenderCost () const
ENGINE_API void	GetChannelLocations (FVector &Left, FVector &Right) const
void	NotifyPlaybackData ()

Public Attributes
TArray< Audio::FOnePoleLPF >	LowpassFilterBank
TArray< Audio::FParam >	LPFParamBank
int32	SampleRate
float	SourceLPFFrequency

Protected Member Functions
bool	AttachToAUGraph ()
bool	DetachFromAUGraph ()
Protected Member Functions inherited from FSoundSource
ENGINE_API void	InitCommon ()
ENGINE_API void	UpdateCommon ()
void	UpdatePause ()
ENGINE_API float	GetDebugVolume (const float InVolume)

Protected Attributes
FIOSAudioDevice *	IOSAudioDevice
FIOSAudioSoundBuffer *	IOSBuffer
uint32	BusNumber
int32	CallbackLock
bool	bChannel0Finished
bool	bAllChannelsFinished
Protected Attributes inherited from FSoundSource
FAudioDevice *	AudioDevice
FWaveInstance *	WaveInstance
FSoundBuffer *	Buffer
float	LFEBleed
float	LPFFrequency
float	HPFFrequency
float	LastLPFFrequency =MAX_FILTER_FREQUENCY
float	LastHPFFrequency =MIN_FILTER_FREQUENCY
float	PlaybackTime
float	Pitch
int32	LastUpdate
int32	LastHeardUpdate
int32	TickCount
FVector	LeftChannelSourceLocation
FVector	RightChannelSourceLocation
int32	NumFramesPlayed
int32	NumTotalFrames
int32	StartFrame
int32	NumChannels = 0
uint32	VoiceId
FThreadSafeBool	Playing
uint8	bReverbApplied: 1
uint8	bIsPausedByGame: 1
uint8	bIsManuallyPaused: 1
uint8	Paused: 1
uint8	bInitialized: 1
uint8	bIsPreviewSound: 1
uint32	bIsVirtual: 1

Friends
class	FIOSAudioDevice

Detailed Description

IOSAudio implementation of FSoundSource, the interface used to play, stop and update sources

Constructor & Destructor Documentation

FIOSAudioSoundSource()

FIOSAudioSoundSource::FIOSAudioSoundSource	(	FIOSAudioDevice *	InAudioDevice,
		uint32	InBusNumber
	)

Constructor

Parameters

InAudioDevice

audio device this source is attached to

~FIOSAudioSoundSource()

FIOSAudioSoundSource::~FIOSAudioSoundSource

(

void

)

Destructor

Member Function Documentation

AttachToAUGraph()

bool FIOSAudioSoundSource::AttachToAUGraph ( )

protected

DetachFromAUGraph()

bool FIOSAudioSoundSource::DetachFromAUGraph ( )

protected

GetAudioUnitElement()

AudioUnitElement FIOSAudioSoundSource::GetAudioUnitElement

(

int32

Channel

)

Calculates the audio unit element of the input channel relative to the base bus number

Init()

bool FIOSAudioSoundSource::Init ( FWaveInstance *  WaveInstance )

overridevirtual

Initializes a source with a given wave instance and prepares it for playback.

Parameters

WaveInstance

wave instance being primed for playback

Returns

true if initialization was successful, false otherwise

Implements FSoundSource.

IsFinished()

bool FIOSAudioSoundSource::IsFinished ( void  )

overridevirtual

Queries the status of the currently associated wave instance.

Returns

true if the wave instance/ source has finished playback and false if it is currently playing or paused.

Implements FSoundSource.

Pause()

void FIOSAudioSoundSource::Pause ( void  )

overridevirtual

Pauses playback of current wave instance.

Implements FSoundSource.

Play()

void FIOSAudioSoundSource::Play ( void  )

overridevirtual

Plays the current wave instance.

Implements FSoundSource.

Stop()

void FIOSAudioSoundSource::Stop ( void  )

overridevirtual

Stops the current wave instance and detaches it from the source.

Reimplemented from FSoundSource.

Update()

void FIOSAudioSoundSource::Update ( void  )

overridevirtual

Updates the source specific parameter like e.g. volume and pitch based on the associated wave instance.

Implements FSoundSource.

Friends And Related Symbol Documentation

FIOSAudioDevice

friend class FIOSAudioDevice

friend

Member Data Documentation

bAllChannelsFinished

bool FIOSAudioSoundSource::bAllChannelsFinished

protected

bChannel0Finished

bool FIOSAudioSoundSource::bChannel0Finished

protected

BusNumber

uint32 FIOSAudioSoundSource::BusNumber

protected

CallbackLock

int32 FIOSAudioSoundSource::CallbackLock

protected

IOSAudioDevice

FIOSAudioDevice* FIOSAudioSoundSource::IOSAudioDevice

protected

IOSBuffer

FIOSAudioSoundBuffer* FIOSAudioSoundSource::IOSBuffer

protected

Cached sound buffer associated with currently bound wave instance. Do not shadow the declaration of Buffer in the parent class since that member gets used by the streaming engine

LowpassFilterBank

TArray<Audio::FOnePoleLPF> FIOSAudioSoundSource::LowpassFilterBank

LPFParamBank

TArray<Audio::FParam> FIOSAudioSoundSource::LPFParamBank

SampleRate

int32 FIOSAudioSoundSource::SampleRate

SourceLPFFrequency

float FIOSAudioSoundSource::SourceLPFFrequency

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/IOS/IOSAudio/Public/IOSAudioDevice.h
• Engine/Source/Runtime/IOS/IOSAudio/Private/IOSAudioSource.cpp