Interface IController

Centralized hub for interfacing with the player. Used for accessing schedules, templates, modules, etc.

Namespace: RevelDigital.Player.RevelScript

Assembly: RevelDigital.Player.RevelScript.dll

Syntax

public interface IController

Properties

Device

Gets the device.

Declaration

Device Device { get; }

Property Value

Type	Description
Device

DeviceKey

Gets the device key.

Declaration

Guid? DeviceKey { get; }

Property Value

Type	Description
System.Nullable<System.Guid>

Schedule

Gets the schedule.

Declaration

Schedule Schedule { get; }

Property Value

Type	Description
Schedule

Template

Gets the currently loaded template.

Declaration

ITemplate Template { get; }

Property Value

Type	Description
ITemplate

Methods

CallRpc(RpcCall)

Initiates an RPC call via AMQP with the supplied

Call

object. Use this method if necessary to track RPC correlation Ids in script.

Declaration

void CallRpc(RpcCall call)

Parameters

Type	Name	Description
RpcCall	call	The RPC call object

CallRpc(String, Object[])

Initates an RPC call via AMQP.

Declaration

void CallRpc(string method, object[] args)

Parameters

Type	Name	Description
System.String	method	The RPC method
System.Object[]	args	The RPC arguments

GetDeviceTime()

Gets the current device time.

Declaration

DateTime GetDeviceTime()

Returns

Type	Description
System.DateTime	DateTime

GetDeviceTime(DateTimeOffset)

Adjusts the supplied time to device time.

Declaration

DateTime GetDeviceTime(DateTimeOffset dateTime)

Parameters

Type	Name	Description
System.DateTimeOffset	dateTime	The date time.

Returns

Type	Description
System.DateTime	DateTime

GetDeviceTimeZone()

Returns the current device timezone.

Declaration

string GetDeviceTimeZone()

Returns

Type	Description
System.String	TimeZoneInfo

LogAffidavit(Source)

Appends a source to the affidavit log as played using the current timestamp.

Declaration

void LogAffidavit(Source source)

Parameters

Type	Name	Description
Source	source	The source.

Print(String, String, String, Uri)

Prints to the specified printer name using Google Cloud Print.

Declaration

bool Print(string printerName, string userName, string password, Uri documentUri)

Parameters

Type	Name	Description
System.String	printerName	Name of the printer registered in Google Cloud Print.
System.String	userName	Google account username.
System.String	password	Google account password.
System.Uri	documentUri	The document URI. Eg: file://c:\mydoc.pdf http://www.example.org/test.png

Returns

Type	Description
System.Boolean	Bool indicating success of print job submission

SendCommand(String, String)

Sends a command to the Controller. All registered command listeners will also receive the command.

Declaration

void SendCommand(string cmd, string arg)

Parameters

Type	Name	Description
System.String	cmd	The command name.
System.String	arg	The command argument.

SendCommand(String, String, Int32)

Sends a command to the Controller. All registered command listeners will also receive the command.

Declaration

void SendCommand(string cmd, string arg, int delay = 0)

Parameters

Type	Name	Description
System.String	cmd	The command name.
System.String	arg	The command argument.
System.Int32	delay	Postpone the command for [delay] seconds.

Shutdown()

Shuts down the player and exits to the desktop.

Declaration

void Shutdown()

Events

Command

Occurs when a command is received.

Declaration

event CommandEventHandler Command

Event Type

Type	Description
CommandEventHandler

Navigation

Occurs when a web zone begins navigation to a new url. Can be used to inspect and cancel the request.

Declaration

event NavigationEventHandler Navigation

Event Type

Type	Description
NavigationEventHandler

Played

Occurs when a media item is played.

This is a global handler for all media within the current template. Set the

Handled

property of the event

True

to prevent the media item from being counted in the affidavit log or from being handled by module specific

Played

handlers.

Declaration

event PlayedEventHandler Played

Event Type

Type	Description
PlayedEventHandler

RpcEvent

Occurs when an event is invoked from the RPC channel

Declaration

event RpcEventEventHandler RpcEvent

Event Type

Type	Description
RpcEventEventHandler

RpcResponse

Occurs when an RPC response is available as invoked via the

CallRpc

method.

Declaration

event RpcResponseEventHandler RpcResponse

Event Type

Type	Description
RpcResponseEventHandler

TemplateClicked

Occurs when [template clicked].

Declaration

event TemplateClickedEventHandler TemplateClicked

Event Type

Type	Description
TemplateClickedEventHandler

TemplateInitialized

Occurs when [template initialized].

Declaration

event EventHandler TemplateInitialized

Event Type

Type	Description
System.EventHandler

TemplateResumed

Occurs when [template resumed].

Declaration

event EventHandler TemplateResumed

Event Type

Type	Description
System.EventHandler

TemplateSuspended

Occurs when [template suspended].

Declaration

event EventHandler TemplateSuspended

Event Type

Type	Description
System.EventHandler

TemplateTerminated

Occurs when [template terminated].

Declaration

event EventHandler TemplateTerminated

Event Type

Type	Description
System.EventHandler