Codecore Logo
Quick Search
»
Advanced Search »

Russound Multiroom Controller

RSS
This driver supports control and monitoring of the Russound CAS, CAA, CAV, CAM controllers and tuners.

Manufacturer: Russound

Primary Communications Port: Serial

Table of Contents [Hide/Show]


Configuration Settings
Events
   All Zones Off Changed
   Connected Changed
   Zone Background Colors Changed
   Zone Current Background Colors Changed
   Zone Balance Level Changed
   Zone Bass Level Changed
   Zone Do Not Disturb State Changed
   Zone Loudness State Changed
   Zone Name Changed
   Zone Party Mode State Changed
   Zone Power State Changed
   Zone Source Changed
   Zone Source Name Changed
   Zone Shared State Changed
   Zone Text Message Changed
   Source Text Message Changed
   Zone Treble Level Changed
   Zone Volume Level Changed
   Zone Mute State Changed
   Tuner Power State Changed
   Tuner Song Title Changed
   Tuner Artist Changed
   Tuner Genre Changed
   Tuner Channel Number Changed
   Tuner Channel Name Changed
   Ready State Changed
   Keypad Button Pressed
   Display Feedback Received
   Tuner Message Received
Instance Properties
   FirmwareVersion
   AllZonesOff
   Connected
   ZoneBackgroundColors
   ZoneCurrentBackgroundColors
   ZoneBalanceLevels
   ZoneBassLevels
   ZoneDNDStates
   ZoneLoudnessStates
   ZoneNames
   ZonePartyModeStates
   ZonePowerStates
   ZoneSources
   ZoneSourceNames
   SourceNames
   RussoundSourceNames
   ZoneSharedStates
   ZoneTextMessages
   SourceTextMessages
   ZoneTrebleLevels
   ZoneVolumes
   ZoneMuteStates
   TunerPowerStates
   TunerSongTitle
   TunerArtist
   TunerGenre
   TunerChannelNumber
   TunerChannelName
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   GetAllZoneData
   GetZoneData ( Number )
   TurnAllZonesOff
   TurnAllZonesOn
   ToggleZonePower ( Number )
   SetZonePowerState ( Number, Boolean )
   TurnZoneOn ( Number )
   TurnZoneOff ( Number )
   DisplayAllMessage ( String, Number, Number )
   DisplaySourceMessage ( Number, String, Number, Number )
   DisplayZoneMessage ( Number, String, Number, Number )
   SetZoneVolume ( Number, Number )
   IncrementZoneVolume ( Number )
   DecrementZoneVolume ( Number )
   SetZoneSource ( Number, Number )
   CycleZoneSource ( Number )
   IncrementZoneSource ( Number )
   DecrementZoneSource ( Number )
   SetZoneBass ( Number, Number )
   IncrementZoneBass ( Number )
   DecrementZoneBass ( Number )
   SetZoneTreble ( Number, Number )
   IncrementZoneTreble ( Number )
   DecrementZoneTreble ( Number )
   SetZoneBalance ( Number, Number )
   IncrementZoneBalance ( Number )
   DecrementZoneBalance ( Number )
   SetZoneTurnOnVolume ( Number, Number )
   IncrementZoneTurnOnVolume ( Number )
   DecrementZoneTurnOnVolume ( Number )
   SetZoneBackgroundColor ( Number, Number )
   ToggleZoneBackgroundColor ( Number )
   SetZoneDoNotDisturb ( Number, Boolean )
   ToggleZoneDoNotDisturb ( Number )
   SetZoneLoudness ( Number, Boolean )
   ToggleZoneLoudness ( Number )
   SetZonePartyMode ( Number, Number )
   RefreshRussoundSourceNames
   MuteAllZones
   UnmuteAllZones
   ToggleZoneMute ( Number )
   SetZoneMuteState ( Number, Boolean )
   MuteZone ( Number )
   UnmuteZone ( Number )
   ToggleTunerPower ( Number )
   SetTunerPowerState ( Number, Boolean )
   IncrementTunerChannel ( Number )
   DecrementTunerChannel ( Number )
   SetTunerChannel ( Number, String )
   IncrementTunerPreset ( Number )
   DecrementTunerPreset ( Number )
   SetTunerPreset ( Number, Number, Number )
   TunerSavePreset ( Number, Number )
   IncrementTunerBank ( Number )
   DecrementTunerBank ( Number )
   SetTunerBank ( Number, Number )
   SetTunerMode ( Number, Number, Number, Number )
   TunerSeek ( Number )
   TunerScan ( Number )
   IncrementTunerCategory ( Number )
   DecrementTunerCategory ( Number )
   SetTunerCategory ( Number, String )
   IncrementTunerCategoryChannel ( Number )
   DecrementTunerCategoryChannel ( Number )
   SendSourceControlEvent ( Number, String )
   SendKeypadEvent ( Number, String )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Serial Port Name : The name of the serial port that the Russound is connected to. Ex. COM1
  • Poll Interval : (optional) The number of minutes between each full poll of the controller. The driver doesn't require polling to maintain the controller's status but is included as a backup. A value of '0' disabled the polling.
  • Controller Number : The Russound controller number this driver will control. Ex. 1
  • Custom Zone Names : (optional) Enter the name of each zone.

These names are used for convenience in the software and not stored in the Russound controller.
  • Custom Source Names : (optional) Enter the custom source names.

The Russound CAS, CAA, CAV and CAM controllers allow for a few user defined names for a source in addition to the predefined values. Of the 83 possible source names only the last 10 can be customized. Enter the custom names in the table below then configure the Russound controller to use the Custom Value name for the source.
  • Auto Populate Zone : A zone used by the driver at startup to populate the Source name information so it's complete after startup. Set to '0' to disable this feature.

The name assigned to each source in the Russound controller can't be determined by the driver at startup so the only way to populate this information is to step through all the sources. Setting this option to a zone number simply tells the driver to step through all the Sources as if someone were pressing the source button to step through the sources. This zone can be an unused zone if any are available.

Events

All Zones Off Changed

AllZonesOff

Whenever Filter:

none

EventArgs:

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

Connected Changed

Connected

Whenever Filter:

none

EventArgs:

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

Zone Background Colors Changed

Occurs when the Background Color for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Current Background Colors Changed

Occurs when the Background Color for a zone is changed due to a power state change.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Balance Level Changed

Occurs when the Balance Level for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Bass Level Changed

Occurs when the Bass Level for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Do Not Disturb State Changed

Occurs when the DND State for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Loudness State Changed

Occurs when the Loudness State for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Name Changed

Occurs when the Name for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Party Mode State Changed

Occurs when the Party Mode State for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Power State Changed

Occurs when the Power State for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Source Changed

Occurs when the Selected Source for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Source Name Changed

Occurs when the Selected Source for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Shared State Changed

Occurs when the Shared State for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Text Message Changed

Occurs when the a Text Message is displayed on a zone.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Source Text Message Changed

Occurs when the a text message is received from a zone.

Whenever Filter:

  • PropertyIndex : Set this to the source to watch for status changes.

EventArgs:

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

Zone Treble Level Changed

Occurs when the Treble Level for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Zone Volume Level Changed

Occurs when the Volume Level for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

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 Mute state for a zone is changed.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the zone to watch for status changes.

EventArgs:

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

Tuner Power State Changed

Occurs when the Power State for a tuner is changed.

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.

Tuner Song Title Changed

Occurs when the Song Title changes on a tuner.

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.

Tuner Artist Changed

Occurs when the Artist changes on a tuner.

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.

Tuner Genre Changed

Occurs when the Genre changes on a tuner.

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.

Tuner Channel Number Changed

Occurs when the channel number changes on a tuner.

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.

Tuner Channel Name Changed

Occurs when the channel name changes on a tuner.

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.

Keypad Button Pressed

Occurs when a button is pressed on a keypad.

Whenever Filter:

  • ZoneNumber : (optional) The zone number (port on back of controller) to which the keypads are connected.
  • ButtonName : (optional) The str of the button pressed.
  • KeypadNumber : (optional) The id number assigned to the keypad on which the button was pressed. This can usually be ignored.
  • SourceNumber : (optional) The number of the source the for which the button was pressed.

EventArgs:

  • String SourceName : The name associated with the source for which the button was pressed.
  • String ZoneName : The name associated with the zone.
  • Number KeypadNumber : The id number assigned to the keypad on which the button was pressed. This can usually be ignored.
  • Number ZoneNumber : The zone number (port on back of controller) to which the keypads are connected.
  • Number ButtonNumber : The id number of the button pressed.
  • String ButtonName : The str of the button pressed.
  • String SourceNumber : The number of the source the for which the button was pressed.

Display Feedback Received

Occurs when a message is sent from a Russound controller to a keypad for display.

Whenever Filter:

  • ZoneNumber : (optional) The zone number of the message.
  • SourceNumber : (optional) The source number of the message.

EventArgs:

  • String MessageText : The text of this message.
  • String ZoneName : The name associated with the zone.
  • Number SourceNumber : The source number.
  • Number DwellTime : The time in milliseconds the message should be displayed.
  • Number ZoneNumber : The zone number (port on back of controller) to which the keypads are connected.
  • String SourceName : The name associated with the source.
  • String MessageType :

Tuner Message Received

Occurs when a message is received from a Russound XM/Sirius tuner.

Whenever Filter:

  • TunerNumber : (optional) The tuner number.

EventArgs:

  • Number TunerNumber : The tuner number
  • String SongTitle : The title of the currently playing song.
  • String ChannelNumber : The currently selected channel number.
  • String Artist : The artist of the currently playing song.
  • String Genre : The genre of the currently playing song.
  • String ChannelName : The currently selected channel name.

Instance Properties

FirmwareVersion

Gets the firmware version.

Accessibility : Read Only

Type: String

AllZonesOff

Indicates if all the zones are powered off.

Accessibility : Read Only

Type: Boolean

Connected

Gets a value indicating if a connection is established with the Russound.

Accessibility : Read Only

Type: Boolean

ZoneBackgroundColors

An array containing the Background Color for each zone.

Accessibility : Read Only

Type: Array

ZoneCurrentBackgroundColors

An array containing the Current Background Color for each zone. The difference between this property and Zone Background Colors is that this updates when power is turned toggled so the touch screen can mimic a real controller.

Accessibility : Read Only

Type: Array

ZoneBalanceLevels

An array containing the Balance Level for each zone.

Accessibility : Read Only

Type: Array

ZoneBassLevels

An array containing the Bass Level for each zone.

Accessibility : Read Only

Type: Array

ZoneDNDStates

An array containing the DND State for each zone.

Accessibility : Read Only

Type: Array

ZoneLoudnessStates

An array containing the Loudness State for each zone.

Accessibility : Read Only

Type: Array

ZoneNames

An array containing the Name for each zone.

Accessibility : Read Only

Type: Array

ZonePartyModeStates

An array containing the Party Mode State for each zone.

Accessibility : Read Only

Type: Array

ZonePowerStates

An array containing the Power State for each zone.

Accessibility : Read Only

Type: Array

ZoneSources

An array containing the Selected Source for each zone.

Accessibility : Read Only

Type: Array

ZoneSourceNames

An array containing the Source name value for each zone. To automatically populate this property set the AutoPopulateZone driver property value.

Accessibility : Read Only

Type: Array

SourceNames

An array containing the Source name string value for each zone. To automatically populate this property set the AutoPopulateZone driver property value.

Accessibility : Read Only

Type: Array

RussoundSourceNames

An array containing the names available for assignment to a source in the russound controller. These values are assigned at system configuration and are displayed when a source is selected. Values 74-83 can be customized by modifying the Custom Source Names driver parameter.

Accessibility : Read Only

Type: Array

ZoneSharedStates

An array containing the Shared State for each zone.

Accessibility : Read Only

Type: Array

ZoneTextMessages

An array containing the last text message displayed for each zone.

Accessibility : Read Only

Type: Array

SourceTextMessages

An array containing the last text message received from a source, usually a Russound tuner. These messages are also sent to any zones currently set to this source.

Accessibility : Read Only

Type: Array

ZoneTrebleLevels

An array containing the Treble Level for each zone.

Accessibility : Read Only

Type: Array

ZoneVolumes

An array containing the Volume Level for each zone.

Accessibility : Read Only

Type: Array

ZoneMuteStates

An array containing the Mute state for each zone.

Accessibility : Read Only

Type: Array

TunerPowerStates

An array containing the Power State for each tuner.

Accessibility : Read Only

Type: Array

TunerSongTitle

An array containing the currently playing Song Title for each XM/Sirius tuner.

Accessibility : Read Only

Type: Array

TunerArtist

An array containing the currently playing Artist for each XM/Sirius tuner.

Accessibility : Read Only

Type: Array

TunerGenre

An array containing the currently playing Genre for each XM/Sirius tuner.

Accessibility : Read Only

Type: Array

TunerChannelNumber

An array containing the currently selected XM/Sirius Channel Number for each tuner.

Accessibility : Read Only

Type: Array

TunerChannelName

An array containing the currently selected XM/Sirius Channel Name for each tuner.

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

GetAllZoneData

Polls the Russound controller for state value of all the zones.

Syntax

void GetAllZoneData( )

Parameters

none

GetZoneData ( Number )

Polls the Russound controller for zone state value of a specific zone.

Syntax

void GetZoneData( Number zoneNumber )

Parameters

zoneNumber : The zone number.

TurnAllZonesOff

Turn all zones off.

Syntax

void TurnAllZonesOff( )

Parameters

none

TurnAllZonesOn

Turn all zones on.

Syntax

void TurnAllZonesOn( )

Parameters

none

ToggleZonePower ( Number )

Toggle the specified zone on and off. This is the same as pushing the PWR button on the DisplayPad.

Syntax

void ToggleZonePower( Number zoneNumber )

Parameters

zoneNumber : The zone number to get the value for.

SetZonePowerState ( Number, Boolean )

Turn the zone either off or on.

Syntax

void SetZonePowerState( Number zoneNumber, Boolean powerState )

Parameters

zoneNumber : The zone number to get the value for.
powerState : The power state.

TurnZoneOn ( Number )

Turn the specified zone on if it is not already on.

Syntax

void TurnZoneOn( Number zoneNumber )

Parameters

zoneNumber : The zone number to power on.

TurnZoneOff ( Number )

Turn the specified zone off if it is not already off.

Syntax

void TurnZoneOff( Number zoneNumber )

Parameters

zoneNumber : The zone number to power off.

DisplayAllMessage ( String, Number, Number )

Display a message on all keypads.

Syntax

void DisplayAllMessage( String message, Number alignment, Number dwellTime )

Parameters

message : The message to display. (12 characters maximum)
alignment : Centered or left aligned.

0 = Center
1 = Left

dwellTime : Time in 10ms Increases for the message to remain on the display. A value of '0' means continuous.

DisplaySourceMessage ( Number, String, Number, Number )

Display a message on the keypads of all zones listening to the specified source.

Syntax

void DisplaySourceMessage( Number sourceNumber, String message, Number alignment, Number dwellTime )

Parameters

sourceNumber : The source number to display the message for.
message : The message to display. (12 characters maximum)
alignment : Centered or left aligned.

0 = Center
1 = Left

dwellTime : Time in 10ms Increases for the message to remain on the display.

DisplayZoneMessage ( Number, String, Number, Number )

Display a message on the keypads of the specified zone.

Syntax

void DisplayZoneMessage( Number zoneNumber, String message, Number alignment, Number dwellTime )

Parameters

zoneNumber : The zone number.
message : The message to display. (12 characters maximum)
alignment : Centered or left aligned.

0 = Center
1 = Left

dwellTime : Time in 10ms Increases for the message to remain on the display.

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

Syntax

void SetZoneVolume( Number zoneNumber, Number volume )

Parameters

zoneNumber : The zone number.
volume : Volume (0=Quietest, 99=Loudest)

IncrementZoneVolume ( Number )

Increment the Volume for a Zone. This is the same as pushing the VOL+ button on the DisplayPad.

Syntax

void IncrementZoneVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneVolume ( Number )

Decrement the Volume for a Zone. This is the same as pushing the VOL- button on the DisplayPad.

Syntax

void DecrementZoneVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneSource ( Number, Number )

Sets the source for a zone.

Syntax

void SetZoneSource( Number zoneNumber, Number sourceNumber )

Parameters

zoneNumber : The zone number.
sourceNumber : The source number.

CycleZoneSource ( Number )

Cycles through each of the available sources for a zone. When the last source is reached, the next source is the first available source. This is basically the same as 'Increment Zone Source'.

Syntax

void CycleZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number.

IncrementZoneSource ( Number )

Selects the next source for a zone. When the last source is reached, the next source is the first source. This is basically the same as 'Cycle Zone Source'.

Syntax

void IncrementZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneSource ( Number )

Selects the previous source for a zone. When the first source is reached, the next source is the last source.

Syntax

void DecrementZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneBass ( Number, Number )

Change the Bass for a Zone.

Syntax

void SetZoneBass( Number zoneNumber, Number bass )

Parameters

zoneNumber : The zone number.
bass : Bass (0=Lowest, 20=Highest)

IncrementZoneBass ( Number )

Increment the Bass for a Zone.

Syntax

void IncrementZoneBass( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneBass ( Number )

Decrement the Bass for a Zone.

Syntax

void DecrementZoneBass( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneTreble ( Number, Number )

Change the Treble for a Zone.

Syntax

void SetZoneTreble( Number zoneNumber, Number treble )

Parameters

zoneNumber : The zone number.
treble : Treble (0=Lowest, 20=Highest)

IncrementZoneTreble ( Number )

Increment the Treble for a Zone.

Syntax

void IncrementZoneTreble( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneTreble ( Number )

Decrement the Treble for a Zone.

Syntax

void DecrementZoneTreble( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneBalance ( Number, Number )

Change the Balance for a Zone.

Syntax

void SetZoneBalance( Number zoneNumber, Number balance )

Parameters

zoneNumber : The zone number.
balance : Balance (0=Farthest Left, 20=Farthest Right)

IncrementZoneBalance ( Number )

Move the Balance to the Left for a Zone.

Syntax

void IncrementZoneBalance( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneBalance ( Number )

Move the Balance to the right for a Zone.

Syntax

void DecrementZoneBalance( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneTurnOnVolume ( Number, Number )

Change the Turn On Volume for a Zone.

Syntax

void SetZoneTurnOnVolume( Number zoneNumber, Number turnOnVolume )

Parameters

zoneNumber : The zone number.
turnOnVolume : Turn On Volume (0=Quietest, 99=Loudest)

IncrementZoneTurnOnVolume ( Number )

Increment the Turn On Volume for a Zone.

Syntax

void IncrementZoneTurnOnVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneTurnOnVolume ( Number )

Decrement the Turn On Volume for a Zone.

Syntax

void DecrementZoneTurnOnVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneBackgroundColor ( Number, Number )

Sets the zone keypad's Background Color to either Off, Amber, or Green

Syntax

void SetZoneBackgroundColor( Number zoneNumber, Number backgroundColor )

Parameters

zoneNumber : The zone number.
backgroundColor : Off, Green, or Amber.

0 = Off
1 = Amber
2 = Green

ToggleZoneBackgroundColor ( Number )

Toggle the Background Color for a Zone.

Syntax

void ToggleZoneBackgroundColor( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneDoNotDisturb ( Number, Boolean )

Sets the zone keypad's Do Not Disturb status

Syntax

void SetZoneDoNotDisturb( Number zoneNumber, Boolean doNotDisturb )

Parameters

zoneNumber : The zone number.
doNotDisturb : Off or On.

ToggleZoneDoNotDisturb ( Number )

Toggle the Do Not Disturb status for a Zone.

Syntax

void ToggleZoneDoNotDisturb( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneLoudness ( Number, Boolean )

Sets the zone keypad's Loudness status

Syntax

void SetZoneLoudness( Number zoneNumber, Boolean loudness )

Parameters

zoneNumber : The zone number.
loudness : Off or On.

ToggleZoneLoudness ( Number )

Toggle the Loudness status for a Zone between Off and On.

Syntax

void ToggleZoneLoudness( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZonePartyMode ( Number, Number )

Sets the zone keypad's Party Mode status

Syntax

void SetZonePartyMode( Number zoneNumber, Number partyMode )

Parameters

zoneNumber : The zone number.
partyMode : Off, On or Master.

0 = Off
2 = Master

RefreshRussoundSourceNames



Syntax

void RefreshRussoundSourceNames( )

Parameters

none

MuteAllZones

Turn the mute on for all zones.

Syntax

void MuteAllZones( )

Parameters

none

UnmuteAllZones

Turn the mute off for all zones.

Syntax

void UnmuteAllZones( )

Parameters

none

ToggleZoneMute ( Number )

Turns the mute on and off for a zone.

Syntax

void ToggleZoneMute( Number zoneNumber )

Parameters

zoneNumber : The zone number to toggle muting.

SetZoneMuteState ( Number, Boolean )

Turn the Mute either off or on.

Syntax

void SetZoneMuteState( Number zoneNumber, Boolean muteState )

Parameters

zoneNumber : The zone number to get the value for.
muteState : The Mute state.

MuteZone ( Number )

Turn the mute on for a zone.

Syntax

void MuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to mute.

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax

void UnmuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to unmute.

ToggleTunerPower ( Number )

Toggle the specified tuner on and off. This command is common to both tuners. If a Power command is sent to one tuner it will affect both tuners (The entire ST2 Chassis). There is no need to address the second tuner for these functions.

Syntax

void ToggleTunerPower( Number tunerNumber )

Parameters

tunerNumber : The tuner number to get the value for.

SetTunerPowerState ( Number, Boolean )

Turn the tuner either off or on. This command is common to both tuners. If a Power command is sent to one tuner it will affect both tuners (The entire ST2 Chassis). There is no need to address the second tuner for these functions.

Syntax

void SetTunerPowerState( Number tunerNumber, Boolean powerState )

Parameters

tunerNumber : The tuner number to get the value for.
powerState : The power state.

IncrementTunerChannel ( Number )

Increment the channel or frequency of the tuner.

Syntax

void IncrementTunerChannel( Number tuner )

Parameters

tuner : The source number for the tuner.

DecrementTunerChannel ( Number )

Decrement the channel or frequency of the tuner.

Syntax

void DecrementTunerChannel( Number tuner )

Parameters

tuner : The source number for the tuner.

SetTunerChannel ( Number, String )

Set the frequency or channel number of the tuner. When using frequencies for AM/FM tuners, the frequencies can be entered with a decimal point as in 107.9

Syntax

void SetTunerChannel( Number tuner, String channel )

Parameters

tuner : The source number for the tuner.
channel : The channel number or frequency. For AM/FM tuners include the decimal point in the frequency, i.e. 107.9.

IncrementTunerPreset ( Number )

Increment the tuner's currently selected preset number.

Syntax

void IncrementTunerPreset( Number tuner )

Parameters

tuner : The source number for the tuner.

DecrementTunerPreset ( Number )

Decrement the tuner's currently selected preset number.

Syntax

void DecrementTunerPreset( Number tuner )

Parameters

tuner : The source number for the tuner.

SetTunerPreset ( Number, Number, Number )

Set the tuner to a preset in a bank.

Syntax

void SetTunerPreset( Number tuner, Number bank, Number preset )

Parameters

tuner : The source number for the tuner.
bank : The bank number to select.
preset : The preset number to select.

TunerSavePreset ( Number, Number )

Save the current channel or frequency to a preset in the currently selected bank.

Syntax

void TunerSavePreset( Number tuner, Number preset )

Parameters

tuner : The source number for the tuner.
preset : The preset number of the currently selected bank.

IncrementTunerBank ( Number )

Increment the tuner's currently selected bank number.

Syntax

void IncrementTunerBank( Number tuner )

Parameters

tuner : The source number for the tuner.

DecrementTunerBank ( Number )

Decrement the tuner's currently selected bank number.

Syntax

void DecrementTunerBank( Number tuner )

Parameters

tuner : The source number for the tuner.

SetTunerBank ( Number, Number )

Set the tuner to a bank number.

Syntax

void SetTunerBank( Number tuner, Number bank )

Parameters

tuner : The source number for the tuner.
bank :

SetTunerMode ( Number, Number, Number, Number )

Set the AM/FM tuner settings. AM/FM Tuner only.

Syntax

void SetTunerMode( Number tuner, Number band, Number mode, Number audio )

Parameters

tuner : The source number for the tuner.
band : The tuner band (AM or FM).

1 = FM
2 = AM

mode : The tuner mode (Local or Distant).

1 = Local
2 = Distant

audio : The tuner audio mode (Stereo or Mono).

1 = Stereo
2 = Mono

TunerSeek ( Number )

Search for the next receivable frequency and stop. AM/FM Tuner only.

Syntax

void TunerSeek( Number tuner )

Parameters

tuner : The source number for the tuner.

TunerScan ( Number )

Search for the next receivable frequency, pause for a bit then continue searching. AM/FM Tuner only.

Syntax

void TunerScan( Number tuner )

Parameters

tuner : The source number for the tuner.

IncrementTunerCategory ( Number )

Increment the tuner's currently selected category number. XM/Sirius tuner only.

Syntax

void IncrementTunerCategory( Number tuner )

Parameters

tuner : The source number for the tuner.

DecrementTunerCategory ( Number )

Decrement the tuner's currently selected category number. XM/Sirius tuner only.

Syntax

void DecrementTunerCategory( Number tuner )

Parameters

tuner : The source number for the tuner.

SetTunerCategory ( Number, String )

Set the category of the tuner. XM/Sirius tuner only.

Syntax

void SetTunerCategory( Number tuner, String category )

Parameters

tuner : The source number for the tuner.
category : The category number.

IncrementTunerCategoryChannel ( Number )

Increment the tuner's currently selected category channel number. XM/Sirius tuner only.

Syntax

void IncrementTunerCategoryChannel( Number tuner )

Parameters

tuner : The source number for the tuner.

DecrementTunerCategoryChannel ( Number )

Decrement the tuner's currently selected category channel number. XM/Sirius tuner only.

Syntax

void DecrementTunerCategoryChannel( Number tuner )

Parameters

tuner : The source number for the tuner.

SendSourceControlEvent ( Number, String )

Sends the IR code associated with the selected event to control the zone's source device.

Syntax

void SendSourceControlEvent( Number zoneNumber, String eventName )

Parameters

zoneNumber : The zone number to get the value for.
eventName : The event to send.

SendKeypadEvent ( Number, String )

Emulates pressing a button on a keypad in a zone.

Syntax

void SendKeypadEvent( Number zoneNumber, String keyName )

Parameters

zoneNumber : The zone number to get the value for.
keyName : The name of the key to send.

SetPropertyForDuration ( String, TimeSpan, Object, Object )

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, Object, Object )

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.