J River Media Center Export Media Library Driver

Modified on 2011/10/09 13:37 by Administrator — Categorized as: Uncategorized

Provides a media library for music in the exported xml file from J. River Media Center.

If you also use the JRMC Media Center media player driver then it is recommended to use that driver as the library instead of this driver.

This driver can be used with touch screen media controls and media player drivers to browse cover art and play music by Artists, Albums, Genres, Titles; and can be filtered by letters. Cover art is retrieved from the music file's meta data, or the folder's folder.jpg file. The file system is rescanned every 24 hours.

Manufacturer: N/A

Configuration Settings

J River Media Center Library Xml File Path : The file path to the J River Media Center Library Xml file to use.'
User Domain Name : (optional) If required, enter the domain name for the user with access to the music folder. If the folder/share was set up to allow 'anonymous' sharing then this is not required.
User Name : (optional) If required, enter a valid user name with access to the music folder. If the folder/share was set up to allow 'anonymous' sharing then this is not required.
User Password : (optional) If required, enter the password for the user with access to the music folder. If the folder/share was set up to allow 'anonymous' sharing then this is not required.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

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

Instance Properties

Loaded

Gets a value indicating if the driver has successfully loaded the music library.

Accessibility : Read Only

Type: Boolean

Scanning

Gets a value indicating if the driver is currently scanning the music folder.

Accessibility : Read Only

Type: Boolean

ScanStartTime

Gets a value indicating if the driver is currently scanning the music folder.

Accessibility : Read Only

Type: DateTime

LastScanDateTime

Gets the date/time of the last successful scan of the music folder.

Accessibility : Read Only

Type: DateTime

ItemCount

Gets the number of tracks and playlists in the library.

Accessibility : Read Only

Type: Number

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

GetMediaImage ( String )

Gets the image.

Syntax

unknown GetMediaImage( String itemID )

Parameters

itemID : The id of the item.

GetMediaFile ( String )

Gets the music file.

Syntax

unknown GetMediaFile( String itemID )

Parameters

itemID : The id of the item.

RescanLibrary

Rescans the music library file.

Syntax

void RescanLibrary( )

Parameters

none

SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )

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

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, IScriptObject, IScriptObject )

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

arrayIndex : The property's array index to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.