How can we help you?

Kaleidescape Control Commands

This document lists all of the available control protocol commands.  For details of the syntax, please refer to the complete Kaleidescape System Control Protocol Reference Manual.
 
ACommandDescription
 ALPHABETIZE_COVER_ARTArranges covers alphabetically.
 ANGLE_NEXTChanges to the next camera angle defined for playback.
 ANGLE_PREVIOUSChanges to the previous camera angle defined for playback.
 Arrow commandsUsed to navigate the onscreen display.
 
CHILD_UP
 
 
CHILD_UP_PRESS
 
 
CHILD_UP_RELEASE
 
 
CHILD_DOWN
 
 
CHILD_DOWN_PRESS
 
 
CHILD_DOWN_RELEASE
 
 
CHILD_LEFT
 
 
CHILD_LEFT_PRESS
 
 
CHILD_LEFT_RELEASE
 
 
DOWN
 
 
DOWN_PRESS
 
 
DOWN_RELEASE
 
 
LEFT
 
 
LEFT_PRESS
 
 
LEFT_RELEASE
 
 
RIGHT
 
 
RIGHT_PRESS
 
 
RIGHT_RELEASE
 
 
UP
 
 
UP_PRESS
 
 
UP_RELEASE
 
 ASSIGN_PLAYING_MUSIC_TO_PRESETAssigns a preset tag to the music item current playing.
 AUDIO_NEXTChanges to the next audio stream during movie playback.
   
BCommandDescription
 BACKSPACEErases the last character entered.
 Blu-ray color buttonsPerforms actions associated with color buttons.
 
BLUE
 
 
BLUE_PRESS
 
 
BLUE_RELEASE
 
 
GREEN
 
 
GREEN_PRESS
 
 
GREEN_RELEASE
 
 
RED
 
 
RED_PRESS
 
 
RED_RELEASE
 
 
YELLOW
 
 
YELLOW_PRESS
 
 
YELLOW_RELEASE
 
 BLURAY_POPUP_MENU_TOGGLEToggles display of Blu-ray Disc pop-up menu.
 BLURAY_SPECIAL_STOPStops Blu-ray Disc playback. Use with caution.
 BROWSEUsed to navigate the text-based music browsing interface (SATP).
   
CCommandDescription
 CANCELDismisses a page, dialog, or text entry.
 CHILD_PLAYIf the child user interface is already active, plays the selected movie. If not, activates the child user interface.
 CHILD_PAUSEIf the child user interface is already active, pauses the movie. If not, activates the child user interface.
 CHILD_SELECTIf child user interface is already active, plays the highlighted movie. If not, activates the child user interface.
 CHILD_SHUFFLE_COVER_ARTIf the child user interface is already active, shuffles the cover art. If not, activates the child user interface.
 CHILD_STOPIf the child user interface is already active, stops movie playback. If not, activates the child user interface.
   
DCommandDescription
 DEFAULT_LEVELChanges the parental control level to the default level.
 DETAILSToggles between the details page and the
current display.
 DISABLE_EVENTSDisables event messages from a specified movie or music zone.
 DISC_IN_TRAY_TOGGLEToggles the disc in player sheet in the OSD.
 DISC_MENUDisplays DVD or Blu-ray Disc menu for the
current playback.
 DISC_OR_KALEIDESCAPE_MENUBehaves like DISC_MENU during movie or music playback. Behaves like KALEIDESCAPE_MENU_TOGGLE in user interface. 
 DISC_RESUMEResumes playback from the point of interruption.
 DISC_TOP_MENUDisplays the top menu for the DVD or Blu-ray Disc.
   
ECommandDescription
 ENABLE_EVENTSEnables event messages from a specified movie or music zone.
 ENTER_CHILD_MODEDisplays the child user interface.
 ENTER_STANDBYPuts component into standby.
   
FCommandDescription
 FILTER_LISTFilters the list view to search criteria.
   
GCommandDescription
 GET_AVAILABLE_DEVICESReturns a list of device IDs for all system components powered on.
 GET_AVAILABLE_DEVICES_BY_SERIAL_NUMBERReturns a list containing the serial number device identifiers of all components in the system.
 GET_CAMERA_ANGLEProvides information about the current camera
angle.
 GET_CINEMASCAPE_MASKProvides aspect ratio when a player is in a CinemaScape mode.
 GET_CINEMASCAPE_MODEIdentifies the CinemaScape mode currently active.
 GET_CONTENT_DETAILSProvides information about a movie or album selected on the user interface. 
 GET_CHILD_MODE_STATEUsed to determine if the onscreen display is displaying the child user interface.
 GET_CONTROLLED_ZONEReturns the music zone currently under control.
 GET_DEVICE_INFOReturns component device type, serial number, device ID, and IP address.
 GET_DEVICE_POWER_STATEReturns power state of a component.
 GET_DEVICE_TYPE_NAMEReturns component type.
 GET_FRIENDLY_NAMEReturns name of component or music zone.
 GET_HIGHLIGHTED_SELECTIONSpecifies the handle of the movie or album currently selected on the user interface.
 GET_MOVIE_LOCATIONIdentifies the location in the movie, whether in the main content, intermission, or end credits.
 GET_MOVIE_MEDIA_TYPEIdentifies the type of media being played.
 GET_MUSIC_NOW_PLAYING_STATUSSends the state of the Now Playing list. 
 GET_MUSIC_PLAY_STATUSProvides playback information for the currently playing music.
 GET_MUSIC_PRESET_INFORMATIONProvides detailed information about a music preset. 
 GET_MUSIC_TITLEProvides detailed information about the music currently playing. 
 GET_NETWORK_SETTINGSReturns component network settings.
 GET_NUM_ZONESReturns number of zones in a component.
 GET_PLAY_STATUSIdentifies movie play mode, speed, location and chapter. 
 GET_PLAYING_MUSIC_INFORMATIONProvides information about music currently playing. 
 GET_PLAYING_TITLE_NAMEProvides the title of the movie currently playing.
 GET_PROTOCOLReturns protocol version number.
 GET_SCALE_MODEIndicates whether the image from the player requires horizontal scaling, vertical and horizontal scaling, or does not require scaling.
 GET_SCREEN_MASKProvides aspect ratio and masking information for the current video image. 
 GET_SCREEN_MASK2Provides masking information based on aspect ratio and overscan area. 
 GET_SYSTEM_CAPABILITIESReturns whether or not the system has movie/music licenses.
 GET_SYSTEM_READINESS_STATEReturns the idle mode of Alto or Cinema One (2nd Generation).
 GET_SYSTEM_VERSIONReturns protocol version number and the version of kOS.
 GET_TIMEDisplays current date and time.
 GET_UI_STATEProvides details about the current state of the user interface. 
 GET_USER_INPUTProvides information about user input requested from the user interface.
 GET_VIDEO_MODEIdentifies the video mode currently active. 
 GO_CALIBRATE_MASKINGCalibrates the top and bottom values for screen masking.
 GO_CALIBRATE_MASKING_OVERSCANDefines the position of the overscan in a movie zone. 
 GO_MOVIE_COLLECTIONDisplays a specific collection in the Movie Collections view.
 GO_MOVIE_COLLECTIONSDisplays the Movie Collections view.
 GO_MOVIE_COVERSDisplays the Movie Covers view. 
 GO_MOVIE_LISTDisplays the Movie List view. 
 GO_MOVIESChanges the interface from a music view to a movie view. 
 GO_MUSICChanges the interface from a movie view to a music view. 
 GO_MUSIC_COLLECTIONDisplays a specific collection in the Music Collections view.
 GO_MUSIC_COLLECTIONSDisplays the Music Collections view.
 GO_MUSIC_COVERSDisplays the Music Covers view. 
 GO_MUSIC_LISTDisplays the Music List view.
 GO_NOW_PLAYINGDisplays the Now Playing view. 
 GO_PARENTAL_CONTROLDisplays the Parental Control view. 
 GO_SCREEN_SAVERDisplays the screen saver.
 GO_SYSTEM_STATUSDisplays the System Status view.
 GO_VAULT_SUMMARYDisplays the Vault Summary view.
   
ICommandDescription
 INTERMISSION_OFFRemoves the intermission screen and resumes
playback.
 INTERMISSION_ONPauses playback and displays intermission
screen.
 INTERMISSION_TOGGLEToggles intermission screen on and off. 
   
KCommandDescription
 KALEIDESCAPE_MENU_OFFRemoves Kaleidescape menu.
 KALEIDESCAPE_MENU_ONDisplays Kaleidescape menu.
 KALEIDESCAPE_MENU_TOGGLEToggles Kaleidescape menu on and off.
 KEYBOARD_CHARACTERSends a single character to the onscreen display.
   
LCommandDescription
 LEAVE_CHILD_MODEExits the child user interface and displays covers view.
 LEAVE_IDLE_MODETakes Alto or Cinema One (2nd generation) out of idle mode.
 LEAVE_STANDBYTakes component out of standby.
   
MCommandDescription
 MUSIC_RANDOM_OFFTurns off random playback for music. 
 MUSIC_RANDOM_ONTurns on random playback for music. 
 MUSIC_RANDOM_TOGGLEToggles on/off random playback for music.
 MUSIC_REPEAT_OFFTurns off repeat playback for music.
 MUSIC_REPEAT_ONTurns on repeat playback for music.
 MUSIC_REPEAT_TOGGLEToggles on/off repeat playback for music.
   
NCommandDescription
 NEXT and PREVIOUSNEXT command skips forward through chapters
or songs.
   
PCommandDescription
 Page up/down commandsPerforms actions associated with color buttons.
 
PAGE_DOWN
 
 
PAGE_DOWN_PRESS
 
 
PAGE_DOWN_RELEASE
 
 
PAGE_UP
 
 
PAGE_UP_PRESS
 
 
PAGE_UP_RELEASE
 
 Paging and skippingPerforms actions associated with color buttons.
 
PAGE_DOWN_OR_NEXT
 
 
PAGE_DOWN_OR_NEXT_PRESS
 
 
PAGE_DOWN_OR_NEXT_RELEASE
 
 
PAGE_DOWN_OR_PREVIOUS
 
 
PAGE_DOWN_OR_PREVIOUS_PRESS
 
 
PAGE_DOWN_OR_PREVIOUS_RELEASE
 
 
PAGE_UP_OR_NEXT
 
 
PAGE_UP_OR_NEXT_PRESS
 
 
PAGE_UP_OR_NEXT_RELEASE
 
 
PAGE_UP_OR_PREVIOUS
 
 
PAGE_UP_OR_PREVIOUS_PRESS
 
 
PAGE_UP_OR_PREVIOUS_RELEASE
 
 PAUSEToggles pause.
 PERFORM_ACTIONPerforms a specified action on a music handle. 
 PLAYBegins playback of movies and music.
 PLAY_FIRST_IN_MUSIC_COLLECTIONPlays the first item in a music collection.
 PLAY_MUSIC_PRESETPlays the music item associated with a preset tag. 
 PLAY_NEXT_IN_MUSIC_COLLECTIONPlays the next item in the collection. 
 PLAY_PREVIOUS_IN_MUSIC_COLLECTIONPlays the item previous item in the collection. 
 PLAY_SCRIPTExecutes one of the scripts created in the browser interface.
 PLAYER_RESTARTEvent message stating that a player has just been restarted.
 POSITION_SELECTTransmits touch screen interaction to the onscreen display. 
 PREVIOUS (see NEXT and PREVIOUS)PREVIOUS command skips backward through chapters or songs.
   
RCommandDescription
 REPLAYSkips back five seconds during movie playback. 
   
SCommandDescription
 SAFE_LEVELChanges parental control to highest level without a passcode.
 SCAN_FORWARD and SCAN_REVERSECycles through fast-forward or fast-reverse.
 SELECTSelects the highlighted item in the onscreen display.
 SELECT_KALEIDESCAPE_INPUTSelects the Kaleidescape input.
 SEND_EVENTEmits a user-defined event to controllers with enabled event messages.
 SEND_TO_SYSLOGPosts a message to Kaleidescape System logs.
 SET_CINEMASCAPE_MODESets the CinemaScape mode. Useful when video output is distributed to displays with different aspect ratios.
 SET_CONTROLLED_ZONEChanges the music zone controlled by the onscreen display.
 SET_FAVORITE_SCENE_ENDRecords a bookmark for the end of a scene. 
 SET_FAVORITE_SCENE_STARTRecords a bookmark for the start of a scene.
 SET_FRIENDLY_NAMERenames component or music zone.
 SET_NETWORK_SETTINGSChanges network settings.
 SET_PROTOCOL_SETTINGSChanges protocol syntax.
 SET_SCREEN_MASKUsed to inform the Kaleidescape System that a masking system is in use.
 SET_STATUS_CUE_PERIODSets the frequency of PLAY_STATUS and MUSIC_PLAY_STATUS event messages.
 SHOW_NAVIGATION_OVERLAYDuring playback, opens the navigation option of the movie overlay to the chapter/title navigation page.
 SHUFFLE_COVER_ARTShuffles cover art on covers view.
 START_CHAPTER_ENTRYDisplays a tab to enter chapter number to skip
directly to.
 START_DISC_TITLE_ENTRYDisplays a tab to enter title number to skip directly to a title. 
 START_SEND_NUMBER_TO_DISC_ENTRYDisplays a tab to enter a number key to send to a DVD or Blu-ray Disc.
 STATUS_AND_SETTINGSDuring playback, toggles the display of the navigation option of the movie overlay. Otherwise, brings up the System Status page.
 STOPStops playback.
 STOP_OR_CANCELBehaves like STOP during movie playback or when sent directly to a music zone. Behaves like CANCEL in the user interface. 
 STOP_SCREEN_SAVERRemoves screen saver.
 SUBTITLES_NEXTChanges to the next subtitle track during playback.
   
UCommandDescription
 USER_DEFINED_EVENTCustom event message that can be set to be generated by scripts created in the browser interface, sent by another controller, initiated by an infrared volume command, or automatically generated based on system events.
   

Contact

+1 877-352-5343 Toll Free (US Only)
+1 650-625-6160
7:00am - 5:00pm PT (M - F)

support@kaleidescape.com

*Kaleidescape will be closed on the following holidays.