FIOSAudioSoundBuffer Class Reference

#include <IOSAudioDevice.h>

Inheritance diagram for FIOSAudioSoundBuffer:

Public Member Functions
	FIOSAudioSoundBuffer (FIOSAudioDevice *InAudioDevice, USoundWave *InWave, bool InStreaming, bool InProcedural)
virtual	~FIOSAudioSoundBuffer (void)
virtual int32	GetSize (void) override
virtual int32	GetCurrentChunkIndex () const override
virtual int32	GetCurrentChunkOffset () const override
virtual bool	ReadCompressedInfo (USoundWave *SoundWave) override
virtual bool	ReadCompressedData (uint8 *Destination, int32 NumFramesToDecode, bool bLooping) override
bool	ReleaseCurrentChunk ()
Public Member Functions inherited from FSoundBuffer
	FSoundBuffer (class FAudioDevice *InAudioDevice)
virtual ENGINE_API	~FSoundBuffer ()
virtual ENGINE_API FString	Describe (bool bUseLongName)
FName	GetSoundClassName ()
FString	GetChannelsDesc ()
virtual void	Seek (const float SeekTime)
virtual bool	IsRealTimeSourceReady ()
virtual void	EnsureRealtimeTaskCompletion ()

Static Public Member Functions
static FIOSAudioSoundBuffer *	Init (FIOSAudioDevice *IOSAudioDevice, USoundWave *InWave)

Public Attributes
int32	RenderCallbackBufferSize
int32	SampleRate
int32	SoundFormat
int16 *	SampleData
uint32	BufferSize
ICompressedAudioInfo *	DecompressionState
bool	bStreaming
bool	bIsProcedural
Public Attributes inherited from FSoundBuffer
virtual int32	GetSize () PURE_VIRTUAL(FSoundBuffer
int32	ResourceID
int32	NumChannels
FString	ResourceName
bool	bAllocationInPermanentPool
class FAudioDevice *	AudioDevice

Detailed Description

IOSAudio implementation of FSoundBuffer, containing the wave data and format information.

Constructor & Destructor Documentation

FIOSAudioSoundBuffer()

FIOSAudioSoundBuffer::FIOSAudioSoundBuffer	(	FIOSAudioDevice *	InAudioDevice,
		USoundWave *	InWave,
		bool	InStreaming,
		bool	InProcedural
	)

~FIOSAudioSoundBuffer()

FIOSAudioSoundBuffer::~FIOSAudioSoundBuffer ( void  )

virtual

Member Function Documentation

GetCurrentChunkIndex()

int32 FIOSAudioSoundBuffer::GetCurrentChunkIndex ( ) const

overridevirtual

Gets the chunk index that was last read from (for Streaming Manager requests)

Reimplemented from FSoundBuffer.

GetCurrentChunkOffset()

int32 FIOSAudioSoundBuffer::GetCurrentChunkOffset ( ) const

overridevirtual

Gets the offset into the chunk that was last read to (for Streaming Manager priority)

Reimplemented from FSoundBuffer.

GetSize()

int32 FIOSAudioSoundBuffer::GetSize ( void  )

overridevirtual

Returns the size of this buffer in bytes.

Returns

Size in bytes

Init()

FIOSAudioSoundBuffer * FIOSAudioSoundBuffer::Init ( FIOSAudioDevice *  IOSAudioDevice, USoundWave *  InWave  )

static

Static function used to create a buffer.

Parameters

InWave	USoundWave to use as template and wave source
AudioDevice	audio device to attach created buffer to

Returns

FIOSAudioSoundBuffer pointer if buffer creation succeeded, NULL otherwise

ReadCompressedData()

bool FIOSAudioSoundBuffer::ReadCompressedData ( uint8 *  Destination, int32  NumFramesToDecode, bool  bLooping  )

overridevirtual

Decompresses a chunk of compressed audio to the destination memory

Parameters

Destination	Memory to decompress to
bLooping	Whether to loop the sound seamlessly, or pad with zeroes

Returns

Whether the sound looped or not

Reimplemented from FSoundBuffer.

ReadCompressedInfo()

bool FIOSAudioSoundBuffer::ReadCompressedInfo ( USoundWave *  SoundWave )

overridevirtual

Read the compressed info (i.e. parse header and open up a file handle) from the given sound wave.

Reimplemented from FSoundBuffer.

ReleaseCurrentChunk()

bool FIOSAudioSoundBuffer::ReleaseCurrentChunk

(

)

Member Data Documentation

bIsProcedural

bool FIOSAudioSoundBuffer::bIsProcedural

bStreaming

bool FIOSAudioSoundBuffer::bStreaming

BufferSize

uint32 FIOSAudioSoundBuffer::BufferSize

DecompressionState

ICompressedAudioInfo* FIOSAudioSoundBuffer::DecompressionState

Wrapper to assist in the bookkeeping of uncompressed data when streaming

RenderCallbackBufferSize

int32 FIOSAudioSoundBuffer::RenderCallbackBufferSize

SampleData

int16* FIOSAudioSoundBuffer::SampleData

SampleRate

int32 FIOSAudioSoundBuffer::SampleRate

SoundFormat

int32 FIOSAudioSoundBuffer::SoundFormat

---

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/IOSAudioBuffer.cpp