NNS_SndArcPlayerSetup

Arguments

Return Values

Returns a boolean value to indicate if the setup is successful.

Description

Sets up the player based on the player settings defined with the sound archive. If not needed, it is possible to not call this function and simply use the initial settings as they are. It is also possible to modify the settings after calling this function.

The sound archive must first be initialized with NNS_SndArcInit or NNS_SndArcInitOnMemory.

The memory needed to create the player heap is allocated from the sound archive designated with heap. Enter a NULL when not creating the player heap. The function will fail if not enough memory can be allocated from the designated heap.

Inside the function, the NNS_SndPlayerSetPlayableSeqCount function, the NNS_SndPlayerSetAllocatableChannel function, and the NNS_SndPlayerCreateHeap function are called in accordance with the player information stored in the sound archive.