mixGetMusicTitleTag function

String? mixGetMusicTitleTag(Pointer<MixMusic> music)

Get the title for a music object.

This returns format-specific metadata. Not all file formats supply this!

If music is NULL, this will query the currently-playing music.

Unlike this function, Mix_GetMusicTitle() produce a string with the music's filename if a title isn't available, which might be preferable for some applications.

This function never returns NULL! If no data is available, it will return an empty string ("").

\param music the music object to query, or NULL for the currently-playing music. \returns the music's title if available, or "".

\since This function is available since SDL_mixer 2.6.0.

\sa Mix_GetMusicTitle \sa Mix_GetMusicArtistTag \sa Mix_GetMusicAlbumTag \sa Mix_GetMusicCopyrightTag

extern DECLSPEC const char *SDLCALL Mix_GetMusicTitleTag(const Mix_Music *music)

Implementation

String? mixGetMusicTitleTag(Pointer<MixMusic> music) {
  final mixGetMusicTitleTagLookupFunction = libSdl2Mixer.lookupFunction<
      Pointer<Utf8> Function(Pointer<MixMusic> music),
      Pointer<Utf8> Function(Pointer<MixMusic> music)>('Mix_GetMusicTitleTag');
  final result = mixGetMusicTitleTagLookupFunction(music);
  if (result == nullptr) {
    return null;
  }
  return result.toDartString();
}