Sound::getNumSyncPoints

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::getNumSyncPoints

Retrieves the number of sync points stored within a sound. These points can be user generated or can come from a wav file with embedded markers.

C++ Syntax

FMOD_RESULT Sound::getNumSyncPoints(
  int *numsyncpoints
);

C Syntax

FMOD_RESULT FMOD_Sound_GetNumSyncPoints(
  FMOD_SOUND *sound,
  int *numsyncpoints
);

C# Syntax

RESULT Sound.getNumSyncPoints(
  out int numsyncpoints
);

JavaScript Syntax

Sound.getNumSyncPoints(
  numsyncpoints                    // writes value to numsyncpoints.val
);

Parameters

numsyncpoints
Address of a variable to receive the number of sync points within this sound.

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

In sound forge, a marker can be added a wave file by clicking on the timeline / ruler, and right clicking then selecting 'Insert Marker/Region'.
Riff wrapped mp3 files are also supported.

See Also




Version 1.10.03 Built on Feb 1, 2018