Firelight Technologies FMOD Studio API

Sound::getNumTags

Retrieves the number of tags belonging to a sound.

C++ Syntax

FMOD_RESULT Sound::getNumTags(
  int *numtags,
  int *numtagsupdated
);

C Syntax

FMOD_RESULT FMOD_Sound_GetNumTags(
  FMOD_SOUND *sound,
  int *numtags,
  int *numtagsupdated
);

C# Syntax

RESULT Sound.getNumTags(
  out int numtags,
  out int numtagsupdated
);

JavaScript Syntax

Sound.getNumTags(
  numtags,                         // writes value to numtags.val
  numtagsupdated                   // writes value to numtagsupdated.val
);

Parameters

numtags

Address of a variable that receives the number of tags in the sound. Optional. Specify 0 or NULL to ignore.

numtagsupdated

Address of a variable that receives the number of tags updated since this function was last called. Optional. Specify 0 or NULL to ignore.

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

The 'numtagsupdated' parameter can be used to check if any tags have been updated since last calling this function.
This can be useful to update tag fields, for example from internet based streams, such as shoutcast or icecast where the name of the song might change.

See Also

• Sound::getTag

Version 1.10.03 Built on Feb 1, 2018