Introduction
Proxies (Commands)
This documentation includes content that details the functions that make up the Media Player 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 media players have common controls such as PLAY, STOP, PAUSE and SKIP. The media player proxy allows for a common user interface to control all media players. 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 Media Player Proxy in conjunction with O.S. Release 3.4.2.
What’s New in 3.4.1
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.4.1.
What’s New in 3.4.0
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.4.0.
What’s New in 3.3.2
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.3.2.
What’s New in 3.3.1
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.3.1.
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.3.0.
What’s New in 3.2.3
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.2.3.
What’s New in 3.2.2
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.2.2.
What’s New in 3.2.1
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.2.1.
What’s New in 3.2.0
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.2.0.
What was New in 3.1.2
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.1.2.
What was New in 3.1.0
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.1.0.
What was New in O.S.3
There were no modifications to the Media Player Proxy in conjunction with O.S. Release 3.0.0.
Media Player Protocol Notifications
DISC_CHANGED
Selected disc has changed.
Name
DISC_CHANGED ()
Parameter | Type | Description |
---|---|---|
DiscNumber | INT | Disc Number |
Returns
None
OFF
Device has turned Off.
Name
OFF ()
Parameter
None
Returns
None
ON
Device has turned On.
Name
ON ()
Parameter
None
Returns
None
PAUSE
Device is paused.
Name
PAUSE ()
Parameter
None
Returns
None
PLAY
Device has entered a playback state.
Name
PLAY ()
Parameter
None
Returns
None
STOP
Device has entered a stopped state.
Name
STOP ()
Parameter
None
Returns
None
TOC
Issued when scanning the table of contents for a particular disc or cd. Director will use this information to lookup and populate the database with the disc information if the lookup succeeds. This command can also be used to indicate a slot now is empty and contains no disc.
Name
TOC ()
Parameter
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 |
Returns
None
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.
Media Player 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
DOWN
Pulse down navigation.
Name
DOWN ()
Parameters
None
Returns
None
EJECT
Eject disc/tape.
Name
EJECT ()
Parameters
None
Returns
None
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.
Name
EMIT_MACRO ()
Parameter | Type | Description |
---|---|---|
MacroCodeName | STR | Macro Code Name |
Returns
None
ENTER
Navigate Enter key
Name
Enter ()
Parameters
None
Returns
None
GO_TO_DISC
Select specified disc.
Name
GO_TO_DISC ()
Parameter | Type | Description |
---|---|---|
DiscNUMBER | INT | Disc Number |
Returns
None
GO_TO_DISC_TRACK
Select specified disc and track.
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 |
Returns
None
GUIDE
Navigate Guide key.
Name
GUIDE ()
Parameters
None
Returns
None
HYPHEN
Pulse ‘-’ button
Name
HYPHEN ()
Parameters
None
Returns
None
INFO
Pulse Info button
Name
INFO ()
Parameters
None
Returns
None
LEFT
Pulse left navigation.
Name
LEFT ()
Parameters
None
Returns
None
MENU
Navigate menu.
Name
MENU ()
Parameters
None
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
NUMBER6
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.
OPEN_CLOSE
Open/close disc tray.
Name
OPEN_CLOSE ()
Parameters
None
Returns
None
PAGE_DOWN
Pulse menu Page down.
Name
PAGE_DOWN ()
Parameters
None
Returns
None
PAGE_UP
Pulse menu Page up.
Name
PAGE_UP ()
Parameters
None
Returns
None
PAUSE
Place device in stop state.
Name
PAUSE ()
Parameters
None
Returns
None
PLAY
Place device in a playback state.
Name
PLAY ()
Parameters
None
Returns
None
POUND
Pulse # button.
Name
POUND ()
Parameters
None
Returns
None
PULSE_ASPECT_RATIO
Toggle (cycle though) aspect ratio.
Name
PULSE_ASPECT_RATIO ()
Parameters
None
Returns
None
PVR
Pulse PVR button.
Name
PVR ()
Parameters
None
Returns
None
RECALL
Pulse Recall button.
Name
RECALL ()
Parameters
None
Returns
None
RIGHT
Pulse right navigation button.
Name
RIGHT ()
Parameters
None
Returns
None
SCAN_FWD
Pulse/scan forward within track/chapter.
Name
SCAN_FWD ()
Parameters
None
Returns
None
SCAN_REV
Pulse scan reverse within track/chapter.
Name
SCAN_REV ()
Parameters
None
Returns
None
SET_UP_DOWN_SWAP
Swap page UP/DOWN buttons (used by AVGen)
Name
SET_UP_DOWN_SWAP ()
Parameter | Type | Description |
---|---|---|
SWAPFLAG | BOOL | Ability to swap UP/DOWN buttons. |
Returns
None
SKIP_FWD
Advance to next track/chapter.
Name
SKIP_FWD ()
Parameters
None
Returns
None
SKIP_REV
Seek to previous track/chapter.
Name
SKIP_REV ()
Parameters
None
Returns
None
STAR
Pulse *
button.
Name
STAR ()
Parameters
None
Returns
None
START_DOWN
Initiate down arrow navigation.
Name
START_DOWN ()
Parameters
None
Returns
None
START_LEFT
Pulse left navigation.
Name e
START_LEFT ()
Parameters
None
Returns
None
START_PAGE_DOWN
Start menu Page down.
Name
START_PAGE_DOWN ()
Parameters
None
Returns
None
START_PAGE_UP
Start menu Page up.
Name
START_PAGE_UP ()
Parameters
None
Returns
None
START_PAGE_RIGHT
Initiate right-arrow navigation.
Name
START_RIGHT ()
Parameters
None
Returns
None
START_SCAN_FWD
Initiate scan forward within track/chapter.
Name
START_SCAN_FWD ()
Parameters
None
Returns
None
START_SCAN_REV
Initiate scan forward within track/chapter.
Name
START_SCAN_REV ()
Parameters
None
Returns
None
START_UP
Initiate up-arrow navigation.
Name
START_UP ()
Parameters
None
Returns
None
STOP
Place device in stop state.
Name
STOP ()
Parameters
None
Returns
None
STOP_DOWN
Terminate down-arrow navigation.
Name
STOP_DOWN ()
Parameters
None
Returns
None
STOP_LEFT
Terminate left navigation.
Name
STOP_LEFT ()
Parameters
None
Returns
None
STOP_PAGE_DOWN
Stop menu page down.
Name
STOP_PAGE_DOWN ()
Parameters
None
Returns
None
STOP_PAGE_UP
Stop menu page up.
Name
STOP_PAGE_UP ()
Parameters
None
Returns
None
STOP_RIGHT
Terminate RIGHT navigation.
Name
STOP_RIGHT ()
Parameters
None
Returns
None
STOP_SCAN_FWD
Terminate scan forward within track/chapter.
Name
STOP_SCAN_FWD ()
Parameters
None
Returns
None
STOP_SCAN_REV
Terminate reverse scan within track/chapter.
Name
STOP_SCAN_REV ()
Parameters
None
Returns
None
STOP_UP
Stop menu Page up.
Name
STOP_UP ()
Parameters
None
Returns
None
TV_VIDEO
Toggle TV/video input.
Signature
TV_VIDEO ()
Parameters
None
Returns
None
UP
Pulse up navigation.
Name
UP ()
Parameters
None
Returns
None