Audio.GetOggTags

table Audio.GetOggTags ( 

number Channel )

Description

Returns a table containing the tags from an Ogg Vorbis file that is currently loaded in an audio channel.

Parameters

Channel

(number) The audio channel whose Ogg Vorbis tags you want:

CONSTANT

VALUE

DESCRIPTION

CHANNEL_BACKGROUND

5

Background audio channel.

CHANNEL_EFFECTS

0

Effects channel (used for mouse over, down, and click sounds).

CHANNEL_NARRATION

6

Narration channel (used for voice overs).

CHANNEL_USER1

1

User channel 1.

CHANNEL_USER2

2

User channel 2.

CHANNEL_USER3

3

User channel 3.

CHANNEL_USER4

4

User channel 4.

Returns

(table) A table containing the Ogg tags, indexed by the following categories:

KEY

TYPE

DESCRIPTION

TITLE

string

The title of the Ogg track (from the Ogg tag). If the information cannot be found, an empty string will be returned.

VERSION

string

The version of the track (eg. remix info). If the information cannot be found, an empty string will be returned.

ALBUM

string

The album name (from the Ogg tag). If the information cannot be found, an empty string will be returned.

TRACKNUMBER

number

The album track for the current song (from the Ogg tag).

ARTIST

string

The artist of the track. If the information cannot be found, an empty string will be returned.

PERFORMER

string

 The performer of the track (often this is the same as the artist). If the information cannot be found, an empty string will be returned.

COPYRIGHT

string

The copyright information (e.g., "2001 Nobody's Band"). If the information cannot be found, an empty string will be returned.

LICENSE

string

The license information (eg.,"All Rights Reserved"). If the information cannot be found, an empty string will be returned.

ORGANIZATION

string

The name of the organization producing the track. If the information cannot be found, an empty string will be returned.

DESCRIPTION

string

A short description of the contents. If the information cannot be found, an empty string will be returned.

GENRE

string

A short text indication of music genre. If the information cannot be found, an empty string will be returned.

DATE

string

The date the track was recorded. If the information cannot be found, an empty string will be returned.

LOCATION

string

The location where the track was recorded. If the information cannot be found, an empty string will be returned.

CONTACT

string

Contact information for the creators or distributors of the track. If the information cannot be found, an empty string will be returned.

ISRC

string

ISRC (International Standard Recording Code) number for the track. For more information on the ISRC, see http://www.ifpi.org/site-content/online/isrc_intro.html. If the information cannot be found, an empty string will be returned.

RAWTAGS

string

A comma separated list of all the tags in the comment field. (The reason for this is because you can have anything in the comments.) It will look something like this:

"TITLE=Roxy,ENGINEER=Jack Coolguy,BUBBLEBOY=No One Is Here".  It does not have to contain the standard tags on the tags that were actually in the Comment field.

If an error occurs, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.

See also: Related Actions