MLITunes Plugin

From Cinemar Wiki
Jump to: navigation, search

Contents

About

This plugin allows users to have multiple clients independently viewing the same iTunes library. While allowing all clients to mantain full control over the iTunes library and player from an attractive user interface. Additional PCs running iTunes can be controlled simultaneously.

Software Requirements

  • iTunes version 7.1.0.59 or newer with an Authorized iTunes Account
  • MLServer 3
  • MLITunes Family Plugin
  • iTunes Control Driver for MLITunes
  • MLiTunes Agent (Runs on Same Computer as iTunes)
  • Internet Connection

Supported Hardware

None

Initial Setup and Configuration

  • Setting up a Shared Cover Art Folder on your iTunes PC
At the end of the MLiTunes Agent Installer you will be asked if you would like to create a shared cover art folder necessary for us to distribute cover art imagery to all clients. If you do not check this box you can manually perform this task using the following procedure:
  1. By default, MLItunesAgent is installed into C:\Program Files\Cinemar\MLItunes, Browse to this folder
  2. Right click on the called MLItunesCoverArt
  3. Select Sharing and Security...
  4. Check the box labeled Share this folder on the network from the Sharing tab
  5. Make sure the Share name is MLItunesCoverArt
  6. Next Check Allow network users to change my files
  7. Finally Press OK


  • Setting up Required Server Variables to Drive User Interface Screens

The iTunes plugin allows control over multiple iTunes applications running on multiple PCs. We use variables to track which iTunes you are connected to. To set this variable initially:

  1. Load itunes_console_thumbs.mls
  2. Select the wrench icon to enter the setup screen
  3. Press the Set Selected iTunes button. This will created a variable called {{clientname}}_Selected_iTunes = 001
  4. Next press the Initialize This Client Now. This sends a command to the iTunes plugin to let it know that a client is there and create any variables that haven't already been created.
  5. You can now return to the Thumbnails page and all data/images should be populated.
Opting to Save Variables in MLServer will prevent you from setting the variable in the steps above everytime you restart MainLobby. Another option, is to issue an MLServeCmd on the Scene startup to set this variable.

The MLiTunes Agent communicates with MLServer's MLiTunes plugin via port 8000 by default. This port has to be opened on both the firewall(s) and antivirus applications on both the Agent PC and the Server PC.

MLServeCmd

It is not recommended to copy and paste any of the following commands for use.

All id numbers and aliases are very generic and may or may not match your specific installation.


Client Commands

NewClient

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NewClient


(Literal)

MLServeCmd.MLITunes|1~NewClient

MLServeCmd.MLITunes|Device_001~NewClient


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

Nothing


Description

This command initializes variables for the client issueing the command.


Notes



Navigation Commands

All navigation commands are client based to allow independant viewing of the iTunes track library.


SelectTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SelectTrack~Track Index


(Literal)

MLServeCmd.MLITunes|1~SelectTrack~F1A739D0421C44DB

MLServeCmd.MLITunes|Device_001~SelectTrack~F1A739D0421C44DB


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Track Index = The index of the track to play.


Returns

Nothing


Description

This command will select the specified track. Only valid when viewing a playlist or album.


Notes


NextTrackPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextTrackPage


(Literal)

MLServeCmd.MLITunes|1~NextTrackPage

MLServeCmd.MLITunes|Device_001~NextTrackPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page_count


Description

This command will displays the next page of tracks for an album or playlist.


Notes


PreviousTrackPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousTrackPage


(Literal)

MLServeCmd.MLITunes|1~PreviousTrackPage

MLServeCmd.MLITunes|Device_001~PreviousTrackPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page_count


Description

This command will displays the previous page of tracks for an album or playlist.


Notes


JumpToDirect

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~JumpToDirect~Value


(Literal)

MLServeCmd.MLITunes|1~JumpToDirect~0

MLServeCmd.MLITunes|Device_001~JumpToDirect~23


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Value = The number of the value to jump to.
Valid Values: 0=#,1=A,...,26=Z


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_more

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_jump_direct

{{clientname}}_mlitunes_{{MLITunes Id}}_current_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page_count


Description

This command will jump the current view to the specified value. If there is no item that starts with the specified value the jump will go to were the value would be logically.

Ex: JumpToDirect~4 will jump the current view to the first item that starts with a "D".


Notes


JumpTo

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~JumpTo~Type~Value


(Literal)

MLServeCmd.MLITunes|1~JumpTo~Alpha~Q

MLServeCmd.MLITunes|Device_001~JumpTo~Number~80


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Type = The type of jump to perform.
Valid Values: Alpha,Number
Value = The value to use to perform the jump.
When Type is Alpha valid values are A-Z
When Type is Number valid values are 0-100


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_more

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_jump_direct

{{clientname}}_mlitunes_{{MLITunes Id}}_current_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page_count


Description

This command will jump the current view to the specified value. Ex:

JumpTo~Alpha~Q will jump the current view to the first item that starts with a Q.

JumpTo~Number~50 will jump the current view to the first item that starts with M.


Notes


Select

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Select~Item Index


(Literal)

MLServeCmd.MLITunes|1~Select~Hello

MLServeCmd.MLITunes|Device_001~Select~F1A739D0421C44DB


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Item Index = The index of the item to select.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page_count


Description

This command selects the specified item from the current view.


Notes


NextPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextPage


(Literal)

MLServeCmd.MLITunes|1~NextPage

MLServeCmd.MLITunes|Device_001~NextPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_more

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_jump_direct

{{clientname}}_mlitunes_{{MLITunes Id}}_current_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page_count


Description

This command will display the next page of items in the current view.


Notes


PreviousPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousPage


(Literal)

MLServeCmd.MLITunes|1~PreviousPage

MLServeCmd.MLITunes|Device_001~PreviousPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_more

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_jump_direct

{{clientname}}_mlitunes_{{MLITunes Id}}_current_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_page_count


Description

This command will display the previous page of items in the current view.


Notes


Back

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Back


(Literal)

MLServeCmd.MLITunes|1~Back

MLServeCmd.MLITunes|Device_001~Back


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

Nothing


Description

This command will bring the user back one level from the current view. Only valid in iPod mode.


Notes


ViewPlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~ViewPlaylist~Index


(Literal)

MLServeCmd.MLITunes|1~ViewPlaylist~Recently Added

MLServeCmd.MLITunes|Device_001~ViewPlaylist~F1A739D0421C44DB


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Index = The name or index of the playlist to play.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_coverart

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_items

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page

{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page_count


Description

This command will display the tracks in the specified playlist.


Notes


NextPlaylistPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextPlaylistPage


(Literal)

MLServeCmd.MLITunes|1~NextPlaylistPage

MLServeCmd.MLITunes|Device_001~NextPlaylistPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_items

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page_count


Description

This command displays the next page of playlists.


Notes


PreviousPlaylistPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousPlaylistPage


(Literal)

MLServeCmd.MLITunes|1~PreviousPlaylistPage

MLServeCmd.MLITunes|Device_001~PreviousPlaylistPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_items

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page_count


Description

This command displays the previous page of playlists.


Notes


SearchArtistAlbums

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchArtistAlbums


(Literal)

MLServeCmd.MLITunes|1~SearchArtistAlbums

MLServeCmd.MLITunes|Device_001~SearchArtistAlbums


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command initializes the search scene variables to search by artist album.


Notes


SearchGenres

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchGenres


(Literal)

MLServeCmd.MLITunes|1~SearchGenres

MLServeCmd.MLITunes|Device_001~SearchGenres


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command initializes the search scene variables to search by genre.


Notes


SearchArtists

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchArtists


(Literal)

MLServeCmd.MLITunes|1~SearchArtists

MLServeCmd.MLITunes|Device_001~SearchArtists


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command initializes the search scene variables to search by artists


Notes


SearchAlbums

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchAlbums


(Literal)

MLServeCmd.MLITunes|1~SearchAlbums

MLServeCmd.MLITunes|Device_001~SearchAlbums


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command initializes the search scene variables to search by albums


Notes


SearchSongs

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchSongs


(Literal)

MLServeCmd.MLITunes|1~SearchSongs

MLServeCmd.MLITunes|Device_001~SearchSongs


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command initializes the search scene variables to search by songs


Notes


NextSearchPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextSearchPage


(Literal)

MLServeCmd.MLITunes|1~NextSearchPage

MLServeCmd.MLITunes|Device_001~NextSearchPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count


Description

This command will display the next page of search results.


Notes


PreviousSearchPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousSearchPage


(Literal)

MLServeCmd.MLITunes|1~PreviousSearchPage

MLServeCmd.MLITunes|Device_001~PreviousSearchPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count


Description

This command will display the previous page of search results.


Notes


SearchJumpToDirect

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchJumpToDirect~Value


(Literal)

MLServeCmd.MLITunes|1~SearchJumpToDirect~0

MLServeCmd.MLITunes|Device_001~SearchJumpToDirect~23


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Id = The value to jump to.
Valid Values: 0=#,1=A,...,26=Z


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count


Description

This command will jump the current search results to the specified position. If there is no item that starts with the specified value the jump will go to were the value would be logically. Ex:

SearchJumpToDirect~0 will jump to the beggining of the search results.

SearchJumpToDirect~10 will jump to the first search item that starts with the letter J.


Notes


SearchJumpTo

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchJumpTo~Type~Value


(Literal)

MLServeCmd.MLITunes|SearchJumpTo~<<Alpha/Number>>~<<Value>>


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Type = The type of jump to perform.
Valid Values: Alpha,Number
Value = The value to use to perform the jump.
When Type is Alpha valid values are A-Z
When Type is Number valid values are 0-100


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count


Description

This command will jump the current search results to the specified value. If there is no item that starts with the specified value the jump will go to were the value would be logically.

Ex:

JumpToDirect~4 will jump the current view to the first item that starts with a "D".


Notes


SearchSelect

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SearchSelect~Item Index


(Literal)

MLServeCmd.MLITunes|1~SearchSelect~Hello

MLServeCmd.MLITunes|Device_001~SearchSelect~1


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Item Index = The index of the item to select. This maybe numeric or text.


Returns

Nothing.


Description

This command will select the specified search item and take the apporpriate action.


Notes


KeyBoard

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Keyboard~key


(Literal)

MLServeCmd.MLITunes|001~KeyBoard~J

MLServeCmd.MLITunes|Device_001~KeyBoard~J


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Key = The letter to add to the search text.
Valid Values: A-Z,1-9,Space,Clear,Back


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

{{clientname}}_mlitunes_{{MLITunes Id}}_search_text


Description

This command will append the specified letter to the clients search text.

When clear is specified the clients search text will be cleared.

When Spave is specified a space is appended to the clients search text

When Back is specified the last character is removed fromm the clients search text.


Notes


NextNowPlayingPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextNowPlayingPage


(Literal)

MLServeCmd.MLITunes|1~NextNowPlayingPage

MLServeCmd.MLITunes|Device_001~NextNowPlayingPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will display the next page of the now playing list.


Notes


PreviousNowPlayingPage

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousNowPlayingPage


(Literal)

MLServeCmd.MLITunes|1~PreviousNowPlayingPage

MLServeCmd.MLITunes|Device_001~PreviousNowPlayingPage


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will display the previous page of the now playing list.


Notes



Now Playing Commands

All now playing commands are global to all clients. As all clients to a single MLITunes controller will use the same now playing list.


RemoveFromNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~RemoveFromNowPlaying~Index


(Literal)

MLServeCmd.MLITunes|1~RemoveFromNowPlaying~1

MLServeCmd.MLITunes|Device_001~RemoveFromNowPlaying~6


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Index = The index of the track to remove fron the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command removes the specified track from the now playing list.


Notes


ClearNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~ClearNowPlaying


(Literal)

MLServeCmd.MLITunes|1~ClearNowPlaying

MLServeCmd.MLITunes|Device_001~ClearNowPlaying


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will clear the now playing list.


Notes


PlayNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayNowPlaying


(Literal)

MLServeCmd.MLITunes|1~PlayNowPlaying

MLServeCmd.MLITunes|Device_001~PlayNowPlaying


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_current_track_album

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_now_playing_index

mlitunes_{{MLITunes Id}}_now_playing_next_album

mlitunes_{{MLITunes Id}}_now_playing_next_artist

mlitunes_{{MLITunes Id}}_now_playing_next_image

mlitunes_{{MLITunes Id}}_now_playing_next_index

mlitunes_{{MLITunes Id}}_now_playing_next_track

mlitunes_{{MLITunes Id}}_now_playing_prev_album

mlitunes_{{MLITunes Id}}_now_playing_prev_artist

mlitunes_{{MLITunes Id}}_now_playing_prev_image

mlitunes_{{MLITunes Id}}_now_playing_prev_index

mlitunes_{{MLITunes Id}}_now_playing_prev_track

mlitunes_{{MLITunes Id}}_now_playing_tracks_count

mlitunes_{{MLITunes Id}}_now_playing_tracks_remaining

mlitunes_{{MLITunes Id}}_play_time

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_player_state

mlitunes_{{MLITunes Id}}_player_total_time


Description

This command will play the now playing list from the beggining.


Notes


StopNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~StopNowPlaying


(Literal)

MLServeCmd.MLITunes|1~StopNowPlaying

MLServeCmd.MLITunes|Device_001~StopNowPlaying


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_play_time

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_player_state

mlitunes_{{MLITunes Id}}_player_total_time


Description

This command will stop the now playing list if it is currently playing.


Notes


NextNowPlayingTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextNowPlayingTrack


(Literal)

MLServeCmd.MLITunes|1~NextNowPlayingTrack

MLServeCmd.MLITunes|Device_001~NextNowPlayingTrack


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_current_track_album

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_now_playing_index

mlitunes_{{MLITunes Id}}_now_playing_next_album

mlitunes_{{MLITunes Id}}_now_playing_next_artist

mlitunes_{{MLITunes Id}}_now_playing_next_image

mlitunes_{{MLITunes Id}}_now_playing_next_index

mlitunes_{{MLITunes Id}}_now_playing_next_track

mlitunes_{{MLITunes Id}}_now_playing_prev_album

mlitunes_{{MLITunes Id}}_now_playing_prev_artist

mlitunes_{{MLITunes Id}}_now_playing_prev_image

mlitunes_{{MLITunes Id}}_now_playing_prev_index

mlitunes_{{MLITunes Id}}_now_playing_prev_track

mlitunes_{{MLITunes Id}}_now_playing_tracks_count

mlitunes_{{MLITunes Id}}_now_playing_tracks_remaining

mlitunes_{{MLITunes Id}}_play_time

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_player_state

mlitunes_{{MLITunes Id}}_player_total_time


Description

This command will play the next now playing track if currently playing the now playing list.


Notes


PreviousNowPlayingTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousNowPlayingTrack


(Literal)

MLServeCmd.MLITunes|1~PreviousNowPlayingTrack

MLServeCmd.MLITunes|Device_001~PreviousNowPlayingTrack


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_current_track_album

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_now_playing_index

mlitunes_{{MLITunes Id}}_now_playing_next_album

mlitunes_{{MLITunes Id}}_now_playing_next_artist

mlitunes_{{MLITunes Id}}_now_playing_next_image

mlitunes_{{MLITunes Id}}_now_playing_next_index

mlitunes_{{MLITunes Id}}_now_playing_next_track

mlitunes_{{MLITunes Id}}_now_playing_prev_album

mlitunes_{{MLITunes Id}}_now_playing_prev_artist

mlitunes_{{MLITunes Id}}_now_playing_prev_image

mlitunes_{{MLITunes Id}}_now_playing_prev_index

mlitunes_{{MLITunes Id}}_now_playing_prev_track

mlitunes_{{MLITunes Id}}_now_playing_tracks_count

mlitunes_{{MLITunes Id}}_now_playing_tracks_remaining

mlitunes_{{MLITunes Id}}_play_time

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_player_state

mlitunes_{{MLITunes Id}}_player_total_time


Description

This command will play the previous now playing track if currently playing the now playing list.


Notes


PlayNowPlayingTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayNowPlayingTrack~Index


(Literal)

MLServeCmd.MLITunes|1~PlayNowPlayingTrack~1

MLServeCmd.MLITunes|Device_001~PlayNowPlayingTrack~3


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Index = The index of the now playing track to play.


Returns

mlitunes_{{MLITunes Id}}_current_track_album

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_now_playing_index

mlitunes_{{MLITunes Id}}_now_playing_next_album

mlitunes_{{MLITunes Id}}_now_playing_next_artist

mlitunes_{{MLITunes Id}}_now_playing_next_image

mlitunes_{{MLITunes Id}}_now_playing_next_index

mlitunes_{{MLITunes Id}}_now_playing_next_track

mlitunes_{{MLITunes Id}}_now_playing_prev_album

mlitunes_{{MLITunes Id}}_now_playing_prev_artist

mlitunes_{{MLITunes Id}}_now_playing_prev_image

mlitunes_{{MLITunes Id}}_now_playing_prev_index

mlitunes_{{MLITunes Id}}_now_playing_prev_track

mlitunes_{{MLITunes Id}}_now_playing_tracks_count

mlitunes_{{MLITunes Id}}_now_playing_tracks_remaining

mlitunes_{{MLITunes Id}}_play_time

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_player_state

mlitunes_{{MLITunes Id}}_player_total_time


Description

This command will play a specific track in the now playing list.


Notes


AppendAlbumNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AppendAlbumNowPlaying~Artist~Album


(Literal)

MLServeCmd.MLITunes|1~AppendAlbumNowPlaying~MyArtist~MyAlbum

MLServeCmd.MLITunes|Device_001~AppendAlbumNowPlaying~MyArtist~MyAlbum


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Artist = The name of the artist of the album to add to the now playing list.
Album = The name of the album to add to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will append the specified artist album to the end of the now playing list.

This command departs slightly from the Cinemar convention of separating parameters with a "~". This is done because the artist and album are considered one parameter and can be retreived from one MLServer variable.

As of plugin version 1.0.0.1523 the Artist and Album are no longer separated by a ".", they are now separated by a "~" as all other mlserver commands.

Notes


AddAlbumNowPlayingNow

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddAlbumNowPlayingNow~Artist~Album


(Literal)

MLServeCmd.MLITunes|1~AddAlbumNowPlayingNow~MyArtist~MyAlbum

MLServeCmd.MLITunes|Device_001~AddAlbumNowPlayingNow~MyArtist~MyAlbum


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Artist = The name of the artist of the album to add to the now playing list.
Album = The name of the album to add to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified artist album to the beggining of the now playing list and start playing it now.

This command departs slightly from the Cinemar convention of separating parameters with a "~". This is done because the artist and album are considered one parameter and can be retreived from one MLServer variable.

As of plugin version 1.0.0.1523 the Artist and Album are no longer separated by a ".", they are now separated by a "~" as all other mlserver commands.

Notes


AddAlbumNowPlayingNext

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddAlbumNowPlayingNext~Artist~Album


(Literal)

MLServeCmd.MLITunes|1~AddAlbumNowPlayingNext~MyArtist~MyAlbum

MLServeCmd.MLITunes|Device_001~AddAlbumNowPlayingNext~MyArtist~MyAlbum


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Artist = The name of the artist of the album to add to the now playing list.
Album = The name of the album to add to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified artist album to the now playing list after the currently playing track.

This command departs slightly from the Cinemar convention of separating parameters with a "~". This is done because the artist and album are considered one parameter and can be retreived from one MLServer variable.

As of plugin version 1.0.0.1523 the Artist and Album are no longer separated by a ".", they are now separated by a "~" as all other mlserver commands.

Notes


AppendNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AppendNowPlaying~Track Index


(Literal)

MLServeCmd.MLITunes|1~AppendNowPlaying~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AppendNowPlaying~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Track Index = The index of the track to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will append the specified track to the end of the now playing list.


Notes


AddNowPlayingNow

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddNowPlayingNow~Track Index


(Literal)

MLServeCmd.MLITunes|1~AddNowPlayingNow~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AddNowPlayingNow~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Track Index = The index of the track to add to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified track to the beggining of the now playing list and start playing it now.


Notes


AddNowPlayingNext

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddNowPlayingNext~Track Index


(Literal)

MLServeCmd.MLITunes|1~AddNowPlayingNext~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AddNowPlayingNext~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Track Index = The index of the track to add to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified track to the now playing list after the currently playing track.


Notes


AppendPlaylistNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AppendPlaylistNowPlaying~List Index


(Literal)

MLServeCmd.MLITunes|1~AppendPlaylistNowPlaying~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AppendPlaylistNowPlaying~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The index number of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will append the specified playlist to the end of the now playing list.


Notes


AppendPlaylistNowPlayingByName

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AppendPlaylistNowPlaying~List Name


(Literal)

MLServeCmd.MLITunes|1~AppendPlaylistNowPlaying~Recently Added

MLServeCmd.MLITunes|Device_001~AppendPlaylistNowPlaying~My Playlist


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Name = The name of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will append the specified playlist to the end of the now playing list.


Notes


AddPlaylistNowPlayingNow

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddPlaylistNowPlayingNow~List Index


(Literal)

MLServeCmd.MLITunes|1~AddPlaylistNowPlayingNow~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AddPlaylistNowPlayingNow~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The index number of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified playlist to the beggining of the now playing list and start playing it now.


Notes


AddPlaylistNowPlayingNowByName

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddPlaylistNowPlayingNow~List Name


(Literal)

MLServeCmd.MLITunes|1~AddPlaylistNowPlayingNow~Recently Added

MLServeCmd.MLITunes|Device_001~AddPlaylistNowPlayingNow~My Playlist


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The name of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command will add the specified playlist to the beggining of the now playing list and start playing it now.


Notes


AddPlaylistNowPlayingNext

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddPlaylistnowPlayingNext~List Index


(Literal)

MLServeCmd.MLITunes|1~AddPlaylistNowPlayingNext~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~AddPlaylistNowPlayingNext~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The index number of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command adds the specified playlist to the now playing list after the currently playing track.


Notes


AddPlaylistNowPlayingNextByName

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddPlaylistnowPlayingNext~List Name


(Literal)

MLServeCmd.MLITunes|1~AddPlaylistNowPlayingNext~Recently Added

MLServeCmd.MLITunes|Device_001~AddPlaylistNowPlayingNext~MyPlaylist


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Name = The name of the playlist to append to the now playing list.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_sortname

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count


Description

This command adds the specified playlist to the now playing list after the currently playing track.


Notes


ShuffleNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~ShuffleNowPlaying


(Literal)

MLServeCmd.MLITunes|1~ShuffleNowPlaying

MLServeCmd.MLITunes|Device_001~ShuffleNowPlaying


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_now_playing_Shuffle


Description

This command will toggle the shuffled state of the now playing list.


Notes


RepeatNowPlaying

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~RepeatNowPlaying


(Literal)

MLServeCmd.MLITunes|1~RepeatNowPlaying

MLServeCmd.MLITunes|Device_001~RepeatNowPlaying


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_now_playing_repeat


Description

This command will toggle the repeat state of the now playing list between Off,All,One.


Notes


Playlist Commands

All playlist commands are global to all users. As all clients to a single MLITunes plugin control the same iTunes library.


AddPlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~AddPlaylist~List Name


(Literal)

MLServeCmd.MLITunes|1~AddPlaylist~New List

MLServeCmd.MLITunes|Device_001~AddPlaylist~New List


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Name = The name of the new playlist.


Returns

Nothing


Description

This command will add a new playlist to the iTunes library with the specified name.


Notes


RemovePlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~RemovePlaylist~List Index


(Literal)

MLServeCmd.MLITunes|1~RemovePlaylist~MyPlaylist

MLServeCmd.MLITunes|Device_001~RemovePlaylist~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The name or index number of the playlist to be removed.


Returns

Nothing


Description

This command remove the specified playlist from the iTunes library.


Notes


ClearPlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~ClearPlaylist~List Index


(Literal)

MLServeCmd.MLITunes|1~ClearPlaylist~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~ClearPlaylist~Mylist


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The name or index number of the playlist to be removed.


Returns

Nothing


Description

This command will clear all tracks from the specified playlist in iTunes.


Notes


RemoveTrackFromPlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~RemoveTrackFromPlaylist~List Index~Track Index


(Literal)

MLServeCmd.MLITunes|1~RemoveTrackFromPlaylist~MyList~10

MLServeCmd.MLITunes|Device_001~RemoveTrackFromPlaylist~MyList~3


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The name or index number of the playlist to have a track removed.
Track Index = The index number of the track to remove.


Returns

Nothing


Description

This command will remove the specified track from the specified playlist.


Notes


ShufflePlaylist (Deprecated)

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~ShufflePlaylist~List Index


(Literal)

MLServeCmd.MLITunes|1~ShufflePlaylist~11

MLServeCmd.MLITunes|Device_001~ShufflePlaylist~1


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The index number of the playlist to have a track removed.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_Shuffle


Description

This command will toggle the shuffle state of the specified playlist.


Notes

This command has been deprecated and is no longer functioning as of plugin version 1.0.0.1523.



RepeatPlaylist (Deprecated)

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~RepeatPlaylist~List Index


(Literal)

MLServeCmd.MLITunes|1~RepeatPlaylist~11

MLServeCmd.MLITunes|Device_001~RepeatPlaylist~1


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The index number of the playlist to have a track removed.


Returns

{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_repeat


Description

This command will toggle the repeat state of the specified playlist betweeen Off,All,One.


Notes

This command has been deprecated and is no longer functioning as of plugin version 1.0.0.1523.



Transport Control Commands

All transport controls are global to all users. As all clients to a single MLITunes plugin control the same iTunes player.


PlayPlaylist

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayPlaylist~List Index


(Literal)

MLServeCmd.MLITunes|1~PlayPlaylist~Recently Added

MLServeCmd.MLITunes|Device_001~PlayPlaylist~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
List Index = The name or number index of the playlist to be played.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description

This command will play the specified playlist.


Notes


PlayTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayTrack~Track Index


(Literal)

MLServeCmd.MLITunes|1~PlayTrack~D03186FEA00A20CE

MLServeCmd.MLITunes|Device_001~PlayTrack~D03186FEA00A20CE


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Track Index = The number index of the track to be played.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description

This command will play the specified track.


Notes


PlayFile

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayFilePath


(Literal)

MLServeCmd.MLITunes|1~PlayFile~C:\MyPath\MyTrack.mp3

MLServeCmd.MLITunes|Device_001~PlayFile~C:\MyTrack.wma


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Path = The path to the file to be played.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description

This command will play the specified file path, adding it to the library if not already present.


Notes


Play

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Play


(Literal)

MLServeCmd.MLITunes|1~Play

MLServeCmd.MLITunes|Device_001~Play


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description

This command will start iTunes playing.


Notes


Pause

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Pause


(Literal)

MLServeCmd.MLITunes|1~Pause

MLServeCmd.MLITunes|Device_001~Pause


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State


Description

This command will pause the currently playing track.


Notes


PlayPause

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayPause


(Literal)

MLServeCmd.MLITunes|1~PlayPause

MLServeCmd.MLITunes|Device_001~PlayPause


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State


Description

This command will toggle the playing/paused state of the current track.


Notes


TogglePlayPause

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~TogglePlayPause


(Literal)

MLServeCmd.MLITunes|1~TogglePlayPause

MLServeCmd.MLITunes|Device_001~TogglePlayPause


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State


Description

This command will toggle the playing/paused state of the current track. This command was implemented as an alternative to the actual iTunes playpause command as that command may stop playback in some cases instead of pausing it. This command will read the current player state from iTunes and pause playback if it is playing otherwise it will resume playback.


Notes


BackTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~BackTrack


(Literal)

MLServeCmd.MLITunes|1~BackTrack

MLServeCmd.MLITunes|Device_001~BackTrack


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_player_position_percent

mlitunes_{{MLITunes Id}}_play_time


Description

This command set the playing position to the beggining of the currently playing track.


Notes


FastForward

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~FastForward


(Literal)

MLServeCmd.MLITunes|1~FastForward

MLServeCmd.MLITunes|Device_001~FastForward


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

Nothing


Description

This command fastforwards the currently playing track.


Notes


NextTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~NextTrack


(Literal)

MLServeCmd.MLITunes|1~NextTrack

MLServeCmd.MLITunes|Device_001~NextTrack


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description

This command will advance to the next track in the current playlist.


Notes


PreviousTrack

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PreviousTrack


(Literal)

MLServeCmd.MLITunes|1~PreviousTrack

MLServeCmd.MLITunes|Device_001~PreviousTrack


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State

mlitunes_{{MLITunes Id}}_current_track_track

mlitunes_{{MLITunes Id}}_current_track_title

mlitunes_{{MLITunes Id}}_current_track_time

mlitunes_{{MLITunes Id}}_current_track_sort_artist

mlitunes_{{MLITunes Id}}_current_track_more

mlitunes_{{MLITunes Id}}_current_track_index

mlitunes_{{MLITunes Id}}_current_track_coverart

mlitunes_{{MLITunes Id}}_current_track_artist

mlitunes_{{MLITunes Id}}_current_track_album


Description This command will return to the previous track in the current playlist.


Notes


Resume

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Resume


(Literal)

MLServeCmd.MLITunes|1~Resume

MLServeCmd.MLITunes|Device_001~Resume


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State


Description

This command will disable fast forward/rewind and resume playback, if playing.


Notes


Rewind

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Rewind


(Literal)

MLServeCmd.MLITunes|1~Rewind

MLServeCmd.MLITunes|Device_001~Rewind


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

Nothing


Description

This command Skip backwards in a playing track.


Notes


Stop

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Stop


(Literal)

MLServeCmd.MLITunes|1~Stop

MLServeCmd.MLITunes|Device_001~Stop


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Player_State


Description

This command will Stop playback.


Notes


Mute

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Mute


(Literal)

MLServeCmd.MLITunes|1~Mute

MLServeCmd.MLITunes|Device_001~Mute


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Volume


Description

This command mutes sound output.


Notes


Volume

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~Volume~Level


(Literal)

MLServeCmd.MLITunes|1~Volume~0

MLServeCmd.MLITunes|Device_001~Volume~75


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Level = The volume level to set iTunes to.


Returns

mlitunes_{{MLITunes Id}}_Volume


Description

This command set the volume to the specified level.


Notes


VolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~VolumeUp


(Literal)

MLServeCmd.MLITunes|1~VolumeUp

MLServeCmd.MLITunes|Device_001~VolumeUp


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Volume


Description

This command will increases the volume by one percent.


Notes


VolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~VolumeDown


(Literal)

MLServeCmd.MLITunes|1~VolumeDown

MLServeCmd.MLITunes|Device_001~VolumeDown


Parameters

Id = The id number or alias of the ITunes controller to send the command to.


Returns

mlitunes_{{MLITunes Id}}_Volume


Description

This command will decreases the volume by one percent.


Notes


PlayerPosition

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayerPosition~Position


(Literal)

MLServeCmd.MLITunes|1~PlayerPosition~30

MLServeCmd.MLITunes|Device_001~PlayerPosition~183


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Position = The new player position in seconds.


Returns

mlitunes_{{MLITunes Id}}_Play_Time

mlitunes_{{MLITunes Id}}_Player_Position_Percent


Description

This command will set the current player position to the specified value if possible.


Notes


PlayerPositionPercent

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~PlayerPositionPercent~Percent


(Literal)

MLServeCmd.MLITunes|1~PlayerPositionPercent~30

MLServeCmd.MLITunes|Device_001~PlayerPositionPercent~89


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Percent = The new player position in a percentage.


Returns

mlitunes_{{MLITunes Id}}_Play_Time

mlitunes_{{MLITunes Id}}_Player_Position_Percent


Description

This command will set the current player position to the specified percentage value.


Notes



Settings Commands

All settings commands are specific to the client issueing the command.

By using -1 as the limit in any of the settings commands will cause all results to be displayed. An example would be issueing the SetAlbumLimit command with a limit of -1. This would cause all albums to be returned when albums are requested.


SetAlbumLimit

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SetAlbumLimit~Limit


(Literal)

MLServeCmd.MLITunes|1~SetAlbumLimit~10

MLServeCmd.MLITunes|1~SetAlbumLimit~-1

MLServeCmd.MLITunes|Device_001~SetAlbumLimit~13


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Limit = The number of albums to display per page.


Returns

Nothing


Description

This command will set the number of albums to display per page.


Notes


SetTrackLimit

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SetTrackLImit~Limit


(Literal)

MLServeCmd.MLITunes|1~SetTrackLimit~4

MLServeCmd.MLITunes|1~SetTrackLimit~-1

MLServeCmd.MLITunes|Device_001~SetTrackLimit~60


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Limit = The number of tracks to display per page.


Returns

Nothing


Description

This command sets the number of tracks to display per page.


Notes


SetSearchLimit

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SetSearchLimit~Limit


(Literal)

MLServeCmd.MLITunes|1~SetSearchLimit~15

MLServeCmd.MLITunes|1~SetSearchLimit~-1

MLServeCmd.MLITunes|1~SetSearchLimit~4


Parameters

Id = The id number or alias of the ITunes controller to send the command to.
Limit = The number of search results to display per page.


Returns

Nothing


Description

This command sets the number of search results to display per page.


Notes


SetPlaylistLimit

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SetPlaylistLimit~Limit


(Literal)

MLServeCmd.MLITunes|1~SetPlaylistLimit~9

MLServeCmd.MLITunes|1~SetPlaylistLimit~-1

MLServeCmd.MLITunes|Device_001~SetPlaylistLimit~20


Parameters


Returns

Nothing


Description

This command set the number of playlists to display per page.


Notes


SetNowPlayingLimit

{MLServeCmd}Script Usage

MLServeCmd.MLITunes|Id~SetNowPlayingLimit~Limit


(Literal)

MLServeCmd.MLITunes|1~SetNowPlayingLimit~6

MLServeCmd.MLITunes|1~SetNowPlayingLimit~-1

MLServeCmd.MLITunes|Device_001~SetNowPlayingLimit~40


Parameters


Returns

Nothing


Description

This command sets the number of tracks in the now playing list to display per page.

MLServer Variables

Client Variables

{{clientname}}_selected_itunes

Description: The currently selected itunes control driver.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_artist

Description: ** Depricated See: {{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_artist

Values:


{{clientname}}_mlitunes_{{MLITunes Id}}_artist_sort_name

Description: ** Depricated See: {{clientname}}_mlitunes_{{MLITunes Id}}_selected_artist_sort_name

Values:


{{clientname}}_mlitunes_{{MLITunes Id}}_album_coverart

Description: ** Depricated See: {{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_coverart

Values:


{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_coverart

Description: The path to the specified album items coverart image.

Values: Any valid file path.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_index

Description: The specified album items index.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_title

Description: The specified album items title. This the album name.

Values: Any valid album name.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_value

Description: The specified album items value. This is the albums track name.

Values: Any valid track name.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_item_{{Item Number}}_visible

Description: The specified album items visible property.

Values: True if the item has data to display, false otherwise.


{{clientname}}_mlitunes_{{MLITunes Id}}_album_more

Description: ** Depricated See: {{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_more

Values:


{{clientname}}_mlitunes_{{MLITunes Id}}_album_name

Description: ** Depricated See: {{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_name

Values:


{{clientname}}_mlitunes_{{MLITunes Id}}_current_item_count

Description: The total number of items in the current view.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_items

Description: The number of items in the current view on the current page.

Values: A number range. Ex: 69-82


{{clientname}}_mlitunes_{{MLITunes Id}}_current_page

Description: The currently displayed page of items.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_page_count

Description: The number of pages in the current view.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_item_count

Description: The total number of track items in the current track view.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_items

Description: The number of items in the current view on the current page.

Values: A number range. Ex: 1-9


{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page

Description: The currently displayed page of the current track view.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_track_page_count

Description: The total number of pages in the current track view.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_current_view

Description: The current view category of the iTunes control driver when in iPod mode.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_coverart

Description: The path to the specified items coverart image;

Values: Any valid file path.


{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_index

Description: The specified items index. This is a comma separated pairing of the album name and the album artist.

Values: AlbumName,AlbumArtist


{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_more

Description: The specified items "more by" property.

Values: True if there is more albums by the same artist, false otherwise.


{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_title

Description: The specified items title. This is the album artist.

Values: Any valid ablum artist.


{{clientname}}_mlitunes_{{MLITunes Id}}_item_{{Item Number}}_value

Description: The specified items value. This is the album name.

Values: Any valid album name.


{{clientname}}_mlitunes_{{MLITunes Id}}_jump

Description: The current position of the selection slider.

Values: A number 0-100.


{{clientname}}_mlitunes_{{MLITunes Id}}_jump_direct

Description: The current value of the selection slider.

Values: A number 0-26.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_album

Description: The specified now playing items album name.

Values: Any valid album name.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_artist

Description: The specified now playing items artist name.

Values: Any valid artist name.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_image

Description: The path to the specified now playing items coverart image.

Values: Any valid file path.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_index

Description: The specified now playing items index.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_{{Item Number}}_name

Description: The specified now playing items name.

Values: Any valid track name.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_index_adj

Description: The current index of the now playing list adjusted for the current page the client is currently viewing.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_item_count

Description: The total number of items in the now playing list.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_items

Description: The number of items in the now playing list on the currently displayed page.

Values: A number range. Ex:1 - 10


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page

Description: The currently displayed page of the now playing list.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_now_playing_page_count

Description: The total number of pages in the now playing list.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_index

Description: The specified playlist items index.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_Repeat

Description: The specified playlists repeat state

Values: Off,All,One


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_shuffle

Description: The specified playlists shuffle state

Values: True,False


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_value

Description: The specified playlist items value. This is the playlist name.

Values: Any valid playlist name.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_{{Item Number}}_visible

Description: The specified playlist items visible property.

Values: True or False.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_item_count

Description: The total number of playlists.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_items

Description: The number of playlist items in the current playlist page.

Values: A number range. Ex:1-14


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page

Description: The currently displayed page of playlists.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_playlist_page_count

Description: The total number of playlist pages.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_index

Description: The specified search items index.

Values: A number or text based on the current search mode.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_title

Description: The specified search items title.

Values: A number or text based on the current search mode.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_value

Description: The specifieid search items value.

Values: This is currently not used but reserved for future use.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_{{Item Number}}_visible

Description: The specified search items visible property.

Values: True or False


{{clientname}}_mlitunes_{{MLITunes Id}}_search_item_count

Description: The total number of items in the current search.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_items

Description: The search items on the current page

Values: A number range. Ex: 25-29


{{clientname}}_mlitunes_{{MLITunes Id}}_search_jump

Description: The current position of the search selection slider.

Values: A number 0-100.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_page

Description: The currently displayed search page.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_page_count

Description: The total number of search pages.

Values: A number.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_text

Description: The current search value.

Values: Text specified by user.


{{clientname}}_mlitunes_{{MLITunes Id}}_search_type

Description: The current search type.

Values: A number. 1=Artist/Album 2= Genres 3=Artists 4=Albums 5=Songs


{{clientname}}_mlitunes_{{MLITunes Id}}_search_type_value

Description: The current search type.

Values: Text. Artist/Album,Genres,Artists,Albums,Songs


{{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_artist

Description: The selected albums artist name.

Values: Any valid album artist name.


{{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_artist_sort_name

Description: The artist sort name of the track currently playing from the now playing list.

Values: Any valid artist sort name


{{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_coverart

Description: The path to the selected albums coverart image.

Values: Any valid file path.


{{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_more

Description: The selected albumns "more by" property

Values: True if there is more albums by the same artist, false otherwise.


{{clientname}}_mlitunes_{{MLITunes Id}}_selected_album_name

Description: The selected albums name.

Values: Any valid album name.


{{clientname}}_mlitunes_selected_item_album

Description: The number of the selected album item

Values: A number 1 - AlbumLimit


Global Variables

mlitunes_{{MLITunes Id}}_current_track_album

Description: The currently playing tracks album name.

Values: Any valid album name.


mlitunes_{{MLITunes Id}}_current_track_artist

Description: The currently playing tracks artist name.

Values: Any valid artist name.


mlitunes_{{MLITunes Id}}_current_track_coverart

Description: The path to the currently playing tracks coverart image.

Values: Any valid file path.


mlitunes_{{MLITunes Id}}_current_track_index

Description: The index of the currently playing track.

Values: A number.


mlitunes_{{MLITunes Id}}_current_track_more

Description: The currently playing tracks "more by" property.

Values: True if there is more albums by the current playing tracks artist, false otherwise.


mlitunes_{{MLITunes Id}}_current_track_sort_artist

Description: The currently playing tracks sort artist.

Values: Any valid track sort artist.


mlitunes_{{MLITunes Id}}_current_track_time

Description: The duration in seconds of the currently playing track.

Values: A number.


mlitunes_{{MLITunes Id}}_current_track_title

Description: The currently playing tracks title.

Values: Any valid track title.


mlitunes_{{MLITunes Id}}_current_track_track

Description: The track number of the currently playing track.

Values: A number.


mlitunes_{{MLITunes Id}}_now_playing_index

Description: The current index of the now playing list.

Values: A number.


mlitunes_{{MLITunes Id}}_now_playing_next_album

Description: The album name of the next track in the now playing list to be played.

Values: Any valid album name.


mlitunes_{{MLITunes Id}}_now_playing_next_artist

Description: The artist name of the next track in the now playing list to be played.

Values: Any valid artist name.


mlitunes_{{MLITunes Id}}_now_playing_next_image

Description: The path to the coverart image of the next track in the now playing list to be played.

Values: Any valid file path.


mlitunes_{{MLITunes Id}}_now_playing_next_index

Description: The index of the next track in the now playing list to be played

Values: A number.


mlitunes_{{MLITunes Id}}_now_playing_next_track

Description: The name of the next track in the now playing list to be played.

Values: Any valid track name.


mlitunes_{{MLITunes Id}}_now_playing_prev_album

Description: The album name of the previous track played from the now playing list.

Values: Any valid album name.


mlitunes_{{MLITunes Id}}_now_playing_prev_artist

Description: The artist name of the previous track played from the now playing list.

Values: Any valid artist name.


mlitunes_{{MLITunes Id}}_now_playing_prev_image

Description: The path to the coverart image of the previous track played from the now playing list.

Values: Any valid file path.


mlitunes_{{MLITunes Id}}_now_playing_prev_index

Description: The previous now playing index.

Values: A number.


mlitunes_{{MLITunes Id}}_now_playing_prev_track

Description: The name of the track previously played from the now playing list.

Values: Any valid track name.


mlitunes_{{MLITunes Id}}_now_playing_repeat

Description: The repeat state of the now playing list.

Values: Off,All,One


mlitunes_{{MLITunes Id}}_now_playing_shuffle

Description: The shuffle state of the now playing list.

Values: True,False


mlitunes_{{MLITunes Id}}_now_playing_tracks_count

Description: The number of tracks in the now playing list.

Values: A number.


mlitunes_{{MLITunes Id}}_now_playing_tracks_remaining

Description: The number of tracks remaining to be played from the now playing list.

Values: A number.


mlitunes_{{MLITunes Id}}_player_position_percent

Description: The position of the currently playing track in a percentage

Values: A number 0-100


mlitunes_{{MLITunes Id}}_player_state

Description: The current state of the iTunes player.

Values: Playing, Stopped, Paused


mlitunes_{{MLITunes Id}}_player_state_controlicons

Description: This is used to show the play/paused state in the play/paused button.

Values: a,c


mlitunes_{{MLITunes Id}}_player_time

Description: The position of the currently playing track in time format.

Values: A time in HH:MM:SS format.


mlitunes_{{MLITunes Id}}_player_time_remainging

Description: The time remaining in the currently playing track.

Values: A time in HH:MM:SS format.


mlitunes_{{MLITunes Id}}_player_total_time

Description: The total time the current track will play for in time format.

Values: A time in HH:MM:SS format.


mlitunes_{{MLITunes Id}}_view

Description: The current view category. Only valid in iPod mode.

Values: Main, Playlists, Artists, Albums, Genres, or Tracks


mlitunes_{{MLITunes Id}}_volume

Description: The current volume level.

Values: A number 0-100

Bugs

If iTunes Agent is processing updates, this will keep MLServer3 from loading.

Release Notes

Release Notes for 11/05/08

"Changes"

  • Added more descriptive error messages in the MLITunesAgent
  • Removed the debug log from the MLITunesAgent as much of the information is now available in the standard log

"Bug Fixes"

  • Resolved an error retrieving playlist albums by the numerical playlist id from the MLITunesAgent


Release Notes for 10/25/08

Notes

  • MainLobby 3.00.151.13 was released that contains some bug fixes to two MainLobby Scene Files. Please update your MainLobby to resolve the SEARCH screens not working.


Release Notes for 10/22/08 - MLiTunesAgent [Version 1.0.0.2146], iTunes Plugin [Version 1.0.0.1518]

Notes & Requirements

  • Users should remove their existing MLiTunes Agent before installing this version
  • From your Control Panel, click on ADD REMOVE PROGRAMS
  • Then REMOVE Cinemar MLiTunes Agent
  • You'll also need to make sure you have installed MainLobby 3.00.151.12 - this install contains required updated scenes
  • Users should be running the latest iTunes 8.0.1.11 as of this writing


Changes

  • MLiTunes Agent is now installed to the Cinemar\Agents\MLiTunes folder
  • When PLAYING or ADDING Albums we now use the "~" as a separator instead of a ","
  • We now take advantage of iTunes 8 features such as persistant IDs that help keep our selections in sync with iTunes

Release Notes for 10/09/08 - MLiTunesAgent [Version 1.0.0.2069], iTunes Plugin [Version 1.0.0.1492]

Changes

  • Renamed MLitunesService to MLItunesAgent
  • This update requires the user to reinstall both applications and opt to overwrite their database in both cases

Added

  • New button on the Log screen to Save the Log

Bug Fixes

  • Resolved resizing problem in Agents window which was causing the LOG TO FILE check box to not show up

Release Notes for 07/30/08 - iTunes Plugin [Version 1.0.0.1489]

NOTE

  • Users should download and install Mainlobby 3.00.151 [Release 4] - this contains an updated file itunes_layer_tracks.mls scene file that has changes

Bug Fixes

  • An error in the reconnection process would cause a runtime error
  • Additional Error Checking Added

Release Notes for 07/18/08 - MLiTunesService [Version 1.0.0.2053], iTunes Plugin [Version 1.0.0.1478]

Bug Fixes

  • An error in the processing of change events from itunes would cause tracks to not be added to the services database after they are imported to itunes
  • An error in the message being sent to the service when a database change was detected , if the user is currently viewing tracks, would cause the user to be automatically sent to the next page of tracks

Added

  • Error Checking
  • Ability to filter out some events from logging to improve performance

Release Notes for 06/25/08 - MLiTunesService [Version 1.0.0.1999]

Notes

  • Please opt to overwrite your database during installation - this version contains a newer database

Bug Fixes

  • Resolved issues when importing and removing tracks from your Library within iTunes


Release Notes for 06/16/08 - MLiTunesService [Version 1.0.0.1966], iTunes Plugin [Version 1.0.0.1477]

Bug Fixes

  • Resolved issues when using the SEARCH page.
  • This update requires an updated MLS file: itunes_layer_tracks.mls (This file will be available in a future release of MainLobby)

Release Notes for 06/12/08 - MLiTunesService [Version 1.0.0.1958], iTunes Plugin [Version 1.0.0.1472]

Notes

  • Users should opt to install the database in this update and it will be rebuilt on startup.


Changes

  • Changed events received from itunes that are form an external device such as a iPod will now be ignored to allow full operation of the MLITunes plugin while still being able to synch an external device with iTunes.

BugFixes

  • Issues Playing Entire Albums when Compilations (Various Artists)
  • If there is only one track in the now playing it would not remove correctly
  • The MLItunesService would popup an error if itunes could not play a specified track (File did not exist)

Release Notes for 05/08/08 - MLiTunesService [Version 1.0.0.1931]

Notes

  • Users should opt to install the database in this update and it will be rebuilt on startup. This version requires MLServer 3.0.499 or higher.

Added

  • Support for PNG coverart images

Release Notes for 05/05/08 - MLiTunesService [Version 1.0.0.1929]

Notes

  • Users should opt to install the database in this update and it will be rebuilt on startup.

Bug Fixes

  • A runtime error would occur if the pc was shutdown with the service still running, only an issue with pcs running Windows Vista

Changes

  • An error in the way coverart was being saved caused all images to be saved as JPG images regardless of the actual type of image it was. The image type is now checked and all but JPG images will be rejected as invalid image types. If a different format is found, it will be replaced with a replacement image. Users must use JPG images within iTunes to maintain compatability with MainLobby.

Release Notes for 04/28/08 - MLiTunesService [Version 1.0.0.1913], iTunes Plugin [Version 1.0.0.1464]

Added

  • More options to control the database verification process

Bug Fixes

  • The pointer to the currently playing track in the now playing list not updating correctly when the remove from playlist option is selected
  • The next now playing track variables not clearing on last track

Release Notes for 04/14/08 - MLiTunesService [Version 1.0.0.1906], iTunes Plugin [Version 1.0.0.1457]

Added

  • Support for adding large playlists to NOW PLAYING. Instead of adding all at once, it will add tracks at a time allowing other interactivity to continue

Release Notes for 04/09/08 - MLiTunesService [Version 1.0.0.1887], iTunes Plugin [Version 1.0.0.1440]

Added

  • An index will now be set for the currently playing track to display an icon in the scenes while browsing to show the track is playing
  • New Command "ShuffleNowPlaying", this will shuffle/unshuffle the nowplaying list
  • New Command "ShufflePlaylist~<<Playlist Index>>" command.
  • The disc number of each track will now be stored in the database.
  • New Repeat playlist command
  • New PlayerPositionPercent command
  • New RepeatNowPlaying Command
  • New Repeat option Repeat1 to repeat now playing
  • New PlayerPosition command
  • New PlayerPositionPercent command
  • New Variable MLItunes_{{Id}}_Now_Playing_Shuffle


Changes

  • Default playlist will now be "Library"
  • The dropdown list for the default playlist is no longer editable
  • Modified the logs to roll to a new log file each day
  • Modified the way data is stored
  • Modified Variable {{Clientname}}_Mlitunes_{{id}}_conencted is now MLITunes_{{id}}_conencted as this is not a client based variable.
  • Increased timeout time when adding items to the now playing to 5 secs.
  • Variable MLITunes_{{Id}}_Play_Time is now MLITunes_{{Id}}_Player_Time
  • Variable MLITunes_{{Id}}_Repeat_Now_Playing is now MLITunes_{{Id}}_Now_Playing_Repeat
  • Variable {{Clientname}}_MLITunes_{{Id}}_Album_Name is now {{Clientname}}_MLITunes_{{Id}}_Selected_Album_Name
  • Variable {{Clientname}}_MLITunes_{{Id}}_Album_Artist is now {{Clientname}}_MLITunes_{{Id}}_Selected_Album_Artist
  • Variable {{Clientname}}_MLITunes_{{Id}}_Album_More is now {{Clientname}}_MLITunes_{{Id}}_Selected_Album_More
  • Variable {{Clientname}}_MLITunes_{{Id}}_Artist_Sort_Name is now {{Clientname}}_MLITunes_{{Id}}_Selected_Album_Artist_Sort_Name
  • Variable {{Clientname}}_MLITunes_{{Id}}_Album_Coverart is now {{Clientname}}_MLITunes_{{Id}}_Selected_Album_Coverart
  • Any leading zeros will now be removed from the player position variables
  • The error displayed when in the MLServer log when the MLITunesService is not running will no longer display the windows err info, instead it will simply say that the service could not be connected to
  • A debuging line that open the MLITunes controller window on MLServer startup was removed


Bug Fixes

  • When track data is changed in iTunes the change was not getting stored in the MLITUnesService database
  • Now Playing index variable not getting set on startup causing all arrows on scenes to show
  • Multi disc albums tracks were not ordering correctly when adding to Now Playing
  • Set connected variable on startup to false
  • Error when adding a 2nd list of items to the now playing after previously playing items

Release Notes for 03/30/08 - MLiTunesService [Version 1.0.0.1732], iTunes Plugin [Version 1.0.0.1269]

Bug Fixes

  • Runtime error when a track is played from the iTunes Store
  • Cover Art images not being deleted on a database rebuild
  • When the next/previous now playing commands are used the next track info would not update properly

Release Notes for 03/26/08 - MLiTunesService [Version 1.0.0.1727], iTunes Plugin [Version 1.0.0.1263]

Added

  • Added Commands to add/append playlists to the now playing list by name


Bug Fixes

  • The ClearNowPlaying MLServeCmd not functioning properly
  • When searching for more by artist any keyboard presses would clear the clients search text
  • Some now playing variables not being cleared when the now plyaing list is cleared
  • Playlists not populating correctly at some points

Release Notes for 03/17/08 - MLiTunesService [Version 1.0.0.1697], iTunes Plugin [Version 1.0.0.1246]

Bug Fixes

  • Some changes in itunes caused a double entry in the MLITunesService database for the music playlist causing a runtime error
  • Attempt to fix the runtime error when loading large libraries
  • Playplaylist commands not working


Added

  • A Logs folder will now be created on startup if it does not already exist
  • MLITunesService log will now be stored in the Logs folder
  • In addition to the normal MLITunesService log a new debug log will also be created to help track bugs
  • Variable to track which track is currently playing on the nowplaying scene