FMOD_CODEC_METADATA_CALLBACK

FMOD Studio API

previous page next page

Firelight Technologies FMOD Studio API

FMOD_CODEC_METADATA_CALLBACK

Callback for sounds that have their

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_CODEC_METADATA_CALLBACK(
  FMOD_CODEC_STATE *codec_state,
  FMOD_TAGTYPE type,
  char *name,
  void *data,
  unsigned int datalen,
  FMOD_TAGDATATYPE datatype,
  int unique
);

Parameters

codec_state

Pointer to the codec state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.

type

Source of tag being updated, ie id3v2 or oggvorbis tag for example. See FMOD_TAGDATATYPE.

name

Name of the tag being updated.

data

Contents of tag.

datalen

Length of the tag data in bytes.

datatype

Data type of tag. Binary / string / unicode etc. See FMOD_TAGDATATYPE.

unique

If this is true, then the tag (determined by the name) being updated is the only one of its type. If it is false then there are multiple versions of this tag with the same name.

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

This callback is usually called from sounds that can udate their metadata / tag info at runtime. Such a sound could be an internet SHOUTcast / Icecast stream for example.

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also




Version 1.10.03 Built on Feb 1, 2018


previous page start next page