Christie Spyder X80 Technical Reference Download Page 97

Page: 97 / 112

Commands

X80 Serial Commands Reference

020-102207-08 Rev. 1 (10-2020)
Copyright

RSN–Request Source Name

Retrieves a list of sources defined within Spyder.

Syntax

RSN

Response

Refer to

Command processor responses

page

10,

for additional information on Result Codes

Arguments

Argument

Description

Values

RSN

Returns a list of sources names separated by spaces.

—

Summary of Contents for Spyder X80

Page 1: ...Technical Reference 020 102207 08 Spyder X80 Serial Commands ...

Page 2: ...e the product is designed for outdoor use problems or damage caused by use of the product outdoors unless such product is protected from precipitation or other adverse weather or environmental conditions and the ambient temperature is within the recommended ambient temperature set forth in the specifications for such product g Defects caused by normal wear and tear or otherwise due to normal aging...

Page 3: ...019 5 1 Added the following command ASC Advance Script Cue Added documentation for the following commands AIR Aspect Insensitive Resize DSL Detailed Source List ICS Input Config Raster Size OCC Output Config Connection OCU Output Config Undo Cancel RIF Request Image File RPM Request PixelSpace Mappings RSCC Request Script CueData Count RSCD Request Script CueData Details RSEC Request Script Elemen...

Page 4: ...ssign Content MVAS Multi Viewer Add Single MVCA Multi Viewer Clear All MVKF Multi Viewer Set Keyframe properties MVPL Multi Viewer Preset Learn MVPR Multi Viewer Preset Recall MVQO Multi Viewer Query Output MVST Multi Viewer Set Titling 10 20 2018 3 1 Added the following commands OCM to include Multiviewer RPN Request Page Names RRD Request register details 10 9 2018 2 1 Added the following comman...

Page 5: ...Capture Layer Image 20 COI Capture Output Image 21 CRP Crop Layer 22 CSO Clear Still on Output 23 DCK Delete Command Key 24 DMB Device Mixer Bus Apply 25 DMT Device Mixer Transition 26 DSL Detailed Source List 27 FKR Function Key Recall 28 FRZ Freeze Layer 29 ICK Input Color Key 30 ICL Input Config Learn 31 ICR Input Configuration Recall 32 ICS Input Config Raster Size 33 IGP Input Get Properties ...

Page 6: ...R Output Configuration Rotation 69 OCS Output Configuration Save 70 OCU Output Config Undo Cancel 71 OFZ Freeze Output 72 OGP Output Get Properties 73 OSP Output Set Properties 74 QRC Query Router Crosspoint 75 RAR Request Aspect Ratio 76 RAS Request Active Sources 77 RBL Request Basic Preset List 78 RCR Router Crosspoint Recall 79 RCS Request Connection Status 80 RIF Request Image File 81 RLC Req...

Page 7: ...Force Server Save 98 SCL Clear Still on Layer 99 SCR Script Cue Request 100 SDN Restart Spyder Server 101 SLD Load Still on Layer 102 SLR Slide Layout Recall 103 SRS Stop Running Scripts 104 SRA Source Apply 105 SWA Swap Layers 106 TPC Test Pattern Clear 107 TPL Test Pattern Load 108 TRN Transition Layers 110 ZPA Zoom Pan Adjust 111 ...

Page 8: ...control see the Spyder Studio User Manual P N 020 102205 XX When using serial control terminate each command with a carriage return Ethernet connectivity To control the Spyder frame send the commands listed in this manual in a UDP packet sent to port 11116 on the frame no configuration is required Each message sent to Spyder over UDP must be precluded by a 10 byte message header provided in the ta...

Page 9: ...mmands When specifying layer IDs the IDs start at 2 Layer ID 0 and 1 are reserved for future commands using the two background layers of the system Replace the string argument spaces with the three character ASCII string 20 to create a valid command as the space is used as the argument delimiter Do not put an argument delimiter space character between the header and the external control command ...

Page 10: ... first response argument is always the error code for the command which lets the user know if a command was successfully processed The table below displays the various responses returned by the Spyder Response Response name Description 0 Success The command was successfully processed 1 Empty The data requested is not available 2 Header An invalid command was specified 3 Argument count The command ...

Page 11: ...lt Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values SizingType Allows window size to be set directly or be offset in size by a specified number of pixels 0 Absolute Size In Pixels 1 Relative Size In Pixels TargetDimension Allows the window size change to be applied to the width or height of the window 0 Adjust Width ...

Page 12: ... ARL RegisterType RegisterID Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RegisterType Sets the register type 0 0x30 Effect 1 0x31 Playitem 2 0x32 Not used 3 0x33 Not used 4 0x34 Command key script 5 0x35 Treatment 6 0x36 Source 7 0x37 Function key 8 0x38 Not used 9 0x39 Not used 10 ...

Page 13: ...yFrame aspect ratio offset directly Syntax ARO Type FloatingPoint Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Type Determines the type of aspect ratio being set t Sets the total aspect ratio o Sets the KeyFrame aspect ratio offset a Adjusts the existing KeyFrame aspect ratio offset ...

Page 14: ...ce Script Cue Advances the current script cue by steps Syntax ASC Steps Response Result Code Refer to Command processor responses page 13 for additional information on Result Codes Arguments Argument Description Values Steps Number of steps optional None no number advances the current script cue by one n to go forward n to go backward default is 1 ...

Page 15: ... Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Filename Specifies the name of the file to load If the image is not the same size as the pixelspace it is being loaded on the image is automatically scaled to fit into it PixelspaceID Sets the ID of the pixelspace to load onto Layer Determines what layer to load the f...

Page 16: ...d preset ID Syntax BPL Preset Duration Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Preset Determines the preset ID to save the current window position and KeyFrame information to Duration Determines how long in frames per second a layer takes to transition from one KeyFrame to another Optional 60...

Page 17: ...g preset from the frame Syntax BPR Preset Duration Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Preset Determines the preset ID to recall from the server Duration Determines how long in frames per second a layer takes to transition from one KeyFrame to another Optional 60 Default ...

Page 18: ...itions the background layers across all pixelspaces The pixelspace backgrounds cannot be transitioned individually Syntax BTR Duration Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Duration Determines how long in frames per second a background layer takes to transition ...

Page 19: ...tures the specified input image to the specified file name Syntax CII InputID FileName Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values InputID Specifies the input ID to capture Zero based FileName File name for the captured image including extension bmp png jpg or tif ...

Page 20: ...fied file name Note if a still image is loaded on a layer it will not be captured and instead the last input selected to that layer will be captured Syntax CLI LayerID FileName Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values LayerID Specifies the layer ID to capture FileName File name for the capture...

Page 21: ...res the specified output image to the specified file name Syntax COI OutputID FileName Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Specifies the output ID to capture Zero based FileName File name for the captured image including extension bmp png jpg or tif ...

Page 22: ...p Bottom Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Left Sets the amount to crop from the left side of the 0 0 No crop 1 0 100 crop Right Sets the amount to crop from the right side of the Top Sets the amount to crop from the top of the layer Bottom Sets the amount to crop from the...

Page 23: ...rights reserved CSO Clear Still on Output Clears an image currently loaded on a specified output ID Syntax CSO OutputID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output to clear the image on ...

Page 24: ...Delete Command Key Deletes an existing command key by either a register ID or script ID Syntax DCK ID Type Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values ID Sets the ID to delete Type Sets the type of ID Optional S ScriptID Default R RegisterID ...

Page 25: ...de Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Duration Sets the transition duration to be applied to layers coming on or off of the program in frames per second Bus Sets the bus state to apply to the device OFF Both layers for a device are off the screen PVW The program layer of the device is in preview and the prev...

Page 26: ...e devices This command is intended for devices configured as mixers Syntax DMT Duration DeviceID1 DeviceID2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Duration Sets the transition duration to be applied in frames per second 1 Forces a cut transition DeviceID1 DeviceIDX Indicates the target devic...

Page 27: ...yright 2020 Christie Digital Systems USA Inc All rights reserved DSL Detailed Source List Returns a detailed source list Syntax DSL Response Lists count and six information fields for each source Count RegisterID SourceName HActive VActive Connector Thumbnail Arguments None ...

Page 28: ...mple to recall a function key at register ID 2 on page 3 send a register ID of 3002 Syntax FKR ID Layer1 Layer2 IDType Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values ID Sets the ID of the function key Layer1 LayerX Sets the IDs of the layers for the relative function keys Optional IDType Defines the...

Page 29: ...e layers Syntax FRZ Freeze Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Freeze Enables or disables freezing the specified layers 0 Disables freezing the specified layers 1 Enables freezing the specified layers Layer1 LayerX Sets the IDs of the layers to freeze or unfreeze ...

Page 30: ...ed Enables or disables the color key adjustment If disabling the color key all key specific arguments are not used and must be set t 0 Disables the color key adjustment 1 Enables the color key adjustment ColorRed Sets the color red parameter for the specified layers 0 to 255 ColorGreen Sets the color green parameter for the specified layers ColorBlue Sets the color blue parameter for the specified...

Page 31: ... the input configuration for a layer ID to a configuration ID for later recall Syntax ICL Input LayerID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Input Sets the input configuration ID to save to LayerID Determines the layer ID to save the input configuration from ...

Page 32: ...ayerID ConnectorType Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values ConfigurationID Sets the ID number to store the current input configuration of the layer ID to 1 Forces an auto synch LayerID Sets the layer ID to apply the input configuration to ConnectorType If ConfigurationID is set to 1 sets th...

Page 33: ...ut config of a layer Syntax ICS LayerID Raster Edge Delta Response None Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Layer ID Layer ID to apply input raster change to Numeric layer index Raster Edge Side of input raster to adjust Top Left Bottom Right Delta Value in pixels to shift the raster Numeric value...

Page 34: ...ights reserved IGP Input Get Properties Returns all input config properties on the specified object The properties are formatted in a list Syntax IGP Layer ID Response Property Name Property Type Current Value Arguments Argument Description Values Layer ID Determines the properties of the source that the layer is using 2 26 ...

Page 35: ...ommand processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Brightness Adjusts the brightness on the specified layers 0 0 to 2 0 Contrast Adjusts the contrast on the specified layers 0 0 to 2 5 Hue Adjusts the hue on the specified layers 180 to 180 Saturation Adjusts the saturation on the specified layers 0 0 to 2 0 Gamma Adjusts the gamma on...

Page 36: ...sult Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values KeyEnabled Enables or disables the color key adjustment If disabling the luminance key all key specific arguments are not used and must be set to zero 0 Disables the luminance key adjustment 1 Enables the luminance key adjustment Clip Sets the clip for the specifi...

Page 37: ...ified layer inspects the video content currently in the layer and repositions the input video automatically Syntax IRA LayerID Edge Delta Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values LayerID Sets the ID of the layer to adjust Edge Sets the edge to adjust L Left R Right T Top B Bottom A AutoRaster ...

Page 38: ... Set Properties Sets the named properties on the input config object for the specified layer Syntax ISP LayerID PropertyName PropertyValue Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Layer ID Determines the source config object on the layer 2 26 ...

Page 39: ...ust BorderThickness Determines the thickness of the border Set a negative number for outside softness 255 to 255 Red Sets the red parameter for the RGB color value If specifying the red parameter the blue and green parameters must also be set 0 to 255 Green Sets the green parameter for the RGB color value If specifying the green parameter the blue and red parameters must also be set Blue Sets the ...

Page 40: ...ights reserved KGP KeyFrame Get Properties Returns all KeyFrame properties for the specified object The properties are formatted in a list Syntax KGP LayerID Response Property Name Property Type Current Value Arguments Argument Description Values Layer ID Determines the properties of the source that the layer is using 2 26 ...

Page 41: ...n changes can be relative to the layer s current position or can be an absolute position setting Syntax KPS Position Horizontal Vertical Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Position Determines if the position is absolute or relative to the current position of the layer 0 Abs...

Page 42: ...arency Softness Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values ID Sets the ID of the layer to adjust Horizontal Sets the horizontal position of the shadow 0 to 255 Vertical Sets the vertical position of the shadow Size Sets the size of the shadow Transparency Sets the transparency of the shadow Soft...

Page 43: ...frame Set Properties Sets the named properties on the Keyframe object for a specified layer Syntax KSP LayerID PropertyName PropertyValue Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Layer ID Determines the source config object on the layer 2 26 ...

Page 44: ...e or more specified layers The vertical size adjusts automatically to ensure the layer s aspect ratio Syntax KSZ Horz Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Horz Sets the horizontal size in pixels of the specified layers Layer1 LayerX Sets the IDs of the layers to size ...

Page 45: ...vailable treatment ID Layer Specifies the layer ID to learn from Treatment Name Optional name for the treatment Text value used as treatment name Do Not use pure numerical names for the treatment as this may cause parsing errors on the server Argument3 Argument12 Learns KeyFrame attributes Argument3 Learns the position attribute Argument4 Learns the crop attribute Argument5 Learns the clone attrib...

Page 46: ... KeyFrame transparency value on layers Syntax KTP transparency Value LayerID s Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values TransparencyValue 0 255 LayerID s Which layer or layers to apply transparency value Layer IDs are 2 based For example Layer 1 is ID 2 Layer 5 is ID 6 ...

Page 47: ...Treatment Recall Recalls a treatment to one or more layers Syntax KTR TreatmentID Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values TreatmentID Sets the ID of treatment to recall Layer1 LayerX Sets the IDs to recall the treatment to ...

Page 48: ...tally to make the center position of all layers match the first specified layer 2 Align Left Repositions specified layers horizontally to make the left edge of all layers match the first specified layer 3 Align Middle Repositions specified layers vertically to make the center position of all layers match the first specified layer 4 Align Right Repositions all specified layers horizontally to make ...

Page 49: ...al Spacing Removes spacing between specified layers causing them to be vertically stacked in the order specified 16 Size to Display Height Resizes specified layers to fill their respective pixelspace vertically no adjustment is made to the horizontal position 1 17 Size to Display Width Resizes specified layers to fill their respective pixelspace horizontally and centers the input vertically 18 Sna...

Page 50: ...al Makes all layers the same width centers them horizontally with the first specified layer and positions them in a vertical array running downward starting at the first layer s position 24 Swap Windows Swaps horizontal position and size between the two specified layers RecallDuration Sets the duration for the alignment recall in frames per second Layer1 Layer X Sets the IDs of the layers to crop ...

Page 51: ...formation on Result Codes Syntax LCC LayerID Mode Offset OffsetType Arguments Argument Description Values ID Sets the pixelspace to associate the layer with Visibility Hides or shows the layers at the time this command is applied Making the layer visible allows additional commands to be sent to configure the layer before it is transitioned t th ith th TRN d 0 Hides the layers Default 1 Makes the l...

Page 52: ...itional information on Result Codes Arguments Argument Description Values LayerID Sets the ID of the layer that the KeyFrame is on Mode Sets the clone mode If the mode is specified with no offset value the clone offset value stored in the layer s current KeyFrame is used 0 Off 1 Offset 2 Mirror Offset Sets the offset distance in relative coordinates or the pixel value for the clone position Option...

Page 53: ...Script ID Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values LearnAs Determines if the command key is learned as absolute or relative 0 Absolute 1 Relative Name Sets the name of the command key to be learned RegisterID Sets the ID of the register to learn the command to LearnFrom Determines what the command key is learned f...

Page 54: ... of loading custom test patterns Syntax LSO Filename OutputID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Filename Sets the file of the image to load The filename must exist in the Stills directory on the Spyder server which can be accessed using FTP or the Spyder Studio software OutputID Sets th...

Page 55: ...nd position commands KPS and KSZ Syntax LSP Position Horizontal Vertical Size Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Position Determines the position 0 Absolute position 1 Relative position to the current position of the layer Horizontal Sets the horizontal position in pixels V...

Page 56: ... a Multiviewer Syntax MVAC OutputID ViewID InputID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output 3 output 4 7 output 8 11 output 12 15 output 16 ViewID ID of Multiviewer input view ID based upon user defined in the Multiviewer properties InputID ID of the Input to...

Page 57: ...mmand processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the output 3 output 4 7 output 8 11 output 12 15 output 16 ViewType Sets the Multiviewer element type 0 PGM 1 PVW 2 Input 3 Output ContentID Assigns the desired element ID to use PGM and PVW Content ID can be found in the system patch section by clicking on the desired p...

Page 58: ... reserved MVCA Multi Viewer Clear All Clears all view types on desired Multiviewer output Syntax MVCA OutputID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the output 3 output 4 7 output 8 11 output 12 15 output 16 ...

Page 59: ... processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output 3 output 4 7 output 8 11 output 12 15 output 16 ViewID ID of Multiviewer View ID based upon user defined value in the Multiviewer properties Left Top Position of the View Dependent on the size of the Multiviewer output resolution 0x0 is the top left posit...

Page 60: ...rns a current viewing Multiviewer preset Syntax MVPL OutputID PresetName Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output 3 output 4 7 output 8 11 output 12 15 output 16 PresetName The name of the desired preset to learn A unique preset name ...

Page 61: ...viewer output Syntax MVPR OutputID PresetType PresetName Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output 3 output 4 7 output 8 11 output 12 15 output 16 PresetType Type of Multiviewer Preset 0 OpMon 1 SourceMon 2 Custom PresetName The current name of the desired cus...

Page 62: ... Syntax MVQO OutputID Response Result Code BackgroundColorRed BackgroundColorGreen BackgroundColorBlue View Count ViewID ViewType ContentId Left Top Width Height BorderThickness BorderColorRed BorderColorGreen BorderColorBlue Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the output 3 output 4 7 output 8 1...

Page 63: ...tomLabel CustomText LabelPosition FontSize Bold Italic Separator ForegroundColorRed ForegroundColorGreen ForegroundColorBlue BackgroundColorRed BackgroundColorGreen BackgroundColorBlue Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Note CustomText is required when ShowCustomLabel is enabled Arguments Argument Description Values OutputID...

Page 64: ...t Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Output Sets the ID of the output to configure Zero based Edge Sets the edge of the blending area of the output L Left R Right Enable Enables or disables the blending of the output 0 Disables the blending of the output 1 Enables the blending of the output BlendWidth S...

Page 65: ...nector type regardless of the enabled parameter Syntax OCC Output ID Connector Type Enabled Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Output ID Output index to query Numeric output index Connector Type Output connector type to set 0 Analog 1 DVI 2 SDI 3 Composite S Video 4 HDMI 5 Display Port E...

Page 66: ...e is specified the closest available refresh value is used Syntax OCF OutputID HActive VActive RefreshRate Interlaced Timing Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the output ID Zero based HActive Sets the horizontal active resolution VActive Sets the vertical active resolution...

Page 67: ...g position for the output Syntax for Multiviewer Mode OCM OutputID Mode PresetName Response for Multiviewer Mode Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments for Multiviewer Mode Argument Description Values OutputID Sets the ID of the output 3 7 11 15 zero based 4th port only Mode Sets the output mode to Multiview Multiview PresetNam...

Page 68: ... SourceMon Mode OCM OutputID Mode Response for SourceMon Mode Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments for SourceMon Mode Argument Description Values OutputID Sets the ID of the output Zero based Mode Sets the output mode to SourceMon X20 or Multiviewer with SourceMon preset type X80 SourceMon Syntax for AUX Mode OCM OutputID Mod...

Page 69: ...put Rotation is not supported on all output module types For additional information contact Christie Technical Support Syntax OCR OutputID RotationAngle Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the output ID Zero based RotationAngle Sets the angle of the rotation in 90 degree inc...

Page 70: ...an output to be saved to the persistent storage on Spyder To prevent changes from being lost when the system is restarted call this command after making output configuration adjustments Syntax OCS OutputID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values OutputID Sets the ID of the output to save Zero...

Page 71: ...nsaved modifications to the output configuration It is equivalent to clicking the cancel button on the output config panel in the Spyder software client Syntax OCU Output ID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Output ID Output ID to cancel changes on Numeric output index ...

Page 72: ... outputs DX4 outputs do not support individual freeze or unfreeze functionality Syntax OFZ Freeze Output1 Output2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Freeze Enables or disables freezing the specified layers 0 Disables freezing the output 1 Enables freezing the output Output1 OutputX Sets ...

Page 73: ... rights reserved OGP Output Get Properties Returns all output properties for the specified object The properties are formatted in a list Syntax OGP LayerID Response Property Name Property Type Current Value Arguments Argument Description Values Layer ID Determines the properties of the source that the layer is using 2 26 ...

Page 74: ...utput Set Properties Sets named properties on the output config object for the specified output Syntax OSP Output ID PropertyName PropertyValue Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Output ID Determines the output config object ID 0 15 ...

Page 75: ...ured to be controlled by Spyder If no specific output is supplied the inputs for all outputs are returned Inputs and outputs returned are zero indexed For example output 1 on the router is returned as a zero 0 An output with no input connected disconnected returns 1 for the input Syntax QRC RouterID OutputID Response Result Code Router ID Output Input Output Input Refer to Command processor respon...

Page 76: ...ts reserved RAR Request Aspect Ratio Requests the aspect ratio of a defined source Syntax RAR Layer Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RAR Layer Sets the ID of the layer or the source name to request the aspect ratio ...

Page 77: ... sources in a third party user interface or it can be used with an external system to trigger a tally device Syntax RAS PixelSpace ID Response Result Code Count Source Name Bus Arguments Argument Description Values PixelSpace ID Sets the PixelSpace ID s to query the active sources Default all PixelSpaces Returned values Respon Description Values Source String name of source Bus Indicates if the sp...

Page 78: ...nts are available to request portions of the list at a time Syntax RBL StartIndex MaxCount Chars Response Result Code Return Count Preset1 ID Preset1 Name Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values StartIndex Determines which index to begin returning the list of preset names MaxCount Sets the maximum number of regis...

Page 79: ... this functionality automatically when sending a command with multiple switch assignments Syntax RCR RouterID Switch Output Input Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RouterID Sets ID of the router to switch Switch Determines which patch is switched If this argument is not specified the lo...

Page 80: ...termine if a video source is connected Do not call this command too frequently more than once per second as system performance may degrade Syntax RCS LayerID Response Result Code Layer ID Current Connector Type Connection Status Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values LayerID Sets the ID of the layer to check the...

Page 81: ...llowing four bytes 0x00 0xAB 0xAC 0xFF would be returned as the string literal 00ABACFF Note This command should be used sparingly and it is recommended that the client device cache images locally to avoid regular re downloading when possible Heavy use of this command particularly when image scaling is in use may have a performance effect on the Spyder server Syntax RIF Image File Name No Path Max...

Page 82: ... within the connected Spyder system Syntax RLC Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RLC Retrieves the logical layer count within the connected Spyder system The logical layer count includes two background layers in Spyder In most cases applications should subtract two from the response ...

Page 83: ...t Border Inside Softness Border Outside Softness OutSide Edges Shadow HOffset Shadow VOffset Shadow HSize Shadow Softness Shadow Transparency Clone Mode Clone Offset Left Crop Right Crop Top Crop Bottom Crop Crop Anchor AR Offset Zoom HPan VPan Pixelspace ID Transparency Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values La...

Page 84: ... If no source is currently assigned to the specified layer an empty result code is returned with no parameters If a source is assigned to the specified layer but no corresponding register can be found 1 is returned for the register ID Syntax RLS LayerID Response Result Code Source Name Source Register ID Refer to Command processor responses page 10 for additional information on Result Codes Argume...

Page 85: ... a list of all the pixelspaces currently defined in the system Syntax Result Code Count ID Name Current Background Next Background X Position YPosition Width Height RenewalGroup ID Response Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RPD Returns a list of all the pixelspaces currently defined in the ...

Page 86: ... Mappings This command returns the mappings between preview and program PixelSpace IDs PixelSpaces with no associated preview program PixelSpace will not be included in the response Syntax RPM Response Result Code Count ProgramID PreviewID Preview Scale Ratio Refer to Command processor responses page 10 for additional information on Result Codes Arguments None ...

Page 87: ...yntax RPN RegisterType Response Result Code Register Count Register Page ID Register Page Name Refer to Command processor responses page 10 for additional information on Result Codes Argument Description Values RegisterType Sets the register type 0 0x30 Effect 1 0x31 Playitem 2 0x32 Not used 3 0x33 Not used 4 0x34 Command key script 5 0x35 Treatment 6 0x36 Source 7 0x37 Function key 8 0x38 Not use...

Page 88: ...ernal state logic such as needing to wait for the image load commands to complete The status returned includes a numeric value from 0 to 101 giving the percent progress as well as an ASCII string with a generic description of the task being processed When idle this request returns a progress message response of 0 empty string or 101 Ready Syntax RPS Chars Response Result Code Progress Status Messa...

Page 89: ...geNumber Response Result Code Register Count Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RegisterType Sets the register type 0 0x30 Effect 1 0x31 Playitem 2 0x32 Not used 3 0x33 Not used 4 0x34 Command key script 5 0x35 Treatment 6 0x36 Source 7 0x37 Function key 8 0x38 Not used 9 0x39 Not used 10 0x31 0x30 Still ima...

Page 90: ...mand processor responses page 10 for additional information on Result Codes Response Cmd Keys Result Code Script ID 0 Absolute 1 Relative Cue Count Response Treatments Result Code Size Enabled 1 0 Position Enabled 1 0 Border Enabled 1 0 Shadow Enabled 1 0 Clone Enabled 1 0 Crop Enabled 1 0 A R Enabled 1 0 Pan Zoom Enabled 1 0 Duration 1 0 Response Source Result Code Source Name Router ID Router In...

Page 91: ...egister1 ID Register1 Name Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RegisterType Sets the register type 0 0x30 Effect 1 0x31 Playitem 2 0x32 Not used 3 0x33 Not used 4 0x34 Command key script 5 0x35 Treatment 6 0x36 Source 7 0x37 Function key 8 0x38 Not used 9 0x39 Not used 10 0x31 0x30 Still image PageNumber Sets...

Page 92: ... Type Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Script Sets the ID of the script being recalled Cue Sets what script cue to recall Type Defines the ID type being recalled being recalled in the Script argument Optional To access registers on pages above the first page add the page number 1000 to...

Page 93: ...pt CueData Count Returns the number of cues in a specified command key script Syntax RSCC Script ID Script or Register ID Response Number of cues in the requested script Arguments Argument Description Values Script Register ID ID to query Numeric script or register ID ID Type Specifies if the ID is a script or register ID S Script ID Default R Register ID ...

Page 94: ...JumpType JumpCue TriggerType TriggerTime Function Key Count Function Key Register ID PlayItemType PlayItem Register ID PlayItem Command Response Codes and Format JumpType None 0 Direct 1 TriggerType None 0 Wait 1 WaitX 2 Time 3 Time Of Day 4 TriggerTime HH MM SS FF Hours Minutes Seconds Frames PlayItem Cue 0 Play 1 Stop 2 Arguments Argument Description Values ID Script or register ID to query Nume...

Page 95: ...unt Returns the number of elements in a specified command key script Syntax RSCC Script ID Script or Register ID Response Number of elements in the requested script Arguments Argument Description Values Script ID Script or Register ID Numeric script or register ID ID Type Specifies that the ID provided is a script ID or a register ID S Script ID Default R Register ID ...

Page 96: ...st System FrameRate Allows the system to be interrogated for its current frame rate setting The number returned from this command is the Frame Rate that is used in Frame Setup of the Configuration Manager Syntax RSF Response System Frame Rate ID Frame Rate ID FR_60 0 NTSC 1 PAL 2 FR_48 3 FR_30 4 FR_29_97 5 FR_25 6 FR_24 7 FR_23_98 8 Arguments None ...

Page 97: ...A Inc All rights reserved RSN Request Source Name Retrieves a list of sources defined within Spyder Syntax RSN Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RSN Returns a list of sources names separated by spaces ...

Page 98: ...ve Forces the remote Spyder frame to save all configuration and user data changes to non volatile storage Syntax SAV Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values SAV Forces the remote frame to save all configuration and user changes to non volatile storage ...

Page 99: ...Inc All rights reserved SCL Clear Still on Layer Clears any loaded still images from one or more layers Syntax SCL Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Layer1 LayerX Sets the IDs of the layers ...

Page 100: ... integer value representing the current cue of the specified script or the command returns 1 if the specified script is not being executed on any layer Syntax SCR ID Type Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values ID Sets the script ID to request the status for Type Defines the ID type for the s...

Page 101: ...tart Spyder Server Restarts or powers off the Spyder server application remotely Syntax SDN 0 1 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values 0 1 Remotely restarts or powers off the server application 0 Powers the server off 1 Restarts the server ...

Page 102: ...eserved SLD Load Still on Layer Loads a file onto one or more layers Syntax SLD Filename Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Filename Sets the name of the file to load Layer1 LayerX Sets the IDs of the layers ...

Page 103: ...D ID of the PixelSpace to execute a slide layout recall to Numeric PixelSpace ID Clear Layers Determines whether all layers should be cleared from the PixelSpace 0 Leave unused layers 1 Remove unused layers Reserved Layer Count Number of reserved layers being set in the next parameter s Numeric count Reserved Layers One or more layer IDs which will not be used as part of the slide recall Numeric l...

Page 104: ...ng scripts cue trigger countdowns or disconnects scripts from layers Syntax SRS Operation Type Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Operation Type Specifies whether to cancel cue triggers or to disconnect layers from scripts D Disconnect layers from scripts S Cancel pending cue triggers ...

Page 105: ...yers A source is defined as an input configuration and a router input To create sources and define connected routers use Spyder Studio Syntax SRA Name Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Name Provides the name of the source Layer1 LayerX Sets the IDs of the layers to apply t...

Page 106: ...yframe Note both layers must be visible on screen when the command is executed or an ArgValue response will be returned Syntax SWA First Layer ID Second Layer ID Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values First Layer ID First layer of the two layer swap Numeric layer ID Second Layer ID Second la...

Page 107: ...lear Clears test patterns from a layer PixelSpace or output Syntax TPC Target ID Response Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Target Specifies whether to clear test patterns on outputs PixelSpaces or layers 0 PixelSpace 1 Layer 2 Output ID Target ID to clear Numeric ID ...

Page 108: ...r to clear test patterns on outputs PixelSpaces or layers 0 PixelSpace 1 Layer 2 Output ID Target ID to load Numeric ID Pattern Type Type of pattern to load 0 ColorBarsGray 1 ColorBarsHorizontal 2 ColorBarsPluge 3 SingleColor 4 ColorRamp8Bit 5 RGBColorGradient8Bit 6 Grid32 7 Grid64 8 Grid128 9 GrayGamma 10 Gray Top to Bottom 16 steps 11 Gray Bottom to top 16 steps 12 Gray Top to Bottom 32 steps 13...

Page 109: ...abled CenterX If enabled an X will be drawn to fill the test pattern image using the foreground color 0 disabled 1 enabled Grid If enabled a 32x32 pixel grid will be drawn over the test pattern using the foreground color 0 disabled 1 enabled BG Red Background Red Color 0 255 BG Green Background Green Color 0 255 BG Blue Background Blue Color 0 255 FG Red Foreground Red Color 0 255 FG Green Foregro...

Page 110: ...gned pixelspace Syntax TRN Mix Duration Layer1 Layer2 Response Result Code Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values Mix Transitions layers on and off of their currently assigned pixelspace 0 Mix off 1 Mix on Duration Sets the transition duration in number of frames per second Layer1 LayerX Sets the IDs of the laye...

Page 111: ...de Refer to Command processor responses page 10 for additional information on Result Codes Arguments Argument Description Values RecallMode Determines if adjustments are relative to the existing zoom pan settings of the layer or can be set to specific values directly 0 Absolute values 1 Relative adjustment Zoom Sets the zoom value 0 0 to 20 0 HorizontalPan Sets the horizontal pan value 2048 to 204...

Search results

Summary of Contents for Spyder X80

Reviews:

Brands by name

Popular brands

Christie Spyder X80, Technical Reference

Search results

Summary of Contents for Spyder X80

Reviews:

Brands by name

Popular brands