Remarks
Retrieves a tag string from the loaded sound. The availability of Tag strings and their total number can be checked using the IsTagAvailable method.
Due to their format, this method cannot be used with ID3V1 and ID3V2 Tags.
The availability of this information requires a prior call to the SoundInfoGet method.
Details about the use of Tags and a sample of use of this method can be found on the How to read TAG information in sound files and How to retrieve basic TAG information from the sound loaded into a player tutorials.
Syntax
[Visual Basic]
Public Function GetTagString (
nPlayerIndex as Int16,
nTagType as enumTagTypes,
nStringIndex as Int16
) as Int16
|
|
[C#]
public Int16 GetTagString (
Int16 nPlayerIndex,
enumTagTypes nTagType,
Int16 nStringIndex
);
|
|
[C++]
public: Int16 GetTagString (
Int16 nPlayerIndex,
enumTagTypes nTagType,
Int16 nStringIndex
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nTagType
|
The type of Tag whose string must be retrieved.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
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
|
TAGTYPE_MIDI
|
8
|
MIDI tag
|
|
nStringIndex
|
The zero-based index of the string to obtain: the total number of available strings can be retrieved using the IsTagAvailable method.
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
The requested string
|
|
