nw::snd::SoundArchivePlayer::SetSequenceUserprocCallback Member Function

#include <nw/snd/snd_SoundArchivePlayer.h>

void SetSequenceUserprocCallback(
     SequenceUserprocCallback callback,
     void* callbackArg
);

	Name	Description
in	callback	The callback function to be registered.
in	callbackArg	User argument passed to the callback function.

None.

Registers the callback function invoked by the userproc sequence command.

The callback registered here is invoked for frames in which the sequence data's userproc sequence command is processed. The callback function is called from the sound thread.

For details on the userproc command, see the Sequence Data Manual.

The callback function set here is called from the sound thread. If exclusive control is required, you will need to use the SoundThreadScopedLock class or the LockSoundThread / UnlockSoundThread functions.

The callback function must quickly finish processing. If processing is prolonged, there is a high probability of noise being generated. It may take time for processing to complete if an API function that might block (a critical section, for example) is called inside the callback function.

SequenceUserprocCallback

2011/01/11

Added mention that callback function is called from sound thread.

2010/01/15

Initial version.