Codecore Logo
Quick Search
»
Advanced Search »

SABnzbd Binary Newsreader Driver

RSS
A driver for monitoring and controlling SABnzbd. SABnzbd is an Open Source Binary Newsreader that automates the downloading, extracting, renaming, and placement of newsgroup files.

Manufacturer: The SABnzbd-Team

Primary Communications Port: Network

Table of Contents [Hide/Show]


Configuration Settings
Events
   SABnzbd Overall ETA Changed.
   SABnzbd Free Disk Space Changed.
   SABnzbd Free Temp Disk Space Changed.
   SABnzbd History Item Names Changed.
   SABnzbd History Last Updated Changed.
   SABnzbd Paused State Changed
   SABnzbd Overall Queue Size Changed.
   SABnzbd Overall Queue Size Left Changed.
   SABnzbd Queue Item Categories Changed.
   SABnzbd Queue Item Count Changed.
   SABnzbd Queue Item ETA Changed.
   SABnzbd Queue Item NZO IDs Changed.
   SABnzbd Queue Item Names Changed.
   SABnzbd Queue Item Priorities Changed.
   SABnzbd Queue Item Priorities Changed.
   SABnzbd Queue Item Sizes Changed.
   SABnzbd Queue Item Size Lefts Changed.
   SABnzbd Queue Item Status Changed.
   SABnzbd Queue Item Time Lefts Changed.
   SABnzbd Queue Last Updated Changed.
   SABnzbd Speed Changed.
   SABnzbd Speed Changed.
   SABnzbd Status Changed.
   SABnzbd Update Available Changed.
   SABnzbd Uptime Changed.
   SABnzbd Version Changed.
   Ready State Changed
Instance Properties
   Eta
   FreeDiskSpace
   FreeDiskSpaceTemp
   HistoryItemNames
   HistoryLastUpdated
   IsPaused
   OverallQueueSize
   OverallQueueSizeLeft
   QueueItemCategories
   QueueItemCount
   QueueItemEtas
   QueueItemIDs
   QueueItemNames
   QueueItemPercentCompletes
   QueueItemPriorities
   QueueItemSizes
   QueueItemSizeLefts
   QueueItemStatuses
   QueueItemTimeLefts
   QueueLastUpdated
   Speed
   SpeedLimit
   Status
   UpdateAvailable
   Uptime
   Version
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   ClearDownloadQueue
   DeleteQueueItem ( String )
   Pause
   QueueByFilePath ( String )
   QueueByNewzbinID ( String )
   QueueByUrl ( String )
   Resume
   SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )
   SetPropertyForDuration ( String, Number, TimeSpan, IScriptObject, IScriptObject )


Configuration Settings

  • API Key : (optional) The API key generated by SABnzbd and used as the prefered method to verify communication with SABnzbd. This value can be found in SABnzbd configuration and should be left blank ONLY when SABnzbd is configured with 'Disable API-key'.
  • History Item Limit : Maximum number of items to retrieve from SABNzbd download history.
  • History Refresh Interval : Interval in seconds between history update requests.
  • Host IP/Name : The IP address or hostname of the SABnzbd server. Ex. 192.168.0.5
  • Password : (optional) The SABnzbd server password used to verify communication with SABnzb. This value can be left blank ONLY when no password is configured in SABnzbd and 'Disable API-key' is uncheck in SABnzbd.
  • Port : The port number of the SABnzbd server. Must match port chosen in SABnzbd configuration.
  • Queue Refresh Interval : Interval in seconds between queue update requests.
  • Username : (optional) The SABnzbd server username used to verify communication with SABnzb. This value can be left blank ONLY when no username is configured in SABnzbd and 'Disable API-key' is uncheck in SABnzbd.

Events

SABnzbd Overall ETA Changed.

Occurs when the overall ETA changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Free Disk Space Changed.

Occurs when free disk space changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Free Temp Disk Space Changed.

Occurs when free temp disk space changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd History Item Names Changed.

Occurs when an item is added/removed from the SABnzbd history.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd History Last Updated Changed.

Occurs when the driver successfully updates the history from SABnzbd.

Whenever Filter:

none

EventArgs:

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

SABnzbd Paused State Changed

Occurs when SABnzbd downloads are paused or resumed.

Whenever Filter:

none

EventArgs:

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

SABnzbd Overall Queue Size Changed.

Occurs when the overall queue size changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Overall Queue Size Left Changed.

Occurs when the overall queue size left changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Queue Item Categories Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's category is changed.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Count Changed.

Occurs when an item is added/removed from the SABnzbd queue.

Whenever Filter:

none

EventArgs:

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

SABnzbd Queue Item ETA Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's ETA changes.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item NZO IDs Changed.

Occurs when an item is added/removed from the SABnzbd queue.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Names Changed.

Occurs when an item is added/removed from the SABnzbd queue.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Priorities Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's % complete changes.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Priorities Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's priority is adjusted.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Sizes Changed.

Occurs when an item is added/removed from the SABnzbd queue.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Size Lefts Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's size left changes.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Status Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's status changes.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Item Time Lefts Changed.

Occurs when an item is added/removed from the SABnzbd queue or when a queue item's time left changes.

Whenever Filter:

  • PropertyIndex : (optional) 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.

SABnzbd Queue Last Updated Changed.

Occurs when the driver successfully updates the queue from SABnzbd.

Whenever Filter:

none

EventArgs:

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

SABnzbd Speed Changed.

Occurs when SABnzbd's download speed changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Speed Changed.

Occurs when SABnzbd's download speed changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Status Changed.

Occurs when SABnzbd's status changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Update Available Changed.

Occurs when a new version of SABnzbd becomes available or when SABnzbd is updated to the latest version.

Whenever Filter:

none

EventArgs:

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

SABnzbd Uptime Changed.

Occurs when SABnzbd's uptime changes.

Whenever Filter:

none

EventArgs:

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

SABnzbd Version Changed.

Occurs when a new version of SABnzbd's software version changes.

Whenever Filter:

none

EventArgs:

  • 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

Eta

Gets the overall ETA for completion. (January 1, 0001 when no ETA is available)

Accessibility : Read Only

Type: DateTime

FreeDiskSpace

Gets the free disk space in the completed downloads directory in gigabytes.

Accessibility : Read Only

Type: Number

FreeDiskSpaceTemp

Gets the free disk space in the temporary downloads directory in gigabytes.

Accessibility : Read Only

Type: Number

HistoryItemNames

Gets an array of history item names.

Accessibility : Read Only

Type: Array

HistoryLastUpdated

Gets the time of the last successful history update.

Accessibility : Read Only

Type: DateTime

IsPaused

Gets or Sets if SABnzbd downloads are paused.

Accessibility : Read / Write

Type: Boolean

OverallQueueSize

Gets the overall size of the queue in megabytes. (Does not include paused items)

Accessibility : Read Only

Type: Number

OverallQueueSizeLeft

Gets the overall size left in the queue in megabytes. (Does not include paused items)

Accessibility : Read Only

Type: Number

QueueItemCategories

Gets an array of queue item categories.

Accessibility : Read Only

Type: Array

QueueItemCount

Gets the number of items in the queue.

Accessibility : Read Only

Type: Number

QueueItemEtas

Gets an array of queue item ETAs. (January 1, 0001 when no ETA is available)

Accessibility : Read Only

Type: Array

QueueItemIDs

Gets an array of queue item NZO IDs.

Accessibility : Read Only

Type: Array

QueueItemNames

Gets an array of queue item names.

Accessibility : Read Only

Type: Array

QueueItemPercentCompletes

Gets an array of queue item % completes.

Accessibility : Read Only

Type: Array

QueueItemPriorities

Gets an array of queue item priorities.

Accessibility : Read Only

Type: Array

QueueItemSizes

Gets an array of queue item sizes in megabytes.

Accessibility : Read Only

Type: Array

QueueItemSizeLefts

Gets an array of queue item size left in megabytes.

Accessibility : Read Only

Type: Array

QueueItemStatuses

Gets an array of queue item statuses.

Accessibility : Read Only

Type: Array

QueueItemTimeLefts

Gets an array of queue item time left.

Accessibility : Read Only

Type: Array

QueueLastUpdated

Gets the time of the last successful queue update.

Accessibility : Read Only

Type: DateTime

Speed

Gets the download speed in kilobytes per second.

Accessibility : Read Only

Type: Number

SpeedLimit

Gets or Sets the download speed limit in kilobytes per second. (0 = No Limit)

Accessibility : Read / Write

Type: Number

Status

Gets the status of SABnzbd.

Accessibility : Read Only

Type: String

UpdateAvailable

Gets an indication if a new version of SABnzbd is available.

Accessibility : Read Only

Type: Boolean

Uptime

Gets the amount of time SABnzbd has been running since last restart. From 00:00:00:00 to 00:00:59:00 value will update every minute, from 00:01:00:00 to 00:23:59:00 value will update very hour, and from 01:00:00:00 on the value will update every day.

Accessibility : Read Only

Type: unknown

Version

Gets the SABnzbd software version.

Accessibility : Read Only

Type: String

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

ClearDownloadQueue

Delete all downloads from the SABnzbd queue.

Syntax

void ClearDownloadQueue( )

Parameters

none

DeleteQueueItem ( String )

Delete the specified download from the SABnzbd queue. Current IDs can be found in the QueueItemIDs property.

Syntax

void DeleteQueueItem( String nzoID )

Parameters

nzoID : The ID of the NZB queue download.

Pause

Pause all SABnzbd downloads.

Syntax

void Pause( )

Parameters

none

QueueByFilePath ( String )

Queue a new item for download by file path. The user that the driver service runs as (usually SYSTEM) must have read access to the file.

Syntax

void QueueByFilePath( String filePath )

Parameters

filePath : The UNC or local (relative to SABnzbd server) path to a .nzb file.

QueueByNewzbinID ( String )

Queue a new item for download by Newzbin ID.

Syntax

void QueueByNewzbinID( String newzbinID )

Parameters

newzbinID : A Newzbin ID.

QueueByUrl ( String )

Queue a new item for download by URL.

Syntax

void QueueByUrl( String url )

Parameters

url : The URL of a .nzb file.

Resume

Resume all SABnzbd downloads.

Syntax

void Resume( )

Parameters

none

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.