Project.Christie_Spyder(deviceName or ID)

Example:
Project.Christie_Spyder("Christie_Spyder1").SubMember

Alternative Example:
Project.Christie_Spyder(1).SubMember

This gives access to all further members of the device "Christie_Spyder" from the Configuration dialog. Using the Project object is an alternative to addressing the device directly by entering its name. The Project object allows to address the device through its name or ID.

Substituting the ID with a dynamic variable allows automation. Actions can be performed on many devices of the same type simultaneously, e.g. by using for-loops:
For i = 1 to 10 {
  Project.Christie_Spyder(i).Enable = False
}

Christie_SpyderName.ApplyTreatment(layerId,treatmentId)

Example:
Christie_Spyder1.ApplyTreatment(1,5)

Alternative Example:
Project.Christie_Spyder(1).ApplyTreatment(1,5)

This member is based on the Spyder command "KTR–Treatment Recall". It recalls a treatment to a layer.

Christie_SpyderName.ClearLayerImage(layerId)

Example:
Christie_Spyder1.ClearLayerImage(1)

Alternative Example:
Project.Christie_Spyder(1).ClearLayerImage(1)

This member is based on the Spyder command "SCL–Clear Still on Layer". It clears any loaded still images from a layer.

Christie_SpyderName.ClearOutputImage(outputId)

Example:
Christie_Spyder1.ClearOutputImage(8)

Alternative Example:
Project.Christie_Spyder(1).ClearOutputImage(8)

This member is based on the Spyder command "CSO–Clear Still on Output". It clears an image currently loaded on a specified output ID.

Christie_SpyderName.Disable

Example:
Christie_Spyder1.Disable

Alternative Example:
Project.Christie_Spyder(1).Disable

This disables the Spyder device in the Configuration dialog as if the "Enable" check box in the window was unchecked. Use the .Enable member to reverse this command.

Christie_SpyderName.Enable

Example:
Christie_Spyder1.Enable

Alternative Example:
Project.Christie_Spyder(1).Enable

This enables the Spyder device in the Configuration dialog as if the "Enable" check box in the window was checked. Use the .Disable member to reverse this command.

Christie_SpyderName.FadeLayerIn(layerId,duration)

Example:
Christie_Spyder1.FadeLayerIn(1,10)

Alternative Example:
Project.Christie_Spyder(1).FadeLayerIn(1,10)

This member is based on the Spyder command "TRN–Transition Layers". It transitions a layer on its currently assigned pixelspace.

The "duration" argument sets the transition duration in number of frames per second. The member FadeLayerOut transitions the layer off of the pixelspace.

Christie_SpyderName.FadeLayerOut(layerId,duration)

Example:
Christie_Spyder1.FadeLayerOut(1,10)

Alternative Example:
Project.Christie_Spyder(1).FadeLayerOut(1,10)

This member is based on the Spyder command "TRN–Transition Layers". It transitions a layer off of its currently assigned pixelspace.

The "duration" argument sets the transition duration in number of frames per second. The member FadeLayerIn transitions the layer on the pixelspace.

Christie_SpyderName.FreezeLayer(layerId)

Example:
Christie_Spyder1.FreezeLayer(1)

Alternative Example:
Project.Christie_Spyder(1).FreezeLayer(1)

This member is based on the Spyder command "FRZ–Freeze Layer". It freezes a layer.

Use the .UnfreezeLayer member to reverse this command.

Christie_SpyderName.FreezeOutput(outputId)

Example:
Christie_Spyder1.FreezeOutput(8)

Alternative Example:
Project.Christie_Spyder(1).FreezeOutput(8)

This member is based on the Spyder command "OFZ–Freeze Output". It freezes or unfreezes one or more outputs. This command is only compatible with universal outputs. DX4 outputs do not support individual freeze or unfreeze functionality.

Use the .UnfreezeOutput member to reverse this command.

Christie_SpyderName.FunctionKeyRecallByFunctionKeyId(layerId,functionKeyId)

Example:
Christie_Spyder1.FunctionKeyRecallByFunctionKeyId(1,5)

Alternative Example:
Project.Christie_Spyder(1).FunctionKeyRecallByFunctionKeyId(1,5)

This member is based on the Spyder command "FKR–Function Key Recall". It recalls a single function key defined in Spyder.
Enter the ID specified within the function ID settings. The example recalls Function Key ID 5, no matter in which register or page it is placed or if it is moved.

There is also the member FunctionKeyRecallByRegisterId.

Christie_SpyderName.FunctionKeyRecallByRegisterId(layerId,pageId,registerId)

Example:
Christie_Spyder1.FunctionKeyRecallByRegisterId(1,2,5)

Alternative Example:
Project.Christie_Spyder(1).FunctionKeyRecallByRegisterId(1,2,5)

This member is based on the Spyder command "FKR–Function Key Recall". It recalls a single function key defined in Spyder.
Enter the Register ID, meaning its slot within the UI. The example recalls register 5 on page 2, no matter which Function Key has been placed in that spot.

There is also the member FunctionKeyRecallByFunctionKeyId.

Christie_SpyderName.GetIpAddress

Example:
vstring = Christie_Spyder1.GetIpAddress

Alternative Example:
vstring = Project.Christie_Spyder(1).GetIpAddress

This returns the IP address of the Spyder device as a string. The result could look as follows: 10.169.80.10
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Spyder1.IpAddress
or simply display it in the Debug Logger: DebugMessage(Christie_Spyder1.IpAddress)

Christie_SpyderName.IpAddress

Example:
vstring = Christie_Spyder1.IpAddress

Alternative Example:
vstring = Project.Christie_Spyder(1).IpAddress

This returns the IP address of the Spyder device as a string. The result could look as follows: 10.169.80.10
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Spyder1.IpAddress
or simply display it in the Debug Logger: DebugMessage(Christie_Spyder1.IpAddress)

In return, you can also assign an IP address to the connected Spyder device. WD automatically connects to it afterwards.
Christie_Spyder1.IpAddress = "10.169.80.10"

Christie_SpyderName.IsEnabled

Example:
vstring = Christie_Spyder1.IsEnabled

Alternative Example:
vstring = Project.Christie_Spyder(1).IsEnabled

This member returns the status of the check box "Enable" of the configuration dialog as a string or Boolean value. The result is "True" if the device is enabled and "False" if it is currently not enabled.
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Spyder1.IsEnabled
or simply display it in the Debug Logger: DebugMessage(Christie_Spyder1.IsEnabled)

Christie_SpyderName.LoadBackgroundImage(pixelSpaceId,filename)

Example:
Christie_Spyder1.LoadBackgroundImage(3,testpattern)

Alternative Example:
Project.Christie_Spyder(1).LoadBackgroundImage(3,testpattern)

This member is based on the Spyder command "BLD–Load Still in Background". It loads a file as the background on the current layer.

The argument "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.

Use the member LoadBackgroundImageNext to load it to the next layer.

Christie_SpyderName.LoadBackgroundImageNext(pixelSpaceId,filename)

Example:
Christie_Spyder1.LoadBackgroundImageNext(3,testpattern)

Alternative Example:
Project.Christie_Spyder(1).LoadBackgroundImageNext(3,testpattern)

This member is based on the Spyder command "BLD–Load Still in Background". It loads a file as the background on the current layer.

The argument "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.

Use the member LoadBackgroundImage to load it to the current layer.

Christie_SpyderName.LoadLayerImage(layerId,filename)

Example:
Christie_Spyder1.LoadLayerImage(1,testpattern)

Alternative Example:
Project.Christie_Spyder(1).LoadLayerImage(1,testpattern)

This member is based on the Spyder command "SLD–Load Still on Layer". It loads a file onto a layer.

Christie_SpyderName.LoadOutputImage(outputId,filename)

Example:
Christie_Spyder1.LoadOutputImage(8,testpattern)

Alternative Example:
Project.Christie_Spyder(1).LoadOutputImage(8,testpattern)

This member is based on the Spyder command "LSO–Load Still on Output". It loads an unscaled still image directly onto a Spyder output for the purpose of loading custom test patterns.

The argument "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.

Christie_SpyderName.MoveAndResizeLayer(layerId,positionX,positionY,width)

Example:
Christie_Spyder1.MoveAndResizeLayer(1,960,540,960)

Alternative Example:
Project.Christie_Spyder(1).MoveAndResizeLayer(1,960,540,960)

The example resizes and places the layer 1 to the absolute position x=960 and y=540 by scaling it to 960px width by keeping its ratio. On an HD screen, the layer is placed into the bottom right quadrant.

This member is based on the Spyder command "LSP–Layer Size and Position Change". It sets the size and horizontal and vertical position of a layer as an absolute position setting. In cases where the size and position are being modified simultaneously for an application, Christie recommends using this command instead of the individual layer size and position commands (KPS and KSZ).

The argument "width" sets the horizontal size, in pixels, of the specified layer.

The member MoveAndResizeLayerRelative changes the position relatively.

Christie_SpyderName.MoveAndResizeLayerRelative(layerId,positionX,positionY,width)

Example:
Christie_Spyder1.MoveAndResizeLayerRelative(1,-200,500,960)

Alternative Example:
Project.Christie_Spyder(1).MoveAndResizeLayerRelative(1,-200,500,960)

The example moves and resizes layer 1 relatively from its original position. It results into moving the layer 200 pixels to the left and 500 pixels down. It is also scaled to 960px width by keeping its ratio.

This member is based on the Spyder command "LSP–Layer Size and Position Change". It sets the size and horizontal and vertical position of a layer relative to the layer's current position. In cases where the size and position are being modified simultaneously for an application, Christie recommends using this command instead of the individual layer size and position commands (KPS and KSZ).

The argument "width" sets the horizontal size, in pixels, of the specified layer.

The member MoveAndResizeLayer applies an absolute position setting.

Christie_SpyderName.MoveLayer(layerId,positionX,positionY)

Example:
Christie_Spyder1.MoveLayer(1,960,540)

Alternative Example:
Project.Christie_Spyder(1).MoveLayer(1,960,540)

The example places the layer 1 to the absolute position x=960 and y=540.

This member is based on the Spyder command "KPS–Layer Position Change". It sets the horizontal and vertical position of a layer as an absolute position setting. Note: Positions are mapped in pixels, relative to the top-left pixelspace corner associated with the layer.

The member MoveLayerRelative changes the position relatively.

Christie_SpyderName.MoveLayerRelative(layerId,positionX,positionY)

Example:
Christie_Spyder1.MoveLayerRelative(1,-200,500)

Alternative Example:
Project.Christie_Spyder(1).MoveLayerRelative(1,-200,500)

The example moves layer 1 relatively from its original position. It results into moving the layer 200 pixels to the left and 500 pixels down.

This member is based on the Spyder command "KPS–Layer Position Change". It sets the horizontal and vertical position of a layer relative to the layer's current position. Note: Positions are mapped in pixels, relative to the top-left pixelspace corner associated with the layer.

The member MoveLayer applies an absolute position setting.

Christie_SpyderName.MoveLayerToPixelSpace(layerId,pixelSpaceId,visibility)

Example:
Christie_Spyder1.MoveLayerToPixelSpace(1,3,0)

Alternative Example:
Project.Christie_Spyder(1).MoveLayerToPixelSpace(1,3,0)

This member is based on the Spyder command "LAP–Layer Assign pixelspace". It associates a layer with a particular pixelspace.

Set the "visibility" argument to 0 in order to hide the layer(s) and to 1 in order to show the layer(s) 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 onto the screen with the TRN command which is the FadeLayerIn member.

Christie_SpyderName.RecallScriptCueByScriptId(scriptId,cueId)

Example:
Christie_Spyder1.RecallScriptCueByScriptId(13,2)

Alternative Example:
Project.Christie_Spyder(1).RecallScriptCueByScriptId(13,2)

This member is based on the Spyder command "RSC–Recall Script Cue". It recalls an existing script at a specific cue. To build scripts, use Spyder Studio.

Enter the ID specified within the script ID settings. The example recalls Script ID 13, no matter in which register or page it is placed or if it is moved.
Note: CueIDs are zero based so (13,2) recalls the third cue of script 13.
Tip: Cue 0 often prepares the Cue in Preview, while Cue1 pushes it to the output.

There is also the member RecallScriptCueRegisterId.

Christie_SpyderName.RecallScriptCueRegisterId(pageId,registerId,cueId)

Example:
Christie_Spyder1.RecallScriptCueRegisterId(2,5,2)

Alternative Example:
Project.Christie_Spyder(1).RecallScriptCueRegisterId(2,5,2)

This member is based on the Spyder command "RSC–Recall Script Cue". It recalls an existing script at a specific cue. To build scripts, use Spyder Studio.

Enter the Register ID, meaning its slot within the UI. The example recalls register 5 on page 2, no matter which Function Key has been placed in that spot.
Note: CueIDs are zero based so (2) recalls the third cue.
Tip: Cue 0 often prepares the Cue in Preview, while Cue1 pushes it to the output.

There is also the member RecallScriptCueByScriptId.

Christie_SpyderName.ResizeLayer(layerId,width)

Example:
Christie_Spyder1.ResizeLayer(1,960)

Alternative Example:
Project.Christie_Spyder(1).ResizeLayer(1,960)

This member is based on the Spyder command "KSZ–Layer Size Change". It sets the horizontal size of the specified layer.

The argument "width" sets the horizontal size, in pixels, of the specified layer. The vertical size adjusts automatically to ensure the layer's aspect ratio.

Christie_SpyderName.RestartSpyderServer

Example:
Christie_Spyder1.RestartSpyderServer

Alternative Example:
Project.Christie_Spyder(1).RestartSpyderServer

This member is based on the Spyder command "SDN–Restart Spyder Server". It restarts the Spyder server application remotely.

The member ShutdownSpyderServer would power it off.

Christie_SpyderName.SendCustomCommand(command)

Example:
Christie_Spyder1.SendCustomCommand("LSP 1 150 300 1920 5")

Alternative Example:
Project.Christie_Spyder(1).SendCustomCommand("LSP 1 150 300 1920 5")

This allows to send a custom command to the Spyder device which gives access to all supported Serial API commands. Please refer to the advanced manual of your Christie Spyder device in the section "External Control Protocol to learn the external control protocol acronyms of the specific command you want to use as well as the requested arguments. You DO NOT need to include the header or trailing parameters. Just enter the command and its parameters. Note that arguments are delimited with a space character.

The example command sends the relative position +150/+300 and width 1920px to Layer 5.

Christie_SpyderName.SetBackgroundTransitionDuration(duration)

Example:
Christie_Spyder1.SetBackgroundTransitionDuration(10)

Alternative Example:
Project.Christie_Spyder(1).SetBackgroundTransitionDuration(10)

This member is based on the Spyder command "BTR–Transition Background". It transitions the background layers across all pixelspaces. Pixelspace backgrounds cannot be transitioned individually.

The "duration" argument determines how long, in frames per second, a background layer takes to transition.

Christie_SpyderName.SetIpAddress(ipAddress)

Example:
Christie_Spyder1.SetIpAddress("10.169.80.10")

Alternative Example:
Project.Christie_Spyder(1).SetIpAddress("10.169.80.10")

This assigns the IP address "10.169.80.10" to the Spyder device. WD automatically connects to it afterwards.

Christie_SpyderName.SetLayerAspectRatio(layerId,aspectRatio)

Example:
Christie_Spyder1.SetLayerAspectRatio(1,1.33)

Alternative Example:
Project.Christie_Spyder(1).SetLayerAspectRatio(1,1.33)

This member is based on the Spyder command "ARO–Aspect Ratio Offset". It sets the aspect ratio for a layer. It keeps its width and changes the height accordingly.

Christie_SpyderName.SetMixerTransitionDuration(duration,deviceIndex)

Example:
Christie_Spyder1.SetMixerTransitionDuration(60,1)

Alternative Example:
Project.Christie_Spyder(1).SetMixerTransitionDuration(60,1)

This member is based on the Spyder command "DMT–Device Mixer Transition". It sets the automatic transition for a mixer one or more devices. This command is intended for devices configured as mixers.

The "duration" argument sets the transition duration to be applied, in frames per second; "1" forces a cut transition.
The "deviceIndex" argument indicates the target device indexes and is zero-based.

The example results into a 1 second fade when set to 60fps.

Christie_SpyderName.SetOutputModeToNormal(outputId,positionX,positionY)

Example:
Christie_Spyder1.SetOutputModeToNormal(8,0,0)

Alternative Example:
Project.Christie_Spyder(1).SetOutputModeToNormal(8,0,0)

This member is based on the Spyder command "OCM–Output Configuration Mode". It applies the output mode "Normal" and sets the horizontal and vertical starting position for an output.
The example shows the image on output 8 beginning in the top left corner.

There is also the member SetOutputModeToScaled.

Christie_SpyderName.SetOutputModeToScaled(outputId,pixelSpaceId)

Example:
Christie_Spyder1.SetOutputModeToScaled(8,3)

Alternative Example:
Project.Christie_Spyder(1).SetOutputModeToScaled(8,3)

This member is based on the Spyder command "OCM–Output Configuration Mode". It applies the output mode "Scaled" and sets the program pixelspace to focus Scaled on. If a preview ID is supplied, its associated program pixelspace is applied.

There is also the member SetOutputModeToNormal.

Christie_SpyderName.ShutdownSpyderServer

Example:
Christie_Spyder1.ShutdownSpyderServer

Alternative Example:
Project.Christie_Spyder(1).ShutdownSpyderServer

This member is based on the Spyder command "SDN–Restart Spyder Server". It powers off the Spyder server application remotely.

The member RestartSpyderServer would restart it.

Christie_SpyderName.SourceApplyToLayer(layerId,sourceName)

Example:
Christie_Spyder1.SourceApplyToLayer(1,PandorasBox)

Alternative Example:
Project.Christie_Spyder(1).SourceApplyToLayer(1,PandorasBox)

This member is based on the Spyder command "SRA–Source Apply". It applies an existing source to the specified layer. A source is defined as an input configuration and a router input. To create sources and define connected routers, use Spyder Studio.

The example assigns the input "PandorasBox" to layer 1.

Christie_SpyderName.SwapLayers(firstLayerId,secondLayerId)

Example:
Christie_Spyder1.SwapLayers(1,2)

Alternative Example:
Project.Christie_Spyder(1).SwapLayers(1,2)

This member is based on the Spyder command "SWA–Swap Layers". It swaps all properties between two specified layers, including PixelSpace, content, and keyframe. Note: both layers must be visible on screen when the command is executed

Christie_SpyderName.UnfreezeLayer(layerId)

Example:
Christie_Spyder1.UnfreezeLayer(1)

Alternative Example:
Project.Christie_Spyder(1).UnfreezeLayer(1)

This member is based on the Spyder command "FRZ–Freeze Layer". It unfreezes a layer.

Use the .FreezeLayer member to reverse this command.

Christie_SpyderName.UnfreezeOutput(outputId)

Example:
Christie_Spyder1.UnfreezeOutput(8)

Alternative Example:
Project.Christie_Spyder(1).UnfreezeOutput(8)

This member is based on the Spyder command "OFZ–Freeze Output". It unfreezes one or more outputs. This command is only compatible with universal outputs. DX4 outputs do not support individual freeze or unfreeze functionality.

Use the .FreezeOutput member to reverse this command.