FMOD_DSP_SETPOSITION_CALLBACK

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_DSP_SETPOSITION_CALLBACK

Callback that is called when the user sets the position of a channel with Channel::setPosition.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_SETPOSITION_CALLBACK(
  FMOD_DSP_STATE *dsp_state,
  unsigned int position
);

Parameters

dsp_state

Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data. Do not cast this to FMOD_DSP! The handle to the user created DSP handle is stored within the FMOD_DSP_STATE structure.

position

Position in channel stream to set to. Units are PCM samples (ie FMOD_TIMEUNIT_PCM).

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Functions that the user would have to call for this callback to be called.

If a DSP unit is attached to a channel and the user calls Channel::setPosition then this funciton will be called.

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also




Version 1.10.03 Built on Feb 1, 2018