Wiki Navigation

Loading...

What does this plugin do?

EventGhost's main functions is all about events and macros.

There's dozens of EventGhost plugins that can trigger an event with the use of peripherals, such as keyboards, IR and RF receivers, joysticks and gamepads, Android devices, network communication, web server, on screen menu, timer, voice control, sunset/sunrise and much more.

There's just as many EventGhost plugins that can be used in macros to execute commands, for example send commands to dozens of preconfigured media software, receivers, TV:s and projectors, lights, ceiling fans, start and stop other software, move the mouse cursor and much more.

It's very simple to combine events and macros in EventGhost. For example create a macro that starts MediaPortal and drag + drop an event from your IR remote's Media button to the macro. The next time you press the Media button on your remote, MediaPortal will start.

EventGhostPlus is the software that connects MediaPortal and EventGhost. It loads into MediaPortal and is responsible for reading events sent from EventGhost's MediaPortal and MediaPortal Message Sender plugins and will also generate events in EventGhost which can be used to trigger other macros.

What can I do with this plugin?

You may use any trigger in EventGhost to control MediaPortal. For example configure an IR remote to send Up, Down, Left, Right and Enter commands to MediaPortal. It's also possible to control MediaPortal from an Android Device or a web page. Start MediaPortal automatically every day when sun sets. Pause the video when your phone rings. Anything is possible.

EventGhostPlus will trigger events in EventGhost when you start, pause or stop a video or play music. The events can be used to trigger any macro such as turn off the lights in the room when playing a video. Turn them on again when stopping or pausing. Automatically set the lights to 80% when watching TV and 40% when playing music. Change your display to 3D mode when playing a Side-by-Side 3D video. Turn on your ceiling fan when watching a movie of the genre Romance. Anything is possible.

Features

Sending Events To EventGhost

Sending events to either local or remote EventGhost installation. Events include: Play, Pause, Resume, Stop, End (see the full list of events below).
When playing a video or recording, EventGhostPlus will also transmit a Long or Short attribute for a long or short video.
The filename and genre(s) of the video playing is transmitted as payload (only with the play event).

Receiving Events From EventGhost

Receiving commands to operate MediaPortal from the EventGhost MediaPortal plugin (advised for controlling MediaPortal with your IR remote).
Receiving Messages and commands top operate MediaPortal with the MediaPortal Message Sender plugin (advised for a single commands from your server like pause when the phone rings).

Installation

Download and install EventGhost (not needed when you plan on only using network events).
Download and install EventGhostPlus.
(optional) Download and install the MediaPortal Message Sender Plugin for EventGhost.

Configuration

You can configure EventGhostPlus from MediaPortal Configuration / Plugins.

Locate EventGhost

Enter the path to your EventGhost installation. You only have to use this box if Event sending mode is set to Submit events locally.

Event Sending Mode

Submit events locally

Sends events directly to EventGhost installed on the local computer. Events will be triggered by executing the EventGhost.exe -e file.

Submit events to a network server

Events will be sent to an EventGhost installation on the IP address or host name entered into the Host field. You need to add the Network Event Receiver plugin in the remote EventGhost configuration for it to be able to receive the trigger sent from EventGhostPlus. EventGhost do not have to be installed on the MediaPortal and EventGhostPlus computer in this case.

Tip: When you see an error like:

[Error  ] [MPMain   ] [ERROR] - EventGhostPlus: Error while trying to connect to SERVER:1024

use and IP adress for the network server host instead of hostname.

Event Sending Options

Send event on window change

When this option is checked, EventGhostPlus will send triggers to EventGhost when navigating around different MediaPortal windows, such as Plugins, TV and Videos.

An example of events received by EventGhost and triggered by EventGhostPlus when opening MP TV-Series plugin, the plugins window, Home and more in MediaPortal.

Event Structure

Defines the structure of the event that is triggered in EventGhost. Below is an example of the structure MediaPortal.Type.Status.

Last part as payload

The last part (Status or Type) will be sent as a payload to EventGhost. This can be useful if you wish all events of a certain type (for example Recordings: Play, Pause, Resume, Stop and End) to trigger a macro without having to add them all or if you use a Python script that processes the event.

Short Video Length

You can decide how long a short video is by entering a maximum video length in the Short video length field. This can be used to trigger different macros in EventGhost depending on the length of the video. For example you might want to turn of the lights in the room when playing a long video but not every time you watch a trailer.

Event Receiving

Messages

In the Plugin Configuration you set a port and a password for receiving events. It's very important that this port is different from what you configured in your local EventGhost Network Message Receiver plugin. When you have set this up extract the

MediaPortalMessageSender.zip

to the

..\EventGhost\plugin

folder.

Now when you add a plugin in EventGhost you'll see MediaPortal Message Sender there to select. The configuration will popup and you have to enter the name or IP-address of the HTPC, the password and port you entered in the EventGhostPlus configuration at the Event receiving section. Now create an action or macro and select the MediaPortal Message Sender > SendMessage action.

You can customize the message and the timeout period in the SendMessage configuration window:

When this action is triggered, it will send the message to the EventGhostPlus plugin which will show it as a dialog in MediaPortal (if it is running):

If MediaPortal is not running or the message could not be sent to the EventGhostPlus plugin, you will see an error message in the EventGhost log pane:

20:32:05      NetworkSender failed

If you trigger events with a payload you can also use

{eg.event.payload[0]}

for any line you like. Where there is

you need to enter the number of the payload you want to send to MediaPortal. Event payloads start with

. Be careful though, EventGhost will generate errors when you use payload with an event without a payload. For testing you should always enter something by hand. And if all is successful you'll see the message in Mediaportal.

Remote Buttons (extensive)

Open EventGhost and add the MediaPortal plugin to the AutoStart folder in your local EventGhost installation on the HTPC (if you wish to control MediaPortal from EventGhost).

A range of macros will be created, you can add events to them to control MediaPortal.

Remote Buttons (limited)

If you plan on only using a few buttons you can also use the SendRemoteButton action in the MediaPortal Message Sender plugin.

Follow the same installation procedure as described in the "Messages" section above.

You can create an action or macro and select the MediaPortalMessageSender -> SendRemoteButton, select the button you want to be sent, and press OK.

Every time this macro is triggered MediaPortal will be controlled with that button as if you pressed the button on your remote.

These buttons can also be customized as described below in "Show Inputmapping".

Show Inputmapping

Inputmapping can be used to configure the input triggers coming from EventGhost (usually remote buttons).

See example below which configures the *-button to switch audio streams in the currently playing video file:

No Condition needs to be at the bottom or removed.
You can use any key that is still free or whose conditions don't interfere with the ones to set up.

Full list of events

Events sent by EventGhostPlus (everything in between brackets [] is sent as payload):

MediaPortal.Plugin.Start

MediaPortal.Plugin.Stop

MediaPortal.Short.Video [action, filename, genre, aspect ratio]

MediaPortal.Short.Video.Play [filename, genre, aspect ratio]

MediaPortal.Short.Video.Pause

MediaPortal.Short.Video.Resume

MediaPortal.Short.Video.Stop

MediaPortal.Short.Video.End

MediaPortal.Long.Video [action, filename, genre, aspect ratio]

MediaPortal.Long.Video.Play [filename, genre, aspect ratio]

MediaPortal.Long.Video.Pause

MediaPortal.Long.Video.Resume

MediaPortal.Long.Video.Stop

MediaPortal.Long.Video.End

MediaPortal.Music [action, filename, genre]

MediaPortal.Music.Play [filename, genre]

MediaPortal.Music.Pause

MediaPortal.Music.Resume

MediaPortal.Music.Stop

MediaPortal.Music.End

MediaPortal.Radio [action]

MediaPortal.Radio.Play

MediaPortal.Radio.Pause

MediaPortal.Radio.Resume

MediaPortal.Radio.Stop

MediaPortal.Radio.End

MediaPortal.Recording [action]

MediaPortal.Short.Recording.Play [filename]

MediaPortal.Short.Recording.Pause

MediaPortal.Short.Recording.Resume

MediaPortal.Short.Recording.Stop

MediaPortal.Short.Recording.End

MediaPortal.Long.Recording.Play [filename]

MediaPortal.Long.Recording.Pause

MediaPortal.Long.Recording.Resume

MediaPortal.Long.Recording.Stop

MediaPortal.Long.Recording.End

MediaPortal.TV [action]

MediaPortal.TV.Play

MediaPortal.TV.Pause

MediaPortal.TV.Resume

MediaPortal.TV.Stop

MediaPortal.TV.End

MediaPortal.Window.Activate [Window ID, Window Name]

MediaPortal.Message.Displaying [Message header]

MediaPortal.Message.Closed [Message header]

MediaPortal.System.Standby

MediaPortal.System.Resume

MediaPortal.Window.Minimize

MediaPortal.Window.Maximize

MediaPortal.Window.Restore

Seitenhierarchie