MP3Sound Control Properties

MP3Sound Control Properties MP3Sound Control Properties

All of the properties that apply to this control are in this table.

MP3Album Property
Description
Returns a string containing information from MP3 file about the album.

Usage
[Form][control]MP3Album[=String]

Remarks

Read
Information is available only if MP3HasTaggedInfo is: TRUE.
If no information about album is available - the property contains the string: "No information"

Data Type
String

MP3GetBitrate Property
Description
Returns information from MP3 file about the bitrate.

Usage
[Form][control]MP3GetBitrate[=Long]
Remarks

Read

Data Type
Long

MP3GetCurrentPos Property
Description
Returns the actual play position (frame).

Usage
[Form][control]MP3GetCurrentPos[=Long]

Remarks

Read

Data Type
Long

MP3GetFrequency Property
Description
Returns information from MP3 file about the frequency.

Usage
[Form][control]MP3GetFrequency[=Long]

Remarks

Read

Data Type
Long

MP3GetLayer Property
Description
Returns information from MP3 file about the layer.

Usage
[Form][control]MP3GetLayer[=Integer]

Remarks

Read
Valid values are : 1, 2 and 3

Data Type
Integer

MP3GetLength Property
Description
Returns information from MP3 file about the length in frames.

Usage
[Form][control]MP3GetLength[=Long]

Remarks

Read

Data Type
Long

MP3GetPlayerMode Property
Description
Returns information from control about the current player mode.

Usage
[Form][control]MP3GetPlayerMode[=Integer]

Remarks

Read

Data Type
Integer

Value Description

0 = no MP3 file loaded -> or after successful call of MP3Close
1 = MP3 file loaded -> after successful call of MP3Open/MP3Stop
3 = playing -> after successful call of MP3Play
4 = playing paused -> after successful call of MP3Pause

MP3GetSliderPosition Property
Description
Returns information from control about the actual play position.

Usage
[Form][control]MP3GetSliderPosition[=Long]

Remarks

Read
Valid values are: 0 ( start playing ) to 100 ( end playing )

Data Type
Long

MP3GetStereoMode Property
Description
Returns information from MP3 file about the stereo mode.

Usage
[Form][control]MP3GetStereoMode[=String]

Remarks

Read
Valid values are: "Stereo", "Joint Stereo", "Dual Channel", "Mono", "Unknown Stereomode"

Data Type
String

MP3GetStereoModeLong Property
Description
Returns information from MP3 file about the stereo mode.

Usage
[Form][control]MP3GetStereoModeLong[=Long]

Remarks

Read

Data Type
Long

Value Description

0 = Stereo
1 = Joint Stereo
2 = Dual Channel
3 = Mono
4 = unknown mode

MP3GetTimeLength Property
Description
Returns information from MP3 file about the length in date format.

Usage
[Form][control]MP3GetTimeLength[=Date]

Remarks

Read
The length of file is returned in format: "hh:nn:ss"

Data Type
Date

MP3GetTimePosition Property
Description
Returns information from control about the actual position in date format.

Usage
[Form][control]MP3GetTimePosition[=Date]

Remarks

Read
The actual position is returned in format: "hh:nn:ss"

Data Type
Date

MP3Interpret Property
Description
Returns a string containing information from MP3 file about the interpret.

Usage
[Form][control]MP3Interpret[=String]

Remarks

Read
Information is available only if MP3HasTaggedInfo is: TRUE.
If no information about album is available - the property contains the string: "No information"

Data Type
String

MP3GetWaveVolumeLeft Property
Description
Returns information from system about the current wave mapper volume of left stereo channel.

Usage
[Form][control]MP3GetWaveVolumeLeft[=Long]

Remarks

Read
Valid values are: 0 ( no sound ) to 100 ( full sound )

Data Type
Long

MP3GetWaveVolumeRight Property
Description
Returns information from system about the current wave mapper volume of right stereo channel.

Usage
[Form][control]MP3GetWaveVolumeRight[=Long]

Remarks

Read
Valid values are: 0 ( no sound ) to 100 ( full sound )

Data Type
Long

MP3HasTaggedInfo Property
Description
Returns wether a MP3 file contains tagged information.

Usage
[Form][control]MP3HasTaggedInfo[=Boolean]

Remarks

Read

Data Type
Boolean

MP3IsPeakmeterAvailable Property
Description
Returns wether the soundcard supports peakmeter information.

Usage
[Form][control]MP3IsPeakmeterAvailable[=Boolean]

Remarks

Read

Data Type
Boolean

MP3IsSpeakerControlAvailable Property
Description
Returns wether the soundcard supports setting of speaker level.

Usage
[Form][control]MP3IsSpeakerControlAvailable[=Boolean]

Remarks

Read

Data Type
Boolean

MP3OutputPath Property
Description
Sets/returns the path and file name for the wave file created by the control while
playing MP3 files in MP3SetOutputDevice mode: 2.

Usage
[Form][control]MP3OutputPath[=String]

Remarks

Read/write
If no path is specified - a wave file: "C:\MP3toWAV.wav" is created by default

Data Type
String

MP3PlayStartPosition Property
Description
Sets/returns the position in MP3 file ( in frames ) to play from.

Usage
[Form][control]MP3PlayStartPosition[=Long]

Remarks

Read/write
Valid values are: 1 to MP3GetLength

Data Type
Long

MP3PlayStopPosition Property
Description
Sets/returns the position in MP3 file ( in frames ) to play to.

Usage
[Form][control]MP3PlayStopPosition[=Long]

Remarks

Read/write
Valid values are: 1 to MP3GetLength

If MP3PlayStopPosition <= MP3PlayStartPosition then MP3PlayStopPosition =

MP3PlayStartPosition + 1 ( set by control )

Data Type
Long

MP3PlayStartPositionTime Property
Description
Sets/returns the position in MP3 file to play from in date format.

Usage
[Form][control]MP3PlayStartPositionTime[=Date]

Remarks

Read/write

Data Type
Date

MP3PlayStopPositionTime Property
Description
Sets/returns the position in MP3 file to play to in date format.

Usage
[Form][control]MP3PlayStopPositionTime[=Date]

Remarks

Read/write
If MP3PlayStopPosition Time<= MP3PlayStartPositionTime then MP3PlayStopPositionTime = MP3PlayStartPositionTime + 1 second ( set by control )

Data Type
Date

MP3PlayLong Property
Description
Sets/Returns wether the start- and stop positions for playing are determined by time or frame.

Usage
[Form][control]MP3PlayLong[=Boolean]

Remarks

Read/write
Value: TRUE = play from frame X to frame Y
Value: FALSE = play from time X to time Y

Data Type
Boolean

MP3Seekable Property
Description
Returns wether the MP3 file supports the MP3Seek method.

Usage
[Form][control]MP3Seekable[=Boolean]

Remarks

Read

Data Type
Boolean

MP3SetOutputDevice Property
Description
Sets/returns current output device.

Usage
[Form][control]MP3SetOutputDevice[=sOutput]

Remarks

Read/write
Default value: 0 - wave mapper

Data Type
Integer ( Enum )

Value Description

0 = Wave mapper
1 = Direct sound
2 = PCM file ( specify path by MP3OutputPath )

MP3SetPlayerPriority Property
Description
Sets/returns the thread priority of codec.

Usage
[Form][control]MP3SetPlayerPriority[=sPriority]

Remarks

Read/write
Default value: 5 - Highest

Data Type
Integer ( Enum )

Value Description

0 = Idle
1 = Lowest
2 = BelowNormal
3 = Normal
4 = AboveNormal
5 = Highest
6 = TimeCritical

MP3Title Property
Description
Returns a string containing information from MP3 file about the title.

Usage
[Form][control]MP3Title[=String]

Remarks

Read
Information is available only if MP3HasTaggedInfo is: TRUE.
If no information about album is available - the property contains the string: "No information"

Data Type
String

MP3Comment Property
Description
Returns a string containing information from MP3 file about the comment.

Usage
[Form][control]MP3Comment[=String]

Remarks

Read
Information is available only if MP3HasTaggedInfo is: TRUE.
If no information about album is available - the property contains the string: "No information"

Data Type
String

MP3Year Property
Description
Returns a string containing information from MP3 file about the year of release.

Usage
[Form][control]MP3Year[=String]

Remarks

Read
Information is available only if MP3HasTaggedInfo is: TRUE.
If no information about album is available - the property contains the string: "No information"

Data Type
String