PK UC,Zc c + mediaplayer_ip_kaleidescape_movieplayer.c4i
Kaleidescape M500 Player
devices_sm/disc_changer.gif
devices_lg/disc_changer.gif
lua_gen
DriverWorks
Audio/Video
Kaleidescape, Inc.
4/1/2009 12:01:00 AM
08/02/2013 10:40:29 AM
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Kaleidescape, Inc.
KPLAYER-M500, KPLAYER-6000, KPLAYER-5000, KPLAYER-2500, KPLAYER-2000
100%
100%
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
1.7
Controlled as a Media Player or an iPod.
1
Mask Unknown
NAME Masking ratio is unknown
2
Mask to 1.33
NAME shows 1.33 aspect ratio
3
Mask to 1.66
NAME shows 1.66 aspect ratio
4
Mask to 1.78
NAME shows 1.78 aspect ratio
5
Mask to 1.85
NAME shows 1.85 aspect ratio
6
Mask to 2.35
NAME shows 2.35 aspect ratio
7
Frame 4x3
NAME is displaying a 4x3 video mode
8
Frame 16x9
NAME is displaying a 16x9 video mode
9
Lights to Movie Playing level
NAME is playing a movie
10
Lights to End Credits level
NAME is showing the end credits
11
Lights to Menu level
NAME is showing a menu
12
Lights to Intermission level
NAME is showing an intermission
14
Screen Aspect Ratio 16:9
CinemaScape Mode is off
15
Screen Aspect Ratio CinemaScape 2.35 Anamorphic
CinemaScape Mode is Anamorphic
16
Screen Aspect Ratio CinemaScape 2.35 Letterbox
CinemaScape Mode is Letterbox
17
Screen Aspect Ratio CinemaScape Native 2.35 Display
CinemaScape Mode is Native
18
No Scaling Required
Image requires no scaling
19
CinemaScape Scale Mode Anamorphic
Image requires horizontal stretch
20
CinemaScape Scale Mode Zoom
Image requires zoom
21
Movie Zone Volume Up
Volume Up was received by player
22
Movie Zone Volume Down
Volume Down was received by player
23
Movie Zone Volume Mute
Toggle Mute was received by player
24
Music Zone 1 Volume Up
Volume Up was received by player
25
Music Zone 1 Volume Down
Volume Down was received by player
26
Music Zone 1 Volume Mute
Toggle Mute was received by player
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved.
This is the Kaleidescape driver to control the M500 Player.
Driver version 1.7, created on 08/02/2013 10:40:29 AM.
For more information, refer to the "Kaleidescape Programming Manual for Control4 Controllers" which can be downloaded from:
http://www.kaleidescape.com/files/documentation/Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf
If you require technical assistance with this driver, please contact Kaleidescape technical support at 650-625-6160 or support@kaleidescape.com.
This driver uses a single Media Player proxy to control the Kaleidescape On-Screen Display (OSD), and a single iPod proxy to control music when the OSD is not visible (SATP). Both proxies control the same physical output of the Kaleidescape player (Zone 1).
________________________
CONTENTS
1. Quick Start Guide
2. Driver Properties
3. Programming Interface
4. Release Notes
________________________
1. QUICK START GUIDE
1. Rename the player zones as appropriate.
2. In the Properties tab, set the appropriate properties:
a. indicate if you want this player to remain permanently on. (not available on the Cinema One (1st generation))
b. indicate if you want presets to show in the list interface.
c. indicate if you're using a controlled mask. (not available on the Music Player)
d. indicate if volume control or feedback are needed by player zone. Only set the Movie Zone Volume or Music Zone 1 Volume, do not set both.
3. Define the IP connection in the IP Network Connection pane to match the player this driver is to control. Note that the player MUST be set to use a fixed IP address.
4. Set up all the A/V connections for the player.
5. Configure any Music Preset Buttons in the Programming View.
6. Define any other Scripts in the Programming View:
a. script to modify the lights at various movie points. (not available on the Music Player)
b. script to set the proper screen mask for an automated masking system. (not available on the Music Player)
c. scripts to trigger volume commands and send volume level and mute feedback to an iPad running the Kaleidescape App for iPad.
________________________
2. PROPERTIES
Not all properties are available on all drivers and some properties are repeated per zone. All interfaces for the same device show the same properties (i.e., the Media Player and iPod show as separate entities on the same player, but share the same properties).
* Version
A read-only field showing the version of the driver as reported by the Lua script.
* Status
A read-only field showing the connection status of the driver and standby status of the player.
* Debug
Turns on and off debugging messages. Messages may be sent to the Control4 system log (log), to the Lua tab (print), or both. Debugging is automatically set to "Off" after 15 minutes as it will affect system performance.
* Power
Indicates if the player should be permanently left on or allowed to enter standby (power off).
* Using a Controlled Mask
Set to "Yes" if the video output will be masked down either with a screen masking system or with a 2.35 lens. This setting will pull the system messages and subtitles out of the masked portion of the video.
* Set Volume Capabilities for Movie Zone
Indicates which volume buttons and feedback will be used for the movie zone.
* Show presets in the list interface
Indicate if the music presets should be listed in the SATP (iPod) interface. When shown, presets are listed by their name (i.e., "Jazz", "The White Album", or "The Rolling Stones") rather than by number, and blank presets are skipped.
* Zone n Status
A read-only field showing the state of the music zone number "n". This will indicate what music item is currently playing.
* Save Zone n Playing Music
This is actually a control that will save the playing music item in zone number "n" (indicated by the Zone n Status) to the selected preset. To view what presets are saved, use the "List presets in Lua tab" button on the "Actions" tab, then view the presets on the "Lua" tab.
* Set Volume Capabilities for Music Zone n
Indicates which volume buttons and feedback will be used for the music zone number "n". If volume capabilities are set for the Movie Zone, do not set volume capabilities for music zone 1.
________________________
3. PROGRAMMING INTERFACE
All Events and Actions described here are available through the "Programming" view in Control4 Composer. Events show in the left pane, Actions show in the right pane. Variables show as child objects of the device interface and each is available as an Event ("Changed") a Conditional ("If value") a Loop ("While value") and a Command ("Set value") -- though many are read-only.
EVENTS -- OSD
-------------
* Power On
The zone has powered on.
* Power Off
The zone has powered off.
* Play
The zone is playing content.
* Stop
The zone is not playing content.
* Pause
The content is paused.
* Mask to ___
Triggers when the playing content is using this aspect ratio -- either 1.33, 1.66, 1.78, 1.85, or 2.35. Use these events to trigger an automated screen masking system or an anamorphic lens. Note that this is different than the Frame -- a 2.35 movie has black bars encoded in the content to make it fit in a 16X9 frame.
* Frame ___
Triggers when the video mode is showing this frame ratio -- either 4X3 or 16X9. Use these events to trigger video mode changes in a display device when needed.
* Lights to ___ level
Triggers at one of these events -- either "Movie Playing", "End Credits", "Menu" or "Intermission". The "Lights to Menu level" will trigger when showing a Kaleidescape OSD place or for most DVD menus. "Lights to Movie Playing" will trigger when showing the main content. "Lights to End Credits" will trigger when the end credits are shown. "Lights to Intermission" will trigger when the intermission is invoked.
* Screen Aspect Ratio ___
Triggers to indicate which CinemaScape mode the player is set to.
* CinemaScape Scale Mode___
If CinemaScape mode is enabled, scale mode triggers to indicate what type of scaling (if any) is required.
* Movie Zone Volume ___,
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
EVENTS -- SATP
--------------
* Docked
The zone has powered on.
* Undocked
The zone has powered off.
* Play
The zone is playing music.
* Stop
The zone is not playing music.
* Pause
The music is paused.
* Music Zone n Volume ___
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
ACTIONS -- OSD Commands
-----------------------
* Power On
Turn the zone on.
* Power Off
Turn the zone off.
* Play/Stop/Pause/Scan Fwd/Scan Rev/Skip Fwd/Skip Rev
Performs the indicated transport command.
* Menu/Up/Down/Left/Right/Enter
Performs the indicated command. Menu will engage the DVD menu when in movie playback and toggle the Kaleidescape menu otherwise.
* Keypad ___
Sends the indicated keypad key. Will not strictly send the indicated number command, but will sometimes perform as an alpha-key depending on what is showing on the OSD.
During DVD playback, the # key will begin the chapter entry and the next two keys (and enter) will select a chapter.
* Favorite Scene Markers
Sets the begin and end point of a favorite scene during movie playback. These commands are also available through the Kaleidescape OSD Info menu during playback.
* Parental Control Mode
Enable "Safe" or "Default" mode of the player. On a Premiere Line system the player's default level is set in the Kaleidescape web utility. On a Cinema Line system the default level is set in the OSD. The safe mode is the least restrictive mode without a password.
Neither command will change the mode to a less restrictive level. For example, if the default mode is "R and below" but the player is only showing "G and below" content, the "Default" command will perform no action.
* Instant Replay
Skip back 5 seconds in the movie.
* Show an OSD Place
Set the OSD to the specified place. The "Movie Selections" will show a movie place and the "Music Selections" will show a music place. "System Status" will show the system status page. All other selections will invoke the specifically indicated movie or music place.
* Play a Video Script
Play the specified Kaleidescape script; the "Script name" is case sensitive. Scripts are created and edited in the Kaleidescape web utility. This may be used to play a custom theater introduction every time the system is powered on. Scripts are only available on Premiere Line systems.
* Control a Music Zone with OSD
Sets the OSD to control a different music zone. Control Zone commands are only available on Premiere Line systems. See the section on Music Zone Control for more information.
* Control the default zone with OSD
Returns the OSD to controlling the default music zone; essentially reverts from the above command. See the section on Music Zone Control for more information.
ACTIONS -- SATP Commands
------------------------
* Transport Control Commands
Performs the indicated command.
* Shuffle Off
Disables the "Random" mode. Note that some playing items will always play randomly and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Shuffle Songs/Albums
Enables the "Random" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Repeat Off
Disables the "Repeat" mode. Note that some playing items will always repeat and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Repeat One Track/All Tracks
Enables the "Repeat" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Manage Music Preset
Stores a preset, recalls a preset, perform a preset button press or release. See the section on Using Music Presets for more information.
VARIABLES -- OSD
----------------
* POWER_STATE
True or false value. Indicates the power state of the zone.
* OSD Intermission
True or false value. Indicates the intermission state of the zone. Can be set to "True" to engage intermission or to "False" to clear it.
* OSD Screen Saver
True or false value. Indicates the screen saver state. Can be set to "True" to engage the screen saver or to "False" to clear it.
* CinemaScape Mask
When the player is in CinemaScape Mode, indicates the aspect ratio of the current image. Possible values are from 0 to 999, for example 133 corresponds to 4:3 or 1.33 video. This value can be used to determine proper screen masking position.
* Movie Zone Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad
* Movie Zone Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad.
VARIABLES -- SATP
-----------------
* IPOD
Text value. Indicates the name of the music zone as set in the Kaleidescape web utility.
* TITLE
Text value. Indicates the title of the currently playing track.
* ARTIST
Text value. Indicates the artist for the currently playing track.
* ALBUM
Text value. Indicates the album for the currently playing track.
* PLAY_STATUS
Text value -- either "Playing", "Stopped" or "Paused".
* Music Zone __ Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Level, do not connect Music Zone 1 Volume Level.
* Music Zone __ Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Mute, do not connect Music Zone 1 Volume Mute.
* Music Preset Button Lockout
True or false value. When true, preset button events will not be able to save a preset on this device. Can be set to "True" or "False".
* Zone n -- Music Preset ___ status
True or false value -- read only. Indicates the status of the preset in zone n. If preset 6 is playing in zone 2, "Zone 2 -- Music Preset 6 status" will be true. Note that several presets can be active simultaneously in the same zone.
________________________
4. RELEASE NOTES
Known issues
------------
* The icon used for control of music zones is an iPod in a dock.
* An eject button is provided when controlling a movie zone, although no eject command is available for the Kaleidescape Player. Pressing the eject button selects the Kaleidescape Menu, from which the Disc tab can be accessed if a disc is in the tray.
* No cover art is provided to touch screens.
* The Kaleidescape driver iPod proxy always shows the Control4 logo in Control4 Composer.
* The Media Player interface (OSD control) audio connections show up on the iPod interface (SATP control).
* If the Movie Player Driver is used to control the (discontinued) KPLAYER-2000, a non-existent HDMI output will be available.
* Improper Events and Actions are shown on the Movie Zone (OSD) and Music Zone (SATP) interfaces. For example, the SATP interface has an Action for Video Frame 4X3 and shows a Variable for OSD Screen Saver.
* The Cinema One (1st generation) driver shows events for CinemaScape Mode and CinemaScape Mask. CinemaScape is only supported on the M-Class Players and Vaults, and the Cinema Line Cinema One.
Versions
--------
1.7
* Created driver for the Cinema One (2nd generation).
1.6
* Fixed problem with module reconnecting to player when player temporarily drops off the network.
1.5
* Support for Volume control.
1.4
* Support for CinemaScape.
1.3
* Support for Composer 2.1.
* Support for Search and Jump in OSD Collections.
1.2
* Added Blu-ray support.
* Added relevant default names for all drivers.
* Renamed driver files to reflect new products.
1.1
* Fixed problem with large touch panel "Back" button.
1.0
* Initial release.
________________________
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Type in the Kaleidescape player's network IP address below.
Version
STRING
true
Status
STRING
Initializing...
true
Debug
LIST
- Off
- Print
- Log
- Print and log
Off
false
Power
LIST
- Allow user to power off
- Always leave player on
Allow user to power off
false
-- Video --
STRING
true
Using a Controlled Mask
LIST
- Yes
- No
No
false
-- Movie Zone Volume --
STRING
true
Set Volume Capabilities for Movie Zone
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
-- Music --
STRING
true
Show presets in the list interface
LIST
- Show presets
- Do not show presets
Show presets
false
Zone 1 Status
STRING
true
Save Zone 1 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 1 Volume --
STRING
true
Set Volume Capabilities for Music Zone 1
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
List presets in Lua tab
List Presets
Force all zones off
Force Off
Favorite Scene Markers
Set the PARAM1 of a favorite scene on NAME
Mark
LIST
- start
- end
Parental Control Mode
Show PARAM1 on OSD of NAME
Set level
LIST
- no password protected selections (safe mode)
- default player selections (default mode)
Instant Replay
Jump playback 15 seconds on NAME
Show an OSD Place
Show the PARAM1 on OSD of NAME
OSD place
LIST
- Movie selections
- Music selections
- Movie List
- Movie Covers
- Movie Collections
- Parental Control
- Music List
- Music Covers
- Music Collections
- Music Now Playing
- System Status
Play a Video Script
Play the script named PARAM1 on NAME
Script name
STRING
Control a Music Zone with OSD
Change the NAME Video to control device with PARAM1 PARAM2, music zone PARAM3
How is this defined
LIST
- Serial Number
- CPDID
Device SN or CPDID
STRING
Zone
RANGED_INTEGER
1
4
Control the default zone with OSD
Change the NAME Video to control its own zone 1
Manage Music Preset
PARAM3 preset PARAM2 on NAME Zone PARAM1
Zone Output
RANGED_INTEGER
1
1
Preset Number
RANGED_INTEGER
1
10
Action
LIST
- Store
- Recall
- Press (button)
- Release (button)
media_player
ipod
5001
2
6
SATP Interface
False
False
False
False
IPOD
5002
2
6
OSD Interface
False
False
False
False
MEDIA_PLAYER
2000
5
Video - Zone 1
False
True
False
True
COMPOSITE
SVIDEO
COMPONENT
HDMI
4000
6
Audio - Zone 1
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
3001
6
Audio Interconnect Rx for OSD
True
True
False
False
2
True
DIGITAL_COAX
True
DIGITAL_OPTICAL
True
STEREO
True
4002
6
Audio Interconnect Tx for OSD
False
True
True
False
2
True
DIGITAL_COAX
True
DIGITAL_OPTICAL
True
STEREO
True
6001
4
6
Kaleidescape Driver IP Connection
True
true
TCP
10000
True
True
True
255
80
False
False
False
255
13d
True
PK UCx x ) mediaplayer_ip_kaleidescape_cinemaone.c4i
Kaleidescape Cinema One
devices_sm/disc_changer.gif
devices_lg/disc_changer.gif
lua_gen
DriverWorks
Audio/Video
Kaleidescape, Inc.
4/1/2009 12:01:00 AM
08/02/2013 10:40:29 AM
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Kaleidescape, Inc.
KSYSTEM-120
100%
100%
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
1.7
Controlled as a Media Player or an iPod.
Controlled as an iPod.
Controlled as an iPod.
1
Mask Unknown
NAME Masking ratio is unknown
2
Mask to 1.33
NAME shows 1.33 aspect ratio
3
Mask to 1.66
NAME shows 1.66 aspect ratio
4
Mask to 1.78
NAME shows 1.78 aspect ratio
5
Mask to 1.85
NAME shows 1.85 aspect ratio
6
Mask to 2.35
NAME shows 2.35 aspect ratio
7
Frame 4x3
NAME is displaying a 4x3 video mode
8
Frame 16x9
NAME is displaying a 16x9 video mode
9
Lights to Movie Playing level
NAME is playing a movie
10
Lights to End Credits level
NAME is showing the end credits
11
Lights to Menu level
NAME is showing a menu
12
Lights to Intermission level
NAME is showing an intermission
14
Screen Aspect Ratio 16:9
CinemaScape Mode is off
15
Screen Aspect Ratio CinemaScape 2.35 Anamorphic
CinemaScape Mode is Anamorphic
16
Screen Aspect Ratio CinemaScape 2.35 Letterbox
CinemaScape Mode is Letterbox
17
Screen Aspect Ratio CinemaScape Native 2.35 Display
CinemaScape Mode is Native
18
No Scaling Required
Image requires no scaling
19
CinemaScape Scale Mode Anamorphic
Image requires horizontal stretch
20
CinemaScape Scale Mode Zoom
Image requires zoom
21
Movie Zone Volume Up
Volume Up was received by player
22
Movie Zone Volume Down
Volume Down was received by player
23
Movie Zone Volume Mute
Toggle Mute was received by player
24
Music Zone 1 Volume Up
Volume Up was received by player
25
Music Zone 1 Volume Down
Volume Down was received by player
26
Music Zone 1 Volume Mute
Toggle Mute was received by player
27
Music Zone 2 Volume Up
Volume Up was received by player
28
Music Zone 2 Volume Down
Volume Down was received by player
29
Music Zone 2 Volume Mute
Toggle Mute was received by player
30
Music Zone 3 Volume Up
Volume Up was received by player
31
Music Zone 3 Volume Down
Volume Down was received by player
32
Music Zone 3 Volume Mute
Toggle Mute was received by player
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved.
This is the Kaleidescape driver to control the Cinema One.
Driver version 1.7, created on 08/02/2013 10:40:29 AM.
For more information, refer to the "Kaleidescape Programming Manual for Control4 Controllers" which can be downloaded from:
http://www.kaleidescape.com/files/documentation/Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf
If you require technical assistance with this driver, please contact Kaleidescape technical support at 650-625-6160 or support@kaleidescape.com.
This driver uses a single Media Player proxy to control the Kaleidescape On-Screen Display (OSD), and a single iPod proxy to control music in that same zone when the OSD is not visible (SATP). Both of these proxies control the same physical output of the Kaleidescape Cinema One (Zone 1). Two additional iPod proxies (SATP) are provided to control the two additional independent music-only outputs (Zones 2 and 3).
________________________
CONTENTS
1. Quick Start Guide
2. Driver Properties
3. Programming Interface
4. Release Notes
________________________
1. QUICK START GUIDE
1. Rename the player zones as appropriate.
2. In the Properties tab, set the appropriate properties:
a. indicate if you want this player to remain permanently on. (not available on the Cinema One (1st generation))
b. indicate if you want presets to show in the list interface.
c. indicate if you're using a controlled mask. (not available on the Music Player)
d. indicate if volume control or feedback are needed by player zone. Only set the Movie Zone Volume or Music Zone 1 Volume, do not set both.
3. Define the IP connection in the IP Network Connection pane to match the player this driver is to control. Note that the player MUST be set to use a fixed IP address.
4. Set up all the A/V connections for the player.
5. Configure any Music Preset Buttons in the Programming View.
6. Define any other Scripts in the Programming View:
a. script to modify the lights at various movie points. (not available on the Music Player)
b. script to set the proper screen mask for an automated masking system. (not available on the Music Player)
c. scripts to trigger volume commands and send volume level and mute feedback to an iPad running the Kaleidescape App for iPad.
________________________
2. PROPERTIES
Not all properties are available on all drivers and some properties are repeated per zone. All interfaces for the same device show the same properties (i.e., the Media Player and iPod show as separate entities on the same player, but share the same properties).
* Version
A read-only field showing the version of the driver as reported by the Lua script.
* Status
A read-only field showing the connection status of the driver and standby status of the player.
* Debug
Turns on and off debugging messages. Messages may be sent to the Control4 system log (log), to the Lua tab (print), or both. Debugging is automatically set to "Off" after 15 minutes as it will affect system performance.
* Power
Indicates if the player should be permanently left on or allowed to enter standby (power off).
* Using a Controlled Mask
Set to "Yes" if the video output will be masked down either with a screen masking system or with a 2.35 lens. This setting will pull the system messages and subtitles out of the masked portion of the video.
* Set Volume Capabilities for Movie Zone
Indicates which volume buttons and feedback will be used for the movie zone.
* Show presets in the list interface
Indicate if the music presets should be listed in the SATP (iPod) interface. When shown, presets are listed by their name (i.e., "Jazz", "The White Album", or "The Rolling Stones") rather than by number, and blank presets are skipped.
* Zone n Status
A read-only field showing the state of the music zone number "n". This will indicate what music item is currently playing.
* Save Zone n Playing Music
This is actually a control that will save the playing music item in zone number "n" (indicated by the Zone n Status) to the selected preset. To view what presets are saved, use the "List presets in Lua tab" button on the "Actions" tab, then view the presets on the "Lua" tab.
* Set Volume Capabilities for Music Zone n
Indicates which volume buttons and feedback will be used for the music zone number "n". If volume capabilities are set for the Movie Zone, do not set volume capabilities for music zone 1.
________________________
3. PROGRAMMING INTERFACE
All Events and Actions described here are available through the "Programming" view in Control4 Composer. Events show in the left pane, Actions show in the right pane. Variables show as child objects of the device interface and each is available as an Event ("Changed") a Conditional ("If value") a Loop ("While value") and a Command ("Set value") -- though many are read-only.
EVENTS -- OSD
-------------
* Power On
The zone has powered on.
* Power Off
The zone has powered off.
* Play
The zone is playing content.
* Stop
The zone is not playing content.
* Pause
The content is paused.
* Mask to ___
Triggers when the playing content is using this aspect ratio -- either 1.33, 1.66, 1.78, 1.85, or 2.35. Use these events to trigger an automated screen masking system or an anamorphic lens. Note that this is different than the Frame -- a 2.35 movie has black bars encoded in the content to make it fit in a 16X9 frame.
* Frame ___
Triggers when the video mode is showing this frame ratio -- either 4X3 or 16X9. Use these events to trigger video mode changes in a display device when needed.
* Lights to ___ level
Triggers at one of these events -- either "Movie Playing", "End Credits", "Menu" or "Intermission". The "Lights to Menu level" will trigger when showing a Kaleidescape OSD place or for most DVD menus. "Lights to Movie Playing" will trigger when showing the main content. "Lights to End Credits" will trigger when the end credits are shown. "Lights to Intermission" will trigger when the intermission is invoked.
* Screen Aspect Ratio ___
Triggers to indicate which CinemaScape mode the player is set to.
* CinemaScape Scale Mode___
If CinemaScape mode is enabled, scale mode triggers to indicate what type of scaling (if any) is required.
* Movie Zone Volume ___,
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
EVENTS -- SATP
--------------
* Docked
The zone has powered on.
* Undocked
The zone has powered off.
* Play
The zone is playing music.
* Stop
The zone is not playing music.
* Pause
The music is paused.
* Music Zone n Volume ___
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
ACTIONS -- OSD Commands
-----------------------
* Power On
Turn the zone on.
* Power Off
Turn the zone off.
* Play/Stop/Pause/Scan Fwd/Scan Rev/Skip Fwd/Skip Rev
Performs the indicated transport command.
* Menu/Up/Down/Left/Right/Enter
Performs the indicated command. Menu will engage the DVD menu when in movie playback and toggle the Kaleidescape menu otherwise.
* Keypad ___
Sends the indicated keypad key. Will not strictly send the indicated number command, but will sometimes perform as an alpha-key depending on what is showing on the OSD.
During DVD playback, the # key will begin the chapter entry and the next two keys (and enter) will select a chapter.
* Favorite Scene Markers
Sets the begin and end point of a favorite scene during movie playback. These commands are also available through the Kaleidescape OSD Info menu during playback.
* Parental Control Mode
Enable "Safe" or "Default" mode of the player. On a Premiere Line system the player's default level is set in the Kaleidescape web utility. On a Cinema Line system the default level is set in the OSD. The safe mode is the least restrictive mode without a password.
Neither command will change the mode to a less restrictive level. For example, if the default mode is "R and below" but the player is only showing "G and below" content, the "Default" command will perform no action.
* Instant Replay
Skip back 5 seconds in the movie.
* Show an OSD Place
Set the OSD to the specified place. The "Movie Selections" will show a movie place and the "Music Selections" will show a music place. "System Status" will show the system status page. All other selections will invoke the specifically indicated movie or music place.
* Play a Video Script
Play the specified Kaleidescape script; the "Script name" is case sensitive. Scripts are created and edited in the Kaleidescape web utility. This may be used to play a custom theater introduction every time the system is powered on. Scripts are only available on Premiere Line systems.
* Control a Music Zone with OSD
Sets the OSD to control a different music zone. Control Zone commands are only available on Premiere Line systems. See the section on Music Zone Control for more information.
* Control the default zone with OSD
Returns the OSD to controlling the default music zone; essentially reverts from the above command. See the section on Music Zone Control for more information.
ACTIONS -- SATP Commands
------------------------
* Transport Control Commands
Performs the indicated command.
* Shuffle Off
Disables the "Random" mode. Note that some playing items will always play randomly and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Shuffle Songs/Albums
Enables the "Random" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Repeat Off
Disables the "Repeat" mode. Note that some playing items will always repeat and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Repeat One Track/All Tracks
Enables the "Repeat" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Manage Music Preset
Stores a preset, recalls a preset, perform a preset button press or release. See the section on Using Music Presets for more information.
VARIABLES -- OSD
----------------
* POWER_STATE
True or false value. Indicates the power state of the zone.
* OSD Intermission
True or false value. Indicates the intermission state of the zone. Can be set to "True" to engage intermission or to "False" to clear it.
* OSD Screen Saver
True or false value. Indicates the screen saver state. Can be set to "True" to engage the screen saver or to "False" to clear it.
* CinemaScape Mask
When the player is in CinemaScape Mode, indicates the aspect ratio of the current image. Possible values are from 0 to 999, for example 133 corresponds to 4:3 or 1.33 video. This value can be used to determine proper screen masking position.
* Movie Zone Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad
* Movie Zone Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad.
VARIABLES -- SATP
-----------------
* IPOD
Text value. Indicates the name of the music zone as set in the Kaleidescape web utility.
* TITLE
Text value. Indicates the title of the currently playing track.
* ARTIST
Text value. Indicates the artist for the currently playing track.
* ALBUM
Text value. Indicates the album for the currently playing track.
* PLAY_STATUS
Text value -- either "Playing", "Stopped" or "Paused".
* Music Zone __ Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Level, do not connect Music Zone 1 Volume Level.
* Music Zone __ Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Mute, do not connect Music Zone 1 Volume Mute.
* Music Preset Button Lockout
True or false value. When true, preset button events will not be able to save a preset on this device. Can be set to "True" or "False".
* Zone n -- Music Preset ___ status
True or false value -- read only. Indicates the status of the preset in zone n. If preset 6 is playing in zone 2, "Zone 2 -- Music Preset 6 status" will be true. Note that several presets can be active simultaneously in the same zone.
________________________
4. RELEASE NOTES
Known issues
------------
* The icon used for control of music zones is an iPod in a dock.
* An eject button is provided when controlling a movie zone, although no eject command is available for the Kaleidescape Player. Pressing the eject button selects the Kaleidescape Menu, from which the Disc tab can be accessed if a disc is in the tray.
* No cover art is provided to touch screens.
* The Kaleidescape driver iPod proxy always shows the Control4 logo in Control4 Composer.
* The Media Player interface (OSD control) audio connections show up on the iPod interface (SATP control).
* If the Movie Player Driver is used to control the (discontinued) KPLAYER-2000, a non-existent HDMI output will be available.
* Improper Events and Actions are shown on the Movie Zone (OSD) and Music Zone (SATP) interfaces. For example, the SATP interface has an Action for Video Frame 4X3 and shows a Variable for OSD Screen Saver.
* The Cinema One (1st generation) driver shows events for CinemaScape Mode and CinemaScape Mask. CinemaScape is only supported on the M-Class Players and Vaults, and the Cinema Line Cinema One.
Versions
--------
1.7
* Created driver for the Cinema One (2nd generation).
1.6
* Fixed problem with module reconnecting to player when player temporarily drops off the network.
1.5
* Support for Volume control.
1.4
* Support for CinemaScape.
1.3
* Support for Composer 2.1.
* Support for Search and Jump in OSD Collections.
1.2
* Added Blu-ray support.
* Added relevant default names for all drivers.
* Renamed driver files to reflect new products.
1.1
* Fixed problem with large touch panel "Back" button.
1.0
* Initial release.
________________________
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Type in the Kaleidescape player's network IP address below.
Version
STRING
true
Status
STRING
Initializing...
true
Debug
LIST
- Off
- Print
- Log
- Print and log
Off
false
-- Video --
STRING
true
Using a Controlled Mask
LIST
- Yes
- No
No
false
-- Movie Zone Volume --
STRING
true
Set Volume Capabilities for Movie Zone
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
-- Music --
STRING
true
Show presets in the list interface
LIST
- Show presets
- Do not show presets
Show presets
false
Zone 1 Status
STRING
true
Save Zone 1 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 1 Volume --
STRING
true
Set Volume Capabilities for Music Zone 1
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
Zone 2 Status
STRING
true
Save Zone 2 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 2 Volume --
STRING
true
Set Volume Capabilities for Music Zone 2
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
Zone 3 Status
STRING
true
Save Zone 3 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 3 Volume --
STRING
true
Set Volume Capabilities for Music Zone 3
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
List presets in Lua tab
List Presets
Force all zones off
Force Off
Favorite Scene Markers
Set the PARAM1 of a favorite scene on NAME
Mark
LIST
- start
- end
Parental Control Mode
Show PARAM1 on OSD of NAME
Set level
LIST
- no password protected selections (safe mode)
- default player selections (default mode)
Instant Replay
Jump playback 15 seconds on NAME
Show an OSD Place
Show the PARAM1 on OSD of NAME
OSD place
LIST
- Movie selections
- Music selections
- Movie List
- Movie Covers
- Movie Collections
- Parental Control
- Music List
- Music Covers
- Music Collections
- Music Now Playing
- System Status
Play a Video Script
Play the script named PARAM1 on NAME
Script name
STRING
Control a Music Zone with OSD
Change the NAME Video to control device with PARAM1 PARAM2, music zone PARAM3
How is this defined
LIST
- Serial Number
- CPDID
Device SN or CPDID
STRING
Zone
RANGED_INTEGER
1
4
Control the default zone with OSD
Change the NAME Video to control its own zone 1
Show Music Zone 1 volume on iPad
RANGED_INTEGER
1
100
Manage Music Preset
PARAM3 preset PARAM2 on NAME Zone PARAM1
Zone Output
RANGED_INTEGER
1
3
Preset Number
RANGED_INTEGER
1
10
Action
LIST
- Store
- Recall
- Press (button)
- Release (button)
media_player
ipod
ipod
ipod
5001
2
6
SATP Interface
False
False
False
False
IPOD
5002
2
6
OSD Interface
False
False
False
False
MEDIA_PLAYER
5003
2
6
SATP Interface
False
False
False
False
IPOD
5004
2
6
SATP Interface
False
False
False
False
IPOD
2000
5
Video - Zone 1
False
True
False
True
COMPOSITE
SVIDEO
COMPONENT
HDMI
4000
6
Audio - Zone 1
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
3001
6
Audio Interconnect Rx for OSD
True
True
False
False
2
True
DIGITAL_COAX
True
DIGITAL_OPTICAL
True
STEREO
True
4002
6
Audio Interconnect Tx for OSD
False
True
True
False
2
True
DIGITAL_COAX
True
DIGITAL_OPTICAL
True
STEREO
True
4001
6
Audio - Zone 2
False
True
True
False
STEREO
4002
6
Audio - Zone 3
False
True
True
False
STEREO
6001
4
6
Kaleidescape Driver IP Connection
True
true
TCP
10000
True
True
True
255
80
False
False
False
255
13d
True
PK UCNWޗ` ` : mediaplayer_ip_kaleidescape_cinemaone (2nd generation).c4i
Kaleidescape Cinema One (2nd generation)
devices_sm/disc_changer.gif
devices_lg/disc_changer.gif
lua_gen
DriverWorks
Audio/Video
Kaleidescape, Inc.
7/2/2013 12:01:00 AM
08/02/2013 10:40:29 AM
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Kaleidescape, Inc.
Cinema One (2nd generation)
100%
100%
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
1.7
Controlled as a Media Player or an iPod.
1
Mask Unknown
NAME Masking ratio is unknown
2
Mask to 1.33
NAME shows 1.33 aspect ratio
3
Mask to 1.66
NAME shows 1.66 aspect ratio
4
Mask to 1.78
NAME shows 1.78 aspect ratio
5
Mask to 1.85
NAME shows 1.85 aspect ratio
6
Mask to 2.35
NAME shows 2.35 aspect ratio
7
Frame 4x3
NAME is displaying a 4x3 video mode
8
Frame 16x9
NAME is displaying a 16x9 video mode
9
Lights to Movie Playing level
NAME is playing a movie
10
Lights to End Credits level
NAME is showing the end credits
11
Lights to Menu level
NAME is showing a menu
12
Lights to Intermission level
NAME is showing an intermission
14
Screen Aspect Ratio 16:9
CinemaScape Mode is off
15
Screen Aspect Ratio CinemaScape 2.35 Anamorphic
CinemaScape Mode is Anamorphic
16
Screen Aspect Ratio CinemaScape 2.35 Letterbox
CinemaScape Mode is Letterbox
17
Screen Aspect Ratio CinemaScape Native 2.35 Display
CinemaScape Mode is Native
18
No Scaling Required
Image requires no scaling
19
CinemaScape Scale Mode Anamorphic
Image requires horizontal stretch
20
CinemaScape Scale Mode Zoom
Image requires zoom
21
Movie Zone Volume Up
Volume Up was received by player
22
Movie Zone Volume Down
Volume Down was received by player
23
Movie Zone Volume Mute
Toggle Mute was received by player
24
Music Zone 1 Volume Up
Volume Up was received by player
25
Music Zone 1 Volume Down
Volume Down was received by player
26
Music Zone 1 Volume Mute
Toggle Mute was received by player
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved.
This is the Kaleidescape driver to control the Cinema One (2nd generation).
Driver version 1.7, created on 08/02/2013 10:40:29 AM.
For more information, refer to the "Kaleidescape Programming Manual for Control4 Controllers" which can be downloaded from:
http://www.kaleidescape.com/files/documentation/Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf
If you require technical assistance with this driver, please contact Kaleidescape technical support at 650-625-6160 or support@kaleidescape.com.
This driver uses a single Media Player proxy to control the Kaleidescape On-Screen Display (OSD), and a single iPod proxy to control music when the OSD is not visible (SATP). Both proxies control the same physical output of the Kaleidescape Cinema One (2nd Generation) (Zone 1).
________________________
CONTENTS
1. Quick Start Guide
2. Driver Properties
3. Programming Interface
4. Release Notes
________________________
1. QUICK START GUIDE
1. Rename the player zones as appropriate.
2. In the Properties tab, set the appropriate properties:
a. indicate if you want this player to remain permanently on. (not available on the Cinema One (1st generation))
b. indicate if you want presets to show in the list interface.
c. indicate if you're using a controlled mask. (not available on the Music Player)
d. indicate if volume control or feedback are needed by player zone. Only set the Movie Zone Volume or Music Zone 1 Volume, do not set both.
3. Define the IP connection in the IP Network Connection pane to match the player this driver is to control. Note that the player MUST be set to use a fixed IP address.
4. Set up all the A/V connections for the player.
5. Configure any Music Preset Buttons in the Programming View.
6. Define any other Scripts in the Programming View:
a. script to modify the lights at various movie points. (not available on the Music Player)
b. script to set the proper screen mask for an automated masking system. (not available on the Music Player)
c. scripts to trigger volume commands and send volume level and mute feedback to an iPad running the Kaleidescape App for iPad.
________________________
2. PROPERTIES
Not all properties are available on all drivers and some properties are repeated per zone. All interfaces for the same device show the same properties (i.e., the Media Player and iPod show as separate entities on the same player, but share the same properties).
* Version
A read-only field showing the version of the driver as reported by the Lua script.
* Status
A read-only field showing the connection status of the driver and standby status of the player.
* Debug
Turns on and off debugging messages. Messages may be sent to the Control4 system log (log), to the Lua tab (print), or both. Debugging is automatically set to "Off" after 15 minutes as it will affect system performance.
* Power
Indicates if the player should be permanently left on or allowed to enter standby (power off).
* Using a Controlled Mask
Set to "Yes" if the video output will be masked down either with a screen masking system or with a 2.35 lens. This setting will pull the system messages and subtitles out of the masked portion of the video.
* Set Volume Capabilities for Movie Zone
Indicates which volume buttons and feedback will be used for the movie zone.
* Show presets in the list interface
Indicate if the music presets should be listed in the SATP (iPod) interface. When shown, presets are listed by their name (i.e., "Jazz", "The White Album", or "The Rolling Stones") rather than by number, and blank presets are skipped.
* Zone n Status
A read-only field showing the state of the music zone number "n". This will indicate what music item is currently playing.
* Save Zone n Playing Music
This is actually a control that will save the playing music item in zone number "n" (indicated by the Zone n Status) to the selected preset. To view what presets are saved, use the "List presets in Lua tab" button on the "Actions" tab, then view the presets on the "Lua" tab.
* Set Volume Capabilities for Music Zone n
Indicates which volume buttons and feedback will be used for the music zone number "n". If volume capabilities are set for the Movie Zone, do not set volume capabilities for music zone 1.
________________________
3. PROGRAMMING INTERFACE
All Events and Actions described here are available through the "Programming" view in Control4 Composer. Events show in the left pane, Actions show in the right pane. Variables show as child objects of the device interface and each is available as an Event ("Changed") a Conditional ("If value") a Loop ("While value") and a Command ("Set value") -- though many are read-only.
EVENTS -- OSD
-------------
* Power On
The zone has powered on.
* Power Off
The zone has powered off.
* Play
The zone is playing content.
* Stop
The zone is not playing content.
* Pause
The content is paused.
* Mask to ___
Triggers when the playing content is using this aspect ratio -- either 1.33, 1.66, 1.78, 1.85, or 2.35. Use these events to trigger an automated screen masking system or an anamorphic lens. Note that this is different than the Frame -- a 2.35 movie has black bars encoded in the content to make it fit in a 16X9 frame.
* Frame ___
Triggers when the video mode is showing this frame ratio -- either 4X3 or 16X9. Use these events to trigger video mode changes in a display device when needed.
* Lights to ___ level
Triggers at one of these events -- either "Movie Playing", "End Credits", "Menu" or "Intermission". The "Lights to Menu level" will trigger when showing a Kaleidescape OSD place or for most DVD menus. "Lights to Movie Playing" will trigger when showing the main content. "Lights to End Credits" will trigger when the end credits are shown. "Lights to Intermission" will trigger when the intermission is invoked.
* Screen Aspect Ratio ___
Triggers to indicate which CinemaScape mode the player is set to.
* CinemaScape Scale Mode___
If CinemaScape mode is enabled, scale mode triggers to indicate what type of scaling (if any) is required.
* Movie Zone Volume ___,
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
EVENTS -- SATP
--------------
* Docked
The zone has powered on.
* Undocked
The zone has powered off.
* Play
The zone is playing music.
* Stop
The zone is not playing music.
* Pause
The music is paused.
* Music Zone n Volume ___
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
ACTIONS -- OSD Commands
-----------------------
* Power On
Turn the zone on.
* Power Off
Turn the zone off.
* Play/Stop/Pause/Scan Fwd/Scan Rev/Skip Fwd/Skip Rev
Performs the indicated transport command.
* Menu/Up/Down/Left/Right/Enter
Performs the indicated command. Menu will engage the DVD menu when in movie playback and toggle the Kaleidescape menu otherwise.
* Keypad ___
Sends the indicated keypad key. Will not strictly send the indicated number command, but will sometimes perform as an alpha-key depending on what is showing on the OSD.
During DVD playback, the # key will begin the chapter entry and the next two keys (and enter) will select a chapter.
* Favorite Scene Markers
Sets the begin and end point of a favorite scene during movie playback. These commands are also available through the Kaleidescape OSD Info menu during playback.
* Parental Control Mode
Enable "Safe" or "Default" mode of the player. On a Premiere Line system the player's default level is set in the Kaleidescape web utility. On a Cinema Line system the default level is set in the OSD. The safe mode is the least restrictive mode without a password.
Neither command will change the mode to a less restrictive level. For example, if the default mode is "R and below" but the player is only showing "G and below" content, the "Default" command will perform no action.
* Instant Replay
Skip back 5 seconds in the movie.
* Show an OSD Place
Set the OSD to the specified place. The "Movie Selections" will show a movie place and the "Music Selections" will show a music place. "System Status" will show the system status page. All other selections will invoke the specifically indicated movie or music place.
* Play a Video Script
Play the specified Kaleidescape script; the "Script name" is case sensitive. Scripts are created and edited in the Kaleidescape web utility. This may be used to play a custom theater introduction every time the system is powered on. Scripts are only available on Premiere Line systems.
* Control a Music Zone with OSD
Sets the OSD to control a different music zone. Control Zone commands are only available on Premiere Line systems. See the section on Music Zone Control for more information.
* Control the default zone with OSD
Returns the OSD to controlling the default music zone; essentially reverts from the above command. See the section on Music Zone Control for more information.
ACTIONS -- SATP Commands
------------------------
* Transport Control Commands
Performs the indicated command.
* Shuffle Off
Disables the "Random" mode. Note that some playing items will always play randomly and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Shuffle Songs/Albums
Enables the "Random" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Repeat Off
Disables the "Repeat" mode. Note that some playing items will always repeat and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Repeat One Track/All Tracks
Enables the "Repeat" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Manage Music Preset
Stores a preset, recalls a preset, perform a preset button press or release. See the section on Using Music Presets for more information.
VARIABLES -- OSD
----------------
* POWER_STATE
True or false value. Indicates the power state of the zone.
* OSD Intermission
True or false value. Indicates the intermission state of the zone. Can be set to "True" to engage intermission or to "False" to clear it.
* OSD Screen Saver
True or false value. Indicates the screen saver state. Can be set to "True" to engage the screen saver or to "False" to clear it.
* CinemaScape Mask
When the player is in CinemaScape Mode, indicates the aspect ratio of the current image. Possible values are from 0 to 999, for example 133 corresponds to 4:3 or 1.33 video. This value can be used to determine proper screen masking position.
* Movie Zone Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad
* Movie Zone Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad.
VARIABLES -- SATP
-----------------
* IPOD
Text value. Indicates the name of the music zone as set in the Kaleidescape web utility.
* TITLE
Text value. Indicates the title of the currently playing track.
* ARTIST
Text value. Indicates the artist for the currently playing track.
* ALBUM
Text value. Indicates the album for the currently playing track.
* PLAY_STATUS
Text value -- either "Playing", "Stopped" or "Paused".
* Music Zone __ Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Level, do not connect Music Zone 1 Volume Level.
* Music Zone __ Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Mute, do not connect Music Zone 1 Volume Mute.
* Music Preset Button Lockout
True or false value. When true, preset button events will not be able to save a preset on this device. Can be set to "True" or "False".
* Zone n -- Music Preset ___ status
True or false value -- read only. Indicates the status of the preset in zone n. If preset 6 is playing in zone 2, "Zone 2 -- Music Preset 6 status" will be true. Note that several presets can be active simultaneously in the same zone.
________________________
4. RELEASE NOTES
Known issues
------------
* The icon used for control of music zones is an iPod in a dock.
* An eject button is provided when controlling a movie zone, although no eject command is available for the Kaleidescape Player. Pressing the eject button selects the Kaleidescape Menu, from which the Disc tab can be accessed if a disc is in the tray.
* No cover art is provided to touch screens.
* The Kaleidescape driver iPod proxy always shows the Control4 logo in Control4 Composer.
* The Media Player interface (OSD control) audio connections show up on the iPod interface (SATP control).
* If the Movie Player Driver is used to control the (discontinued) KPLAYER-2000, a non-existent HDMI output will be available.
* Improper Events and Actions are shown on the Movie Zone (OSD) and Music Zone (SATP) interfaces. For example, the SATP interface has an Action for Video Frame 4X3 and shows a Variable for OSD Screen Saver.
* The Cinema One (1st generation) driver shows events for CinemaScape Mode and CinemaScape Mask. CinemaScape is only supported on the M-Class Players and Vaults, and the Cinema Line Cinema One.
Versions
--------
1.7
* Created driver for the Cinema One (2nd generation).
1.6
* Fixed problem with module reconnecting to player when player temporarily drops off the network.
1.5
* Support for Volume control.
1.4
* Support for CinemaScape.
1.3
* Support for Composer 2.1.
* Support for Search and Jump in OSD Collections.
1.2
* Added Blu-ray support.
* Added relevant default names for all drivers.
* Renamed driver files to reflect new products.
1.1
* Fixed problem with large touch panel "Back" button.
1.0
* Initial release.
________________________
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Type in the Kaleidescape player's network IP address below.
Version
STRING
true
Status
STRING
Initializing...
true
Debug
LIST
- Off
- Print
- Log
- Print and log
Off
false
Power
LIST
- Allow user to power off
- Always leave player on
Allow user to power off
false
-- Video --
STRING
true
Using a Controlled Mask
LIST
- Yes
- No
No
false
-- Movie Zone Volume --
STRING
true
Set Volume Capabilities for Movie Zone
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
-- Music --
STRING
true
Show presets in the list interface
LIST
- Show presets
- Do not show presets
Show presets
false
Zone 1 Status
STRING
true
Save Zone 1 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 1 Volume --
STRING
true
Set Volume Capabilities for Music Zone 1
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
List presets in Lua tab
List Presets
Force all zones off
Force Off
Favorite Scene Markers
Set the PARAM1 of a favorite scene on NAME
Mark
LIST
- start
- end
Parental Control Mode
Show PARAM1 on OSD of NAME
Set level
LIST
- no password protected selections (safe mode)
- default player selections (default mode)
Instant Replay
Jump playback 15 seconds on NAME
Show an OSD Place
Show the PARAM1 on OSD of NAME
OSD place
LIST
- Movie selections
- Music selections
- Movie List
- Movie Covers
- Movie Collections
- Parental Control
- Music List
- Music Covers
- Music Collections
- Music Now Playing
- System Status
Play a Video Script
Play the script named PARAM1 on NAME
Script name
STRING
Control a Music Zone with OSD
Change the NAME Video to control device with PARAM1 PARAM2, music zone PARAM3
How is this defined
LIST
- Serial Number
- CPDID
Device SN or CPDID
STRING
Zone
RANGED_INTEGER
1
4
Control the default zone with OSD
Change the NAME Video to control its own zone 1
Manage Music Preset
PARAM3 preset PARAM2 on NAME Zone PARAM1
Zone Output
RANGED_INTEGER
1
1
Preset Number
RANGED_INTEGER
1
10
Action
LIST
- Store
- Recall
- Press (button)
- Release (button)
media_player
ipod
5001
2
6
SATP Interface
False
False
False
False
IPOD
5002
2
6
OSD Interface
False
False
False
False
MEDIA_PLAYER
2000
5
Video - Zone 1
False
True
False
True
HDMI
4000
6
Audio - Zone 1
False
True
True
False
DIGITAL_COAX
STEREO
3001
6
Audio Interconnect Rx for OSD
True
True
False
False
2
True
DIGITAL_COAX
True
STEREO
True
4002
6
Audio Interconnect Tx for OSD
False
True
True
False
2
True
DIGITAL_COAX
True
STEREO
True
6001
4
6
Kaleidescape Driver IP Connection
True
true
TCP
10000
True
True
True
255
80
False
False
False
255
13d
True
PK UC-Qw_ab ab * mediaplayer_ip_kaleidescape_miniplayer.c4i
Kaleidescape M300 Player
devices_sm/disc_changer.gif
devices_lg/disc_changer.gif
lua_gen
DriverWorks
Audio/Video
Kaleidescape, Inc.
4/1/2009 12:01:00 AM
08/02/2013 10:40:29 AM
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Kaleidescape, Inc.
KPLAYER-M300, KPLAYER-300
100%
100%
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
1.7
Controlled as a Media Player or an iPod.
1
Mask Unknown
NAME Masking ratio is unknown
2
Mask to 1.33
NAME shows 1.33 aspect ratio
3
Mask to 1.66
NAME shows 1.66 aspect ratio
4
Mask to 1.78
NAME shows 1.78 aspect ratio
5
Mask to 1.85
NAME shows 1.85 aspect ratio
6
Mask to 2.35
NAME shows 2.35 aspect ratio
7
Frame 4x3
NAME is displaying a 4x3 video mode
8
Frame 16x9
NAME is displaying a 16x9 video mode
9
Lights to Movie Playing level
NAME is playing a movie
10
Lights to End Credits level
NAME is showing the end credits
11
Lights to Menu level
NAME is showing a menu
12
Lights to Intermission level
NAME is showing an intermission
14
Screen Aspect Ratio 16:9
CinemaScape Mode is off
15
Screen Aspect Ratio CinemaScape 2.35 Anamorphic
CinemaScape Mode is Anamorphic
16
Screen Aspect Ratio CinemaScape 2.35 Letterbox
CinemaScape Mode is Letterbox
17
Screen Aspect Ratio CinemaScape Native 2.35 Display
CinemaScape Mode is Native
18
No Scaling Required
Image requires no scaling
19
CinemaScape Scale Mode Anamorphic
Image requires horizontal stretch
20
CinemaScape Scale Mode Zoom
Image requires zoom
21
Movie Zone Volume Up
Volume Up was received by player
22
Movie Zone Volume Down
Volume Down was received by player
23
Movie Zone Volume Mute
Toggle Mute was received by player
24
Music Zone 1 Volume Up
Volume Up was received by player
25
Music Zone 1 Volume Down
Volume Down was received by player
26
Music Zone 1 Volume Mute
Toggle Mute was received by player
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved.
This is the Kaleidescape driver to control the M300 Player.
Driver version 1.7, created on 08/02/2013 10:40:29 AM.
For more information, refer to the "Kaleidescape Programming Manual for Control4 Controllers" which can be downloaded from:
http://www.kaleidescape.com/files/documentation/Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf
If you require technical assistance with this driver, please contact Kaleidescape technical support at 650-625-6160 or support@kaleidescape.com.
This driver uses a single Media Player proxy to control the Kaleidescape On-Screen Display (OSD), and a single iPod proxy to control music when the OSD is not visible (SATP). Both proxies control the same physical output of the Kaleidescape player (Zone 1).
________________________
CONTENTS
1. Quick Start Guide
2. Driver Properties
3. Programming Interface
4. Release Notes
________________________
1. QUICK START GUIDE
1. Rename the player zones as appropriate.
2. In the Properties tab, set the appropriate properties:
a. indicate if you want this player to remain permanently on. (not available on the Cinema One (1st generation))
b. indicate if you want presets to show in the list interface.
c. indicate if you're using a controlled mask. (not available on the Music Player)
d. indicate if volume control or feedback are needed by player zone. Only set the Movie Zone Volume or Music Zone 1 Volume, do not set both.
3. Define the IP connection in the IP Network Connection pane to match the player this driver is to control. Note that the player MUST be set to use a fixed IP address.
4. Set up all the A/V connections for the player.
5. Configure any Music Preset Buttons in the Programming View.
6. Define any other Scripts in the Programming View:
a. script to modify the lights at various movie points. (not available on the Music Player)
b. script to set the proper screen mask for an automated masking system. (not available on the Music Player)
c. scripts to trigger volume commands and send volume level and mute feedback to an iPad running the Kaleidescape App for iPad.
________________________
2. PROPERTIES
Not all properties are available on all drivers and some properties are repeated per zone. All interfaces for the same device show the same properties (i.e., the Media Player and iPod show as separate entities on the same player, but share the same properties).
* Version
A read-only field showing the version of the driver as reported by the Lua script.
* Status
A read-only field showing the connection status of the driver and standby status of the player.
* Debug
Turns on and off debugging messages. Messages may be sent to the Control4 system log (log), to the Lua tab (print), or both. Debugging is automatically set to "Off" after 15 minutes as it will affect system performance.
* Power
Indicates if the player should be permanently left on or allowed to enter standby (power off).
* Using a Controlled Mask
Set to "Yes" if the video output will be masked down either with a screen masking system or with a 2.35 lens. This setting will pull the system messages and subtitles out of the masked portion of the video.
* Set Volume Capabilities for Movie Zone
Indicates which volume buttons and feedback will be used for the movie zone.
* Show presets in the list interface
Indicate if the music presets should be listed in the SATP (iPod) interface. When shown, presets are listed by their name (i.e., "Jazz", "The White Album", or "The Rolling Stones") rather than by number, and blank presets are skipped.
* Zone n Status
A read-only field showing the state of the music zone number "n". This will indicate what music item is currently playing.
* Save Zone n Playing Music
This is actually a control that will save the playing music item in zone number "n" (indicated by the Zone n Status) to the selected preset. To view what presets are saved, use the "List presets in Lua tab" button on the "Actions" tab, then view the presets on the "Lua" tab.
* Set Volume Capabilities for Music Zone n
Indicates which volume buttons and feedback will be used for the music zone number "n". If volume capabilities are set for the Movie Zone, do not set volume capabilities for music zone 1.
________________________
3. PROGRAMMING INTERFACE
All Events and Actions described here are available through the "Programming" view in Control4 Composer. Events show in the left pane, Actions show in the right pane. Variables show as child objects of the device interface and each is available as an Event ("Changed") a Conditional ("If value") a Loop ("While value") and a Command ("Set value") -- though many are read-only.
EVENTS -- OSD
-------------
* Power On
The zone has powered on.
* Power Off
The zone has powered off.
* Play
The zone is playing content.
* Stop
The zone is not playing content.
* Pause
The content is paused.
* Mask to ___
Triggers when the playing content is using this aspect ratio -- either 1.33, 1.66, 1.78, 1.85, or 2.35. Use these events to trigger an automated screen masking system or an anamorphic lens. Note that this is different than the Frame -- a 2.35 movie has black bars encoded in the content to make it fit in a 16X9 frame.
* Frame ___
Triggers when the video mode is showing this frame ratio -- either 4X3 or 16X9. Use these events to trigger video mode changes in a display device when needed.
* Lights to ___ level
Triggers at one of these events -- either "Movie Playing", "End Credits", "Menu" or "Intermission". The "Lights to Menu level" will trigger when showing a Kaleidescape OSD place or for most DVD menus. "Lights to Movie Playing" will trigger when showing the main content. "Lights to End Credits" will trigger when the end credits are shown. "Lights to Intermission" will trigger when the intermission is invoked.
* Screen Aspect Ratio ___
Triggers to indicate which CinemaScape mode the player is set to.
* CinemaScape Scale Mode___
If CinemaScape mode is enabled, scale mode triggers to indicate what type of scaling (if any) is required.
* Movie Zone Volume ___,
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
EVENTS -- SATP
--------------
* Docked
The zone has powered on.
* Undocked
The zone has powered off.
* Play
The zone is playing music.
* Stop
The zone is not playing music.
* Pause
The music is paused.
* Music Zone n Volume ___
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
ACTIONS -- OSD Commands
-----------------------
* Power On
Turn the zone on.
* Power Off
Turn the zone off.
* Play/Stop/Pause/Scan Fwd/Scan Rev/Skip Fwd/Skip Rev
Performs the indicated transport command.
* Menu/Up/Down/Left/Right/Enter
Performs the indicated command. Menu will engage the DVD menu when in movie playback and toggle the Kaleidescape menu otherwise.
* Keypad ___
Sends the indicated keypad key. Will not strictly send the indicated number command, but will sometimes perform as an alpha-key depending on what is showing on the OSD.
During DVD playback, the # key will begin the chapter entry and the next two keys (and enter) will select a chapter.
* Favorite Scene Markers
Sets the begin and end point of a favorite scene during movie playback. These commands are also available through the Kaleidescape OSD Info menu during playback.
* Parental Control Mode
Enable "Safe" or "Default" mode of the player. On a Premiere Line system the player's default level is set in the Kaleidescape web utility. On a Cinema Line system the default level is set in the OSD. The safe mode is the least restrictive mode without a password.
Neither command will change the mode to a less restrictive level. For example, if the default mode is "R and below" but the player is only showing "G and below" content, the "Default" command will perform no action.
* Instant Replay
Skip back 5 seconds in the movie.
* Show an OSD Place
Set the OSD to the specified place. The "Movie Selections" will show a movie place and the "Music Selections" will show a music place. "System Status" will show the system status page. All other selections will invoke the specifically indicated movie or music place.
* Play a Video Script
Play the specified Kaleidescape script; the "Script name" is case sensitive. Scripts are created and edited in the Kaleidescape web utility. This may be used to play a custom theater introduction every time the system is powered on. Scripts are only available on Premiere Line systems.
* Control a Music Zone with OSD
Sets the OSD to control a different music zone. Control Zone commands are only available on Premiere Line systems. See the section on Music Zone Control for more information.
* Control the default zone with OSD
Returns the OSD to controlling the default music zone; essentially reverts from the above command. See the section on Music Zone Control for more information.
ACTIONS -- SATP Commands
------------------------
* Transport Control Commands
Performs the indicated command.
* Shuffle Off
Disables the "Random" mode. Note that some playing items will always play randomly and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Shuffle Songs/Albums
Enables the "Random" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Repeat Off
Disables the "Repeat" mode. Note that some playing items will always repeat and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Repeat One Track/All Tracks
Enables the "Repeat" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Manage Music Preset
Stores a preset, recalls a preset, perform a preset button press or release. See the section on Using Music Presets for more information.
VARIABLES -- OSD
----------------
* POWER_STATE
True or false value. Indicates the power state of the zone.
* OSD Intermission
True or false value. Indicates the intermission state of the zone. Can be set to "True" to engage intermission or to "False" to clear it.
* OSD Screen Saver
True or false value. Indicates the screen saver state. Can be set to "True" to engage the screen saver or to "False" to clear it.
* CinemaScape Mask
When the player is in CinemaScape Mode, indicates the aspect ratio of the current image. Possible values are from 0 to 999, for example 133 corresponds to 4:3 or 1.33 video. This value can be used to determine proper screen masking position.
* Movie Zone Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad
* Movie Zone Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad.
VARIABLES -- SATP
-----------------
* IPOD
Text value. Indicates the name of the music zone as set in the Kaleidescape web utility.
* TITLE
Text value. Indicates the title of the currently playing track.
* ARTIST
Text value. Indicates the artist for the currently playing track.
* ALBUM
Text value. Indicates the album for the currently playing track.
* PLAY_STATUS
Text value -- either "Playing", "Stopped" or "Paused".
* Music Zone __ Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Level, do not connect Music Zone 1 Volume Level.
* Music Zone __ Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Mute, do not connect Music Zone 1 Volume Mute.
* Music Preset Button Lockout
True or false value. When true, preset button events will not be able to save a preset on this device. Can be set to "True" or "False".
* Zone n -- Music Preset ___ status
True or false value -- read only. Indicates the status of the preset in zone n. If preset 6 is playing in zone 2, "Zone 2 -- Music Preset 6 status" will be true. Note that several presets can be active simultaneously in the same zone.
________________________
4. RELEASE NOTES
Known issues
------------
* The icon used for control of music zones is an iPod in a dock.
* An eject button is provided when controlling a movie zone, although no eject command is available for the Kaleidescape Player. Pressing the eject button selects the Kaleidescape Menu, from which the Disc tab can be accessed if a disc is in the tray.
* No cover art is provided to touch screens.
* The Kaleidescape driver iPod proxy always shows the Control4 logo in Control4 Composer.
* The Media Player interface (OSD control) audio connections show up on the iPod interface (SATP control).
* If the Movie Player Driver is used to control the (discontinued) KPLAYER-2000, a non-existent HDMI output will be available.
* Improper Events and Actions are shown on the Movie Zone (OSD) and Music Zone (SATP) interfaces. For example, the SATP interface has an Action for Video Frame 4X3 and shows a Variable for OSD Screen Saver.
* The Cinema One (1st generation) driver shows events for CinemaScape Mode and CinemaScape Mask. CinemaScape is only supported on the M-Class Players and Vaults, and the Cinema Line Cinema One.
Versions
--------
1.7
* Created driver for the Cinema One (2nd generation).
1.6
* Fixed problem with module reconnecting to player when player temporarily drops off the network.
1.5
* Support for Volume control.
1.4
* Support for CinemaScape.
1.3
* Support for Composer 2.1.
* Support for Search and Jump in OSD Collections.
1.2
* Added Blu-ray support.
* Added relevant default names for all drivers.
* Renamed driver files to reflect new products.
1.1
* Fixed problem with large touch panel "Back" button.
1.0
* Initial release.
________________________
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Type in the Kaleidescape player's network IP address below.
Version
STRING
true
Status
STRING
Initializing...
true
Debug
LIST
- Off
- Print
- Log
- Print and log
Off
false
Power
LIST
- Allow user to power off
- Always leave player on
Allow user to power off
false
-- Video --
STRING
true
Using a Controlled Mask
LIST
- Yes
- No
No
false
-- Movie Zone Volume --
STRING
true
Set Volume Capabilities for Movie Zone
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
-- Music --
STRING
true
Show presets in the list interface
LIST
- Show presets
- Do not show presets
Show presets
false
Zone 1 Status
STRING
true
Save Zone 1 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 1 Volume --
STRING
true
Set Volume Capabilities for Music Zone 1
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
List presets in Lua tab
List Presets
Force all zones off
Force Off
Favorite Scene Markers
Set the PARAM1 of a favorite scene on NAME
Mark
LIST
- start
- end
Parental Control Mode
Show PARAM1 on OSD of NAME
Set level
LIST
- no password protected selections (safe mode)
- default player selections (default mode)
Instant Replay
Jump playback 15 seconds on NAME
Show an OSD Place
Show the PARAM1 on OSD of NAME
OSD place
LIST
- Movie selections
- Music selections
- Movie List
- Movie Covers
- Movie Collections
- Parental Control
- Music List
- Music Covers
- Music Collections
- Music Now Playing
- System Status
Play a Video Script
Play the script named PARAM1 on NAME
Script name
STRING
Control a Music Zone with OSD
Change the NAME Video to control device with PARAM1 PARAM2, music zone PARAM3
How is this defined
LIST
- Serial Number
- CPDID
Device SN or CPDID
STRING
Zone
RANGED_INTEGER
1
4
Control the default zone with OSD
Change the NAME Video to control its own zone 1
Manage Music Preset
PARAM3 preset PARAM2 on NAME Zone PARAM1
Zone Output
RANGED_INTEGER
1
1
Preset Number
RANGED_INTEGER
1
10
Action
LIST
- Store
- Recall
- Press (button)
- Release (button)
media_player
ipod
5001
2
6
SATP Interface
False
False
False
False
IPOD
5002
2
6
OSD Interface
False
False
False
False
MEDIA_PLAYER
2000
5
Video - Zone 1
False
True
False
True
COMPOSITE
COMPONENT
HDMI
4000
6
Audio - Zone 1
False
True
True
False
DIGITAL_COAX
STEREO
3001
6
Audio Interconnect Rx for OSD
True
True
False
False
2
True
DIGITAL_COAX
True
STEREO
True
4002
6
Audio Interconnect Tx for OSD
False
True
True
False
2
True
DIGITAL_COAX
True
STEREO
True
6001
4
6
Kaleidescape Driver IP Connection
True
true
TCP
10000
True
True
True
255
80
False
False
False
255
13d
True
PK UCA A + mediaplayer_ip_kaleidescape_musicplayer.c4i
Kaleidescape Music Player
devices_sm/disc_changer.gif
devices_lg/disc_changer.gif
lua_gen
DriverWorks
Audio/Video
Kaleidescape, Inc.
4/1/2009 12:01:00 AM
08/02/2013 10:40:29 AM
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Kaleidescape, Inc.
KMUSIC-4000
100%
100%
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
1.7
Controlled as an iPod.
Controlled as an iPod.
Controlled as an iPod.
Controlled as an iPod.
24
Music Zone 1 Volume Up
Volume Up was received by player
25
Music Zone 1 Volume Down
Volume Down was received by player
26
Music Zone 1 Volume Mute
Toggle Mute was received by player
27
Music Zone 2 Volume Up
Volume Up was received by player
28
Music Zone 2 Volume Down
Volume Down was received by player
29
Music Zone 2 Volume Mute
Toggle Mute was received by player
30
Music Zone 3 Volume Up
Volume Up was received by player
31
Music Zone 3 Volume Down
Volume Down was received by player
32
Music Zone 3 Volume Mute
Toggle Mute was received by player
33
Music Zone 4 Volume Up
Volume Up was received by player
34
Music Zone 4 Volume Down
Volume Down was received by player
35
Music Zone 4 Volume Mute
Toggle Mute was received by player
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved.
This is the Kaleidescape driver to control the Music Player.
Driver version 1.7, created on 08/02/2013 10:40:29 AM.
For more information, refer to the "Kaleidescape Programming Manual for Control4 Controllers" which can be downloaded from:
http://www.kaleidescape.com/files/documentation/Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf
If you require technical assistance with this driver, please contact Kaleidescape technical support at 650-625-6160 or support@kaleidescape.com.
This driver uses four iPod proxies (SATP) to control the four independent music-only outputs (Zones 1 through 4). The Music Player does not have any video output, and this driver does not provide any OSD control. The Media Player proxy does not provide any control.
________________________
CONTENTS
1. Quick Start Guide
2. Driver Properties
3. Programming Interface
4. Release Notes
________________________
1. QUICK START GUIDE
1. Rename the player zones as appropriate.
2. In the Properties tab, set the appropriate properties:
a. indicate if you want this player to remain permanently on. (not available on the Cinema One (1st generation))
b. indicate if you want presets to show in the list interface.
c. indicate if you're using a controlled mask. (not available on the Music Player)
d. indicate if volume control or feedback are needed by player zone. Only set the Movie Zone Volume or Music Zone 1 Volume, do not set both.
3. Define the IP connection in the IP Network Connection pane to match the player this driver is to control. Note that the player MUST be set to use a fixed IP address.
4. Set up all the A/V connections for the player.
5. Configure any Music Preset Buttons in the Programming View.
6. Define any other Scripts in the Programming View:
a. script to modify the lights at various movie points. (not available on the Music Player)
b. script to set the proper screen mask for an automated masking system. (not available on the Music Player)
c. scripts to trigger volume commands and send volume level and mute feedback to an iPad running the Kaleidescape App for iPad.
________________________
2. PROPERTIES
Not all properties are available on all drivers and some properties are repeated per zone. All interfaces for the same device show the same properties (i.e., the Media Player and iPod show as separate entities on the same player, but share the same properties).
* Version
A read-only field showing the version of the driver as reported by the Lua script.
* Status
A read-only field showing the connection status of the driver and standby status of the player.
* Debug
Turns on and off debugging messages. Messages may be sent to the Control4 system log (log), to the Lua tab (print), or both. Debugging is automatically set to "Off" after 15 minutes as it will affect system performance.
* Power
Indicates if the player should be permanently left on or allowed to enter standby (power off).
* Using a Controlled Mask
Set to "Yes" if the video output will be masked down either with a screen masking system or with a 2.35 lens. This setting will pull the system messages and subtitles out of the masked portion of the video.
* Set Volume Capabilities for Movie Zone
Indicates which volume buttons and feedback will be used for the movie zone.
* Show presets in the list interface
Indicate if the music presets should be listed in the SATP (iPod) interface. When shown, presets are listed by their name (i.e., "Jazz", "The White Album", or "The Rolling Stones") rather than by number, and blank presets are skipped.
* Zone n Status
A read-only field showing the state of the music zone number "n". This will indicate what music item is currently playing.
* Save Zone n Playing Music
This is actually a control that will save the playing music item in zone number "n" (indicated by the Zone n Status) to the selected preset. To view what presets are saved, use the "List presets in Lua tab" button on the "Actions" tab, then view the presets on the "Lua" tab.
* Set Volume Capabilities for Music Zone n
Indicates which volume buttons and feedback will be used for the music zone number "n". If volume capabilities are set for the Movie Zone, do not set volume capabilities for music zone 1.
________________________
3. PROGRAMMING INTERFACE
All Events and Actions described here are available through the "Programming" view in Control4 Composer. Events show in the left pane, Actions show in the right pane. Variables show as child objects of the device interface and each is available as an Event ("Changed") a Conditional ("If value") a Loop ("While value") and a Command ("Set value") -- though many are read-only.
EVENTS -- OSD
-------------
* Power On
The zone has powered on.
* Power Off
The zone has powered off.
* Play
The zone is playing content.
* Stop
The zone is not playing content.
* Pause
The content is paused.
* Mask to ___
Triggers when the playing content is using this aspect ratio -- either 1.33, 1.66, 1.78, 1.85, or 2.35. Use these events to trigger an automated screen masking system or an anamorphic lens. Note that this is different than the Frame -- a 2.35 movie has black bars encoded in the content to make it fit in a 16X9 frame.
* Frame ___
Triggers when the video mode is showing this frame ratio -- either 4X3 or 16X9. Use these events to trigger video mode changes in a display device when needed.
* Lights to ___ level
Triggers at one of these events -- either "Movie Playing", "End Credits", "Menu" or "Intermission". The "Lights to Menu level" will trigger when showing a Kaleidescape OSD place or for most DVD menus. "Lights to Movie Playing" will trigger when showing the main content. "Lights to End Credits" will trigger when the end credits are shown. "Lights to Intermission" will trigger when the intermission is invoked.
* Screen Aspect Ratio ___
Triggers to indicate which CinemaScape mode the player is set to.
* CinemaScape Scale Mode___
If CinemaScape mode is enabled, scale mode triggers to indicate what type of scaling (if any) is required.
* Movie Zone Volume ___,
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
EVENTS -- SATP
--------------
* Docked
The zone has powered on.
* Undocked
The zone has powered off.
* Play
The zone is playing music.
* Stop
The zone is not playing music.
* Pause
The music is paused.
* Music Zone n Volume ___
Triggers to indicate the corresponding player zone has received a volume up command. These triggers can be connected to the corresponding volume actions for a room or other device that controls volume. If the events are connected to a room, the event will not pass through the room unless the room is powered on.
ACTIONS -- OSD Commands
-----------------------
* Power On
Turn the zone on.
* Power Off
Turn the zone off.
* Play/Stop/Pause/Scan Fwd/Scan Rev/Skip Fwd/Skip Rev
Performs the indicated transport command.
* Menu/Up/Down/Left/Right/Enter
Performs the indicated command. Menu will engage the DVD menu when in movie playback and toggle the Kaleidescape menu otherwise.
* Keypad ___
Sends the indicated keypad key. Will not strictly send the indicated number command, but will sometimes perform as an alpha-key depending on what is showing on the OSD.
During DVD playback, the # key will begin the chapter entry and the next two keys (and enter) will select a chapter.
* Favorite Scene Markers
Sets the begin and end point of a favorite scene during movie playback. These commands are also available through the Kaleidescape OSD Info menu during playback.
* Parental Control Mode
Enable "Safe" or "Default" mode of the player. On a Premiere Line system the player's default level is set in the Kaleidescape web utility. On a Cinema Line system the default level is set in the OSD. The safe mode is the least restrictive mode without a password.
Neither command will change the mode to a less restrictive level. For example, if the default mode is "R and below" but the player is only showing "G and below" content, the "Default" command will perform no action.
* Instant Replay
Skip back 5 seconds in the movie.
* Show an OSD Place
Set the OSD to the specified place. The "Movie Selections" will show a movie place and the "Music Selections" will show a music place. "System Status" will show the system status page. All other selections will invoke the specifically indicated movie or music place.
* Play a Video Script
Play the specified Kaleidescape script; the "Script name" is case sensitive. Scripts are created and edited in the Kaleidescape web utility. This may be used to play a custom theater introduction every time the system is powered on. Scripts are only available on Premiere Line systems.
* Control a Music Zone with OSD
Sets the OSD to control a different music zone. Control Zone commands are only available on Premiere Line systems. See the section on Music Zone Control for more information.
* Control the default zone with OSD
Returns the OSD to controlling the default music zone; essentially reverts from the above command. See the section on Music Zone Control for more information.
ACTIONS -- SATP Commands
------------------------
* Transport Control Commands
Performs the indicated command.
* Shuffle Off
Disables the "Random" mode. Note that some playing items will always play randomly and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Shuffle Songs/Albums
Enables the "Random" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Repeat Off
Disables the "Repeat" mode. Note that some playing items will always repeat and this command will have no affect when those items are playing. See Music Items in the Kaleidescape System for more information.
* Repeat One Track/All Tracks
Enables the "Repeat" mode. The Kaleidescape System does not distinguish between these two modes; they are identical.
* Manage Music Preset
Stores a preset, recalls a preset, perform a preset button press or release. See the section on Using Music Presets for more information.
VARIABLES -- OSD
----------------
* POWER_STATE
True or false value. Indicates the power state of the zone.
* OSD Intermission
True or false value. Indicates the intermission state of the zone. Can be set to "True" to engage intermission or to "False" to clear it.
* OSD Screen Saver
True or false value. Indicates the screen saver state. Can be set to "True" to engage the screen saver or to "False" to clear it.
* CinemaScape Mask
When the player is in CinemaScape Mode, indicates the aspect ratio of the current image. Possible values are from 0 to 999, for example 133 corresponds to 4:3 or 1.33 video. This value can be used to determine proper screen masking position.
* Movie Zone Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad
* Movie Zone Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad.
VARIABLES -- SATP
-----------------
* IPOD
Text value. Indicates the name of the music zone as set in the Kaleidescape web utility.
* TITLE
Text value. Indicates the title of the currently playing track.
* ARTIST
Text value. Indicates the artist for the currently playing track.
* ALBUM
Text value. Indicates the album for the currently playing track.
* PLAY_STATUS
Text value -- either "Playing", "Stopped" or "Paused".
* Music Zone __ Volume Level
Connect this variable to a room, or device controlling a room's volume, volume level to allow it to be displayed on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Level, do not connect Music Zone 1 Volume Level.
* Music Zone __ Volume Mute
Connect this variable to a room, or device controlling a room's volume, mute feedback to show mute status on an iPad running the Kaleidescape App for iPad. If connecting Movie Zone Volume Mute, do not connect Music Zone 1 Volume Mute.
* Music Preset Button Lockout
True or false value. When true, preset button events will not be able to save a preset on this device. Can be set to "True" or "False".
* Zone n -- Music Preset ___ status
True or false value -- read only. Indicates the status of the preset in zone n. If preset 6 is playing in zone 2, "Zone 2 -- Music Preset 6 status" will be true. Note that several presets can be active simultaneously in the same zone.
________________________
4. RELEASE NOTES
Known issues
------------
* The icon used for control of music zones is an iPod in a dock.
* An eject button is provided when controlling a movie zone, although no eject command is available for the Kaleidescape Player. Pressing the eject button selects the Kaleidescape Menu, from which the Disc tab can be accessed if a disc is in the tray.
* No cover art is provided to touch screens.
* The Kaleidescape driver iPod proxy always shows the Control4 logo in Control4 Composer.
* The Media Player interface (OSD control) audio connections show up on the iPod interface (SATP control).
* If the Movie Player Driver is used to control the (discontinued) KPLAYER-2000, a non-existent HDMI output will be available.
* Improper Events and Actions are shown on the Movie Zone (OSD) and Music Zone (SATP) interfaces. For example, the SATP interface has an Action for Video Frame 4X3 and shows a Variable for OSD Screen Saver.
* The Cinema One (1st generation) driver shows events for CinemaScape Mode and CinemaScape Mask. CinemaScape is only supported on the M-Class Players and Vaults, and the Cinema Line Cinema One.
Versions
--------
1.7
* Created driver for the Cinema One (2nd generation).
1.6
* Fixed problem with module reconnecting to player when player temporarily drops off the network.
1.5
* Support for Volume control.
1.4
* Support for CinemaScape.
1.3
* Support for Composer 2.1.
* Support for Search and Jump in OSD Collections.
1.2
* Added Blu-ray support.
* Added relevant default names for all drivers.
* Renamed driver files to reflect new products.
1.1
* Fixed problem with large touch panel "Back" button.
1.0
* Initial release.
________________________
Copyright (c) 2009-2013 Kaleidescape, Inc. Sunnyvale, California. All rights reserved. This driver is the intellectual property of Kaleidescape, Inc. Kaleidescape grants the non-exclusive right to modify and/or compress this driver, and upload such modified and/or compressed driver to control systems that control at least one licensed Kaleidescape System. No right is otherwise granted to copy, reproduce, modify, upload, download, transmit, display, or distribute the driver or derivative works, or to create derivative works, in any way. The driver, and any derivative works, are protected by copyright, trade secret, and other intellectual property laws and by international treaties, which provide rights and obligations in addition to the rights and obligations set forth here.
Type in the Kaleidescape player's network IP address below.
Version
STRING
true
Status
STRING
Initializing...
true
Debug
LIST
- Off
- Print
- Log
- Print and log
Off
false
Power
LIST
- Allow user to power off
- Always leave player on
Allow user to power off
false
-- --
STRING
true
Show presets in the list interface
LIST
- Show presets
- Do not show presets
Show presets
false
Zone 1 Status
STRING
true
Save Zone 1 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 1 Volume --
STRING
true
Set Volume Capabilities for Music Zone 1
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
Zone 2 Status
STRING
true
Save Zone 2 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 2 Volume --
STRING
true
Set Volume Capabilities for Music Zone 2
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
Zone 3 Status
STRING
true
Save Zone 3 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 3 Volume --
STRING
true
Set Volume Capabilities for Music Zone 3
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
Zone 4 Status
STRING
true
Save Zone 4 Playing Music to
LIST
- Select Preset
- Preset 1
- Preset 2
- Preset 3
- Preset 4
- Preset 5
- Preset 6
- Preset 7
- Preset 8
- Preset 9
- Preset 10
Select Preset
false
-- Music Zone 4 Volume --
STRING
true
Set Volume Capabilities for Music Zone 4
LIST
- No volume control or feedback
- Volume control but no mute or feedback
- Volume and mute control but no feedback
- Volume and mute control with volume feedback
- Volume and mute control with feedback
- Volume control and feedback but no mute
- Do not send volume capabilities
No Volume control or feedback
false
List presets in Lua tab
List Presets
Force all zones off
Force Off
Manage Music Preset
PARAM3 preset PARAM2 on NAME Zone PARAM1
Zone Output
RANGED_INTEGER
1
4
Preset Number
RANGED_INTEGER
1
10
Action
LIST
- Store
- Recall
- Press (button)
- Release (button)
media_player
ipod
ipod
ipod
ipod
5000
2
6
Music Player
False
False
False
False
MEDIA_PLAYER
5001
2
6
SATP Interface
False
False
False
False
IPOD
5002
2
6
SATP Interface
False
False
False
False
IPOD
5003
2
6
SATP Interface
False
False
False
False
IPOD
5004
2
6
SATP Interface
False
False
False
False
IPOD
4000
6
Audio - Zone 1
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
4001
6
Audio - Zone 2
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
4002
6
Audio - Zone 3
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
4003
6
Audio - Zone 4
False
True
True
False
DIGITAL_COAX
DIGITAL_OPTICAL
STEREO
6001
4
6
Kaleidescape Driver IP Connection
True
true
TCP
10000
True
True
True
255
80
False
False
False
255
13d
PK ;FvjF 6\W > Programming-Control4-Controllers-for-a-Kaleidescape-System.pdf̺uTݶ>JKqwbݝ5Xp(EZ'H"Sx\o1539JYWQ[yskzO@HPGRGhѤѡ'ʣD/ ǣM/$cpOOLGތ^PL^WBZn;ן5e
E=PaC/
w{xKK(;<ʮ6`_Sx$EE+((
((+KK *)
)*
+(()
K[ʝ_OB0x4`'zߘ/~x=<