MP3 - Get Property

Gets a property of the global MP3 player and stores it in a variable.

Use this action to get information about the current state of the global MP3 player.

Action ID:
Action Category:
Action List Syntax:

110
MP3
<<VARIABLE>>
= MP3.GetProperty (<<PROPERTY>>)

Settings

Variable:

The variable that you want the information to be stored in.

Property:

The property that will be returned from the MP3. Choose from:

PROPERTY

DESCRIPTION

Album

The album name (from the MP3's ID3 tag).

Artist

The artist (from the ID3 tag).

Bitrate

The bitrate of the MP3 (e.g. 128).

Channel Mode

A number indicating the channel mode used in the MP3:

0 - Stereo
1 - Joint stereo (frees up bits by combining similar left and right channels)
2 - Dual channel (Stereo)
3 - Single channel (Mono)

Comment

The comment embedded in the ID3 tag.

Filename

The full path and filename of the MP3 file currently associated with the global MP3 player.

Genre Index

A number indicating the genre that the MP3 belongs to.  (more info)

Is Copyrighted

A boolean number indicating whether the MP3 is copyrighted:

0 - not copyrighted
1 - copyrighted

Is Original

A boolean number indicating whether the MP3 is an original:

0 - not original
1 - original

Length

The length of the MP3 file in the following format: "hh:mm:ss"

(Returns "00:00:00" if there is no length in the ID3 tag.)

MPEG Layer

A number indicating the MPEG layer for the MP3:

0 - unable to determine
1 - MPEG Layer I
2 - MPEG Layer II
3 - MPEG Layer III

MPEG Version

A number indicating the MPEG version of the MP3:

0 - unable to determine
1 - MPEG Version 1 (ISO/IEC 11172-3)
2 - MPEG Version 2 (ISO/IEC 13818-3)
2.5 - MPEG Version 2.5

Number of Frames

The number of frames in the MP3.

Play State

The play state of the global MP3 player. Returns one of:

"EMPTY" - No MP3 has been loaded.
"LOADED" - An MP3 is loaded.
"PLAYING" - The MP3 is currently playing.
"EOF" - End of File (the end of the MP3 has been reached).
"STOPPED" - The MP3 is stopped.
"PAUSED" - The MP3 is paused.

Progress

The current progress of the MP3. Returns the elapsed time (distance from the beginning of the MP3) in the following format: "hh:mm:ss"

Repeat State

The repeat state for the global MP3 player. Returns either TRUE or FALSE:

"TRUE" - The MP3 player will automatically repeat the current song when it reaches the end.
"FALSE" - The MP3 player will just stop when it reaches the end.

Sample Rate

The sampling rate (frequency) of the current MP3, in hertz (e.g. "44100").

Title

The title of the MP3 (from the ID3 tag).

Track

The album track for the current MP3 (from the ID3 tag).

Year

The year that the MP3 was released in (from the ID3 tag).

NOTE

 

 

 

Some of these properties are retrieved from the ID3 tag, which is located near the end of all MP3 files. (How much information is actually available in the ID3 tag depends on what the author of the MP3 provided. In fact, some MP3s may not have any information in their ID3 tag at all.)

Additional information on the ID3 tag can be found at http://www.id3.org/id3v1.html.

Error Codes

Value
(%LastErrorNum%)

Simple Message
(%LastErrorMsg%)

Verbose Message
(%LastErrorDetails%)

0 (OK)

 

 

Examples

None