Codecore Logo
Quick Search
»
Advanced Search »

Xantech MRC88 Driver

RSS
This driver supports control and monitoring of the Xantech MRC controllersin Single or expanded configuration. With passtrough for IR Command Macros. The serial interface on the Xantech is 9600 Baud, and if the driver is used for expanded mode (16 zones) then the Xantech should be initialized and cabled for operation in this mode.

Manufacturer: Xantech

Primary Communications Port: Serial

Table of Contents [Hide/Show]


Configuration Settings
Events
   Zone Power State Changed
   Zone Mute State Changed
   Zone Volume Level Changed
   Zone Bass Level Changed
   Zone Treble Level Changed
   Zone Balance Level Changed
   Zone Source Changed
   Zone Source Names Changed
   Ready State Changed
Instance Properties
   ZoneNames
   ZonePowerStates
   ZoneMuteStates
   ZoneVolumes
   ZoneBassLevels
   ZoneTrebleLevels
   ZoneBalanceLevels
   ZoneSources
   ZoneSourceNames
   SourceNames
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SendRawCommand ( String )
   SetZonePower ( Number, Boolean )
   TurnZoneOff ( Number )
   TurnZoneOn ( Number )
   ToggleZonePower ( Number )
   TurnAllZonesOff
   TurnAllZonesOn
   SetZoneMute ( Number, Boolean )
   MuteZone ( Number )
   UnmuteZone ( Number )
   ToggleZoneMute ( Number )
   MuteAllZones
   UnMuteAllZones
   SetZoneVolume ( Number, Number )
   IncrementZoneVolume ( Number )
   DecrementZoneVolume ( Number )
   SetZoneBass ( Number, Number )
   IncrementZoneBass ( Number )
   DecrementZoneBass ( Number )
   SetZoneTreble ( Number, Number )
   IncrementZoneTreble ( Number )
   DecrementZoneTreble ( Number )
   SetZoneBalance ( Number, Number )
   IncrementZoneBalance ( Number )
   DecrementZoneBalance ( Number )
   SetZoneSource ( Number, Number )
   CycleZoneSource ( Number )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Serial Port Name : The name of the serial port that the Xantech MRC88 is connected to. Ex. COM1
  • Matrix Configuration : The configuration mode of the matrix
  • Custom Zone Names : (optional) Enter the name of each Zone output from the Matrix.
  • Custom Source Names : (optional) Enter the name of each Source connected to the Matrix

Events

Zone Power State Changed

Occurs when the current power setting for the 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 Mute State Changed

Occurs when the current mute setting for the 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 Volume Level 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 Bass Level Changed

Occurs when the current bass setting for the matrix 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 Treble Level Changed

Occurs when the current treble setting for the matrix 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 Balance Level Changed

Occurs when the current balance setting for the matrix 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 Source Changed

Occurs when the current source setting for the 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 Source Names Changed

Occurs when the current source name setting for the 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.

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

ZonePowerStates

Gets or sets the current power setting for the zone. The setting is On/Off or True/False.

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets or sets the current mute setting for the zone. The setting is On/Off or True/False.

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

ZoneBassLevels

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

Accessibility : Read Only

Type: Array

ZoneTrebleLevels

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

Accessibility : Read Only

Type: Array

ZoneBalanceLevels

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

Accessibility : Read Only

Type: Array

ZoneSources

Gets or sets the current source setting for the zones.

Accessibility : Read Only

Type: Array

ZoneSourceNames

Gets the name of the current soruce setting for a zone

Accessibility : Read Only

Type: Array

SourceNames

Gets the name of all sources.

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

SendRawCommand ( String )

Send a raw command to the projector

Syntax

void SendRawCommand( String rawCommand )

Parameters

rawCommand : The command to send

SetZonePower ( Number, Boolean )

Change the Power Status for a Zone.

Syntax

void SetZonePower( Number zoneNumber, Boolean power )

Parameters

zoneNumber : The zone number.
power : Set the Power Status to ON or OFF

TurnZoneOff ( Number )

Turn Off the Power for a Zone.

Syntax

void TurnZoneOff( Number zoneNumber )

Parameters

zoneNumber : The zone number.

TurnZoneOn ( Number )

Turn On the Power for a Zone.

Syntax

void TurnZoneOn( Number zoneNumber )

Parameters

zoneNumber : The zone number.

ToggleZonePower ( Number )

Toggle the Power for a Zone.

Syntax

void ToggleZonePower( Number zoneNumber )

Parameters

zoneNumber : The zone number.

TurnAllZonesOff

Power Down all Zone.

Syntax

void TurnAllZonesOff( )

Parameters

none

TurnAllZonesOn

Power Up all Zone.

Syntax

void TurnAllZonesOn( )

Parameters

none

SetZoneMute ( Number, Boolean )

Change the Mute Status for a Zone.

Syntax

void SetZoneMute( Number zoneNumber, Boolean mute )

Parameters

zoneNumber : The zone number.
mute : Set the Mute Status to ON or OFF

MuteZone ( Number )

Turn On the Mute Status on a Zone.

Syntax

void MuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number.

UnmuteZone ( Number )

Turn Off the Mute Status on a Zone.

Syntax

void UnmuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number.

ToggleZoneMute ( Number )

Toggle the Mute Status for a Zone.

Syntax

void ToggleZoneMute( Number zoneNumber )

Parameters

zoneNumber : The zone number.

MuteAllZones

Enable Mute on all Zones.

Syntax

void MuteAllZones( )

Parameters

none

UnMuteAllZones

Disable Mute on all Zones.

Syntax

void UnMuteAllZones( )

Parameters

none

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, 100=Loudest)

IncrementZoneVolume ( Number )

Increment the Volume for a Zone.

Syntax

void IncrementZoneVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneVolume ( Number )

Decrement the Volume for a Zone.

Syntax

void DecrementZoneVolume( 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 : Volume (0=Quietest, 100=Loudest)

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=Quietest, 100=Loudest)

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=Quietest, 100=Loudest)

IncrementZoneBalance ( Number )

Increment the Balance for a Zone.

Syntax

void IncrementZoneBalance( Number zoneNumber )

Parameters

zoneNumber : The zone number.

DecrementZoneBalance ( Number )

Decrement the Balance for a Zone.

Syntax

void DecrementZoneBalance( Number zoneNumber )

Parameters

zoneNumber : The zone number.

SetZoneSource ( Number, Number )

Change the Source for a Zone.

Syntax

void SetZoneSource( Number zoneNumber, Number source )

Parameters

zoneNumber : The zone number.
source : Source Input (1 to 8)

CycleZoneSource ( Number )

Cycle the Input Source for a Zone.

Syntax

void CycleZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number.

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.