MP3Sound Control Methods

MP3Sound Control Methods MP3Sound Control Methods

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

ShowAboutBox Method
Description
Displays information about control.

Usage
Sub ctlname [ShowAboutBox]

MP3Close Method
Description
Closes and removes the current MP3 file from codec.

Usage
Sub ctlname [MP3Close]

Remarks
If succeeded MP3GetPlayerMode = 0

MP3Pause Method
Description
First call pauses playing MP3 file.
Second call resumes playing MP3 file.

Usage
Sub ctlname [MP3Pause]

Remarks
If succeeded MP3GetPlayerMode = 4

MP3CancelSearch Method
Description
The search for Mp3 files is immediately cancelled by this method.

Usage
Sub ctlname [MP3CancelSearch]

Remarks

MP3Stop Method
Description
Stops playing MP3 file - the file is not unloaded from codec.

Usage
Sub ctlname [MP3Stop]

Remarks
If succeeded MP3GetPlayerMode = 1

MP3Seek Method
Description
Sets the current playing position to a defined value.

Usage
Sub ctlname [MP3Seek(sValue as Long)]

Remarks
Method can be called successful only after calling MP3Open and/or MP3Play
Available only when MP3Seekable = True

MP3Open Method
Description
Loads a valid MP3 file to codec.

Usage
Sub ctlname [MP3Open(mp3Path as String)]

Remarks

MP3Play Method
Description
Plays a valid MP3 file.

Usage
Sub ctlname [MP3Play()]

Remarks
Method can be called successful only after calling MP3OpenMP3OpenSam

MP3SetSpeakerVolume Method
Description
Sets the volume level of speakers.

Usage
Sub ctlname [MP3SetSpeakerVolume(speakervolume as Long)]

Remarks
Valid values are: = 0( no sound ) to 100 ( full sound )
Method can be called successful only if sound card supports this feature

MP3SetWaveVolume Method
Description
Sets the volume level ( both stereo channels separately ) of wave mapper.

Usage
Sub ctlname [MP3SetWaveVolume(leftChannelVolume as Integer, rightChannelVolume as Integer)]

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

MP3GetVolume Function
Description
Returns the current level of wave mappers peak meter.

Usage
result( Long ) =ctlname [MP3GetVolume()]

Remarks
Valid values for result are: = 0 to 100

MP3DeleteAllTags Method
Description
Deletes all tagged information in a given MP3 file.

Usage
subctlname [MP3DeleteAllTags(MP3File as String)]

Remarks
Specify the full path to MP3 file as MP3File

MP3GetAllFiles Function
Description
Returns all MP3 files on the machine, or from a given directory ( incl. subdirectories )
in a collection as string with full path name.

Usage
result( Collection ) =ctlname [MP3GetAllFiles(Optional startDirectory as String )]

Remarks
If no directory or drive are specified - all drives are searched for MP3 files
except of floppy disk drives

MP3SetAlbum Method
Description
Sets the tag info about album.

Usage
Sub ctlname [MP3SetAlbum(mp3File as String, album as String)]

Remarks
The string mp3file should contain the full path to specified MP3 file
The string album should contain the information about album ( <= 30 characters )
If the MP3 file is opened by MP3Sound control the MP3Close method must be called before
using this method.

MP3SetInterpret Method
Description
Sets the tag info about artist.

Usage
Sub ctlname [MP3SetAlbum(mp3File as String, interpret as String)]

Remarks
The string mp3file should contain the full path to specified MP3 file
The string album should contain the information about interpret ( <= 30 characters )
If the MP3 file is opened by MP3Sound control the MP3Close method must be called before
using this method.

MP3SetComment Method
Description
Sets the tag info comment.

Usage
Sub ctlname [MP3SetComment(mp3File as String, comment as String)]

Remarks
The string mp3file should contain the full path to specified MP3 file
The string album should contain the comment ( <= 30 characters )
If the MP3 file is opened by MP3Sound control the MP3Close method must be called before
using this method.

MP3SetTitle Method
Description
Sets the tag info about title.

Usage
Sub ctlname [MP3SetTitle(mp3File as String, title as String)]

Remarks
The string mp3file should contain the full path to specified MP3 file
The string album should contain the information about title ( <= 30 characters )
If the MP3 file is opened by MP3Sound control the MP3Close method must be called before
using this method.

MP3SetYear Method
Description
Sets the tag info about year.

Usage
Sub ctlname [MP3SetYear(mp3File as String, year as String)]

Remarks
The string mp3file should contain the full path to specified MP3 file
The string album should contain the information about year ( <= 4 characters )
If the MP3 file is opened by MP3Sound control the MP3Close method must be called before
using this method.