Firelight Technologies FMOD Studio API
Sound::addSyncPoint
Adds a sync point at a specific time within the sound. These points can be user generated or can come from a wav file with embedded markers.
C++ Syntax
FMOD_RESULT Sound::addSyncPoint(
unsigned int offset,
FMOD_TIMEUNIT offsettype,
const char *name,
FMOD_SYNCPOINT **point
);
C Syntax
FMOD_RESULT FMOD_Sound_AddSyncPoint(
FMOD_SOUND *sound,
unsigned int offset,
FMOD_TIMEUNIT offsettype,
const char *name,
FMOD_SYNCPOINT **point
);
C# Syntax
RESULT Sound.addSyncPoint(
uint offset,
TIMEUNIT offsettype,
string name,
out IntPtr point
);
JavaScript Syntax
Sound.addSyncPoint(
);
Parameters
- offset
- offset in units specified by offsettype to add the callback syncpoint for a sound.
- offsettype
- offset type to describe the offset provided. Could be PCM samples or milliseconds for example.
- name
- A name character string to be stored with the sync point. This will be provided via the sync point callback.
- point
- Address of a variable to store a pointer to the newly created syncpoint.
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.
JavaScript only :
This function is not currently supported
See Also
Version 1.10.03 Built on Feb 1, 2018