Remarks
Retrieves content of a given specified tag field for the loaded sound.
The availability of this information requires a prior call to the SoundInfoGet method.
Details about the use of Tags can be found inside 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 GetFileTagField (
nPlayerIndex as Int16,
nField as enumTagFields
) as Int16
|
|
[C#]
public Int16 GetFileTagField (
Int16 nPlayerIndex,
enumTagFields nField
);
|
|
[C++]
public: Int16 GetFileTagField (
Int16 nPlayerIndex,
enumTagFields nField
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the player whose information must be retrieved
|
iField
|
Number representing the zero-based index of the field that must be retrieved.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
TAG_FIELD_TITLE
|
0
|
Title
|
TAG_FIELD_ARTIST
|
1
|
Artist
|
TAG_FIELD_ALBUM
|
2
|
Album
|
TAG_FIELD_YEAR
|
3
|
Year
|
TAG_FIELD_COMMENT
|
4
|
Comment
|
TAG_FIELD_TRACK
|
5
|
Track number
|
TAG_FIELD_GENRE_CODE
|
6
|
Genre code
|
TAG_FIELD_GENRE_STRING
|
7
|
Genre
|
TAG_FIELD_COMPOSER
|
8
|
Composer
|
TAG_FIELD_COPYRIGHT
|
9
|
Copyright
|
TAG_FIELD_SUBTITLE
|
10
|
Subtitle
|
TAG_FIELD_ALBUMARTIST
|
11
|
Album artist
|
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
The requested string
|
|
