nw::snd::SoundSystem::SoundSystemParam Structure

Header file: nw/snd/snd_SoundSystem.h

Syntax

struct SoundSystemParam
{
   s32 soundThreadPriority;
   s32 soundThreadCoreNo;
   size_t soundThreadStackSize;
   s32 taskThreadPriority;
   size_t taskThreadStackSize;
   bool autoCreateSoundThread;
   bool enableGetSoundThreadTick;
};

Description

Structure used to initialize the sound system.

Setting soundThreadCoreNo to 1 allows sound threads to be processed in the system core (Core 1).

If autoCreateSoundThread is set to false, the user must create threads used by sound thread on his or her own. Because the user is not permitted to create threads that run in the system core, the sound thread must be run in the application core (core 0) in such cases.

Member Constants

S DEFAULT_SOUND_THREAD_PRIORITY const s32 The default priority for sound threads.
S DEFAULT_TASK_THREAD_PRIORITY const s32 The default priority for threads that load sound data.
S DEFAULT_SOUND_THREAD_STACK_SIZE const u32 The default stack size for sound threads.
S DEFAULT_TASK_THREAD_STACK_SIZE const u32 The default stack size for threads that load sound data.

Member Variables

soundThreadPriority s32 Sound thread priority. The initial value is 4.
soundThreadCoreNo s32 The sound thread core number. The initial value is 0.
soundThreadStackSize size_t Size of the sound thread stack. Specify a value that is a multiple of 8. The default value is 16KB.
taskThreadPriority s32 Sound data load thread priority. The initial value is 3.
taskThreadStackSize size_t Stack size for threads that load sound data. Specify a value that is a multiple of 8. The default value is 16KB.
autoCreateSoundThread bool Flag indicating whether a sound thread is created automatically by Initialize. The initial value is true. If false, soundThreadStackSize, soundThreadPriority, and soundThreadCoreNo are ignored.
enableGetSoundThreadTick bool Flag indicating whether to measure the sound thread processing load. The initial value is true. If false, GetSoundThreadTickCount does not function normally.

Member Functions

SoundSystemParam Constructor.

See Also

SoundSystem Class

Revision History

2010/12/02
Added mention of the fact that soundThreadCoreNo is ignored to the description of autoCreateSoundThread.
2010/09/24
Added the members soundThreadCoreNo and enableGetSoundThreadTick
2010/01/29
Changed the types of member variables (from u32 to size_t) and names (from romThread*** to taskThread***).
2010/01/15
Initial version.

CONFIDENTIAL