nw::snd::SoundDataManager::LoadData Member Function

Syntax

bool LoadData(
     SoundArchive::ItemId id,
     SoundMemoryAllocatable * pAllocator,
     u32 loadFlag = LOAD_ALL,
     size_t loadBlockSize = 0
);

Arguments

Name Description
in id Item ID of the data to load.
in pAllocator Allocator that allocates memory for loading data.
in loadFlag Flag used to load related data.
in loadBlockSize Block size (in bytes) when data is loaded in blocks.

Return Values

Returns true if data was loaded successfully and false otherwise.

Description

Loads the data in a sound archive.

The memory required to load data is allocated by pAllocater. Returns FALSE if sufficient memory cannot be allocated.

This function synchronously loads sound data. When loading sound data asynchronously, call this function from a thread used for loading. This function is thread-safe as long as no operations are performed while loading on the associated sound archive or on the sound heap passed as an argument.

See Also

IsDataLoaded

Revision History

2010/12/17
Removed Initialize and IsAvailable from See Also, and added IsDataLoaded.
2010/09/06
Adjusted argument names in line with support for specifying loadBlockSize.
2010/04/09
Made minor revisions to the wording (changed "group" to "sound data"), and added IsDataLoaded to See Also.
2010/01/15
Initial version.

CONFIDENTIAL