Firelight Technologies FMOD Studio API

Sound::unlock

Releases previous sample data lock from Sound::lock.

C++ Syntax

FMOD_RESULT Sound::unlock(
  void *ptr1,
  void *ptr2,
  unsigned int len1,
  unsigned int len2
);

C Syntax

FMOD_RESULT FMOD_Sound_Unlock(
  FMOD_SOUND *sound,
  void *ptr1,
  void *ptr2,
  unsigned int len1,
  unsigned int len2
);

C# Syntax

RESULT Sound.unlock(
  IntPtr ptr1,
  IntPtr ptr2,
  uint len1,
  uint len2
);

JavaScript Syntax

Sound.unlock(
  ptr1,                            
  ptr2,                            
  len1,                            
  len2                             
);

Parameters

ptr1

Pointer to the 1st locked portion of sample data, from Sound::lock.

ptr2

Pointer to the 2nd locked portion of sample data, from Sound::lock.

len1

Length of data in bytes that was locked for ptr1.

len2

Length of data in bytes that was locked for ptr2. This will be 0 if the data locked hasn't wrapped at the end of the buffer.

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.

See Also

• Sound::lock
• System::createSound

Version 1.10.03 Built on Feb 1, 2018