Sound::getSyncPoint

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::getSyncPoint

Retrieve a handle to a sync point. These points can be user generated or can come from a wav file with embedded markers.

C++ Syntax

FMOD_RESULT Sound::getSyncPoint(
  int index,
  FMOD_SYNCPOINT **point
);

C Syntax

FMOD_RESULT FMOD_Sound_GetSyncPoint(
  FMOD_SOUND *sound,
  int index,
  FMOD_SYNCPOINT **point
);

C# Syntax

RESULT Sound.getSyncPoint(
  int index,
  out IntPtr point
);

JavaScript Syntax

Sound.getSyncPoint(
);

Parameters

index
Index of the sync point to retrieve. Use Sound::getNumSyncPoints to determine the number of syncpoints.
point
Address of a variable to receive a pointer to a sync point.

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