Loading...
This chapter gives an overview of the members available for the Terra device.
Please read the chapter "Terra" if you would like to know how to add and use a Terra device. There is also a "Terra Tutorial" available which explains the most important steps.
As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.
Project.Christie_Terra(deviceName or ID) |
Example: Alternative Example: |
This gives access to all further members of the device "Christie_Terra" 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: |
Christie_TerraName.ApplyLayout(layoutName) |
Example: Alternative Example: |
This applies the layout named "PIP" to the display array it was created for. |
Christie_TerraName.ApplyMasterLayout(masterLayoutName) |
Example: Alternative Example: |
This applies the master layout named "PIP+MicroAll" to the display arrays the original layouts were created for. If master layouts in the Terra Manager are updated whilst WD is running, please restart WD when the configuration is finished. In difference to (sub) layout or device names, Widget Designer receives the names of available master layouts only when the application is launched. |
Christie_TerraName.ApplyVideoSource(displayArrayName,layoutName,viewIndex,transmitterName) |
Example: Alternative Example: |
This applies the video source of the Transmitter named "Pandora_Dual_1" to the window with the view index 2 within the layout named "PIP" on the display array named "4LCDs". Bare in mind that this change of the layout is not saved automatically. To save the layout, use the member "SaveLayout". |
Christie_TerraName.ClearDisplayArray(displayArrayName) |
Example: Alternative Example: |
This clears the current layout and all sources from the display array named "4LCDs". |
Christie_TerraName.DeleteLayout(layoutName) |
Example: Alternative Example: |
This removes the layout named "PIP" from the Terra Manager so that it cannot be applied anymore. |
Christie_TerraName.DeviceInfo(deviceName) |
Example: Alternative Example: |
Use this member with its further members, e.g.: Fps,Height,Id,... You can either use: |
Christie_TerraName.DeviceInfo(deviceName).Id |
Example: Alternative Example: |
This member returns the ID of the receiver (or transmitter) named "Top_Left". Which, by the way, is its MAC address. The result could look as follows: 000948dd0118 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").Id |
Christie_TerraName.DeviceInfo(deviceName).Name |
Example: Alternative Example: |
This member returns the name of the receiver (or transmitter) named "Top_Left". The result could look as follows: Top_Left (or 000948DD0118 if you did not change the default name) You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").Name |
Christie_TerraName.DeviceInfo(deviceName).Width |
Example: Alternative Example: |
This member returns the resolution width of the receiver (or transmitter) named "Top_Left". The result could look as follows: 1920 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").Width |
Christie_TerraName.DeviceInfo(deviceName).Height |
Example: Alternative Example: |
This member returns the resolution height of the receiver (or transmitter) named "Top_Left". The result could look as follows: 1080 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").Height |
Christie_TerraName.DeviceInfo(deviceName).Fps |
Example: Alternative Example: |
This member returns the Framerate of the receiver (or transmitter) named "Top_Left". The result could look as follows: 60 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").Fps |
Christie_TerraName.DeviceInfo(deviceName).IsReceiver |
Example: Alternative Example: |
This member returns the answer whether the receiver (or transmitter) named "Top_Left" is a receiver. The result is "true" or "false". You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").IsReceiver |
Christie_TerraName.DeviceInfo(deviceName).IsTransmitter |
Example: Alternative Example: |
This member returns the answer whether the receiver (or transmitter) named "Top_Left" is a transmitter. The result is "true" or "false". You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Top_Left").IsTransmitter |
Christie_TerraName.DeviceInfo(deviceName).InputConnector |
Example: Alternative Example: |
This member returns the connected inputs of the transmitter (!) named "Pandora_Dual_1". The result could look as follows: HDMI (or "DisplayPort" or in case of a receiver "none") You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DeviceInfo("Pandora_Dual_1").InputConnector If you would like to change the input connector, use the command Christie_Terra1.SwitchInputConnector("Pandora_Dual_1","HDMI") |
Christie_TerraName.DeviceNames |
Example: Alternative Example: |
This member returns all device names (i.e. running transmitters and receivers) as a list. The result could look as follows: [Pandora_Dual_1, Pandora_Dual_2, Top_Left, Top_Right, Bottom_Left, Bottom_Right] (or [000948AA006A, 000948AA0698, 000948DD0118, 000948DD0227, 000948DD0336, 000948DD0445] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.DeviceNames) |
Christie_TerraName.Disable |
Example: Alternative Example: |
This disables the Terra 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_TerraName.DisplayArrayLayoutName(displayArrayName) |
Example: Alternative Example: |
This member returns the name of the layout currently applied to the display array named "4LCDs". The result could look as follows: PIP You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DisplayArrayLayoutName("4LCDs") |
Christie_TerraName.DisplayArrayNames |
Example: Alternative Example: |
This member returns all display array names as a list. The result could look as follows: [4LCDs,Projectorblend,MicroTiles] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.DisplayArrayNames) |
Christie_TerraName.DisplayArrayWindowCount(displayArrayName) |
Example: Alternative Example: |
This member returns the current window count for the display array named "4LCDs" as an integer number. Note that all windows have a view index which always starts with [1] and is numbered through depending on the window's position, so the next one has [2]. The result could look as follows: 4 The first example shows how to use it with an integer variable named "vint". You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DisplayArrayWindowCount("4LCDs") |
Christie_TerraName.DisplayArrayWindowSourceName(displayArrayName,viewIndex) |
Example: Alternative Example: |
This member returns the name of the source (= transmitter) for the window with view index [1] within the display array named "4LCDs". The result could look as follows: Pandora_Dual_1 (or 000948AA006A if you did not change the default name) You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.DisplayArrayWindowSourceName("4LCDs",1) |
Christie_TerraName.Enable |
Example: Alternative Example: |
This enables the Terra 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_TerraName.GetDeviceNames |
Example: Alternative Example: |
This member returns all device names (i.e. running transmitters and receivers) as a list. The result could look as follows: [Pandora_Dual_1, Pandora_Dual_2, Top_Left, Top_Right, Bottom_Left, Bottom_Right] (or [000948AA006A, 000948AA0698, 000948DD0118, 000948DD0227, 000948DD0336, 000948DD0445] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetDeviceNames) |
Christie_TerraName.GetDisplayArrayNames |
Example: Alternative Example: |
This member returns all display array names as a list. The result could look as follows: [4LCDs,Projectorblend,MicroTiles] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetDisplayArrayNames) |
Christie_TerraName.GetIpAddress |
Example: Alternative Example: |
This returns the IP address of the Terra device as a string. The result could look as follows: 10.169.80.10 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.IpAddress |
Christie_TerraName.GetLayoutNames |
Example: Alternative Example: |
This member returns all layout names as a list. The result could look as follows: [PIP,Fullscreen,MicroAll,MicroBarOnly] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetLayoutNames) |
Christie_TerraName.GetMasterLayoutNames |
Example: Alternative Example: |
This member returns all names of master layouts as a list. The result could look as follows: [PIP+MicroAll,PIP+MicroBarOnly] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetMasterLayoutNames) |
Christie_TerraName.GetReceiverNames |
Example: Alternative Example: |
This member returns the names of all running receiver devices as a list. The result could look as follows: [Top_Left, Top_Right, Bottom_Left, Bottom_Right] (or [000948DD0118,000948DD0227,000948DD0336,000948DD0445] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetReceiverNames) |
Christie_TerraName.GetTransmitterNames |
Example: Alternative Example: |
This member returns the names of all running transmitter devices as a list. The result could look as follows: [Pandora_Dual_1, Pandora_Dual_2] (or [000948AA006A,000948AA0698] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.GetTransmitterNames) |
Christie_TerraName.IpAddress |
Example: Alternative Example: |
This returns the IP address of the Terra device as a string. The result could look as follows: 10.169.80.10 You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.IpAddress In return, you can also assign an IP address to the connected Terra controller. WD automatically connects to it afterwards. |
Christie_TerraName.IsConnected |
Example: Alternative Example: |
This member returns the connection status for the Terra controller as a Boolean value. The result is "True" if the device is connected and "False" if it is currently disconnected. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.IsConnected |
Christie_TerraName.IsEnabled |
Example: Alternative Example: |
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. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Christie_Terra1.IsEnabled |
Christie_TerraName.LayoutNames |
Example: Alternative Example: |
This member returns all layout names as a list. The result could look as follows: [PIP,Fullscreen,MicroAll,MicroBarOnly] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.LayoutNames) |
Christie_TerraName.LayoutNamesByDisplayArray(displayArrayName) |
Example: Alternative Example: |
This member returns all layout names as a list that are saved with the display array named "4LCDs". The result could look as follows: [PIP,Fullscreen] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.LayoutNamesByDisplayArray("4LCDs")) |
Christie_TerraName.MasterLayoutNames |
Example: Alternative Example: |
This member returns all names of master layouts as a list. The result could look as follows: [PIP+MicroAll,PIP+MicroBarOnly] You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.MasterLayoutNames) |
Christie_TerraName.ReceiverNames |
Example: Alternative Example: |
This member returns the names of all running receiver devices as a list. The result could look as follows: [Top_Left, Top_Right, Bottom_Left, Bottom_Right] (or [000948DD0118,000948DD0227,000948DD0336,000948DD0445] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.ReceiverNames) |
Christie_TerraName.RestartSystem |
Example: Alternative Example: |
This shuts down the Terra controller and restarts it. |
Christie_TerraName.SaveLayout(displayArrayName,newLayoutName,overwrite) |
Example: Alternative Example: |
This saves a (new) layout with the name "Fullscreen" for the display array named "4LCDs". As the "overwrite" parameter is set to "true" the current state of the layout will be overwritten. Set it to "false" in case you never want to overwrite existing layouts but only save completely new ones. |
Christie_TerraName.SendRS232(deviceName,targetGroup,port,data) |
Example: Alternative Example: |
This creates the data package "foo" and sends it to the receiver named "Top_Left" to output it to a connected device like a monitor or projector. If you set the parameter "targetGroup" to another of the suggested values (ALL, ALL_RX, ALL_TX)you can access more than one device. |
Christie_TerraName.SetIpAddress(ipAddress) |
Example: Alternative Example: |
This assigns the IP address "10.169.80.10" to the Terra device. WD automatically connects to it afterwards. |
Christie_TerraName.StopDevice(deviceName) |
Example: Alternative Example: |
This tells the transmitter named "Pandora_Dual_1" to stop sending any video streams. Use the SwitchVideo member to start sending a stream again. |
Christie_TerraName.SwitchAudio(fromTransmitterName,toReceiverName,type) |
Example: Alternative Example: |
This switches the audio source from the transmitter named "Pandora_Dual_1" to the receiver named "Top_Left" With the "type" parameter you can choose between the analog or HDMI audio source. Note that this does not show up in the Terra Manager as it directly routes the signal and has nothing to do with Layouts or Display Arrays. |
Christie_TerraName.SwitchInputConnector(transmitterName,connector) |
Example: Alternative Example: |
This chooses the HDMI input to be the source for the transmitter named "Pandora_Dual_1" e.g. if you have two inputs connected to one transmitter. You can also switch it to the input "DisplayPort". |
Christie_TerraName.SwitchRS232(fromTransmitterName,toReceiverName) |
Example: Alternative Example: |
This switches the RS232 source from the transmitter named "Pandora_Dual_1" to the receiver named "Top_Left". Note that this does not show up in the Terra Manager as it directly routes the signal and has nothing to do with Layouts or Display Arrays. |
Christie_TerraName.SwitchUSB(fromReceiverName,toTransmitterName) |
Example: Alternative Example: |
This switches the USB source from the receiver (!) named "Top_Left" to the transmitter (!) named "Pandora_Dual_1". Note that this does not show up in the Terra Manager as it directly routes the signal and has nothing to do with Layouts or Display Arrays. |
Christie_TerraName.SwitchVideo(fromTransmitterName,toReceiverName) |
Example: Alternative Example: |
This switches the video source from the transmitter named "Pandora_Dual_1" to the receiver named "Top_Left". Note that this does not show up in the Terra Manager as it directly routes the signal and has nothing to do with Layouts or Display Arrays. Use the member "SwitchVideoWithEmbeddedAudio" if you would like to switch video together with its embedded audio information. Use the member "StopDevice" to stop sending any stream. |
Christie_TerraName.SwitchVideoWithEmbeddedAudio(fromTransmitterName,toReceiverName) |
Example: Alternative Example: |
This switches the video (with embedded audio) source from the transmitter named "Pandora_Dual_1" to the receiver named "Top_Left". Note that this does not show up in the Terra Manager as it directly routes the signal and has nothing to do with Layouts or Display Arrays. |
Christie_TerraName.TransmitterNames |
Example: Alternative Example: |
This member returns the names of all running transmitter devices as a list. The result could look as follows: [Pandora_Dual_1, Pandora_Dual_2] (or [000948AA006A,000948AA0698] if you did not change the default names). You could also write it into a Widget, e.g. a DropDown List via the script and a local variable "list": or simply display it in the Debug Logger: DebugMessage(Christie_Terra1.TransmitterNames) |