ActiveWinamp Scripting Reference (Rev. 1)

This documentation is horribly outdated - you should use an object browser (ie OLEview, or the freeware iTripoli Type Library Viewer) to view the type library information of gen_activewa.dll for better documentation

ActiveWinamp (gen_activewa.dll) written by ShaneH. Documentation written by Saivert. Wikified by osmosis.

Here is the complete listing of all methods and properties as of version 0.3:

All examples are written in VBScript (Visual Basic Scripting Edition), but should be easy to rewrite in JScript (aka JavaScript, ECMAScript).

The main object is “Application” but usually you don’t have to specify this when writing your script. Here are two examples:

' Returns the Media Item for the current song
Set mi = Application.Playlist(Application.Playlist.Position)

' Returns the Media Item for the current song
Set mi = Playlist(Playlist.Position)

Sub Application_ChangedVolume

End Sub

• Triggered when Winamp starts playing a new song

• Triggered when volume (and also balance/panning) changes

• Triggered when user stops, pauses and/or starts playback

• Input plugins send this when they are done playing back

Const ForReading = 1, ForWriting = 2, ForAppending = 8

Set fso = CreateObject("Scripting.FileSystemObject")
Set MyFile = fso.OpenTextFile("c:\songlog.txt", ForAppending, True)

Sub Application_ChangedTrack
Set mi = playlist(playlist.position)
MyFile.WriteLine(mi.ATFString("%artist% - %title%") + vbNewLine + mi.ATFString("BitRate = %bitrate%"))
End Sub

• Gives access to the playlist, see below for further info

• Gives access to the media library, see below for further info

• Adjust/get the volume in the range 0-255 (where 255 is max and 0 is min)

• Adjust/Get the balance level (aka panning).
• 0 is center, -127 is all left and +127 is all right

• The window handle of Winamp’s main window. Use for miscellanous stuff.

• Returns the playback status. Returns 1 if playing, 3 if paused, 0 if stopped

• Get or set the current skin

• Get or set the current shuffle status (boolean)

• Get or set the current repeat status

• Does nothing really...but it’s there!!!

• |> Starts playback, or restarts if currently playing.
• Use PlayState property to check this.

• [] Stops playback

• || Pauses playback

• |< Steps back to previous song

• >| Skips to next track

• Use GetRef() to obtain a reference to a function, like GetRef(MyFunction)
• Returns a timerid you can use with CancelTimer.

• Give it the timerid you got from SetTimeout to cancel the timer.

• Returns full path and filename to winamp.ini

• Returns the directory to where you can store your config files

• Call it like this: “vis_avs.dll,0” or “vis_plugin,2”

• Restarts winamp. Dont do anything fancy after this call as the script will terminate.

• Displays the Song notification popup used in Winamp Modern skin (and skins which clones this).

• Returns an integer representing the current version of Winamp

• Returns a list of items added to the Send To menu.

• Used to send a message to the Main Window of Winamp.
• msg=Message number/ID
• wParam=First message parameter
• lParam=Second message parameter

• Same syntax as SendMsg, except the message is “posted” and will return immediately.

• Executes the script named “scriptfile”

• Winamp will update information about the current title

This applies to the Playlist object which you get by using the Playlist property on the main object (Application).

• Number of playlist entries

• Returns a MediaItem object for the playlist entry

• Gets the current playlist position. Set it to change playlist position.

• The window handle of the playlist editor window.

• Returns an collection of the selected playlist items (highlighted)

• Clears the playlist, removing all playlist items.

• Removes the specified playlist item. DeleteIndex(3) deletes the third item.

• Swaps the playlist item <from> with <to>

• Flushes the playlist cache, re-reading all titles.

• Used to send a message to the Main Window of Winamp.
• msg=Message number/ID
• wParam=First message parameter
• lParam=Second message parameter

• Same syntax as SendMsg, except the message is “posted” and will return immediately.

A media item is an item that contains properties and methods for accessing an item in the media library and playlist.

• Name of the media item.

• The media items’s filename.

• The position of the item in the playlist

• Title of media item (song name).

• Media item’s Artist field.

• Media items’s Album field.

• User’s rating of media item.

• The media item’s playcount (how many times the song has been played) field.

• Index of this media item in the media library.

• Length of media item in seconds

• Media item’s Track field.

• Last recorded date this media item was played.

• Returns a title string formatted using <ATFSpecification>.

See http://www.winamp.com/support/help/50/atf/atf_help.htm for the ATF specification (Winamp’s Advanced Title Formatting).

• Adds the media item to the playlist.

• Inserts the Media items at the position <index> in the playlist.

• Refreshes the Meta data for this Media item.

The Media Library object can be accessed through the “MediaLibrary” property of the main object (Application).

• Runs a query in the media library and returns an array of the items that match.

• Loads an item from the media library by filename.

• Returns a Media Item for the item <index> in the Media Library.

• Window handle of the Media Library window