
                                                                                   
                    WA_Link_SDK v1.0 by the bASE crew (09.06.2002)                 
                               for WA Link 1.2+                                    
    Offical Site - http://www.base.is/thecrew/ (New versions come here first)      
                                                                                   


1. What is WA Link SDK?
2. How to load into mIRC?
3. Identifier list.
4. Notes.
5. Version history.

Credits, special thanks and copyright, see bottom of this file

If you need help with something not explained in this file or in the mIRC help
contact us at: base@base.is or come to our channel. (See bottom of this file)



1. What is WA Link SDK?

   This is a mIRC script to ease communication with WA_Link.dll so you never have to
   worry about calling the WA_Link.dll. This script needs WA_Link.dll version 1.2 or more.

2. How to load into mIRC?

   Put WA_Link_SDK.mrc in the same folder as WA_Link.dll and load the script into mIRC.

3. Identifier list.
   
   The $wa.info(info) identifier only returns info. Returns $false if Winamp is not running
   or if requested info could not be found. 

     $wa.info(sdkversion)    - Returns the version of the SDK  
     $wa.info(dllversion)    - Returns the version of the WA_Link.dll (Not available with WA_Link 1.2)
     $wa.info(wadir)         - Returns the path of default Winamp. If called with $wa.info(wadir,s) 
                               then returns in short file format.
     $wa.info(version)       - Returns the version of Winamp  
     $wa.info(title)         - Returns current playing Title 
     $wa.info(artist)        - Returns current playing Artist 
     $wa.info(album)         - Returns current playing Album
     $wa.info(genre)         - Returns current playing Genre 
     $wa.info(comment)       - Returns current playing Comment 
     $wa.info(year)          - Returns current playing Year
     $wa.info(tracksec)      - Returns current track length in seconds. If called with 
                               $wa.info(tracksec,ms) then returns in mins:secs format
     $wa.info(possec)        - Returns what is left of current track in seconds. If called
                               with $wa.info(possec,ms) then returns in mins:secs format
     $wa.info(state)         - Returns the state of Winamp
                               $WA_PLAYING    - Winamp playing 
                               $WA_STOPPED    - Winamp stopped
                               $WA_PAUSED     - Winamp paused
                               $WA_NOTRUNNING - Winamp is not running
     $wa.info(filetype)      - Returns the file extention. i.e mp3
     $wa.info(trackfilename) - Returns the name and full path to the current playing track. If called 
                               with $wa.info(trackfilename,s) then returns in short file format.
     $wa.info(channels)      - Returns the number of channels 1 being mono 2 being stereo.
     $wa.info(samplerate)    - Returns the samplerate of the current track in kHz 
                               (e.g 44). 1 Kilohertz (kHz) is equal to 1000 cycles per second.
     $wa.info(bitrate)       - Returns the bitrate the track was recorded at, in kbps. 
                               (Kilobytes per Second)
     $wa.info(getshuffle)    - Returns the state of shuffle. $SHUFFLE_OFF is off, $SHUFFLE_ON is on.
     $wa.info(repeate)       - Returns the state of repeat. $REPEAT_OFF is off, $REPEAT_ON is on.
     $wa.info(donebar)       - Returns i.e [||||||||--] Can easily by changed by editing the script.
     $wa.info(tracksize)     - Returns the physical size of the current track in bytes. 
                               (8 Bits = 1 Byte, 1 Kilebyte = 1024 bytes, 1 Megabyte = 1048576 Bytes)
                               If called like $wa.info(tracksize,m) then returns in MegaBytes X.XX
     $wa.info(trackno)       - Returns the number of the current playing track (nr in playlist)
                                
      
-
      
      
   $wa.stats(path) identifier runs a theme through the WA_Link.dll and returns it. You need to supply
   a fullpathname to the theme. For theme format info check readme.txt which comes with WA_Link.zip
                                     
             
-
             
                   
   $wa.command(command[,X]) identifier commands WA Link to tell Winamp to do something.
   NOTE: You can also use these identifiers as aliases, 
   	 i.e. /wa.command play 
   	 and  /wa.command jump X    (where X is song number)
                             
     $wa.command(play)       - Starts playing or resume playing
     $wa.command(next)       - Jumps to the next track in the playlist 
     $wa.command(prev)       - Jumps to the previous track in the playlist
     $wa.command(pause)      - Pauses or resumes playing  
     $wa.command(stop)       - Stops playing alltogether 
     $wa.command(bofpl)      - Jumps to the first track in the playlist. (Short for Beginning Of PlayList) 
     $wa.command(eofpl)      - Jumps to the last track in the playlist. (Short for End Of PlayList) 
     $wa.command(fadestop)   - Fades the volume down and then stops playing 
     $wa.command(FFW5)       - Skips forward 5 seconds. (Short for Fast Forward 5sec)
     $wa.command(REW5)       - Skips backward 5 seconds. (Short for Rewind 5sec)
     $wa.command(shuffle)    - Toggles shuffle or random if you will, on/off
     $wa.command(repeat)     - Toggles repeat on/off  
     $wa.command(hide)       - Hides WinAMP.  This is not the same thing as minimize.
     $wa.command(show)       - Shows a hidden WinAMP.  It does not restore a minimized WinAMP
     $wa.command(ontop)      - Toggles WinAMP stay-ontop on/off
     $wa.command(playlist)   - Toggles the playlist on/off 
     $wa.command(shade)	     - Toggles shade mode on/off.
     $wa.command(plshade)    - Toggles playlist shade mode on/off
     $wa.command(EQ)         - Toggles the equalizer window on/off 
     $wa.command(open)       - Opens the WinAMP openfile dialog
     $wa.command(visplug)    - Starts or stops the selected visualization plug-in
     $wa.command(close)      - Closes WinAMP
     $wa.command(start)      - Starts/Opens WinAMP 
     
     $wa.command(jump,X)     - Jumps to a track number (X) and starts playing.
     $wa.command(find[,-j],X) - Searches for a track.  Returns $false if not found.  This command does not 
                               start playing the track. The scripts alias just simulates it.
                               If you specify -j before the search text, it will automaticly jump to
                               the song WA Link found.
     $wa.command(seek,X)     - Skips to a X percentage into the track.
     $wa.command(vol,X)	     - Sets the volume to a X percentage.
     $wa.command(pan,X)      - Sets the panning, -100 being left, 0 being center and 100 being right.
      
-

   $wa.do(command) identifier commands WA Link and Winamp to do something.
   NOTE: You can also use these identifiers as aliases.
         i.e. /wa pladdd
         
     $wa.do(writepl)         - Makes WinAMP write the default playlist, since the automation of this 
                                    event is only when WinAMP quits.
     $wa.do(savepl)          - Reads winamp playlist and writes into script dir  
     $wa.do(pladdd)          - Does not actually call the DLL but it calls WinAMP, used to add a directory.
                               This command parses the chosen directory and adds *.MP3, *.WMA, *.WAV, *.CDA 
                               and *.MID files to the playlist.
     $wa.do(pladdf)          - Does not actually call the DLL but it calls WinAMP, used to add a single file.
                               Since this is a single file, the extension is irrelevant.
     $wa.do(pladd)           - Does not actually call the DLL but it calls WinAMP, used to add files, seperated by "
                               This command can be called with relevant path or full path, so the extension is irrelevant.
   
4. Notes.

   Aliases which are used by the SDK:
    Global:
      wa.info
      wa.stats
      wa.command
      wa.do
    Local:
      wa.dll
      wa.donebar
      wa.savepl
   
   
   
5. Version history

   WA_Link_SDK 1.0 (09.06.2002)                                                                
   - Initial version                                                           



WA Link SDK is a freeware and everyone are free to distribute it and to use 
WA_Link_SDK as they see fit, without having to include any of the original
files or credits. But if you decide to distribute a modified WA_Link_SDK 
an E-mail would be very much appreciated (base@base.is).

Even though this script should not be able to damage anything in your or other computers,
we cannot be held responsible if so unlikely this would happen. This script is provided 
"as is" and is to be used on the users own responsibilty. 

Credits:
WA_Link_SDK v1.0 was made by the bASE Crew
mIRC scripting  : Dagur Hilmarsson
Documentation   : The bASE Crew

Official IRC channel #base.is on gamers-net.com
USA Server    : us1.gamers-net.com channel: #base.is
Europe Server : dk1.gamers-net.com channel: #base.is

Offical Site http://www.base.is/thecrew/

Special thanks : Bergr Olivert Thorstensen : Supplying a few script routines (bASE crew member)
                 Sveinn Steinarsson          : WA Link DLL coder (bASE crew member)
                 

Winamp is a trademark of the Nullsoft, Inc.
mIRC is a trademark of the mIRC co. Ltd.
WA_Link is not a trademark. If it were, it would be a trademark of the bASE crew.