Winamp Driver

The Winamp driver controls and reacts to events from the AOL/Nullsoft Winamp Media Player. Winamp and the Desktop Server must be installed on the computer that the driver runs on.

This driver requires that the Desktop Server application be running. This is because Winamp runs on the windows desktop within a user session.

Manufacturer: AOL / Nullsoft

Table of Contents [Hide/Show] Configuration Settings Events    Zone Current Track Artist Changed    Zone Current Track Album Changed    Zone Current Track Title Changed    Zone Current Track Genr Changed    Zone Volume Changed    Zone Mute State Changed    Zone Mode Changed    Zone Shuffle State Changed    Zone Repeat Mode Changed    Zone Playlist Position Changed    Zone Playlist Length Changed    Ready State Changed    Playing    Paused    Track Changed Instance Properties    ZoneNames    ZoneCurrentTrackArtists    ZoneCurrentTrackAlbums    ZoneCurrentTrackTitles    ZoneCurrentTrackGenres    ZoneVolumes    ZoneMuteStates    ZoneTransportModes    Connected    ZoneCount    ZoneCurrentTrackDurations    ZoneCurrentTrackPositions    ZoneCurrentTrackPaths    ZoneShuffleStates    ZoneRepeatModes    ZonePlaylistPositions    ZonePlaylistLengths    ZoneCurrentTrackCoverArts    DeviceDisplayName    DeviceStartTime    DeviceLifecycleStage    DeviceIsRunningAndReady Instance Methods    PlayZone ( Number )    StopZone ( Number )    PauseZone ( Number )    ToggleZonePause ( Number )    PlayNextZoneTrack ( Number )    PlayPreviousZoneTrack ( Number )    PlayZoneItem ( Number, String )    PlayZoneItems ( Number, Array )    ClearZonePlaylist ( Number )    AppendZonePlaylistItem ( Number, String )    SetZoneVolume ( Number, Number )    OffsetZoneVolume ( Number, Number )    MuteZone ( Number )    UnmuteZone ( Number )    SetZoneTransportMode ( Number, String )    SetZoneCurrentTrackPosition ( Number, TimeSpan )    SetPropertyForDuration ( String, TimeSpan, Object, Object )    SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

• Host Name : The host name or ip address of the desktop server.
  

Events

Zone Current Track Artist Changed

Occurs when the current track's artist changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Album Changed

Occurs when the current track's album changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Title Changed

Occurs when the current track's title changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Genr Changed

Occurs when the current track's genre changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Volume Changed

Occurs when the current volume setting for the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Mute State Changed

Occurs when the current mute setting for the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Mode Changed

Occurs when the player's mode changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Shuffle State Changed

Occurs when the shuffle state of the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Repeat Mode Changed

Occurs when the repeat state of the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Position Changed

Occurs when the index of the currently playing song changes on a zone.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Length Changed

Occurs when the total number of tracks in a zone's playlist changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Ready State Changed

The device's running and ready state changed.

Whenever Filter:


EventArgs:

• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Playing

Occurs when the player mode changes to playing.

Whenever Filter:


EventArgs:

Paused

Occurs when the player mode changes to paused.

Whenever Filter:


EventArgs:

Track Changed

Occurs when the currently playing song changes.

Whenever Filter:


EventArgs:

Instance Properties

ZoneNames

Gets the name of all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackArtists

Gets the current track's artist property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackAlbums

Gets the current track's album property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackTitles

Gets the current track's title property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackGenres

Gets the current track's genre property for all zones.

Accessibility : Read Only

Type: Array

ZoneVolumes

Gets or sets the current volume setting for the player zones. The scale is 0 to 100.

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets or sets a value indicating if a zone's volume setting for the player is muted.

Accessibility : Read Only

Type: Array

ZoneTransportModes

Gets or sets a zone's transport mode as 'play', 'stop' or 'pause'.

Accessibility : Read Only

Type: Array

Connected

Gets the connected state of the player, true if the driver is connected to the Winamp application, otherwise false.

Accessibility : Read Only

Type: Boolean

ZoneCount

Gets the number of zones supported by this media player driver.

Accessibility : Read Only

Type: Number

ZoneCurrentTrackDurations

Gets the duration of a zone's currently playing song.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPositions

Gets or sets the current time position that the each zone's current song has been playing.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPaths

Gets the path for the currently playing track for each zone.

Accessibility : Read Only

Type: Array

ZoneShuffleStates

Gets or set the shuffle state of a zone playlist.

Accessibility : Read Only

Type: Array

ZoneRepeatModes

Gets or sets the repeat state. The winamp interface only supports on and off, while the Winamp application actually supports off, by song, and by playlist.

Accessibility : Read Only

Type: Array

ZonePlaylistPositions

Gets or sets the playlist song position that is currently playing by index. When setting, a one-based value may be used to indicate which song to play.

Accessibility : Read Only

Type: Array

ZonePlaylistLengths

Gets the total number of tracks in each zone's playlist.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackCoverArts

Gets the cover art for the each zone's current track.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

PlayZone ( Number )

Starts playing the a zone's playlist.

Syntax


Parameters

StopZone ( Number )

Stops playing the a zone's playlist.

Syntax


Parameters

PauseZone ( Number )

Pauses the playing of a zone's playlist.

Syntax


Parameters

ToggleZonePause ( Number )

Toggles the pause state of a zone's playlist.

Syntax


Parameters

PlayNextZoneTrack ( Number )

Plays the next track in a zone's playlist.

Syntax


Parameters

PlayPreviousZoneTrack ( Number )

Plays the previous track in a zone's playlist.

Syntax


Parameters

PlayZoneItem ( Number, String )

Adds the specified song file path, playlist file path, URL, or directory path contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax


Parameters

PlayZoneItems ( Number, Array )

Adds the specified song file paths, playlist file paths, URLs, or directory paths contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax


Parameters

ClearZonePlaylist ( Number )

Clears a zone's playlist and stops the player.

Syntax


Parameters

AppendZonePlaylistItem ( Number, String )

Adds the specified song file path, playlist file path, URL, or directory path contents to the end of a zone's playlist.

Syntax


Parameters

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

Syntax


Parameters

OffsetZoneVolume ( Number, Number )

Offsets the current volume setting for the player. Positive numbers increase the volume by the specified number and negative numbers decrease the volume. The full volume scale is 0 to 100.

Syntax


Parameters

MuteZone ( Number )

Turn the mute on for a zone.

Syntax


Parameters

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax


Parameters

SetZoneTransportMode ( Number, String )

Set's a zone's transport mode as 'play', 'stop' or 'pause'.

Syntax


Parameters

SetZoneCurrentTrackPosition ( Number, TimeSpan )

Set's a zone's track position.

Syntax


Parameters

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters