MLNetflix Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLNetflix plugin for MLServer is designed to allow you to browse the entire Netflix catalog on any MainLobby client and then play any Netflix movie or TV episode on any connected PC on your network.

System Requirements

  • MLServer version 3.75.203 or later
  • MainLobby Client v 3.0.152.2 or later
  • Microsoft Windows 7, Vista or XP (32 or 64 bit versions. 32 bit recommended because all of our software are 32 bit applications and gain no benefit from running on a 64 bit operating system)
  • MLServer PC with persistent Internet connection

Configuration

Download and run the MLNetflix Plugin Installer on the primary MLServer PC. You can optionally download the sample MainLobby Netflix client scenes and install them on your client PCs.

Restart MLServer.

Agents Dialog

NFSetup1.png

This window presents a list of the remote PCs where you will be playing the Netflix media. You will need to install and configure the Netflix Agent on each of these PCs. Make sure each alias is unique and that they all talk on the same port. 6300 is the default port and it should not be changed. There is no limit to the number of agents you can define. However, Netflix imposes a limit of 6 unique playback devices per account.


Settings Window

NFSetup2.png

Here are the general settings for the plugin. Most important is the entry of your Netflix username and password. If you are a Canadian resident and subscribe to the Netflix service in Canada please make sure to check the Canadian subscriber box.


IMPORTANT NOTE

Browsing performance is gained by creating a local cache of the entire Netflix catalog on your MLServer PC. The first time you install the plugin you will see a process called "NetflixCollector.exe" running in your task manager. This is the program that is responsible for downloading the Netflix metadata into the local cache. The fist time this program runs it can take up to 30 minutes depending on your Internet connection speed to download the entire catalog. After that this program will run every 4 hours to check for updates to the online catalog. Netflix makes constant updates to its catalog throughout the day. You should make sure you update your cache frequently. The collector will create a log of any errors it encounters in the MLServer\Logs folder.

Sample Client Scenes

When you install the sample clients scenes you get one of the best Netflix browsers in the industry. The user interface is exactly like DVDLobby. You can browser by cover art and have the ability to filter and search on a host of different parameters.

Main Browser - Netflix\Netflix_Console_Thumbs.mls

This is the primary browser window to the entire Netflix Catalog.

NFClient1.png


Filter Selections

Allows you to filter listings to narrow your movie choices. NFClient2.png


Content Search

If the quick filters cannot find what you want then you can use the powerful search engine to find exactly what you are looking for. (Provided Netflix offers it.)

NFClient3.png


Movie Details

This is a full details scene where you can look at all of the metadata associated with the movie.

NFClient4.png


Remote Control

The Netflix Silverlight movie player has a very limited set of controls. The remote control scene will allow you to control the playback on the remote PC.

NFClient5.png


TV Episodes

When the browser detects that you are looking at a movie or TV show with episodes then the Episodes tab will be enabled and you will be able to browse and play the individual episodes associated with the show.

NFClient6.png

MLServeCmds

InitDatabase

{MLServeCmd}Script Usage

MLNetflix|InitDatabase


(Literal)

MLNetflix|InitDatabase

Description

Deletes all existing media from the local database.


UpdateDatabase

{MLServeCmd}Script Usage

MLNetflix|UpdateDatabase


(Literal)

MLNetflix|UpdateDatabase

Description

Launches the collector and begins an immediate update of the database.


Browse

{MLServeCmd}Script Usage

MLNetflix|Browse~command


(Literal)

MLNetflix|Browse~First

Parameters
Command = #,First,Last,Prev,Next


Description

Commands the movie browser to advance in the direction specified.


GetMovie

{MLServeCmd}Script Usage

MLNetflix|GetMovie~dvdNumber


(Literal)

MLNetflix|GetMovie~12345~1


Parameters
dvdNumber = The unique dvdNumber for this movie.
DiscNumber = Optional Defaults to "1". The disc number in the set.


Description

Looks up the movie in the database and sets the "Netflix_Selection" series of server variables.


BrowseFilter

{MLServeCmd}Script Usage

MLNetflix|BrowseFilter~Direction


(Literal)

MLNetflix|BrowseFilter~Next


Parameters
Direction = Prev or Next.


Description

Moves the Filters page in the specified direction.


SetFilter

{MLServeCmd}Script Usage

MLNetflix|SetFilter~FilterItem~FilterValue


(Literal)

MLNetflix|SetFilter~Genre~Action


Parameters
FilterItem = The core filter to use.
FilterValue = The value for the applied filter.


Description

Sets the browser filter parameters to only display movies that match the specified parameters.


ToggleScreening

{MLServeCmd}Script Usage

MLNetflix|ToggleScreening~DvdNumber


(Literal)

MLNetflix|ToggleScreening~12345~1


Parameters
dvdNumber = The unique dvdNumber for the movie.


Description

Toggles the movie in and out of the screening queue.


PlayMovie

{MLServeCmd}Script Usage

MLNetflix|PlayMovie~dvdNumber


(Literal)

MLNetflix|PlayMovie~1234


Parameters
dvdNumber = The unique dvdNumber of the movie.


Description

Plays the specified movie / episode.


SetActiveThumb

{MLServeCmd}Script Usage

MLNetflix|SetActiveThumb~Number


(Literal)

MLNetflix|SetActiveThumb~1


Parameters
Number = The thumbnail number of the movie to set as active.


Description

Sets the specified movie thumbnail as active.


MovieSearch

{MLServeCmd}Script Usage

MLNetflix|MovieSearch~Command~Value


(Literal)

MLNetflix|MovieSearch~NextPage

Parameters
Command = The page direction command Next, Previous, AlphaVal.
Value = The value when using the command AlphaVal.

Description

Performs the search as specified by the user selections stored in server variables.


Keyboard

{MLServeCmd}Script Usage

MLNetflix|Keyboard~Command


(Literal)

MLNetflix|Keyboard~A


Parameters
Command = The letter or number of the keyboard key press to process.


Description

Processes the keystroke coming in from the search keyboard.


ToggleContainsFilter

{MLServeCmd}Script Usage

MLNetflix|ToggleContainsFilter


(Literal)

MLNetflix|ToggleContainsFilter


Description

Toggles the search filter for "Contains" to "Starts With" when performing searches.


AddToScreening

{MLServeCmd}Script Usage

MLNetflix|AddToScreening~dvdNumber


(Literal)

MLNetflix|AddToScreening~11221


Parameters
dvdNumber = The unique dvdNumber for the movie.


Description

Adds the selected movie into the screening queue.


RemoveFromScreening

{MLServeCmd}Script Usage

MLNetflix|RemoveFromScreening~dvdNumber


(Literal)

MLNetflix|RemoveFromScreening~112345~1


Parameters
dvdNumber = The unique dvdNumber for the movie.


Description

Removes the specified movie from the screening queue.


SetBrowseFilter

{MLServeCmd}Script Usage

MLNetflix|SetBrowseFilter~class~value


(Literal)

MLNetflix|SetBrowseFilter~Genre~Action


Parameters
Class = The filter class
Value = The filter value.


Description

Sets the filter values for the movie browser.


ClearScreeningQueue

{MLServeCmd}Script Usage

MLNetflix|ClearScreeningQueue


(Literal)

MLNetflix|ClearScreeningQueue



Description

Removes all movies from the screening queue.


GetNextPlayer

{MLServeCmd}Script Usage

MLNetflix|GetNextPlayer


(Literal)

MLNetflix|GetNextPlayer


Description

Advances to the next media player.


GetPrevPlayer

{MLServeCmd}Script Usage

MLNetflix|GetPrevPlayer


(Literal)

MLNetflix|GetPrevPlayer


Description

Advances to the previous movie player.


SetActivePlayer

{MLServeCmd}Script Usage

MLNetflix|SetActivePlayer~Number


(Literal)

MLNetflix|SetActivePlayer~1


Parameters
Number = The number or alias for the active player for the client.


Description

Sets the active player for the current client.


InitBrowser

{MLServeCmd}Script Usage

MLNetflix|InitBrowser~Mode~ItemsPerPage~CoverWith~CoverHeight~ThumbWidth~ThumbHeight~MoviePlayerNumber


(Literal)

MLNetflix|InitBrowser~Thumbs~18~288~383~112~168~1


Parameters
Mode = The browser mode Thumbs or List.
ItemsPerPage = The number of items to show per page.
CoverWidth = The desired cover art width.
CoverHeight = The desired cover art height.
ThumbWidth = The desired thumbnail width.
ThumbHeight = The desired thumbnail height.
MoviePlayerNumber = The index into the MovieZones cycle states for the desired movie player.


Description

Used in the scene start up macro for the thumbnail and list view browser pages.


InitDetails

{MLServeCmd}Script Usage

MLNetflix|InitDetails~CoverWidth~CoverHeight


(Literal)

MLNetflix|InitDetails~288~383


Parameters
CoverWidth = The desired cover art width.
CoverHeight = The desired cover art height.


Description

Used in the scene start up macro for the movie details scenes.


InitFilters

{MLServeCmd}Script Usage

MLNetflix|InitFilters~ItemsPerPage

(Literal)

MLNetflix|InitFilters~18


Parameters
ItemsPerPage = The number of items per page.


Description

Used in the scene start up macro for the filters selection.


Beamer

{MLServeCmd}Script Usage

MLNetflix|Beamer


(Literal)

MLNetflix|Beamer


Description

Is used as a feedback mechanism on the remote control scenes.


RemoteBrowse

{MLServeCmd}Script Usage

MLNetflix|RemoteBrowse~Command


(Literal)

MLNetflix|RemoteBrowse~Next


Parameters
Command = Direction to browse. Up, Down, Left, Right, Prev, Next, #


Description

Commands the remote control browser to movie in the specified direction.


SetCredentials

{MLServeCmd}Script Usage

MLNetflix|SetCredentials~Username~Password~Location


(Literal)

MLNetflix|SetCredentials~HappyNetflixUser~MyPassword~US


Parameters
Username = Your Netflix Username
Password = Your Netflix Password
Location = (Optional) Location. Use US or CA. Will default US


Description

Command is used to update your Netflix username and password. The credentials will automatically be passed to each Netflix agent when they connect.


Power

{MLServeCmd}Script Usage

MLNetflix|Power~State


(Literal)

MLNetflix|Power~Off


Parameters
State = On or Off


Description

Turns the active player off or on.


Play

{MLServeCmd}Script Usage

MLNetflix|Play


(Literal)

MLNetflix|Play


Description

Toggles Play/Pause on the active player.


Pause

{MLServeCmd}Script Usage

MLNetflix|Pause


(Literal)

MLNetflix|Pause


Description

Toggles Play/Pause on the active player.


Rewind

{MLServeCmd}Script Usage

MLNetflix|Rewind


(Literal)

MLNetflix|Rewind


Description

Rewinds the current movie.


Forward

{MLServeCmd}Script Usage

MLNetflix|Forward


(Literal)

MLNetflix|Forward


Description

Advances the current movie.


Stop

{MLServeCmd}Script Usage

MLNetflix|Stop


(Literal)

MLNetflix|Stop


Description

Stops playback of the current movie.


Fullscreen

{MLServeCmd}Script Usage

MLNetflix|Fullscreen


(Literal)

MLNetflix|Fullscreen


Description

Toggles Full screen / Window mode.


Focus

{MLServeCmd}Script Usage

MLNetflix|Focus


(Literal)

MLNetflix|Focus


Description

Brings the player into focus if lost.


MLServer Variables

The MLNetflix plugin will auto generate variables in MLServer based on the settings you have entered. All the server variables created will start with the prefix Netflix_.