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

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

Proxies (Commands)

This documentation includes content that details the functions that make up the Disc Changer Proxy which is supported in the DriverWorks Software Development Kit.

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

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.4.2.

What’s New in 3.4.1

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.4.1.

What’s New in 3.4.0

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.4.0.

What’s New in 3.3.2

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.3.2.

What’s New in 3.3.1

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.3.1.

What’s New in 3.3.0

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.3.0.

What’s New in 3.2.3

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.2.3.

What’s New in 3.2.2

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.2.2.

What’s New in 3.2.1

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.2.1.

What’s New in 3.2.0

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.2.0.

What was New in 3.1.2

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.1.2.

What was New in 3.1.0

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.1.0.

What was New in O.S.3

There were no modifications to the Disc Changer Proxy in conjunction with O.S. Release 3.0.0.

Disc Changer Capabilities

can_play_cd

Disc Changer is capable of playing CD audio formats.

Signature

<can_play_cd></can_play_cd>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <can_play_cd>true</can_play_cd>
</capabilities>

can_scan_media

Disc Changer is capable of scanning media and returning disc information via the driver.

Signature

<can_scan_media></can_scan_media>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <can_scan_media>true</can_scan_media>
</capabilities>

has_discreet_disc_button

Capable of seeking directly to a specified disc.

Signature

<has_discrete_disc_button></has_discrete_disc_button>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <has_discreet_disc_button>true</has_discreet_disc_button>
</capabilities>

has_discreet_disc_access

Capable of seeking directly to a specified disc (and specified track on that disc).

Signature

<has_discrete_disc_access></has_discrete_disc_access>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <has_discreet_disc_access>true</has_discreet_disc_access>
</capabilities>

has_discreet_input_selection

Capable of directly selecting specified input.

Signature

<has_discrete_input_selection></has_discrete_input_selection>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <has_discreet_disc_button>true</has_discreet_disc_button>
</capabilities>

media_count

Number of discs available within the changer.

Signature

<media_count></media_count>

Parameter	Description
int	nMediaCount

Returns

None

Example

<capabilities>
   <media_count>true</media_count>
</capabilities>

media_type

Media that the device is capable of playing. Bitmask of:

CD = 0X01
Audio Files (mp3) = 0X2
Video = 0X4
Broadcast = 0X8

Signature

<media_type></media_type>

Parameter	Description
int	nMediaTypeBitmask

Returns

None

Example

<capabilities>
   <media_type>true</media_type>
</capabilities>

selection_delay

Delay time in milliseconds before new tuner selection is online.

Signature

<selection_delay></selection_delay>

Parameter	Description
bool	True/False

Returns

None

Example

<capabilities>
   <selection_delay>true</selection_delay>
</capabilities>

Disc Changer Protocol Notifications

DISC_CHANGED

Selected disc has changed.

Name

DISC_CHANGED ()

Parameter	Type	Description
DiscNumber	INT	Disc Number

Parameter	Type	Description
INDEX	INT	Index of the disc being scanned
DISCTYPE	STR	‘cd’ for CD or ‘dvd’ for DVD
DATA	XML	table of contents

TRACK_CHANGED

Selected track has changed.

Name

TRACK_CHANGED ()

Parameter	Type	Description
DiscNumber	INT	Track Number

Returns

None

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.

Disc Changer Proxy Commands

EMIT_CODE

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

Name

EMIT_CODE ()

Parameter	Type	Description
IRCodeID	INT	ID OF IR Code

Returns

None

EMIT_MACRO

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

Name

EMIT_MACRO ()

Parameter	Type	Description
MacroCodeNam	STR	Macro Code Name

Name

GO_TO_DISC_TRACK ()

Parameter	Type	Description
DiscNumber	INT	Disc Number
TrackNUMBER	INT	Track Number

Returns

None

GO_TO_TRACK

Select specified track.

Name

GO_TO_TRACK ()

Parameter	Type	Description
TrackNUMBER	INT	Track Number

None

SET_UP_DOWN_SWAP ()

Parameter	Type	Description
SWAPFLAG	BOOL	Ability to swap page buttons.

Returns

None

UPDATE _PROGRESS _SCAN _MEDIA

Notification of the progress of the current media scan

Signature

UPDATE_PROGRESS_SCAN_MEDIA ()

Parameter	Type	Description
TOTAL COUNT	NUM	Total number of discs to be scanned.
CURRENT INDEX	Num	How many currently have been scanned.

Returns

None

GO_TO_DISC

Select specified disc.

Name

GO_TO_DISC ()

Parameter	Type	Description
DiscNumber	INT	Disc Number

Returns

None

License, Copyright, and Trademark

Introduction

Proxies (Commands)

Protocol (Notifications)

What’s New

What’s New in 3.4.2

What’s New in 3.4.1

What’s New in 3.4.0

What’s New in 3.3.2

What’s New in 3.3.1

What’s New in 3.3.0

What’s New in 3.2.3

What’s New in 3.2.2

What’s New in 3.2.1

What’s New in 3.2.0

What was New in 3.1.2

What was New in 3.1.0

What was New in O.S.3

Disc Changer Capabilities

can_play_cd

Signature

Returns

Example

can_scan_media

Signature

Returns

Example

has_discreet_disc_button

Signature

Returns

Example

has_discreet_disc_access

Signature

Returns

Example

has_discreet_input_selection

Signature

Returns

Example

media_count

Signature

Returns

Example

media_type

Signature

Returns

Example

selection_delay

Signature

Returns

Example

Disc Changer Protocol Notifications

DISC_CHANGED

Name

Returns

OFF

Name

Parameter

Returns

ON

Name

Parameter

Returns

PAUSE

Name

Parameter

Returns

PLAY

Name

Parameter

Returns

STOP

Name

Parameter

Returns

TOC

Name

Parameter

Returns

TRACK_CHANGED