Elve Media Player Driver

This is the standard audio media player for the Elve system and is recommended for single zone needs when you do not need to play digital rights management protected files. Supports mp3, wma, m4a, wav, m3u, and wpl files and any other files you have a direct source codec for. If you are not able to hear audio from newer file types such as m4a you are likely missing a DirectSound codec. As of October 2010 there are not many 64 bit codec's available so you may have trouble playing m4a files on a 64 bit machine. While we don't endorse any particular codec pack, a quick search on the internet reveals Window Essentials Codec Pack, Combined Community Codec Pack, K-Lite Codec Pack, among others.

Manufacturer: N/A

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

Configuration Settings

Events

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 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 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 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 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.
  

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 Modes Changed

Occurs when the repeat mode 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.
  

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.
  

Track Changed

Occurs when the currently playing song changes.

Whenever Filter:


EventArgs:

• String CurrentTitle : The title of the new track.
• Number PlaylistIndex : The playlist index of the new track.
  

Playing

Occurs when the player mode changes to playing.

Whenever Filter:


EventArgs:

Paused

Occurs when the player mode changes to paused.

Whenever Filter:


EventArgs:

Instance Properties

ZoneCurrentTrackAlbums

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

Accessibility : Read Only

Type: Array

ZoneCurrentTrackArtists

Gets the current track's artist 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

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 a value indicating if a connection with Microsoft DirectX was successful.

Accessibility : Read Only

Type: Boolean

ZoneCount

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

Accessibility : Read Only

Type: Number

ZoneCurrentTrackCoverArts

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

Accessibility : Read Only

Type: Array

ZoneNames

Gets the name of all zones.

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

ZoneCurrentTrackDurations

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

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPaths

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

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

ZoneShuffleStates

Gets or set the shuffle state of a zone playlist.

Accessibility : Read Only

Type: Array

ZoneRepeatModes

Gets or sets the repeat mode which indicates if the player will stop playing at the end of the zone's playlist, repeat the current song indefinitely, or repeat the zone's playlist indefinitely. A value of '0' indicates that the player will stop at the end of the playlist, '1' indicates that the player will repeat the current song indefinitely and a value of '2' indicates that the player will repeat the entire playlist indefinitely.

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

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

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

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

PlayZoneItem ( Number, String )

Adds the specified track or playlist file path 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 track or playlist file path 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 track or playlist file path to the end of a zone's playlist.

Syntax


Parameters

InsertZonePlaylistItem ( Number, String )

Inserts the specified track or playlist file path to be played immediately after the current song in a zone's playlist.

Syntax


Parameters

RemoveZonePlaylistItem ( Number, Number )

Removes the song at the specified index from a zone's playlist.

Syntax


Parameters

MoveZonePlaylistItem ( Number, Number, Number )

Moves the song at the specified index to a new index in a zone's playlist.

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