Copyright © 2001-2008 MultiMedia Soft  Return to Table of contents

 

IsTagAvailable method 

 

Remarks 

 

Verifies if the loaded sound contains Tag information and, in case of multi-string Tags separated by NULL characters (like OGG Vorbis), returns the number of available strings. These strings can be retrieved one by one at a later time using the GetTagString method. 

 

Details about the use of Tags can be found inside the How to retrieve Tag information section. 

 

 

Syntax 

 

[Visual Basic]  control.IsTagAvailable (  nPlayer as Integer,  nTagType as enumTagTypes  ) as Integer

 

[C++]  BOOL control.IsTagAvailable (  short nPlayer,  short nTagType  );

 

 

Parameter	Description
nPlayer	Number representing the zero-based index of the involved player
nTagType	The type of Tag whose presence we need to check.  Supported values are the following:  Mnemonic constant Value Meaning TAGTYPE_ID3V1 0 MP3 ID3V1 tag TAGTYPE_ID3V2 1 MP3 ID3V2 tag TAGTYPE_ICY 2 ICY Shoutcast tag TAGTYPE_METADATA 3 Shoutcast metadata TAGTYPE_OGG 4 OGG Vorbis tag

 

 

Return value 

 

Value	Meaning
Negative value	An error occurred (see the LastError property for further error details)
0	The requested Tag is not available inside the loaded sound
>= 1	The requested Tag is available inside the loaded sound and this return value gives the number of found strings.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Copyright © 2001-2008 MultiMedia Soft 

Return to Table of contents