Collapse All
libZPlay documentation (Win32)
IndexReferenceHome
PreviousUpNext
libZPlayCpp::zplay_LoadFileID3 Function

Load ID3 data from specified file. (ANSI version)

C++
__stdcall __declspec(dllimport) int zplay_LoadFileID3(ZPLAY_HANDLE handle, const char * pchFileName, TStreamFormat nFormat, TID3Version nId3Version, TID3Info * pId3Info);
File
Parameters
Parameters 
Description 
ZPLAY_HANDLE handle 
ZPLAY handle. Get this handle with zplay_CreateZPlay. 
const char * pchFileName 
Points to a ANSI null-terminated string that specifies the name of the file. 
TStreamFormat nFormat 
Stream format. Use sfAutodetect if you need to autodetect stream format of specified file. 
TID3Version nId3Version 
ID3 version.
Note: This value is only used for sfMp3 stream format. For all other stream formats this parameter is ignored. 
TID3Info * pId3Info 
Pointer to TID3Info structure receiving ID3 data. User must allocate memory for this structure. 
Return Values
Return Values 
Description 
1 
All OK. 
0 
Error. To get error message read here. 
Remarks

Check supported formats for info tag support. Some formats can support some sort of "Info tags", but not all. 

libZPlay library implements "ID3 tag" interface to different info tags (VORBIS comment, RIFF Info, ...). So, you can retrieve ID3 informations from different streams (mp3, ogg, flac, wav) because library will convert "format specific tag" to ID3 tag info. 

Note: Use this function if you just need ID3 data and you don't need to play this file. This function only loads ID3 data. There is no checking if this is valid file, wave output isn't open ... This function has no effect on currently open file or stream. 

See Also
Example

Load ID3 info from specified file. 

ZPlay C++ Class interface  

TId3Info id3_info;
if(instance->LoadFileID3("mySong.ogg", sfAutodetect, id3Version2, &id3_info))
{
  printf("Title:   %s\n", id3_info.Title);
  printf("Artist:  %s\n", id3_info.Artist);
  printf("Album:   %s\n", id3_info.Album);
  printf("Year:    %s\n", id3_info.Year);
  printf("Comment: %s\n", id3_info.Comment);
  printf("Genre:   %s\n", id3_info.Genre);
  printf("Track:   %s\n", id3_info.TrackNum);
}

 

C Style interface 

TId3Info id3_info;
if(zplay_LoadID3(instance, "mySong.ogg", sfAutodetect, id3Version2, &id3_info))
{
  printf("Title:   %s\n", id3_info.Title);
  printf("Artist:  %s\n", id3_info.Artist);
  printf("Album:   %s\n", id3_info.Album);
  printf("Year:    %s\n", id3_info.Year);
  printf("Comment: %s\n", id3_info.Comment);
  printf("Genre:   %s\n", id3_info.Genre);
  printf("Track:   %s\n", id3_info.TrackNum);
}
Group
Copyright (c) 2010. Zoran Cindori - All rights reserved.

Web: http://libzplay.sourceforge.net/

Email: zcindori@inet.hr

Made with Doc-O-Matic® Express

Doc-O-Matic