PlayerControl
  • 18 Dec 2023
  • 5 Minutes to read
  • Dark
    Light

PlayerControl

  • Dark
    Light

Article summary

All required functions for the remote control of the player, such as for the starting of event playlists or navigation within a playlist or spot, can be found under Player Control.

The interface definition for the player's REST interface can be found here: http://localhost:8080/REST/PlayerControl/help

Uri

Method

Description

PlayBegin/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayBegin/?screenNr={SCREENNR}

PlayEnd/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayEnd/?screenNr={SCREENNR}

PlayForward/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayForward/?screenNr={SCREENNR}

PlayNextSpot/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayNextSpot/?screenNr={SCREENNR}&splittNr={SPLITNR}

PlayPrevSpot/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayPrevSpot/?screenNr={SCREENNR}&splittNr={SPLITNR}

PlayRewind/

GET

Service at http://localhost:8080/REST/PlayerControl/PlayRewind/?screenNr={SCREENNR}

PlaySpot/

GET

Service at http://localhost:8080/REST/PlayerControl/PlaySpot/?screenNr={SCREENNR}&splittNr={SPLITNR}&spotName={SPOTNAME}

ScreenSaver/

GET

Service at http://localhost:8080/REST/PlayerControl/ScreenSaver/?action={ACTION}

SetLiveTags

POST

Service at http://localhost:8080/REST/PlayerControl/SetLiveTags

TriggerEvent/

GET

Service at http://localhost:8080/REST/PlayerControl/TriggerEvent/?messageSubType={MESSAGESUBTYPE}&eventCode={EVENTCODE}

TriggerEventPlaySpot/

GET

Service at http://localhost:8080/REST/PlayerControl/TriggerEventPlaySpot/?messageSubType={MESSAGESUBTYPE}&eventCode={EVENTCODE}&spotName={SPOTNAME}

Playing a spot from the Start (PlayBegin)

The 'PlayBegin' command tells all split areas to jump back to the beginning of the medium selected for playing.

Parameter:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

REST:

http://localhost:8080/REST/PlayerControl/PlayBegin/?screenNr=1

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayBegin>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
		</tem:PlayBegin>
	</soapenv:Body>
</soapenv:Envelope>

Jumping to the end of the current Spot (PlayEnd)

The 'PlayEnd' command tells all split areas from specified screens to jump to the end of the current medium being played.

Parameter:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

REST:

http://localhost:8080/REST/PlayerControl/PlayEnd/?screenNr=1

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayEnd>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
		</tem:PlayEnd>
	</soapenv:Body>
</soapenv:Envelope>

Fast forward (PlayForward)

The 'PlayForward' command tells all split areas of a specified screen to jump ahead a few seconds on the medium that is currently being played. The amount of time can be set in the player configuration under "Player / Advanced controls through the SeekOperationSeconds setting. By default, this is set to five seconds.

Parameter:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

REST:

http://localhost:8080/REST/PlayerControl/PlayForward/?screenNr=1

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayForward>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
		</tem:PlayForward>
	</soapenv:Body>
</soapenv:Envelope>

Playing the next spot (PlayNextSpot)

The 'PlayNextSpot' command tells a split area to immediately play the next spot in the current playlist.

Parameters:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

splitNr

This is the number assigned to the split area. As long as the screen layout is not split into different zones, only one 'split' with the number 1 exists (main split). When using a split screen layout, the numbers of each split can be seen in the XML-file of the program scheme.

REST:

http://localhost:8080/REST/PlayerControl/PlayNextSpot/?screenNr=1&splittNr=0

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayNextSpot>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
			<!--Optional:-->
			<tem:splitNr>0</tem:splitNr>
		</tem:PlayNextSpot>
	</soapenv:Body>
</soapenv:Envelope>

Playing the previous spot (PlayPrevSpot)

The 'PlayPrevSpot' command tells a split screen area to immediately play the spot preceding the current spot in the playlist.

Parameters:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

splitNr

This is the number assigned to the split area. If the screen layout is not split into different zones, only one 'split' with the number 1 exists (main split). When using a split screen layout, the numbers of each split can be seen in the XML-file of the program scheme.

REST:

http://localhost:8080/REST/PlayerControl/PlayPrevSpot/?screenNr=1&splittNr=0

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayPrevSpot>
			<tem:screenNr>1</tem:screenNr>
			<tem:splitNr>0</tem:splitNr>
		</tem:PlayPrevSpot>
	</soapenv:Body>
</soapenv:Envelope>

Rewinding (PlayRewind)

The 'PlayRewind' command tells all split areas from specified screens to jump back a few seconds in the currently playing medium. The time (in seconds) can be set in the player configuration under Player / Advanced controls via the SeekOperationSeconds setting. By default, it is set to five seconds.

Parameter:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

REST:

http://localhost:8080/REST/PlayerControl/PlayRewind/?screenNr=1

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlayRewind>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
		</tem:PlayRewind>
	</soapenv:Body>
</soapenv:Envelope>

Jumping to a spot (PlaySpot)

The 'Playspot' command tells a split screen to immediately start a certain spot that is in the currently active playlist. After the spot the playlist continues from that position.

Parameters:

screenNr

This is the number assigned to the screen. The numbering starts with 1 for the main screen. If additional screens are connected, these are assigned consecutive numbers (2,3, etc.).

splitNr

This is the number assigned to the split area. As long as the screen layout is not split into different zones, only one 'split' with the number 1 exists (main split). When using a split screen layout, the number of each split can be seen in the XML-file of the program scheme.

spotName

This is the name of the spot, as it appears in the Grassfish CMS. Keep in mind that this is not the original file name.

REST:

http://localhost:8080/REST/PlayerControl/PlaySpot/?screenNr=1&splittNr=0&spotName=grassfish_show_video

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:PlaySpot>
			<!--Optional:-->
			<tem:screenNr>1</tem:screenNr>
			<!--Optional:-->
			<tem:splitNr>0</tem:splitNr>
			<!--Optional:-->
			<tem:spotName>grassfish_show_video</tem:spotName>
		</tem:PlaySpot>
	</soapenv:Body>
</soapenv:Envelope>

Activating/deactivating the screen saver (ScreenSaver)

The 'ScreenSaver' command is used to control the operating mode of the player's screen saver. Depending on the parameter, the screen saver can be activated, deactivated or the time set back until activation of the screen saver.

Parameter:

action

Available parameters:

  • Activate: Permanently activates the screen saver. If no valid idle playlist has been defined in the CMS, the settings will still be accepted, but they will not have any influence until the change has been made in the CMS.

  • Deactivate: Deactivates the screen saver until the next restart of the player.

  • ResetIdleTimer: Resets the internal timer that measures the user's inactive time.

REST:

http://localhost:8080/REST/PlayerControl/ScreenSaver/?action=Activate

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:ScreenSaver>
			<!--Optional:-->
			<tem:action>Activate</tem:action>
		</tem:ScreenSaver>
	</soapenv:Body>
</soapenv:Envelope>

Setting Live Tags (SetLiveTags)

The 'SetLiveTags' command is used to set the live tags that are currently used by the player. The setting of live tags is always followed by an update and tags which are not present in the request are removed from the player.

Parameters:

LiveTag[]

A list of live tags


Name

The name of the live tag


Values[]

A list of values of a live tag



Value

The value of a live tag

REST:

http://localhost:8080/REST/PlayerControl/SetLiveTags

[{
	"Name":"Gender",
	"Values":[{
		"Value":"Male"
	}]
}]

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gras="http://schemas.datacontract.org/2004/07/Grassfish.CommonBase.DataTransferObjects">
	<soapenv:Header />
	<soapenv:Body>
		<tem:SetLiveTags>
			<tem:tags>
				<gras:LiveTag>
					<gras:Name>Gender</gras:Name>
					<gras:Values>
						<!--Zero or more repetitions:-->
						<gras:LiveTagValue>
							<gras:Value>Male</gras:Value>
						</gras:LiveTagValue>
					</gras:Values>
				</gras:LiveTag>
			</tem:tags>
		</tem:SetLiveTags>
	</soapenv:Body>
</soapenv:Envelope>

Triggering an event (TriggerEvent)

The 'TriggerEvent' command is used to instantly start or stop a predefined event playlist on the player.

Parameters:

messageSubType

The type of event that should be triggered.

Available parameters:

  • Start: Starts a predefined event playlist of the type 'Start'.

  • StartLoop: Starts a predefined event playlist of the type 'StartLoop' (a continuously repeated playlist).

  • StopLoop: Stops a running event playlist of the type 'StartLoop'.

  • StopAllEventPlaylists: Stops all current event playlists.

eventCode

The event ID of the selected event playlist.

REST:

http://localhost:8080/REST/PlayerControl/TriggerEvent/?messageSubType=Start&eventCode=event_12

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:TriggerEvent>
			<tem:messageSubType>Start</tem:messageSubType>
			<tem:eventCode>event_12</tem:eventCode>
		</tem:TriggerEvent>
	</soapenv:Body>
</soapenv:Envelope>

Triggering an event and jumping directly to a spot (TriggerEventPlaySpot)

The 'TriggerEventPlaySpot' command starts a selected event playlist and immediately jumps to a specified spot in the playlist.

Windows players, this feature is available from version 10.0.8.

Parameters:

messageSubType

The type of event that should be triggered.

Available parameters:

  • Start: Starts a selected event playlist of the type 'Start'.

  • StartLoop: Starts a selected event playlist of the type 'StartLoop' (a continuously repeated playlist).

  • StopLoop: Stops a running event playlist of the type 'StartLoop'.

  • StopAllEventPlaylists: Stops all currently active event playlists.

eventCode

The event ID of the selected event playlist.

spotName

The name of the spot you would like to advance to.

REST:

http://localhost:8080/REST/PlayerControl/TriggerEventPlaySpot/?messageSubType=Start&eventCode=event_12&spotName=spot1

SOAP:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
	<soapenv:Header />
	<soapenv:Body>
		<tem:TriggerEventPlaySpot>
			<tem:messageSubType>Start</tem:messageSubType>
			<tem:eventCode>event_12</tem:eventCode>
<tem:spotName>spot1</tem:spotName>
		</tem:TriggerEventPlaySpot>
	</soapenv:Body>
</soapenv:Envelope>


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.