Codecore Logo
Quick Search
»
Advanced Search »

SageTV Information Popup Driver

RSS
This driver sends messages to the SageTV Infopopup Plug-In. This driver is pretty simple in design and simply allows us to present a popup notification on the SageTV screen. The listener should be enabled to accept connections from all servers (0.0.0.0), and must be installed from the SageTV 7 plugin repository. The Service provides no feedback so this driver is a single shoot option.

Manufacturer: SageTV

Primary Communications Port: Network


Configuration Settings

  • SageTV IP or Host : The host name or IP address SageTV Infopopup service is listening on
  • Port : (optional) The TCP port which the InfoPopup Service is listening on. Defaults to 10629.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

DisplayMessage ( String )

Display a message on all the extenders

Syntax

void DisplayMessage( String message )

Parameters

message : The Message to display

DisplayMessage ( String, String )

Display a message and Image on all the extenders

Syntax

void DisplayMessage( String message, String image )

Parameters

message : The Message to display
image : The Image to display

DisplayMessage ( String, String, String )

Display a message and Image on a specific extender

Syntax

void DisplayMessage( String message, String image, String uicontext )

Parameters

message : The Message to display
image : The Image to display
uicontext : Error: The method 'DisplayMessage' is missing a ScriptObjectMethodParameterAttribute for 'uicontext'.

DisplayCaller ( String, String )

Display a Caller Note on all the extenders

Syntax

void DisplayCaller( String caller, String number )

Parameters

caller : The Callers Name to display
number : The Callers Number to display

DisplayCaller ( String, String, String )

Display a Caller Note with Description on all the extenders

Syntax

void DisplayCaller( String caller, String number, String description )

Parameters

caller : The Callers Name to display
number : The Callers Number to display
description : A Description to display

DisplayCaller ( String, String, String, String )

Display a Caller Note with Description and Image on all the extenders

Syntax

void DisplayCaller( String caller, String number, String description, String image )

Parameters

caller : The Callers Name to display
number : The Callers Number to display
description : A Description to display
image : The Image to display

DisplayCaller ( String, String, String, String, String )

Display a Caller Note with Description and Image on a specific extender

Syntax

void DisplayCaller( String caller, String number, String description, String image, String uicontext )

Parameters

caller : The Callers Name to display
number : The Callers Number to display
description : A Description to display
image : The Image to display
uicontext : Error: The method 'DisplayCaller' is missing a ScriptObjectMethodParameterAttribute for 'uicontext'.

SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, IScriptObject, IScriptObject )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.