Firelight Technologies FMOD Studio API
Sound::getSyncPointInfo
Retrieves information on an embedded sync point. These points can be user generated or can come from a wav file with embedded markers.
C++ Syntax
FMOD_RESULT Sound::getSyncPointInfo(
FMOD_SYNCPOINT *point,
char *name,
int namelen,
unsigned int *offset,
FMOD_TIMEUNIT offsettype
);
C Syntax
FMOD_RESULT FMOD_Sound_GetSyncPointInfo(
FMOD_SOUND *sound,
FMOD_SYNCPOINT *point,
char *name,
int namelen,
unsigned int *offset,
FMOD_TIMEUNIT offsettype
);
C# Syntax
RESULT Sound.getSyncPointInfo(
IntPtr point,
StringBuilder name,
int namelen,
out uint offset,
TIMEUNIT offsettype
);
JavaScript Syntax
Sound.getSyncPointInfo(
);
Parameters
- point
- Pointer to a sync point. Use Sound::getSyncPoint to retrieve a syncpoint or Sound::addSyncPoint to create one.
- name
- Address of a variable to receive the name of the syncpoint. Optional. Specify 0 or NULL to ignore.
- namelen
- Size of buffer in bytes for name parameter. FMOD will only copy to this point if the string is bigger than the buffer passed in. Specify 0 to ignore name parameter.
- offset
- Address of a variable to receieve the offset of the syncpoint in a format determined by the offsettype parameter. Optional. Specify 0 or NULL to ignore.
- offsettype
- A timeunit parameter to determine a desired format for the offset parameter. For example the offset can be specified as pcm samples, or milliseconds.
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