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]
Public Function IsTagAvailable (
nPlayerIndex as Int16,
nTagType as enumTagTypes
) as Int16
|
|
[C#]
public Int16 IsTagAvailable (
Int16 nPlayerIndex,
enumTagTypes nTagType
);
|
|
[C++]
public: Int16 IsTagAvailable (
Int16 nPlayerIndex,
enumTagTypes nTagType
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
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 value
|
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
|
TAGTYPE_WMA
|
5
|
Window Media Audio tag
|
TAGTYPE_MP4
|
6
|
MP4 tag
|
TAGTYPE_APE
|
7
|
APE 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.
|
|
