WARNING - CONTENT NOW DEPRECATED

The content from this repository has been broken down into multiple smaller repositories, each focussed on one proxy. For the complete list, please see the main landing page for Driverworks

License, Copyright, and Trademark

The content contained in this repository is the intellectual property of Snap One, LLC, (formerly known as Wirepath Home Systems, LLC), and use without a valid license from Snap One is strictly prohibited. The user of this repository shall keep all content contained herein confidential and shall protect this content in whole or in part from disclosure to any and all third parties except as specifically authorized in writing by Snap One.

License and Intellectual Property Disclaimer

The content in this repository is provided in connection with Snap One products. No license, express or implied, by estoppal or otherwise, to any intellectual property rights is granted by this document or in this repository. Except as provided in Snap Oneʼs terms and conditions for the license of such products, Snap One and its affiliates assume no liability whatsoever and disclaim any express or implied warranty, relating to the sale and/or use of Snap One products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Snap One products are not intended for use in medical, lifesaving, or life sustaining applications.

Information regarding third-party products is provided solely for educational purposes. Snap One is not responsible for the performance or support of third-party products and does not make any representations or warranties whatsoever regarding the quality, reliability, functionality or compatibility of these products. The reader is advised that third parties can have intellectual property rights that can be relevant to this repository and the technologies discussed herein, and is advised to seek the advice of competent legal counsel regarding the intellectual property rights of third parties, without obligation of Snap One.

Snap One retains the right make changes to this repository or related product specifications and descriptions in this repository, at any time, without notice. Snap One makes no warranty for the use of this repository and assumes no responsibility for any errors that can appear in the repository nor does it make a commitment to update the content contained herein.

Copyright

Copyright 2023 Snap One, LLC. All rights reserved.

The above copyright notice applies to all content in this repository unless otherwise stated explicitly herein that a third-party’s copyright applies.

No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher.

Trademarks

Snap One and Snap One Logo, Control4 and the Control4 logo, and DriverWorks are trademarks or registered trademarks of Snap One, LLC. Other product and company names mentioned in this repository may be the trademarks or registered trademarks of their respective owners.

 Derivative Works

To the extent that you create any “Derivative Work” (meaning any work that is based upon one or more preexisting versions of the work provided to you in this repository, such as an enhancement or modification, revision, translation, abridgement, condensation, expansion, collection, compilation or any other form in which such preexisting works may be recast, modified, transformed or adapted, explicitly including without limitation, any updates or changes to Snap One, LLC’s software code or intellectual property) such Derivative Work shall be owned by Snap One, LLC and all right, title and interest in and to each such Derivative Work shall automatically vest in Snap One, LLC. To the extent any Derivative Work does not automatically vest in Snap One, LLC by operation of law, you hereby assign such Derivative Work to Snap One, LLC with full title guarantee. Snap One, LLC shall have no obligation to grant you any right in any such Derivative Work.

Contact Us

Snap One, LLC 11734 S. Election Road Salt Lake City, UT 84020 USA

http://www.control4.com

Introduction

WARNING - CONTENT NOW DEPRECATED

The content from this repository has been broken down into multiple smaller repositories, each focussed on one proxy. For the complete list, please see the main landing page for Driverworks

Proxies (Commands)

A proxy driver is an interface to the Control4 system for a set of devices that share common functionality. For instance, most DVD disc changers have common controls such as PLAY, STOP, PAUSE and FAST FORWARD.  The disc changer proxy allows for a common user interface to control all disc changers.  The Control4 system (Director) sends information to and receives information from the proxy drivers.  The proxy drivers send information to and receives information from the protocol drivers. Remember, your DriverWorks driver interacts with the proxy driver which then interacts with the system.  As a driver developer you will be relying on this proxy to provide status (notification) to the Control4 system for the device you are controlling.  You will also receive commands from the system that you will act on to control the device.  These commands and notifications are at the heart of what you will be implementing in your driver.  Essentially your driver is becoming the go-between from the Control4 system and your device with the proxy driver giving structure to the commands and notifications which you will be implementing. Your driver can facilitate communications with multiple types of proxies for a single device. As an example, a Security System driver will utilize both the Security proxy and the Contacts proxy. These additional proxies are configured in the <connections> section of the .c4z.

Protocol (Notifications)

Two similar devices may have the same functionality but utilize a very different command set.  A protocol driver provides the device-specific information needed to communicate with the Control4 system.  In the case of DriverWorks, the DriverWorks driver is the protocol driver.  When combined with the device-specific.c4Z file it provides the custom code necessary to implement the 2-way device driver. In the case of DriverWorks, the DriverWorks driver is the protocol driver. When combined with the device-specific.c4Z file it provides the custom code necessary to implement the 2-way device driver.

What’s New

What’s New in 3.4.2

AV Proxies

The following Proxy Commands have been enhanced in this release to include a new command parameters:

• CONNECT_OUTPUT
• DISCONNECT_OUTPUT
• SET_INPUT

The new command parameters is:

• PREV_DEV_LIST- This parameter returns an ordered array for all devices upstream in the AV path.

Non-AV Proxies

Fan Proxy

The Fan Proxy has been enhanced in this release to include a new capability: proxy_fan_speed_connections. This capability is applicable to newer fan drivers to create BUTTON_LINK connections dynamically in association with fan speeds.

Keypad Proxy

The Keypad Proxy has been enhanced in this release to include a new capability: clear_led_current_color_support. Enabling this capability allows the Keypad Proxy to clear a keypad’s button(s) color. Previously, this had to be done at the protocol level. In order to use this capability, two new Keypad Proxy commands have been delivered as well: KEYPAD_BUTTON_COLOR_CLEAR & KEYPAD_ALL_BUTTON_COLOR_CLEAR.

Light V2 Proxy

This Light V2 Proxy has been enhanced in this release with several new capabilities and a modification. These include:

The cold_start capability has been modified in this release to now be a Dynamic Capability. This enhancement has no impact on existing drivers currently using the cold_start capability. Beginning with O.S release 3.4.2, a driver can now dynamically change this capability if needed.

A new capability named disable_flash has been included to indicates whether the driver supports Flash behavior. This capability is useful with regard to Flash functionality being offered in the Advanced Lighting Scenes Composer Pro UI.

A new capability named multi_click has been included to disable multi-click events/actions for a light driver. This is useful when it is desirable to disable the ability to use press, release, single, double or triple click programming in Composer Pro.

Two new capabilities have been included to help support nesting of drivers in Composer Pro’s System Design tree. While this functionality is defined within the Light V2 Proxy, it is applicable to any Proxy and drivers that will benefit from a nested view in Composer Pro’s System Design.

The nesting_driver_is_parent capability indicates whether or not a driver is dependent on other, supporting drivers. These supporting drivers will appear nested under the parent driver. This capability must be used in conjunction with the new variable: VAR_C4_NESTING_PARENTS_CHILD_DEVICES. This variable includes a comma delimited list of ID values for the secondary (child) drivers(s) required by the parent driver. This list represents the drivers that will be nested under the parent driver in Composer Pro.

The nested_driver_is_child capability indicates whether or not this driver is a dependent driver required by primary driver for use. When used correctly, it will setup the dependent driver(s) to be nested under the primary driver in Composer Pro. This capability must be used in conjunction with the new variable: VAR_C4_NESTED_CHILDS_PARENT_DEVICE. This variable includes the ID of primary (parent) driver requiring its use. This is the associated driver with the nesting_driver_is_parent capability set to true.

What’s New in 3.4.1

There were no modifications to the Proxy and Protocol Guide in conjunction with O.S. Release 3.4.1.

What’s New in 3.4.0

Blind Proxy

A new capability has been added to the proxy called always_send_level. If value is true, then the SetTargetLevel commands are always sent regardless of current level values. This is useful if the blind device does not support two-way communication and is controlled outside of the Control4 operating system.

Camera Proxy

Beginning with O.S. 3.4.0, camera drivers have the ability to distribute audio to devices running Navigator. If a camera supports the proper CODEC and the camera microphone has been enabled in the appropriate interface a new audio button will appear at the bottom of the single-camera view. This will allow the user to hear live audio with the live video.

Generic Media Player Proxy

A new capability has been added to the proxy called allow_audio_pathing. This capability is applicable in the scenario where the AV Switch proxy is included as a secondary proxy to the Generic Media Player Proxy. It is useful when modeling streaming media devices that require minidrivers.

Light (v2) Proxy

The following color conversion functions have been modified in 3.4.0. The gamut parameter now receives a new valid string of: "custom”. See the links below for more information.

RGB functions: - ColorRGBtoXY - ColorXYtoRGB

HSV functions: - ColorHSVtoXY - ColorXYtoHSV

What’s New in 3.3.2

Camera Proxy

Support for Dynamic Camera Streams

Camera drivers can now implement a new dynamic streams API to provide a list of streams that the Navigators can pick from.

Light V2 Proxy

Capabilities that have been Added

A new feature has been delivered in O.S. 3.3.2 which allows dealers and customers to specify how a light's brightness behaves when the light is turned on. The functionality includes:

• Preset - Light turns on to a preset level.
• Previous - Light turns on to the previous light level.
• Default On - Provided for backwards compatibility and is the same as setting Preset to On.

Driver developers must opt-in to this new feature and which parts it wants to support via the following new capabilities:

brightness_on_mode_preset has been included to enable the brightness presets for "On Mode" behavior for a light.

brightness_on_mode_previous has been included to enable the Previous On "On Mode" brightness behavior for a light.

A new feature was created to allow dealers and customers to specify how a light's color behaves when a light is turned on. The functionality includes:

• Color Fade - Color behavior such as Dim to Warm
• Preset - Color changes to a preset.
• Previous - Color changes to the previous color value.
• Default On - Provided for backwards compatibility and is the same as setting Preset to On.

Driver developers must opt-in to this new feature and which parts it wants to support via the following new capabilities:

color_on_mode_fade has been included to enable the Fade On "On Mode" behavior, such as Dim to Warm, for a light.

color_on_mode_preset has been included to enable presets for use with "On Mode" behavior for a light.

color_on_mode_previous has been included to enable the Previous On "On Mode" behavior for a light.

Additionally, the following new capabilities have been included in 3.3.2:

A new capability: brightness_rate_max has been included in support of drivers without buttons. This capability allows these driver to no longer need to define click and hold maximum rates.

A new capability: brightness_rate_min has been included in support of drivers without buttons. This capability allows these driver to no longer need to define click and hold minimum rates.

A new capability: supports_brightness_stop has been included if a light brightness transition can be stopped during a ramp.

Capabilities that have been Deprecated

fixed_ramp_rate - Use click_rate_min and click_rate_max instead.

has_fixed_ramp_rate - Use click_rate_min and click_rate_max instead.

num_buttons

ramp_level

min_max

on_off

buttons_are_virtual

Commands that have been Added

Note: Enforcement of valid minimum and maximum values for many Light v2 commands are being enforced in conjunction with 3.3.2.

A new command: ADD_DRIVER_COLOR_PRESET has been included to add a new driver specific color preset.

A new command: DELETE_DRIVER_COLOR_PRESET has been added to remove a driver configured color preset.

A new command: DYNAMIC_OFF has been added to support UIs with an off command to pair with the DYNAMIC_ON command.

A new command: DYNAMIC_ON has been added to allows UI's and programming to "turn on" a light involving both brightness and color in a single command

A new command MODIFY_DRIVER_COLOR_PRESET has been included to change an existing driver color preset.

A new command SET_BRIGHTNESS_STOP has been added to stop a ramp if in progress.

A new command SET_COLOR_STOP has been added to stops a ramp of color if in progress.

A new command SET_BRIGHTNESS_ON_MODE has been added to maintain the On preset value.

A new command SET_BRIGHTNESS_RATE_DEFAULT has been added. This command is used in conjunction with generic On/Off commands to retrieve the UPDATE_BRIGHTNESS_RATE_DEFAULT value.

A new command SET_COLOR_ON_MODE has beed added define color on mode.

A new command SET_COLOR_RATE_DEFAULT has been added. This command is used in conjunction with generic On/Off commands to retrieve the UPDATE_COLOR_RATE_DEFAULT value.

A new command UPDATE_BRIGHTNESS_ON_MODE has been added to obtain how a light should turn on with regards to brightness.

A new command UPDATE_BRIGHTNESS_RATE_DEFAULT has been added to provide a default value when a rate change is not provided.

A new command UPDATE_BRIGHTNESS_PRESET has beeb added to send a command when a press is changed.

A new command UPDATE_COLOR_ON_MODE has been added to obtain how a light should turn on with regards to color.

A new command UPDATE_COLOR_PRESET has been added to manage On and Dim values across various brands and models of lights.

A new command UPDATE_COLOR_RATE_DEFAULT has been added. This command is used in conjunction with generic On/Off commands to update the color rate default value.

Commands that have been Modified

The SET_COLOR_TARGET command has been enhanced with new parameters to support hue, saturation and presets. Additionally, this command previously included a parameter of RATE. This parameter name has changed to LIGHT_COLOR_TARGET_RATE.

Commands that have been Deprecated

GET_LIGHT_LEVEL

GET_CONNECTED_STATE

GET_PROPERTIES

Conditionals that have been Added

IS_BRIGHTNESS

IS_BRIGHTNESS_TARGET

IS_COLOR_TARGET

Notifications that have been Modified

The LIGHT_BRIGHTNESS_CHANGING notify has been modified to include two new optional parameters: LIGHT_BRIGHTNESS_CURRENT_PRESET_ID and LIGHT_BRIGHTNESS_TARGET_PRESET_ID.

The LIGHT_COLOR_CHANGING notify has been modified to include parameters for Preset IDs. Additionally, this notify previously included a parameter of RATE. This parameter name has changed to LIGHT_COLOR_TARGET_RATE.

The LIGHT_COLOR_CHANGED notify has been modified to include a parameter for a Preset ID.

Variables that have been Added

Brightness Target Ramp Rate in Milliseconds

Brightness Target Rate Remaining in Milliseconds

Variables that have been Deprecated

PRESET_LEVEL has been deprecated as the brightness_on_mode_preset capability contains this value.

Known Issue(s)

Color Lighting Control may not Work on Some Drivers

Currently, there is a known problem with color control not working on drivers that are looking for a RATE parameter in the SET_COLOR_TARGET command. The RATE parameter was not correctly implemented due to the limits of support for color rate ramping in previous versions. We are finalizing the changes to make this fully work in 3.3.2. As a result, the “RATE” parameter name has been changed to “LIGHT_COLOR_TARGET_RATE”.

Button Link Binding for Brightness Stop Functionality not Working

A defect in 3.3.2 prevents keypad buttons bound to the Proxy’s BUTTON_LINK binding for Brightness Stop from working. This will be resolved in 3.3.3.

What’s New in 3.3.1

Light V2 Proxy

The capability: color_trace_tolerance has been modified to accept a Delta value of > .01. When provided, the CIELa*b* tolerance formula is used to determining if a color is the as another color in the system.

The following Conversion Commands have been enhanced to include an optional parameter: gamut. This parameter allows for the specification of a gamut type for use in the conversions.

• ColorHSVtoXY
• ColorXYtoHSV
• ColorRGBtoXY
• ColorXYtoRGB

Camera Proxy

The Camera Proxy documentation has been has enhanced to include new information regarding:

• Camera Streams
• Driver Support for Multiple Streams
• Support for Caching URLS
• Support for The Extras Interface Library

A new command: GET_STREAM_URLS has been added. It is used to obtain URLs for a camera that does not have a constant URL like a Cloud based camera or for cameras that have a wider range of features and configurable options that can produce better customer experiences using various client

A new notification: STREAM_URLS_READY has been added. This notify is used as a follow up to a GET_STREAM_URLS Synchronous call. This Notify will let a UI know that the URL information they requested is ready.

New capabilities added to the Camera proxy include:

• dynamic_urls_use_type
• requires_dynamic_stream_urls

Dynamic Presets are now supported within the Camera Proxy. The following preset functionality has been include:

• Save new presets.
• Change preset name.
• Recapture/update existing preset.
• Reorder presets.
• Delete a preset.

Dynamic Presets require the following new Capability:

• has_dynamic_presets

Dynamic Presets require the following new Notifications:

• DYNAMIC_URLS_CHANGED

Dynamic Presets require the following new Commands:

• SELECT_PRESET
• CHANGE_PRESET_NAME
• MODIFY_PRESET
• DELETE_PRESET
• CHANGE_PRESET_ORDER

The following existing Camera Proxy capabilities are now Dynamic Capabilities:

• has_pan
• has_tilt
• has_zoom
• has_home

What’s New in 3.3.0

Light Proxy Color Enhancements

This release of the 3.3.0 beta Proxy and Protocol Guide has been delivered to support the Light Proxy’s new color management functionality. This includes:

Light V2 Proxy Capabilities

color_correlated_temperature_max

color_correlated_temperature_min

color_rate_behavior

color_rate_max

color_rate_min

color_trace_tolerance

supports_color

supports_color_correlated_temperature

Light V2 Proxy Commands

SET_COLOR_TARGET

Light V2 Proxy Conversion Commands

This section lists the Commands used for converting to/from hue, saturation and lightness (HSV) and red, blue and green (RGB).

Light V2 Proxy Conditionals

IS_COLOR

Light v2 Protocol Notifications

LIGHT_COLOR_CHANGED

LIGHT_COLOR_CHANGING

Light V2 Proxy Events

light_color_changed

light_color_changing

Light V2 Proxy Extras

New supporting documentation.

Advanced Lighting Scene Agent 

New supporting documentation.

Light Driver Development Best Practices

A new section has been added to the Light V2 proxy content including best practice recommendations for light driver developers.

Audio Video Switch Display Adjustable Bindings

O.S. releases 3.3.0 provides the ability to hide AV Switch Bindings that are not being used. This feature has been provided to better manage the UI display within ComposerPro.

What’s New in 3.2.3

Audio Equalization available on Navigators

The Amplifier and AV Switch Proxies have been enhanced to support the ability to display audio EQ functions on devices running Navigator. The enhancement includes a set of new Proxy Commands, Notifications and Capabilities to support this functionality.

Dynamic Transport Controls on Navigators

Audio Video drivers now have the ability to define which transport controls are displayed on Navigators. This includes which buttons appear on the Button Bar as well as the Media Dashboard. This enhancement allows for the appropriate transport controls being displayed for each AV device.

What’s New in 3.2.2

There were no changes to this content for Operating System 3.2.2.

What’s New in 3.2.1

There were no changes to this content for Operating System 3.2.1.

What’s New in 3.2.0

Proxies that were Modified** 

Security Proxy The REQUEST_DEFAULT_USER_CODE partition notification was added as a mechanism for the protocol driver to initiate the communication to get that default user code upon driver update.

The following Security Protocol Notifications were deprecated from the SDK: ALARM, ALARM_CLEAR, AWAY, DISARM, HOME, TROUBLE. Please see the Security Panel Notification and Security Partition Notification areas for the latest list of Notifies.

What was New in 3.1.2

Proxies that were Deprecated** 

The following Proxies were deprecated from the Proxy and Protocol Guide:

• iPod
• Load Controller

What was New in 3.1.0

Proxies that were Modified** 

Light V2 Proxy light sample.c4i - A sample driver has been included to assist with better understanding the basic flow of commands from the Light Proxy as well as receiving protocol notifications. The driver can be found in the Samples directory under the root level of the DriverWorks SDK.zip file

Media Service Proxy Detail Screen Type - Information regarding the implementation of the Detail Type Screen has been added to the documentation.

What was New in O.S.3

Proxies that were Modified** 

KeyPad Proxy

New Button Linking functionality has been added to the Proxy. Button Linking supports the ability of a driver interacting with a second driver using Button State and Button LED State.

Light (V2) Proxy LightV2 Proxy has been significantly enhanced in this release. It is recommended that Light Driver writers thoroughly review the Proxy content in this release. The changes included not only impact drivers written against OS 3. Previously delivered Light Proxy elements have been modified or in some cases deprecated.

In OS 3, the proxy has been conceptually split into two components. The first being a Wall Control/Keypad portion and the second is a redesigned Light portion.The Light portion has been developed as a Bulb Library. The ultimate goal of the Bulb Library is to support ,more versatility for drivers to interrogate, group, control and manage individual drivers and bulbs. Bulb color, target level, minimum and maximum levels, cold start timing and other features are implemented in the Bulb Library. Dynamic Capabilities have also been added to the Light Portion. Note that all changes maintain backwards compatibility for driver side interaction. However, Navigators will have functionality deprecated due to performance reasons or improved ways of communicating with the driver.

Media Service Proxy Favoriting: In conjunction with the ability to "Favorite" Navigator UI screens in OS 3, drivers written using the Media Service Proxy can now provide the ability for end users to designate favorite media delivered through an Media Service Proxy driver such as Playlists, Albums, Tracks, Stations, Movies, TV Shows, etc.

DashboardChanged Event: The DashboardChanged event now includes content on the use of custom icons and actions.

Driver Notification Context Example: New code examples on have been added to the Media Service Proxy Driver Notification Prototype section in the Appendix.

 Best Practices A new section called Best Practices has been added to the Proxy and Protocol Guide. This section contains information regarding the use cases that fall outside of the typical Proxy/Protocol driver implementation. This release contains Best Practice content on the following:

Using the new Proxy-less command UPDATE PROPERTY. This is a non proxy-specific function that can be called from any device to change a property of any other device.

OS 3 Navigator UI and Volume Control - Managing Volume Commands in conjunction with the use of OS 3's new volume control slider on the Control4 UI.

Amplifier Protocol Notifications

AUDIO_PARAMETER _CHANGED

Audio parameter has changed

Name

AUDIO_PARAMETER_CHANGED ()

Returns

None

BALANCE_LEVEL_CHANGED

Selected balance level has changed.

Name

BALANCE_LEVEL_CHANGED ()

Returns

None

BASS_LEVEL_CHANGED

Selected bass level has changed

Name

BASS_LEVEL_CHANGED ()

Returns

None

INPUT_OUTPUT_CHANGED

Selected inputs & outputs have changed.

Name

INPUT_OUTPUT_CHANGED ()

Returns

None

LOUDNESS_CHANGED

Loudness state (On/Off) has changed.

Name

LOUDNESS_CHANGED ()

Returns

None

MUTE_CHANGED

MUTE state (On/Off) has changed.

Name

MUTE_CHANGED ()

Returns

None

OFF

Device has turned off.

Name

OFF ()

Parameter

None

Returns

None

ON

Device has turned on.

Name

ON ()

Parameter

None

Returns

None

TREBLE_LEVEL_CHANGED

Selected treble level has changed.

Name

TREBLE_LEVEL_CHANGED ()

Returns

None

VOLUME_LEVEL_CHANGED

Selected volume level has changed.

Name

VOLUME_LEVEL_CHANGED ()

Returns

None

Amplifier Proxy Capabilities

audio_consumer_count

Count of number of audio consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_consumer_count></audio_consumer_count>

Example

<capabilities>
   <audio_consumer_count>8</audio_consumer_count>
</capabilities>

audio_provider_count

Count of number of audio providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_provider_count></audio_provider_count>

Example

<capabilities>
   <audio_provider_count>8</audio_provider_count>
</capabilities>

can_downclass

Specifies if the device switch can down convert. For example: S-Video -> Composite

Signature

<can_downclass></can_downclass>

Example

<capabilities>
   <can_downclass>true</can_downclass>
</capabilities>

can_switch_separately

Device specific capability that must be set to True to in order for a device’s Composer Pro interface reflecting independent audio and video signal switching.

Signature

<can_switch_separately></can_switch_separately>

Usage Note

This capability is not related with the requires separate switching capability.  A setting of True or False will have no impact on requires separate switching.

Example

<capabilities>
   <can_switch_separately>true</can_switch_separately>
</capabilities>

can_upclass

Specifies if the device switch can up convert. For example: Composite -> S-Video

Signature

<can_upclass></can_upclass>

Example

<capabilities>
   <can_upclass>true</can_upclass>
</capabilities>

has_audio_signal_sense

Specifies device switching is capable of sensing audio on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_audio_signal_sense></has_audio_signal_sense>

Example

<capabilities>
   <has_audio_signal_sense>true</has_audio_signal_sense>
</capabilities>

has_discrete_balance_control

Capable of directly specifying a balance setting.

Signature

<has_discrete_balance_control></has_discrete_balance_control>

Example

<capabilities>
   <has_discrete_balance_control>true</has_discrete_balance_control>
</capabilities>

has_discrete_bass_control

Capable of directly specifying a bass setting.

Signature

<has_discrete_bass_control></has_discrete_bass_control>

Example

<capabilities>
   <has_discrete_bass_control>true</has_discrete_bass_control>
</capabilities>

has_discrete_loudness_control

Capable of directly specifying a loudness setting.

Signature

<has_discrete_loudness_control></has_discrete_loudness_control>

Example

<capabilities>
   <has_discrete_loudness_control>true</has_discrete_loudness_control>
</capabilities>

has_discrete_mute_control

Capable of directly specifying mute ON or OFF setting.

Signature

<has_discrete_ mute_control></has_discrete_ mute_control>

Example

<capabilities>
   <has_discrete_mute_control>true</has_discrete_mute_control>
</capabilities>

has_discrete_treble_control

Capable of directly specifying a treble setting.

Signature

<has_discrete_treble_control></has_discrete_treble_control>

Example

<capabilities>
   <has_discrete_treble_control>true</has_discrete_treble_control>
</capabilities>

has_discrete_volume_control

Capable of directly specifying a volume setting.

Signature

<has_discrete_volume_control></has_discrete_volume_control>

Example

<capabilities>
   <has_discrete_volume_control>true</has_discrete_volume_control>
</capabilities>

has_discrete_loudness_control

Capable of handling ON/OFF loudness control.

Signature

<has_discrete_loudness_control></has_discrete_loudness_control>

Example

<capabilities>
   <has_discrete_loudness_control>true</has_discrete_loudness_control>
</capabilities>

has_toggle_mute_control

Capable of handling ON/OFF mute control.

Signature

<has_toggle_mute_control></has_toggle_mute_control>

Example

<capabilities>
   <has_toggle_mute_control>true</has_toggle_mute_control>
</capabilities>

has_up_down_balance_control

Capable of directly specifying a balance setting.

Signature

<has_up_down_balance_control></has_up_down_balance_control>

Example

<capabilities>
   <has_up_down_balance_control>true</has_up_down_balance_control>
</capabilities>

has_up_down_bass_control

Capable of directly specifying a bass setting.

Signature

<has_up_down_bass_control></has_up_down_bass_control>

Example

<capabilities>
   <has_up_down_bass_control>true</has_up_down_bass_control>
</capabilities>

has_up_down_treble_control

Capable of directly specifying a treble setting.

Signature

<has_up_down_treble_control></has_up_down_treble_control>

Example

<capabilities>
   <has_up_down_treble_control>true</has_up_down_treble_control>
</capabilities>

has_up_down_volume_control

Has capability of handling volume UP and DOWN adjustments.

Signature

<has_up_down_volume_control></has_up_down_volume_control>

Example

<capabilities>
   <has_up_down_volume_control>true</has_up_down_volume_control>
</capabilities>

has_video_signal_sense

Specifies if the device switching is capable of sensing video on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_video_signal_sense></has_video_signal_sense>

Example

<capabilities>
   <has_video_signal_sense>true</has_video_signal_sense>
</capabilities>

requires_separate_switching

Device specific capability that when set to True notifies Director of the existence of individual audio and video paths. This capability has no impact on Composer Pro user interface. For that reason, when set to True it is recommended that the capability can switch separately be set to True as well.

Signature

<requires_separate_switching></requires_separate_switching>

Example

<capabilities>
   <requires_separate_switching>true</requires_separate_switching>
</capabilities>

video_consumer_count

Count of number of video consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<video_consumer_count></video_consumer_count>

Example

<capabilities>
   <video_consumer_count>8</video_consumer_count>
</capabilities>

video_provider_count

Count of number of video providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<video_provider_count></video_provider_count>

Example

<capabilities>
   <video_provider_count>8</video_provider_count>
</capabilities>

Amplifier Navigator EQ

Introduction

The ability to display audio equalization controls on devices running Navigator was added in conjunction with Operating System 3.2.3. Currently, the only Proxies that support Navigator EQ controls are the Amplifier and AV Switch Proxies.

The majority of the of the commands, notifications and capabilities defined here must be implemented in your driver to display EQ controls. Several commands are optional including SET_AUDIOMODE_BYPASS, SET_AUDIOMODE_EQ and SET_AUDIOMODE_TONECONTROL as these have been included to suspect legacy Audio Matrix Switches.

Note that this functionality is disabled by default. The HIDE EQ FROM NAVS CHANGED notification must be sent with a value of False to enable the EQ functionality in Navigator.

Navigator EQ Proxy Commands

LOUDNESS_OFF

Navigator EQ command called to set the loudness off for indicated output. The driver should notify proxy with the LOUDNESS_CHANGED notification of the new value.

Signature

LOUDNESS_OFF

Returns

None

LOUDNESS_ON

Navigator EQ command called to set the loudness on for indicated output. The driver should notify proxy with the LOUDNESS_CHANGED notification of the new value.

Signature

LOUDNESS_ON

Returns

None

SET_AUDIOMODE_BYPASS

Navigator EQ command called to change the output's mode to BYPASS. This is an optional command and should be used only if your device needs to switch modes.

Signature

SET_AUDIOMODE_BYPASS

Returns

None

SET_AUDIOMODE_EQ

Navigator EQ command called to change the output's mode to EQUALIZER. This is an optional command and should be used only if your device needs to switch modes.

Signature

SET_AUDIOMODE_EQ

Returns

None

SET_AUDIOMODE_TONECONTROL

Navigator EQ command called to change the output's mode to TONE_CONTROL. This is an optional command and should be used only if your device needs to switch modes.

Signature

SET_AUDIOMODE_TONECONTROL

Returns

None

SAVE_EQ_TO_CUSTOM_PRESET

Navigator EQ command called to save the current EQ values to a custom preset with a name. The driver should notify proxy with the EQ_NAMES_CHANGED notification with the updated name.

Signature

SAVE_EQ_TO_CUSTOM_PRESET

Returns

None

SET_BASS_LEVEL

Navigator EQ command called to set the bass level for tone control. The driver should notify proxy with the BASS_LEVEL_CHANGED notification of the new value.

Signature

SET_BASS_LEVEL

Returns

None

SET_EQPRESET

Navigator EQ command called to change the selected preset for an output.

Signature

SET_EQPRESET

Returns

None

SET_EQ_GAIN_VALUES

Navigator EQ command called to set the current equalizer’s gain values.

Signature

SET_EQ_GAIN_VALUES

Returns

None

SET_TREBLE_LEVEL

Navigator EQ command called to set the treble level for tone control. The driver should notify the proxy with TREBLE_LEVEL_CHANGED notification of the new value.

Signature

SET_TREBLE_LEVEL

Returns

None

Navigator EQ Protocol Notifications

AUDIOMODE_CHANGED

Navigator EQ notification that the output's audio mode has changed to either Tone Control or Equalizer for the output. This is an optional notification and should be used only if your device has audio modes.

Signature

AUDIOMODE_CHANGED

Returns

None

BALANCE_LEVEL_CHANGED

Navigator EQ notification that the balance has changed.

Signature

BALANCE_LEVEL_CHANGED

Returns

None

Example

-- Notify Balance level is set to 'Full Left' for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "BALANCE_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = 0 }, "NOTIFY")



-- Notify Balance level is set to 'Center' for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "BALANCE_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = 50 }, "NOTIFY")



-- Notify Balance level is set to 'Full Right' for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "BALANCE_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = 100 }, "NOTIFY")

BASS_LEVEL_CHANGED

Navigator EQ notification that the bass has changed.

Signature

BASS_LEVEL_CHANGED

Returns

None

Example

-- Notify Bass Level is at -6 for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "BASS_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = -6 }, "NOTIFY") 

-- Notify Bass Level is at +6 for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "BASS_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = 6 }, "NOTIFY")

EQ_DISPLAY_ORDER_CHANGED

Navigator EQ notification of the order that the names from EQ_NAMES_CHANGED should be presented to the user.

Signature

EQ_DISPLAY_ORDER_CHANGED

Returns

None

Example

C4:SendToProxy(5001, "EQ_DISPLAY_ORDER_CHANGED", {​​​​​​​ [1] = 1, [2] = 2, [3] = 3, [4] = 4, [5] = 5, OUTPUT = "4002" }​​​​​​​, "NOTIFY")

C4:SendToProxy(5001, "EQ_DISPLAY_ORDER_CHANGED", {​​​​​​​ 1, 2, 3, 4, 5, OUTPUT = "4002" }​​​​​​​, "NOTIFY")

EQ_NAMES_CHANGED

Navigator EQ notification of the current names for the equalizer presets.

Signature

EQ_NAMES_CHANGED

Returns

None

Example

C4:SendToProxy(5001, "EQ_NAMES_CHANGED", { [1] = "FLAT", [2] = "CLASSICAL", [3] = "JAZZ", [4] = "POP", [5] = "ROCK", OUTPUT = "4002" }, "NOTIFY")

C4:SendToProxy(5001, "EQ_NAMES_CHANGED", {"FLAT", "CLASSICAL", "JAZZ", "POP", "ROCK", OUTPUT = 4002}, "NOTIFY")

EQ_FREQS_CHANGED

Navigator EQ notification that the frequencies of a equalizer have been modified.

Signature

EQFREQS_CHANGED

Returns

None

Example

-- Notify Gains and Frequencies for EQ Bands for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "EQGAINS_CHANGED", { OUTPUT = "4002", VALUES = "7.5,3.8,5.4,4.59,7.8,7.4" }, "NOTIFY")_

C4:SendToProxy(5001, "EQFREQS_CHANGED", { OUTPUT = "4002", VALUES = "33,125,750,3000,8000,16000" }, "NOTIFY")

EQ_GAINS_CHANGED

Navigator EQ notification that the gains of an equalizer have been modified.

Signature

EQGAINS_CHANGED

Returns

None

Example

-- Notify Gains and Frequencies for EQ Bands for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "EQGAINS_CHANGED", { OUTPUT = "4002", VALUES = "7.5,3.8,5.4,4.59,7.8,7.4" }, "NOTIFY")_

C4:SendToProxy(5001, "EQFREQS_CHANGED", { OUTPUT = "4002", VALUES = "33,125,750,3000,8000,16000" }, "NOTIFY")

EQ_PRESET_CHANGED

Navigator EQ notification used when a different preset is selected for an output. Should be called after SET_EQPRESET is sent or if the preset is changed from a different event.

Signature

EQPRESET_CHANGED

Returns

None

Example

-- Notify change of current EQ Preset for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "EQPRESET_CHANGED", { OUTPUT = "4002", EQPRESET = 2 }, "NOTIFY")

HIDE_EQ_FROM_NAVS _CHANGED

Navigator EQ notification that the equalizer should be shown or hidden from Navigator. This must be sent with a value of False to enable the EQ functionality in Navigator.

Signature

HIDEEQFROMNAVS_CHANGED

Returns

None

Example

-- Notify Hide (or show) Navigator EQ for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "HIDEEQFROMNAVS_CHANGED", { OUTPUT = "4002", ENABLED = false }, "NOTIFY")

LOUDNESS_CHANGED

Navigator EQ notification that the loudness has changed.

Signature

LOUDNESS_CHANGED

Returns

None

TREBLE_LEVEL_CHANGED

Navigator EQ notification that the treble level has changed.

Signature

TREBLE_LEVEL_CHANGED

Returns

None

Example

-- Notify Treble Level is at -6 for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "TREBLE_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = -6 }, "NOTIFY")


-- Notify Treble Level is at +6 for Output 3 (Binding ID 4002)
C4:SendToProxy(5001, "TREBLE_LEVEL_CHANGED", { OUTPUT = "4002", LEVEL = 6 }, "NOTIFY")

Navigator EQ Capabilities

<has_eq_preset_control></has_eq_preset_control>: Boolean capability where True indicates this device supports the navigator equalizer interface and should allow navigators to interact with equalizers.

<eq_preset_nav_count></eq_preset_nav_count>: Capability that requires a count (integer) of the number of presets to be presented to the Navigators.

<eq_band_nav_count></<eq_band_nav_count>: Capability that requires a count (integer) of the number of adjustable bands for equalizer control.

<use_tone_max_value></use_tone_max_value>: Capability that requires the max value (integer) for tone controls.

<use_tone_min_value></use_tone_min_value>: Capability that requires the minimum value (integer) for tone controls.

Audio Output Bindings and Proxy Events

Note: Audio Output binding ID values defined in drivers written in conjunction with this Proxy must start with a binding value of 4000. The acceptable range for Audio Outputs is 4000 - 4999. However, if the first output binding ID value is not 4000, issues with Proxy Events firing correctly can be encountered.

For a list of valid Binding ID values please see the Connections section of the DriverWorks Fundamentals Guide.

Amplifier Proxy Commands

BACK

Pulse Back button

Name

BACK ()

Parameters

None

Returns

None

BINDING_CHANGE_ACTION

Command sent when a bound binding changes. Performs any actions needed to the protocol.

Name

BINDING_CHANGE_ACTION ()

Returns

None

CANCEL

Pulse Cancel button

Name

CANCEL ()

Parameters

None

Returns

None

DASH

Pulses the ‘-’ button.

Name

DASH ()

Parameter

None

Returns

None

DISCONNECT_ OUTPUT

Disconnect (turn off) selected output on device

Name

DISCONNECT_OUTPUT ()

Returns

None

EMIT_CODE

Emit IR/Serial code. This is used by the AVGen IR/Serial Proxy.

Name

EMIT_CODE ()

Returns

None

EMIT_MACRO

Emit IR/Serial code macro (used by AVGen IR/Serial Proxy)

Name

EMIT_MACRO ()

Returns

None

GET_AUDIO_INPUTS

Command sent to the protocol during the proxy initialization. Returns available audio inputs from the protocol device.

Name

GET_AUDIO_INPUTS ()

Parameters

None

Returns

None

HYPHEN

Pulse ‘-’ button

Name

HYPHEN ()

Parameters

None

Returns

None

INFO

Pulse Info button

Name

INFO ()

Parameters

None

Returns

None

LOUDNESS_OFF

Turn loudness off.

Name

LOUDNESS_OFF ()

Returns

None

LOUDNESS_ON

Turn loudness on.

Name

LOUDNESS_ON ()

Returns

None

LOUDNESS_TOGGLE

Toggle loudness on/off.

Name

LOUDNESS_TOGGLE ()

Returns

None

MUTE_OFF

Turning muting off.

Name

MUTE_OFF ()

Returns

None

MUTE_ON

Turn muting on.

Name

MUTE_ON ()

Returns

None

MUTE_TOGGLE

Toggle muting on/off.

Name

MUTE_TOGGLE ()

Returns

None

NUMBER_0

Pulse ‘0’ button

Name

Number_0 ()

Parameters

None

Returns

None

NUMBER_1

Pulse ‘1’ button

Name

Number_1 ()

Parameters

None

Returns

None

NUMBER_2

Pulse ‘2’ button

Name

Number_2 ()

Parameters

None

Returns

None

NUMBER_3

Pulse ‘3’ button

Name

Number_3 ()

Parameters

None

Returns

None

NUMBER_4

Pulse ‘4’ button

Name

Number_4 ()

Parameters

None

Returns

None

NUMBER_5

Pulse ‘5’ button

Name

Number_5 ()

Parameters

None

Returns

None

NUMBER_6

Pulse ‘6’ button

Name

Number_6 ()

Parameters

None

Returns

None

NUMBER_7

Pulse ‘7’ button

Name

Number_7 ()

Parameters

None

Returns

None

NUMBER_8

Pulse ‘8’ button

Name

Number_8 ()

Parameters

None

Returns

None

NUMBER_9

Pulse ‘9’ button

Name

Number_9 ()

Parameters

None

Returns

None

OFF

Turn device Off.

Name

OFF ()

Parameters

None

Returns

None

Usage Note

The ON and OFF proxy commands have the ability to send proxy notifications to display a device power state in Composer and Navigator Devices only. Any desired commands or notifications based off the device ON/OFF state must be handled by your DriverWorks driver.

ON

Turn device On.

Name

ON ()

Parameters

None

Returns

None

Usage Note

The ON and OFF proxy commands have the ability to send proxy notifications to display a device power state in Composer and Navigator Devices only. Any desired commands or notifications based off the device ON/OFF state must be handled by your DriverWorks driver.

POUND

Pulse ‘#’ button

Name

POUND ()

Parameters

None

Returns

None

PULSE_BALANCE_DOWN

Pulse balance down (Left)

Name

PULSE_BALNCE_DOWN ()

Returns

None

PULSE_BALANCE_UP

Pulse balance up (Right)

Name

PULSE_BALNCE_UP ()

Returns

None

PULSE_BASS_DOWN

Pulse bass down (Left)

Name

PULSE_BASS_DOWN ()

Returns

None

PULSE_BASS_UP

Pulse bass up (Right)

Name

PULSE_BASS_UP ()

Returns

None

PULSE_INPUT

Toggle (cycle through) input selection on device.

Name

PULSE_INPUT

Parameters

None

Returns

None

PULSE_SUR_UP

Toggle (cycle through) surround mode presets on device.

Name

PULSE_SUR_UP

Returns

None

PULSE_VOL_DOWN

Pulse volume level down.

Name

PULSE_VOL_DOWN

Returns

None

PULSE_VOL_ UP

Pulse volume level up.

Name

PULSE_VOL_UP

Returns

None

PULSE_TREBLE_ DOWN

Pulse treble down.

Name

PULSE_TREBLE_DOWN ()

Returns

None

PULSE_TREBLE_UP

Pulse treble up.

Name

PULSE_TREBLE_UP ()

Returns

None

RECALL

Pulse Recall button

Name

RECALL ()

Parameters

None

Returns

None

STAR

Pulse * button

Name

STAR ()

Parameters

None

Returns

None

START_BALANCE_DOWN

Start ramping balance down (left).

Name

START_BALANCE_DOWN ()

Returns

None

START_BASS_DOWN

Start ramping bass down.

Name

START_BASS_DOWN ()

Returns

None

START_BASS_UP

Start ramping bass up.

Name

START_BASS_UP ()

Returns

None

START_TREBLE_DOWN

Start ramping treble down.

Name

START_TREBLE_DOWN ()

Returns

None

START_TREBLE_UP

Start ramping treble up.

Name

START_TREBLE_UP ()

Returns

None

START_VOL_DOWN

Start ramping volume down.

Name

START_VOL_DOWN ()

Returns

None

START_VOL_UP

Start ramping volume up.

Name

START_VOL_UP ()

Returns

None

SET_ALL_EQ_SETTINGS

Set balance to a specified position.

Name

SET_ALL_EQ_SETTINGS ()

Returns

None

SET_BALANCE

Set balance to a specified position.

Name

SET_BALANCE ()

Returns

None

SET_BALANCE_UP

Set balance to a specified position.

Name

SET_BALANCE_UP ()

Returns

None

SET_BASS_LEVEL

Set bass to a specified level.

Name

SET_BASS_LEVEL

Returns

None

SET_DIGI_OFF

Used with the v.3 amp to turn digital inputs off.

Name

SET_DIGI_OFF ()

Parameters

None

Returns

None

SET_DIGI_ON

Used with the v.3 amp to turn digital inputs on.

Name

SET_DIGI_ON ()

Parameters

None

Returns

None

SET_INPUT

Specify input selection of device.

Name

SET_INPUT ()

Returns

None

Usage Note

• Control Bindings = 1 -> 999
• Video Inputs = 1000 -> 1099
• Video Outputs = 2000 -> 2999
• Audio Inputs = 3000 -> 3099
• Audio Outputs = 4000 -> 4999
• Proxy Bindings = 5000 -> 5999
• Network Bindings = 6000 -> 6999
• Room Bindings = 7000 -> 7999
• Power Manager = 8000 -> 8999

SET_LOUDNESS

Turn loudness on.

Name

SET_LOUDNESS ()

Returns

None

SET_MAX_VOLUME

Set maximum allowable volume level

Name

SET_MAX_VOLUME ()

Returns

None

SET_OUTPUT_INPUT

Specify input and output selection of device.

Name

SET_OUTPUT_INPUT ()

Returns

None

SET_SURROUND_MODE

Select specified surround mode preset on device.

Name

SET_SURROUND_MODE ()

Returns

None

SET_TREBLE_LEVEL

Set treble to a specified level.

Name

SET_TREBLE_LEVEL ()

Returns

None

SET_ UP_DOWN_SWAP

Swap page UP/DOWN buttons (used by AVGen)

Name

SET_UP_DOWN_SWAP ()

Returns

None

STOP_VOL_DOWN

Stop ramping volume down.

Name

SET_VOL_DOWN ()

Returns

None

SET_VOLUME_LEVEL

Set volume to a specified level.

Name

SET_VOLUME_LEVEL () 

Returns

None

STOP_BALANCE_DOWN

Start ramping balance.

Name

STOP_BALANCE_DOWN ()

Returns

None

STOP_BASS_DOWN

Stop ramping bass

Name

STOP_BALANCE_UP ()

Returns

None

STOP_BASS_DOWN

Stop ramping bass down.

Name

STOP_BASS_DOWN ()

Returns

None

STOP_BASS_UP

Stop ramping bass up

Name

STOP_BASS_UP ()

Returns

None

STOP_TREBLE_DOWN

Stop ramping the treble down

Name

STOP_TREBLE_DOWN ()

Returns

None

STOP_TREBLE_UP

Stop ramping the treble up.

Name

STOP_TREBLE_UP ()

Returns

None

STOP_VOL_DOWN

Stop ramping the volume down.

Name

STOP_VOL_DOWN ()

Returns

None

STOP_VOL_UP

Stop ramping the volume up.

Name

STOP_VOL_UP ()

Returns

None

Audio Switch Proxy Commands

BACK

Pulse Back button

Name

BACK ()

Parameters

None

Returns

None

CANCEL

Pulse Cancel button

Name

CANCEL ()

Parameters

None

Returns

None

DASH

Pulses the ‘-’ button.

Name

DASH ()

Parameter

None

Returns

None

DISCONNECT_OUTPUT

Disconnect (turn off) selected output on device

Name

DISCONNECT_OUTPUT ()

Returns

None

SET_LOUDNESS

Turn loudness on.

Name

SET_LOUDNESS ()

Returns

None

Audio Video Switch Capabilities

audio_consumer_count

Count of number of audio consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_consumer_count></audio_consumer_count>

Example

<capabilities>
   <audio_consumer_count>8</audio_consumer_count>
</capabilities>

audio_provider_count

Count of number of audio providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_provider_count></audio_provider_count>

Example

<capabilities>
   <audio_provider_count>8</audio_provider_count>
</capabilities>

can_ downclass

Specifies if the A/V switch can down convert. For example: S-Video -> Composite

Signature

<can_downclass></can_downclass>

Example

<capabilities>
   <can_downclass>true</can_downclass>
</capabilities>

can_switch_separately

Device specific capability that must be set to True to in order for an AV Switch’s Composer Pro interface reflecting independent audio and video signal switching.

Signature

<can_switch_separately></can_switch_separately>

Usage Note

This capability is not related with the requires separate switching capability.  A setting of True or False will have no impact on requires separate switching.

Example

<capabilities>
   <can_switch_separately>true</can_switch_separately>
</capabilities>

can_upclass

Specifies if the A/V switch can up convert. For example: Composite -> S-Video

Signature

<can_upclass></can_upclass>

Example

<capabilities>
   <can_upclass>true</can_upclass>
</capabilities>

has_audio_signal_sense

Specifies AV switching is capable of sensing audio on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_audio_signal_sense></has_audio_signal_sense>

Example

<capabilities>
   <has_audio_signal_sense>true</has_audio_signal_sense>
</capabilities>

has_ discrete_balance_control

Capable of directly specifying a balance setting.

Signature

<has_discrete_balance_control></has_discrete_balance_control>

Example

<capabilities>
   <has_discrete_balance_control>true</has_discrete_balance_control>
</capabilities>

has_discrete_bass_control

Capable of directly specifying a bass setting.

Signature

<has_discrete_bass_control></has_discrete_bass_control>

Example

<capabilities>
   <has_discrete_bass_control>true</has_discrete_bass_control>
</capabilities>

has_discrete_loudness_control

Capable of directly specifying a loudness setting.

Signature

<has_discrete_loudness_control></has_discrete_loudness_control>

Example

<capabilities>
   <has_discrete_loudness_control>true</has_discrete_loudness_control>
</capabilities>

has_discrete_mute_control

Capable of directly specifying mute ON or OFF setting.

Signature

<has_discrete_ mute_control></has_discrete_ mute_control>

Example

<capabilities>
   <has_discrete_mute_control>true</has_discrete_mute_control>
</capabilities>

has_discrete_treble_control

Capable of directly specifying a treble setting.

Signature

<has_discrete_treble_control></has_discrete_treble_control>

Example

<capabilities>
   <has_discrete_treble_control>true</has_discrete_treble_control>
</capabilities>

has_discrete_volume_control

Capable of directly specifying a volume setting.

Signature

<has_discrete_volume_control></has_discrete_volume_control>

Example

<capabilities>
   <has_discrete_volume_control>true</has_discrete_volume_control>
</capabilities>

has_discrete_loudness_control

Capable of handling ON/OFF loudness control.

Signature

<has_discrete_loudness_control></has_discrete_loudness_control>

Example

<capabilities>
   <has_discrete_loudness_control>true</has_discrete_loudness_control>
</capabilities>

has_toggle_mute_control

Capable of handling ON/OFF mute control.

Signature

<has_toggle_mute_control></has_toggle_mute_control>

Example

<capabilities>
   <has_toggle_mute_control>true</has_toggle_mute_control>
</capabilities>

has_up_down_balance_control

Capable of directly specifying a balance setting.

Signature

<has_up_down_balance_control></has_up_down_balance_control>

Example

<capabilities>
   <has_up_down_balance_control>true</has_up_down_balance_control>
</capabilities>

has_up_down_bass_control

Capable of directly specifying a bass setting.

Signature

<has_up_down_bass_control></has_up_down_bass_control>

Example

<capabilities>
   <has_up_down_bass_control>true</has_up_down_bass_control>
</capabilities>

has_up_down_treble_control

Capable of directly specifying a treble setting.

Signature

<has_up_down_treble_control></has_up_down_treble_control>

Example

<capabilities>
   <has_up_down_treble_control>true</has_up_down_treble_control>
</capabilities>

has_up_down_volume_control

Has capability of handling volume UP and DOWN adjustments.

Signature

<has_up_down_volume_control></has_up_down_volume_control>

Example

<capabilities>
   <has_up_down_volume_control>true</has_up_down_volume_control>
</capabilities>

has_video_signal_sense

Specifies AV switching is capable of sensing video on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_video_signal_sense></has_video_signal_sense>

Example

<capabilities>
   <has_video_signal_sense>true</has_video_signal_sense>
</capabilities>

requires_ separate_switching

Device specific capability that when set to True notifies Director of the existence of individual audio and video paths. This capability has no impact on Composer Pro user interface. For that reason, when set to True it is recommended that the capability can switch separately be set to True as well.

Signature

<requires_separate_switching></requires_separate_switching>

Example

<capabilities>
   <requires_separate_switching>true</requires_separate_switching>
</capabilities>

video_consumer_count

Count of number of video consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<video_consumer_count></video_consumer_count>

Example

<capabilities>
   <video_consumer_count>8</video_consumer_count>
</capabilities>

video_provider_count

Count of number of video providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<video_provider_count></video_provider_count>

Example

<capabilities>
   <video_provider_count>8</video_provider_count>
</capabilities>

Audio Video Switch Protocol Notifications

AUDIO_PARAMETER_CHANGED

Audio parameter has changed

Name

AUDIO_PARAMETER_CHANGED ()

Returns

None

BALANCE_LEVEL_CHANGED

Selected balance level has changed.

Name

BALANCE_LEVEL_CHANGED ()

Returns

None

BASS_LEVEL_CHANGED

Selected bass level has changed

Name

BASS_LEVEL_CHANGED ()

Returns

None

INPUT_OUTPUT_CHANGED

Selected inputs & outputs have changed.

Name

INPUT_OUTPUT_CHANGED ()

Returns

None

LOUDNESS_CHANGED

Loudness state (On/Off) has changed.

Name

LOUDNESS_CHANGED ()

Returns

None

MUTE_CHANGED

MUTE state (On/Off) has changed.

Name

MUTE_CHANGED ()

Returns

None

OFF

Device has turned off.

Name

OFF ()

Parameter