MLClientSvc Plugin

From Cinemar Wiki
Jump to: navigation, search

About

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

The MLClientSvc Agent is a multi-purpose program used to augment the capabilities of MLServer. This application serves as the conduit between MLServer and remote control of applications on client PCs.

Installation

MLClientSvc.dll

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

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

Default TCP port is 6292 and is also user configurable. When you first restart MLServer with MLClientSvc loaded, your Antivirus software may detect activity on this TCP port. Make sure you Accept this activity as being friendly. You may also have to manually configure your firwall 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 ClientSvc.exe port settings. This port also has to be open on all antivirus and firewalls. The AutoDiscover checkbox will connect to a ClientSvc.exe automatically, when it is seen on the network.

MLClientSvc supports one command called "Send"

MLClientSvc is a member of the SYS family. It supports commands in the form

SYS.PCAliasName|Send~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.

MLClientSvc1.jpg MLClientSvc.dll


ClientSvc.exe

ClientSvc.exe is a mini application intended to run on a PC where you want to issues commands and control programs. It's uses will expand with future MainLobby Suite updates.

Install on any PC (optionally including the MLServer3 PC) where you want to issue commands and control programs. Run the ClientSvc_Setup.exe to install. It is recommended to accept all installation defaults. Typically, you would have ClientSvc.exe to start when that PC is started up (put a link to it in the Startup Folder in Windows)

Default TCP port is 6292 and is also user configurable. This port needs to match the port setup in the MLClientSvc plugin for that PC Alias. When you first start ClientSvc.exe, your Antivirus software may detect activity on this TCP port. Make sure you Accept this activity as being friendly. You may also have to manually configure your firwall and antivirus software to permit TCP traffic on this port.

You can add Program Alias's and the corresponding program to execute.


MLServeCmd Syntax for ClientSvc.exe

Commands to control the user defined ripping applications. These programs are used with the DVDLobby plugin to automate the ripping of DVDs and Blu-Ray movies. AnyDVD and DVDFab are the rippers of choice. The basic commands for controlling the rippers are built into the program. All the user has to do is make sure the paths to the installed applications are correct. DVDLobby will send commands to ClientSvc in the form

Sys.PCAliasName|Send~ProgramAliasName~Param1~Param2~ParamN

Other Supported commands

Launch an application on the remote PC.

Sys.PCAliasName|Send~Run~Program

Where Program is the full Path and Name of program to run on the PC


Open a file on the remote PC.

Sys.PCAliasName|Send~Open~Path to file

Using the full Path and Name of file to open on the PC


Sys.PCAliasName|Send~Stop~ProgramName.exe

Terminate the named application on the remote PC.


Sys.PCAliasName|Send~Eject

Ejects the disk in the DVD drive on the remote PC.


Sys.PCAliasName|Send~Monitor~Off Sys.PCAliasName|Send~Monitor~On'

Turns the Monitor Off and On


Commands to control the Audio Mixer on the remote PC.

Sys.PCAliasName|Send~WaveVolumeUp

Sys.PCAliasName|Send~WaveVolumeDown

Sys.PCAliasName|Send~SetWaveVolume~0..100

Sys.PCAliasName|Send~WaveMute~On,Off,Toggle


Sys.PCAliasName|Send~WaveInVolumeUp

Sys.PCAliasName|Send~WaveInVolumeDown

Sys.PCAliasName|Send~SetWaveInVolume~0..100

Sys.PCAliasName|Send~WaveInMute~On,Off,Toggle


Sys.PCAliasName|Send~LineInVolumeUp

Sys.PCAliasName|Send~LineInVolumeDown

Sys.PCAliasName|Send~SetLineInVolume~0..100

Sys.PCAliasName|Send~LineInMute~On,Off,Toggle


Sys.PCAliasName|Send~MicVolumeUp

Sys.PCAliasName|Send~MicVolumeDown

Sys.PCAliasName|Send~SetMicVolume~0..100

Sys.PCAliasName|Send~MicMute~On,Off,Toggle


Sys.PCAliasName|Send~CDVolumeUp

Sys.PCAliasName|Send~CDVolumeDown

Sys.PCAliasName|Send~SetCDVolume~0.100

Sys.PCAliasName|Send~CDMute~On,Off,Toggle


Sys.PCAliasName|Send~MIDIVolumeUp

Sys.PCAliasName|Send~MIDIVolumeDown

Sys.PCAliasName|Send~SetMIDIVolume~0.100

Sys.PCAliasName|Send~MidiMute~On,Off,Toggle


You can send keystrokes to any application running on the remote PC using the following command.


Sys.PCAliasName|Send~SendKey~<<window name>>~<<key>>

Valid keystroke arguments

Any valid ASCII character, prefix char with + for shift, ^ for control or % for alt. e.g. %{F4} = Alt-F4

Special Keys

{+} {^} {%} {BACKSPACE} {BS} {BKSP} {DELETE} {DEL} {DOWN} {END} {ENTER} {ESC} {HELP} {HOME} {INSERT} {INS} {LEFT} {NUMLOCK} {PGDN} {PGUP} {RIGHT} {SPACE} {TAB} {UP} {F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12} {ADD} {SUBTRACT} {MULTIPLY} {DIVIDE} {LWIN} {RWIN}


ClientSvc supports full two-way control of the VLC Media Player on the remote PC. For VLC the following commands are supported:

Sys.PCAliasName|Send~VLC~<<command>>~<<arg>>~<<option>>


ClientSvc support control of Windows Media Player PC. For WMP the following commands are supported:

Sys.PCAliasName|Send~WMP~<<command>>~<<arg>>~<<option>>

Special control for Windows media player.

Supported commands

Sys.PCAliasName|Send~WMP~POWERON

Sys.PCAliasName|Send~WMP~POWEROFF

Sys.PCAliasName|Send~WMP~EXIT

Sys.PCAliasName|Send~WMP~PLAYFILE~<<filename>>

Sys.PCAliasName|Send~WMP~NEXT

Sys.PCAliasName|Send~WMP~PAUSE

Sys.PCAliasName|Send~WMP~FASTFWD

Sys.PCAliasName|Send~WMP~FASTREV

Sys.PCAliasName|Send~WMP~PLAY

Sys.PCAliasName|Send~WMP~PREVIOUS

Sys.PCAliasName|Send~WMP~STOP

Sys.PCAliasName|Send~WMP~MUTE

Sys.PCAliasName|Send~WMP~VOLUME~0..100

Sys.PCAliasName|Send~WMP~VOLUMEUP

Sys.PCAliasName|Send~WMP~VOLUMEDOWN

Sys.PCAliasName|Send~WMP~WINDOW