MLiPort Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLiPod Device Family Manager allows for support of iPod docking stations.


Software Requirements

MainLobby Server 3

MainLobby 3 Client

iPod Device Family Manager Plugin

iPod driver (like the iPort driver)

Supported Hardware

iPort RS232 docking station


Installation

Setup

Note: If any settings that have changed you will be prompted when you close the control window to save those changes


Play

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Play

(Literal) MLServeCmd.MLIPod|1~Play

Parameters None

Returns Nothing.

Description This command sends a play/pause command to the IPort. If the current play state is play then the ipod will pause, if the current play state is pause then the ipod will resume playing.

This command will also resume playing if the play state is seek forward or seek backward.

Notes:


Stop

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Stop

(Literal) MLServeCmd.MLIPod|1~Stop

Parameters None

Returns Nothing.

Description This command sends a stop command to the IPort.

Notes:


FastForward

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~FastForward

(Literal) MLServeCmd.MLIPod|1~FastForward

Parameters None

Returns Nothing.

Description This command sends a seek forward command to the IPort. If the current play state is playing then the ipod will seek forward, if the current play state is seek forward then the ipod will resume playing.

Notes:


Rewind

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Rewind

(Literal) MLServeCmd.MLIPod|1~Rewind

Parameters None

Returns Nothing.

Description This command sends a seek backward command to the IPort. If the current play state is playing then the ipod will seek forward, if the current play state is seek backward then the ipod will resume playing.

Notes:


NextTrack

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~NextTrack

(Literal) MLServeCmd.MLIPod|1~NextTrack

Parameters None

Returns Nothing.

Description This command sends a next track command to the IPort.

Notes:


PreviousTrack

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~PreviousTrack

(Literal) MLServeCmd.MLIPod|1~PreviousTrack

Parameters None

Returns Nothing.

Description This command sends a previous track command to the IPort.

Notes:


Shuffle

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Shuffle~<<Shuffle Mode>>

(Literal) MLServeCmd.MLIPod|1~ShuffleMode~Off MLServeCmd.MLIPod|1~ShuffleMode~Songs

Parameters ShuffleMode = The new shuffle mode. Values = Off, Albums, Songs, Cycle

Returns Nothing.

Description This command sets the shuffle mode.

Notes: When cycle is used as the shuffle mode, the shuffle mode will go to the next mode. If shuffle mode is off then a cycle command would set it to Albums.


Repeat

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Repeat~<<Repeat Mode>>

(Literal) MLServeCmd.MLIPod|1~ShuffleMode~Off MLServeCmd.MLIPod|1~ShuffleMode~Track

Parameters ShuffleMode = The new shuffle mode. Values = Off, Track, All

Returns Nothing.

Description This command sets the repeat mode.

Notes: When cycle is used as the repeat mode, the shuffle mode will go to the next mode. If repeat mode is off then a cycle command would set it to Albums.


Menu

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Menu

(Literal) MLServeCmd.MLIPod|1~Menu

Parameters None

Returns Nothing.

Description This command sends a menu command to the IPort. This has the same effect as the menu button on the IPod.

Notes:


Select

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~Select~<<Record Index>>

(Literal) MLServeCmd.MLIPod|1~Select~00 00 00 01

Parameters RecordIndex = The record index of the record to be selected.

Returns Nothing.

Description This command selects the record with the specified record index.

Notes:


NextPage

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~NextPage

(Literal) MLServeCmd.MLIPod|1~NextPage

Parameters None

Returns Nothing.

Description This command gets the net page of records from the IPort. This command does nothing if the user is on th last page of records.

Notes:


PreviousPage

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~PreviousPage

(Literal) MLServeCmd.MLIPod|1~PreviousPage

Parameters None

Returns Nothing.

Description This command gets the previous page of records from the IPod. This command does nothing if the user is on the first page of records.

Notes:


GetAlphaPage

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~GetAlphaPage~<<Letter>>

(Literal) MLServeCmd.MLIPod|1~GetAlphaPage~C

Parameters Letter = The alpha value for the page number to go to based on first letter. (0, A, B, C, D, E, F...X, Y, Z)

Returns Nothing.

Description This command gets the specified page of records based on the first letter you send.

Notes:


GetPage

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~GetPage~<<Page Number>>

(Literal) MLServeCmd.MLIPod|1~GetPage~3

Parameters Page Number = The page number to get.

Returns Nothing.

Description This command gets the specified page of records.

Notes:


FrontPanel

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~FrontPanel~<<On/Off>>

(Literal) MLServeCmd.MLIPod|1~FrontPanel~On

Parameters On/Off = The new state of the IPods front panel.

Returns Nothing.

Description This command will enable/disable the IPods front panel.

Notes: When the IPods front panel is enabled all commands to the IPod from this plugin are disabled.


GetCategory

{MLServeCmd}Script Usage

MLServeCmd.MLIPod|<<ID>>~GetCategory~<<Category>>

(Literal) MLServeCmd.MLIPod|1~GetCategory~Playlists MLServeCmd.MLIPod|1~GetCategory~Artists

Parameters Category = The new category to view. Values= Playlists, Artists, Albums, Genres, Songs, Composers

Returns Nothing.

Description This command resets all selections and brings the user to the specified category.

Notes:

MLServer Variables

MLIPod_IPort_<<#>>_FrontPanel

MLIPod_IPort_<<#>>_History

MLIPod_IPort_<<#>>_IsMenu

MLIPod_IPort_<<#>>_Name

MLIPod_IPort_<<#>>_PageCount

MLIPod_IPort_<<#>>_PageNumber

MLIPod_IPort_<<#>>_PlayingAlbum

MLIPod_IPort_<<#>>_PlayingArtist

MLIPod_IPort_<<#>>_PlayingTitle

MLIPod_IPort_<<#>>_PlayState

MLIPod_IPort_<<#>>_RecordCount

MLIPod_IPort_<<#>>_RepeatMode

MLIPod_IPort_<<#>>_ShuffleMode

MLIPod_IPort_<<#>>_SongLength

MLIPod_IPort_<<#>>_Record_Data_<<RecNumber>>

MLIPod_IPort_<<#>>_Record_Index_<<RecNumber>>


Bugs

Feature Requests