MLVLC

From Cinemar Wiki
Revision as of 15:50, 12 June 2010 by CinemarDave (Talk | contribs) (Key)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

About

The MLVLC Plugin works in conjunction with the VLCAgent application that runs on a Client PC. Both the plugin and the Agent are available as separate downloads through the Installation Assistant.

Installation

MLVLC.dll

Plugin that communicates to the remote VLCAgent app running on the remote PCs.

With MLServer shutdown, run the MLVLC_Plugin_Setup.exe. This will install MLVLC plugin to the MLServer Plugins directory. It is recommended to accept all installation defaults.

Default TCP port is 6298 and is also user configurable. When you first restart MLServer with MLVLC loaded, your firewall may detect activity on this TCP port. Make sure you Accept this activity as being friendly. You may also have to manually configure your firewall and antivirus software to permit TCP traffic on this port.

Add a PC Alias with - a PC Alias name, that PC's Windows PC name (or preferably IP address as shown), and a Port. This port must match with your VLCAgent.exe port settings. This port also has to be open on all antivirus and firewalls. The AutoDiscover checkbox will connect to a VLCAgent.exe automatically, when it is seen on the network.

MLVLC is a member of the AV family. It supports commands in the form

AV.AliasName|command~param1~param2~...paramN

You can define an unlimited number of remote workstations. Assign each one a unique alias. You have the option of having the plugin auto connect to the remotes as they come online.

MLVLC.png


VLCAgent

The VLCAgent.exe is a mini application intended to run on a PC where you want to run the VLC player.

Install on any PC (optionally including the MLServer PC) where you want to run the VLC player. Run the VLCAgent_Setup.exe to install. It is recommended to accept all installation defaults.

The Default TCP port is 6298 and is also user configurable. This port needs to match the port setup in the MLVLC plugin for that PC Alias. When you first start the VLCAgent.exe, your firewall software may detect activity on this TCP port. Make sure you Accept this activity as being friendly.


VLCAgent-Settings.png

Settings

The Settings / Settings tab is the most import of all the tabs. Before you play your fist movie you will need to set the path to the VLC.exe program. You can also define option startup command line options. WARNING: Do not change the default command line options. It is safe to add additional command options but do not change or remove the defaults.


VLCAgent-Testing.png

Settings

The testing tab will allow you to control and verify your VLC installation prior to testing in MLServer.

MLServeCmds

PowerOff

{MLServeCmd}Script Usage

AV.Alias|PowerOff

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|PowerOff

Description

Terminates the VLC.exe application.


PowerOn

{MLServeCmd}Script Usage

AV.Alias|PowerOn

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|PowerOn

Description

Launches the VLC.exe application in a hidden window. You will not see the player running until the movie starts to play.


PlayMovie

{MLServeCmd}Script Usage

AV.Alias|PlayMovie~MovieFile

Parameters
Alias = The Alias of the player to send the command to
MovieFile = Full Path to the movie to play

(Literal)
AV.Alias|PlayMovie~Any Valid Movie File

Description

Plays the specified movie


Play

{MLServeCmd}Script Usage

AV.Alias|Play

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Play

Description

Starts playback of the loaded movie


Stop

{MLServeCmd}Script Usage

AV.Alias|Stop

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Stop

Description

Stops playback of the specified movie


Pause

{MLServeCmd}Script Usage

AV.Alias|Pause

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Pause

Description

Pauses playback of the current movie


Mute

{MLServeCmd}Script Usage

AV.Alias|Mute

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Mute

Description

Toggles mute


Volume

{MLServeCmd}Script Usage

AV.Alias|Volume~volume

Parameters
Alias = The Alias of the player to send the command to
Volume = The desired relative volume 0..100

(Literal)
AV.Alias|Volume~50

Description

Sets the VLC player volume to the specified value


VolUp

{MLServeCmd}Script Usage

AV.Alias|VolUp

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|VolUp

Description

Increments the VLC player volume one step (approximately +3db)


VolDown

{MLServeCmd}Script Usage

AV.Alias|VolDown

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|VolDown

Description

Decrements the VLC player volume one step (approximately -3db)


FullScreen

{MLServeCmd}Script Usage

AV.Alias|Fullscreen

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|FullScreen

Description

Toggles between fullscreen and window view


VideoRatio

{MLServeCmd}Script Usage

AV.Alias|VideoRatio~ratio

Parameters
Alias = The Alias of the player to send the command to
Ratio = The desired new aspect ratio (BestFit,1:1,4:3,16:9,16:10,221:100,5:4)

(Literal)
AV.Alias|VideoRatio~4:3

Description

Sets the VLC player aspect ratio to the specified value


Faster

{MLServeCmd}Script Usage

AV.Alias|Faster

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Faster

Description

Speeds up video playback


Slower

{MLServeCmd}Script Usage

AV.Alias|Slower

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Slower

Description

Slows down video playback


Normal

{MLServeCmd}Script Usage

AV.Alias|Normal

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Normal

Description

Returns video playback to normal speed


Rewind

{MLServeCmd}Script Usage

AV.Alias|Rewind

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|Rewind

Description

Jumps back five seconds


FastForward

{MLServeCmd}Script Usage

AV.Alias|FastForward

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|FastForward

Description

Jumps ahead five seconds


Seek

{MLServeCmd}Script Usage

AV.Alias|Seek~percent

Parameters
Alias = The Alias of the player to send the command to
Percent = The desired jump point into the movie (0..100)

(Literal)
AV.Alias|Seek~34

Description

Jumps the specified percentage into the playing movie (0..100%)


Chapter

{MLServeCmd}Script Usage

AV.Alias|Chapter~ChapterNum

Parameters
Alias = The Alias of the player to send the command to
ChapterNum = The chapter numer to go to

(Literal)
AV.Alias|Chapter~3

Description

Jump to the specified chapter


NextChapter

{MLServeCmd}Script Usage

AV.Alias|NextChapter

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|NextChapter

Description

Jump to the next chapter


PrevChapter

{MLServeCmd}Script Usage

AV.Alias|PrevChapter

Parameters
Alias = The Alias of the player to send the command to

(Literal)
AV.Alias|PrevChapter

Description

Jumps to the previous chapter


Key

{MLServeCmd}Script Usage

AV.Alias|Key~KeyCommand

Parameters
Alias = The Alias of the player to send the command to
KeyCommand = One of the valid VLC key mapping commands

(Literal)
AV.Alias|Key~-key-menu

Description

Executes the specified key mapping command. Uses the following "key-" names.


"key-quit", ACTIONID_QUIT

"key-play-pause", ACTIONID_PLAY_PAUSE

"key-play", ACTIONID_PLAY,

"key-pause", ACTIONID_PAUSE,

"key-stop", ACTIONID_STOP,

"key-position", ACTIONID_POSITION,

"key-jump-extrashort", ACTIONID_JUMP_BACKWARD_EXTRASHORT,

"key-jump+extrashort", ACTIONID_JUMP_FORWARD_EXTRASHORT,

"key-jump-short", ACTIONID_JUMP_BACKWARD_SHORT,

"key-jump+short", ACTIONID_JUMP_FORWARD_SHORT,

"key-jump-medium", ACTIONID_JUMP_BACKWARD_MEDIUM,

"key-jump+medium", ACTIONID_JUMP_FORWARD_MEDIUM,

"key-jump-long", ACTIONID_JUMP_BACKWARD_LONG,

"key-jump+long", ACTIONID_JUMP_FORWARD_LONG,

"key-frame-next", ACTIONID_FRAME_NEXT,

"key-prev", ACTIONID_PREV,

"key-next", ACTIONID_NEXT,

"key-faster", ACTIONID_FASTER,

"key-slower", ACTIONID_SLOWER,

"key-rate-normal", ACTIONID_RATE_NORMAL,

"key-rate-faster-fine", ACTIONID_RATE_FASTER_FINE,

"key-rate-slower-fine", ACTIONID_RATE_SLOWER_FINE,

"key-toggle-fullscreen", ACTIONID_TOGGLE_FULLSCREEN,

"key-leave-fullscreen", ACTIONID_LEAVE_FULLSCREEN,

"key-vol-up", ACTIONID_VOL_UP,

"key-vol-down", ACTIONID_VOL_DOWN,

"key-vol-mute", ACTIONID_VOL_MUTE,

"key-subdelay-down", ACTIONID_SUBDELAY_DOWN,

"key-subdelay-up", ACTIONID_SUBDELAY_UP,

"key-audiodelay-down", ACTIONID_AUDIODELAY_DOWN,

"key-audiodelay-up", ACTIONID_AUDIODELAY_UP,

"key-audio-track", ACTIONID_AUDIO_TRACK,

"key-subtitle-track", ACTIONID_SUBTITLE_TRACK,

"key-aspect-ratio", ACTIONID_ASPECT_RATIO,

"key-crop", ACTIONID_CROP,

"key-deinterlace", ACTIONID_DEINTERLACE,

"key-intf-show", ACTIONID_INTF_SHOW,

"key-intf-hide", ACTIONID_INTF_HIDE,

"key-snapshot", ACTIONID_SNAPSHOT,

"key-zoom", ACTIONID_ZOOM,

"key-unzoom", ACTIONID_UNZOOM,

"key-crop-top", ACTIONID_CROP_TOP,

"key-uncrop-top", ACTIONID_UNCROP_TOP,

"key-crop-left", ACTIONID_CROP_LEFT,

"key-uncrop-left", ACTIONID_UNCROP_LEFT,

"key-crop-bottom", ACTIONID_CROP_BOTTOM,

"key-uncrop-bottom", ACTIONID_UNCROP_BOTTOM,

"key-crop-right", ACTIONID_CROP_RIGHT,

"key-uncrop-right", ACTIONID_UNCROP_RIGHT,

"key-nav-activate", ACTIONID_NAV_ACTIVATE,

"key-nav-up", ACTIONID_NAV_UP,

"key-nav-down", ACTIONID_NAV_DOWN,

"key-nav-left", ACTIONID_NAV_LEFT,

"key-nav-right", ACTIONID_NAV_RIGHT,

"key-disc-menu", ACTIONID_DISC_MENU,

"key-title-prev", ACTIONID_TITLE_PREV,

"key-title-next", ACTIONID_TITLE_NEXT,

"key-chapter-prev", ACTIONID_CHAPTER_PREV,

"key-chapter-next", ACTIONID_CHAPTER_NEXT,

"key-zoom-quarter", ACTIONID_ZOOM_QUARTER,

"key-zoom-half", ACTIONID_ZOOM_HALF,

"key-zoom-original", ACTIONID_ZOOM_ORIGINAL,

"key-zoom-double", ACTIONID_ZOOM_DOUBLE,

"key-set-bookmark1", ACTIONID_SET_BOOKMARK1,

"key-set-bookmark2", ACTIONID_SET_BOOKMARK2,

"key-set-bookmark3", ACTIONID_SET_BOOKMARK3,

"key-set-bookmark4", ACTIONID_SET_BOOKMARK4,

"key-set-bookmark5", ACTIONID_SET_BOOKMARK5,

"key-set-bookmark6", ACTIONID_SET_BOOKMARK6,

"key-set-bookmark7", ACTIONID_SET_BOOKMARK7,

"key-set-bookmark8", ACTIONID_SET_BOOKMARK8,

"key-set-bookmark9", ACTIONID_SET_BOOKMARK9,

"key-set-bookmark10", ACTIONID_SET_BOOKMARK10,

"key-play-bookmark1", ACTIONID_PLAY_BOOKMARK1,

"key-play-bookmark2", ACTIONID_PLAY_BOOKMARK2,

"key-play-bookmark3", ACTIONID_PLAY_BOOKMARK3,

"key-play-bookmark4", ACTIONID_PLAY_BOOKMARK4,

"key-play-bookmark5", ACTIONID_PLAY_BOOKMARK5,

"key-play-bookmark6", ACTIONID_PLAY_BOOKMARK6,

"key-play-bookmark7", ACTIONID_PLAY_BOOKMARK7,

"key-play-bookmark8", ACTIONID_PLAY_BOOKMARK8,

"key-play-bookmark9", ACTIONID_PLAY_BOOKMARK9,

"key-play-bookmark10", ACTIONID_PLAY_BOOKMARK10,

"key-history-back", ACTIONID_HISTORY_BACK,

"key-history-forward", ACTIONID_HISTORY_FORWARD,

"key-record", ACTIONID_RECORD,

"key-dump", ACTIONID_DUMP,

"key-random", ACTIONID_RANDOM,

"key-loop", ACTIONID_LOOP,

"key-wallpaper", ACTIONID_WALLPAPER,

"key-menu-on", ACTIONID_MENU_ON,

"key-menu-off", ACTIONID_MENU_OFF,

"key-menu-right", ACTIONID_MENU_RIGHT,

"key-menu-left", ACTIONID_MENU_LEFT,

"key-menu-up", ACTIONID_MENU_UP,

"key-menu-down", ACTIONID_MENU_DOWN,

"key-menu-select", ACTIONID_MENU_SELECT,

"key-audiodevice-cycle", ACTIONID_AUDIODEVICE_CYCLE,

"key-toggle-autoscale", ACTIONID_TOGGLE_AUTOSCALE,

"key-incr-scalefactor", ACTIONID_SCALE_UP,

"key-decr-scalefactor", ACTIONID_SCALE_DOWN,


Menu

{MLServeCmd}Script Usage

AV.Alias|Menu~MenuCommand

Parameters
Alias = The Alias of the player to send the command to
MenuCommand = One of the supported VLC menu commands

(Literal)
AV.Alias|Menu~Up

Description

Executes the specified VLC menu command


MLServer Variables

Core VLC Plugin Server Variables

The MLVLC plugin will auto generate variables in MLServer based on the settings you have entered.

  • VLC_MovieLength_{{alias}}
  • VLC_MovieTime_{{alias}}
  • VLC_Mute_{{alias}}
  • VLC_Pause_{{alias}}
  • VLC_PlayPercent_{{alias}}
  • VLC_Power_{{alias}}
  • VLC_Volume_{{alias}}



Transport Commands for the Remote Control Interface

The RC (Remote Control) interface to the VLC player does not expose a lot of transport commands. You get the following

  • AV.VLCn|Play
  • AV.VLCn|Pause
  • AV.VLCn|Stop
  • AV.VLCn|FastForward
  • AV.VLCn|Rewind
  • AV.VLCn|Faster
  • AV.VLCn|Slower
  • AV.VLCn|Normal
  • AV.VLCn|Mute
  • AV.VLCn|VolUp
  • AV.VLCn|VolDown
  • AV.VLCn|PrevChapter
  • AV.VLCn|NextChapter
  • AV.VLCn|PowerOn
  • AV.VLCn|PowerOff
  • AV.VLCn|VideoRatio~1:1 or 4:3 or 16:9 or 16:10 or 5:4 or 221:100 or Bestfit

These are the same commands that are defined above.

Play and Stop do not work like standard transport controls. Stop will stop the movie but pressing play will always start you from the beginning of the movie. You want to use the Pause command as a play/pause toggle.

The VLC agent does not know how to automatically mount an iso because the VLC player has built in support for iso files.