SageTV Driver

RSS

SageTV is a DVR application. The SageX-Services plugin must be installed within SageTV to use this driver. Ensure the Secured HTTPI is set to False. In the SageTV Plug-In Manager, select SageX-Services and choose Configure Plug-In. There is an option called Secured HTTP API that is True by default. Change the setting to False. The SageTV driver does not support playlist editing at this time, check in a future version.

Manufacturer: Frey Technologies

Primary Communications Port: Network

Table of Contents [Hide/Show]

Configuration Settings

Zone Settings : The SageTV sagex api URL and zone settings.

Events

Zone Name Changed

Occurs when a zone name changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Player Connected State Changed

Occurs when the connection state of a zone changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Mode Changed

Occurs when the player's mode changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Shuffle State Changed

Occurs when the shuffle state of the player changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Repeat State Changed

Occurs when the repeat state of the player changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Current Track Genre Changed

Occurs when the current track's album changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Current Track Album Changed

Occurs when the current track's album changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Current Track Artist Changed

Occurs when the current track's artist changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Current Track Title Changed

Occurs when the current track's title changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Playlist Position Changed

Occurs when the index of the currently playing song changes on a zone.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Playlist Length Changed

Occurs when the total number of tracks in a zone's playlist changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Power State Changed

Occurs when the power state of player changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Volume Changed

Occurs when the current volume setting for the player changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Mute State Changed

Occurs when the current mute setting for the player changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

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

ZoneNames

Gets the name of all zones.

Accessibility : Read Only

Type: Array

ZonePlayerConnected

Gets the connection state of all zones, true or false depending on if the zone is connected.

Accessibility : Read Only

Type: Array

Connected

Gets a value indicating if a connection is established with the Sage server.

Accessibility : Read Only

Type: Boolean

ZoneCount

Gets the number of zones supported by this media player driver.

Accessibility : Read Only

Type: Number

ZoneTransportModes

Gets or sets a zone's transport mode as 'play', 'stop' or 'pause'.

Accessibility : Read Only

Type: Array

ZoneShuffleStates

Gets or set the shuffle state of a zone playlist.

Accessibility : Read Only

Type: Array

ZoneRepeatModes

Gets or sets the repeat state which indicates if the player will stop playing at the end of the zone's playlist, repeat the current song indefinitely, or repeat the zone's playlist indefinitely. A value of '0' indicates that the player will stop at the end of the playlist, '1' indicates that the player will repeat the current song indefinitely and a value of '2' indicates that the player will repeat the entire playlist indefinitely.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPositions

Gets or sets the current time position that the each zone's current song has been playing.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackGenres

Gets the current track's album property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackAlbums

Gets the current track's album property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackArtists

Gets the current track's artist property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackTitles

Gets the current track's title property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackDurations

Gets the duration of a zone's currently playing song.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPaths

Gets the path for the currently playing track for each zone.

Accessibility : Read Only

Type: Array

ZonePlaylistPositions

Gets or sets the playlist song position that is currently playing by index. When setting, a one-based value may be used to indicate which song to play.

Accessibility : Read Only

Type: Array

ZonePlaylistLengths

Gets the total number of tracks in each zone's playlist.

Accessibility : Read Only

Type: Array

ZonePowerStates

Gets or sets the power state (on/off) of each player zone.

Accessibility : Read Only

Type: Array

ZoneVolumes

Gets or sets the current volume setting for the player zones. The scale is 0 to 100.

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets or sets a value indicating if a zone's volume setting for the player is muted.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackCoverArts

Gets the cover art for the each zone's current track.

Accessibility : Read Only

Type: Array

ScheduledAirings

Get an array of up to the next 50 scheduled recordings.

Accessibility : Read Only

Type: Array

ScheduledTitles

Get an array of up to the next 50 scheduled recordings.

Accessibility : Read Only

Type: Array

ScheduledEpisodes

Get an array of up to the next 50 scheduled recording episode names.

Accessibility : Read Only

Type: Array

ScheduledDescriptions

Get an array of up to the next 50 scheduled recording descriptions.

Accessibility : Read Only

Type: Array

ScheduledStartTimes

Get an array of up to the next 50 scheduled recording start times.

Accessibility : Read Only

Type: Array

ScheduledEndTimes

Get an array of up to the next 50 scheduled recording end times.

Accessibility : Read Only

Type: Array

ScheduledChannels

Get an array of up to the next 50 scheduled recording channels.

Accessibility : Read Only

Type: Array

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

PlayZone ( Number )

Starts playing the a zone's playlist.

Syntax

void PlayZone( Number zoneID )

Parameters

zoneID : The zone to play.

StopZone ( Number )

Stops playing the a zone's playlist.

Syntax

void StopZone( Number zoneID )

Parameters

zoneID : The zone to stop.

PauseZone ( Number )

Pauses the playing of a zone's playlist.

Syntax

void PauseZone( Number zoneID )

Parameters

zoneID : The zone to pause.

UnpauseZone ( Number )

Unpauses the playing of a zone's playlist.

Syntax

void UnpauseZone( Number zoneID )

Parameters

zoneID : The zone to pause.

ToggleZonePause ( Number )

Toggles the pause state of a zone's playlist.

Syntax

void ToggleZonePause( Number zoneID )

Parameters

zoneID : The zone to toggle pause.

SetZoneTransportMode ( Number, String )

Set's a zone's transport mode as 'play', 'stop' or 'pause'.

Syntax

void SetZoneTransportMode( Number zoneID, String mode )

Parameters

zoneID : The zone number.

mode : The mode, one of 'play', 'stop', or 'pause'.

ClearZonePlaylist ( Number )

Clears a zone's playlist and stops the player.

Syntax

void ClearZonePlaylist( Number zoneID )

Parameters

zoneID : The zone number.

AppendZonePlaylistItem ( Number, String )

Adds the specified song URL, playlist or directory contents to the end of a zone's playlist.

Syntax

void AppendZonePlaylistItem( Number zoneID, String item )

Parameters

zoneID : The zone number to play the items on.

item : A song URL, playlist, file or directory path

InsertZonePlaylistItem ( Number, String )

Inserts the specified song URL, playlist or directory contents to be played immediately after the current song in a zone's playlist.

Syntax

void InsertZonePlaylistItem( Number zoneID, String item )

Parameters

zoneID : The zone number to play the items on.

item : A song URL, playlist, file or directory path

RemoveZonePlaylistItem ( Number, Number )

Removes the song at the specified index from a zone's playlist.

Syntax

void RemoveZonePlaylistItem( Number zoneID, Number index )

Parameters

zoneID : The zone number to play the items on.

index : The index of the item to remove. The first item is at index 1.

MoveZonePlaylistItem ( Number, Number, Number )

Moves the song at the specified index to a new index in a zone's playlist.

Syntax

void MoveZonePlaylistItem( Number zoneID, Number fromIndex, Number toIndex )

Parameters

zoneID : The zone number to play the items on.

fromIndex : The index to the item to move.

toIndex : The destination index.

SetZoneShuffleState ( Number, Boolean )

Set the shuffle state for a zone playlist.

Syntax

void SetZoneShuffleState( Number zoneID, Boolean shuffleState )

Parameters

zoneID : The zone number.

shuffleState : Indicates if shuffle is on or off.

SetZoneRepeatMode ( Number, Number )

Set the repeat mode for a zone playlist.

Syntax

void SetZoneRepeatMode( Number zoneID, Number repeatMode )

Parameters

zoneID : The zone number.

repeatMode : Indicates the repeat mode.

0 = Off

1 = Song

2 = Playlist

SetZoneCurrentTrackPosition ( Number, TimeSpan )

Set's a zone's track position.

Syntax

void SetZoneCurrentTrackPosition( Number zoneID, unknown position )

Parameters

zoneID : The zone number.

position : The track position.

OffsetZoneCurrentTrackPosition ( Number, Number )

Jump to a relative position within a zone's currently playing track based on the current position by specifying the number of seconds to jump.

Syntax

void OffsetZoneCurrentTrackPosition( Number zoneID, Number offset )

Parameters

zoneID : The zone.

offset : A positive or negative number of seconds to jump relative to the position in the currently playing track.

OffsetZonePlaylistPosition ( Number, Number )

Offsets the a zone's currently playing track by the specified number of tracks. -1 to play the previous track, 1 to play the next track.

Syntax

void OffsetZonePlaylistPosition( Number zoneID, Number offset )

Parameters

zoneID : The zone.

offset : A positive or negative number of tracks to jump relative to the currently playing track.

PlayNextZoneTrack ( Number )

Plays the next track in a zone's playlist.

Syntax

void PlayNextZoneTrack( Number zoneID )

Parameters

zoneID : The zone to toggle pause.

PlayPreviousZoneTrack ( Number )

Plays the previous track in a zone's playlist.

Syntax

void PlayPreviousZoneTrack( Number zoneID )

Parameters

zoneID : The zone to toggle pause.

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

Syntax

void SetZoneVolume( Number zoneID, Number volume )

Parameters

zoneID : The zone number.

volume : Volume (0=Quietest, 100=Loudest)

OffsetZoneVolume ( Number, Number )

Offsets the current volume setting for the player. Positive numbers increase the volume by the specified number and negative numbers decrease the volume. The full volume scale is 0 to 100.

Syntax

void OffsetZoneVolume( Number zoneID, Number offset )

Parameters

zoneID : The zone to toggle pause.

offset : A positive or negative number offset the volume relative to the current volume. The volume scale is 0 to 100.

MuteZone ( Number )

Turn the mute on for a zone.

Syntax

void MuteZone( Number zoneID )

Parameters

zoneID : The zone number to mute.

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax

void UnmuteZone( Number zoneID )

Parameters

zoneID : The zone number to unmute.

PlayZoneItems ( Number, IScriptArray )

Adds the specified song URLs, playlists or directory contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax

void PlayZoneItems( Number zoneID, Array locations )

Parameters

zoneID : The zone number to play the items on.

locations : An array of ScriptString objects representing song URLs, playlists, files or directory paths.

PlayZoneItem ( Number, String )

Adds the specified song URL, playlist or directory contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax

void PlayZoneItem( Number zoneID, String item )

Parameters

zoneID : The zone number to play the item on.

item : A song URL, playlist, file or directory path

PlayFaster ( Number )

Sets the playback rate of the MediaPlayer to be twice the current playback rate.

Syntax

void PlayFaster( Number zoneID )

Parameters

zoneID : The zone.

PlaySlower ( Number )

Sets the playback rate of the MediaPlayer to be half the current playback rate.

Syntax

void PlaySlower( Number zoneID )

Parameters

zoneID : The zone.

SkipForward ( Number )

Performs a time seek forward in the MediaPlayer.

Syntax

void SkipForward( Number zoneID )

Parameters

zoneID : The zone.

SkipForward2 ( Number )

Performs a time seek forward in the MediaPlayer.

Syntax

void SkipForward2( Number zoneID )

Parameters

zoneID : The zone.

SkipBackward ( Number )

Performs a time seek backward in the MediaPlayer.

Syntax

void SkipBackward( Number zoneID )

Parameters

zoneID : The zone.

SkipBackward2 ( Number )

Performs a time seek backward in the MediaPlayer.

Syntax

void SkipBackward2( Number zoneID )

Parameters

zoneID : The zone.

ChannelDown ( Number )

Performs a logical channel down in the MediaPlayer. This only has effect if the content that is currently being viewed has the concept of channels, tracks, chapters, etc.

Syntax

void ChannelDown( Number zoneID )

Parameters

zoneID : The zone.

ChannelUp ( Number )

Performs a logical channel up in the MediaPlayer. This only has effect if the content that is currently being viewed has the concept of channels, tracks, chapters, etc.

Syntax

void ChannelUp( Number zoneID )

Parameters

zoneID : The zone.

VolumeUp ( Number )

Increases the volume in the MediaPlayer.

Syntax

void VolumeUp( Number zoneID )

Parameters

zoneID : The zone.

VolumeDown ( Number )

Decreases the volume in the MediaPlayer.

Syntax

void VolumeDown( Number zoneID )

Parameters

zoneID : The zone.

Guide ( Number )

Invokes the Guide Command.

Syntax

void Guide( Number zoneID )

Parameters

zoneID : The zone.

DontLike ( Number )

Invokes the Don't LIke Command.

Syntax

void DontLike( Number zoneID )

Parameters

zoneID : The zone.

Right ( Number )

Invokes the Right Command.

Syntax

void Right( Number zoneID )

Parameters

zoneID : The zone.

Up ( Number )

Invokes the Up Command.

Syntax

void Up( Number zoneID )

Parameters

zoneID : The zone.

Down ( Number )

Invokes the Down Command.

Syntax

void Down( Number zoneID )

Parameters

zoneID : The zone.

Left ( Number )

Invokes the Left Command.

Syntax

void Left( Number zoneID )

Parameters

zoneID : The zone.

TV ( Number )

Invokes the TV Command.

Syntax

void TV( Number zoneID )

Parameters

zoneID : The zone.

Select ( Number )

Invokes the Select Command.

Syntax

void Select( Number zoneID )

Parameters

zoneID : The zone.

Watched ( Number )

Invokes the Watched Command.

Syntax

void Watched( Number zoneID )

Parameters

zoneID : The zone.

Favorite ( Number )

Invokes the Favorite Command.

Syntax

void Favorite( Number zoneID )

Parameters

zoneID : The zone.

Info ( Number )

Invokes the Info Command.

Syntax

void Info( Number zoneID )

Parameters

zoneID : The zone.

Record ( Number )

Invokes the Record Command.

Syntax

void Record( Number zoneID )

Parameters

zoneID : The zone.

Home ( Number )

Invokes the Home Command.

Syntax

void Home( Number zoneID )

Parameters

zoneID : The zone.

Options ( Number )

Invokes the Options Command.

Syntax

void Options( Number zoneID )

Parameters

zoneID : The zone.

Power ( Number )

Invokes the Power Command.

Syntax

void Power( Number zoneID )

Parameters

zoneID : The zone.

PowerOn ( Number )

Invokes the Power On Command.

Syntax

void PowerOn( Number zoneID )

Parameters

zoneID : The zone.

PowerOff ( Number )

Invokes the Power Off Command.

Syntax

void PowerOff( Number zoneID )

Parameters

zoneID : The zone.

Back ( Number )

Invokes the Back Command.

Syntax

void Back( Number zoneID )

Parameters

zoneID : The zone.

Forward ( Number )

Invokes the Forward Command.

Syntax

void Forward( Number zoneID )

Parameters

zoneID : The zone.

Customize ( Number )

Invokes the Customize Command.

Syntax

void Customize( Number zoneID )

Parameters

zoneID : The zone.

Music ( Number )

Invokes the Music Jukebox Command.

Syntax

void Music( Number zoneID )

Parameters

zoneID : The zone.

RecordingSchedule ( Number )

Invokes the Recording Schedule Command.

Syntax

void RecordingSchedule( Number zoneID )

Parameters

zoneID : The zone.

Recordings ( Number )

Invokes the SageTV Recordings Command.

Syntax

void Recordings( Number zoneID )

Parameters

zoneID : The zone.

Pictures ( Number )

Invokes the Picture Library Command.

Syntax

void Pictures( Number zoneID )

Parameters

zoneID : The zone.

Videos ( Number )

Invokes the Video Library Command.

Syntax

void Videos( Number zoneID )

Parameters

zoneID : The zone.

Eject ( Number )

Invokes the Eject Command.

Syntax

void Eject( Number zoneID )

Parameters

zoneID : The zone.

StopEject ( Number )

Invokes the Stop/Eject Command.

Syntax

void StopEject( Number zoneID )

Parameters

zoneID : The zone.

Input ( Number )

Invokes the Input Command.

Syntax

void Input( Number zoneID )

Parameters

zoneID : The zone.

FastForward ( Number )

Invokes the FastForward Command.

Syntax

void FastForward( Number zoneID )

Parameters

zoneID : The zone.

Rewind ( Number )

Invokes the Rewind Command.

Syntax

void Rewind( Number zoneID )

Parameters

zoneID : The zone.

Dash ( Number )

Invokes the - Command.

Syntax

void Dash( Number zoneID )

Parameters

zoneID : The zone.

Search ( Number )

Invokes the Search Command.

Syntax

void Search( Number zoneID )

Parameters

zoneID : The zone.

Setup ( Number )

Invokes the Setup Command.

Syntax

void Setup( Number zoneID )

Parameters

zoneID : The zone.

Library ( Number )

Invokes the Library Command.

Syntax

void Library( Number zoneID )

Parameters

zoneID : The zone.

Delete ( Number )

Invokes the Delete Command.

Syntax

void Delete( Number zoneID )

Parameters

zoneID : The zone.

Num ( Number, Number )

Invokes a Number Command.

Syntax

void Num( Number zoneID, Number num )

Parameters

zoneID : The zone.

num : Number to Send (0-9)

AspectRatio ( Number, String )

Invokes the Aspect Ratio Command.

Syntax

void AspectRatio( Number zoneID, String ratio )

Parameters

zoneID : The zone.

ratio : Ratio to change

Page ( Number, String )

Invokes the Page + Direction Command.

Syntax

void Page( Number zoneID, String direction )

Parameters

zoneID : The zone.

direction : Direction to Page

Scroll ( Number, String )

Invokes the Scroll + Direction Command.

Syntax

void Scroll( Number zoneID, String direction )

Parameters

zoneID : The zone.

direction : Direction to Scroll

DVDCommand ( Number, String )

Invokes a DVD Specific Command.

Syntax

void DVDCommand( Number zoneID, String command )

Parameters

zoneID : The zone.

command : DVD Command

PreviousChannel ( Number )

Invokes the PreviousChannel Command.

Syntax

void PreviousChannel( Number zoneID )

Parameters

zoneID : The zone.

LiveTV ( Number )

Invokes the LiveTV Command.

Syntax

void LiveTV( Number zoneID )

Parameters

zoneID : The zone.

DVD ( Number )

Invokes the DVD Command.

Syntax

void DVD( Number zoneID )

Parameters

zoneID : The zone.

VideoOutput ( Number )

Invokes the Video Output Command.

Syntax

void VideoOutput( Number zoneID )

Parameters

zoneID : The zone.

Online ( Number )

Invokes the Online Command.

Syntax

void Online( Number zoneID )

Parameters

zoneID : The zone.

SageCommand ( Number, String )

Invokes an arbitraty Sage Command.

Syntax

void SageCommand( Number zoneID, String command )

Parameters

zoneID : The zone.

command : Command to invoke

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 )

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.