Node: Projector

From Waltz
Revision as of 15:56, 9 March 2020 by Patrick Angle (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The Projector node in Waltz allows you to control numerous different projectors over ethernet from different manufacturers using a single type of node. Each Projector node represents a single physical projector on your network. Not all features are available on all protocols or projectors.

Settings

Expected Type Details Default
localInterface LocalInterface The local network adapter that will be used to communicate with the projector. LocalInterface("0.0.0.0")
remoteAddress RemoteAddress/IP The address of the remote projector. Different projectors and protocols use different ports for communication. Be sure to select the correct port for the type of projector you are using. IP("10.22.1.101", 3002)
Projector Type Projector Type The type of projector to which you are trying to connect. Currently supported options are Christie Boxer/Mirage, Christie M-Series, Barco Pulse, and JBMISIA PJLink. Christie Boxer/Mirage
username String The username that will be used to authenticate with the projector. Some types of projectors, like PJLink projectors, ignore the username and only use the password. "service"
password String The password that will be used to authenticate with the projector. Some types of projectors, like PJLink projectors, ignore the username and only use the password. For Barco Pulse projectors, the password is expected to be a number, like "1234" "service"

Parameters

Type Details
projectorModel String Note: The parameter is read-only. The name of the projector, including the manufacturer and model if available.
powerState String Note: The parameter is read-only. The power state of the projector. This will be one of On, StandBy, CoolingDown, or WarmingUp.
shuttered Boolean true if the projector is shuttered, otherwise false. Setting this value will shutter or unshutter the projector if such functionality is available.
input Number The input, as a number, that is currently being used by the projector. These numbers do not always line up with those used by the projector's remote, so try setting the input via the remote and observing this value to determine the correct number to use if you wish to set the input.
hasSignal Boolean Note: The parameter is read-only. true if there is currently a signal for the active input, otherwise false.
testPattern Number The test pattern, as a number, that is currently being shown by the projector. Generally 0 means no pattern is being shown. The remaining numbers vary by projector make and model.
signalPreview Material Note: The parameter is read-only. A low resolution preview of the input into the projector, as a Material. This is useful for providing users with visual feedback as to what the projector is seeing on its input. This feature is currently only supported on Christie 4k Boxers and Christie Mirage projectors. Returns null if no preview is available, or if no signal is present.
information Map<Any> Note: The parameter is read-only. A Map of information about the projector. The available information is different for every projector make and model, and therefor not documented here.
warnings Map<Any> Note: The parameter is read-only. A subset of the information map, containing only items reading as a warning at the current moment.
errors Map<Any> Note: The parameter is read-only. A subset of the information map, containing only items reading as an error at the current moment.
lamps Map<Map<Any>> Note: The parameter is read-only. A map of maps containing information about each lamp in the projector. The first map is keyed by lamp number, and the second map is keyed by lamp stat, like totalLampHours. The available parameters vary by projector make and model.
zoomSupported Boolean Note: The parameter is read-only. true if zoom control is supported, otherwise false.
zoom Number The current zoom of the projector lens, as a number between 0 and 1. This value can be set if zoomSupported is true. If zoomSupported is false, this value may always be 0.5, depending on the projector make and model.
horizontalShiftSupported Boolean Note: The parameter is read-only. true if horizontalShift control is supported, otherwise false.
horizontalShift Number The current horizontal shift of the projector lens, as a number between 0 and 1. This value can be set if horizontalShiftSupported is true. If horizontalShiftSupported is false, this value may always be 0.5, depending on the projector make and model.
verticalShiftSupported Boolean Note: The parameter is read-only. true if verticalShift control is supported, otherwise false.
verticalShift Number The current vertical shift of the projector lens, as a number between 0 and 1. This value can be set if verticalShiftSupported is true. If verticalShiftSupported is false, this value may always be 0.5, depending on the projector make and model.
focusSupported Boolean Note: The parameter is read-only. true if focus control is supported, otherwise false.
focus Number The current focus of the projector lens, as a number between 0 and 1. This value can be set if focusSupported is true. If focusSupported is false, this value may always be 0.5, depending on the projector make and model.

Functions

Arguments Returns Details
lampOn() Void Lamp on the projector. This command may be ignored by some projectors while the projector is lamping off. This command is also ignored if the projector is already lamped on, or in the process of lamping on.
lampOff() Void Lamp off the projector. This command may be ignored by some projectors while the projector is lamping on. This command is also ignored if the projector is already lamped off, or in the process of lamping off.
send(message) String message - The message you wish to send to the projector. Void Send the specified message to the projector, first checking to make sure that the message is structured as a valid command for the projector. This does not guarantee the command itself is valid, only that the format of the message is valid. For example, all Christie projectors require commands be enclosed in parenthesis. That requirement is enforced here when a Christie-type projector is being used.

Example Usage

No examples provided.

Nodes
Devices ArtNet Input · ArtNet Output · Interactive LED Processor · NDI™ Input · NDI™ Output · OSC Input · OSC Output · Projector · SensorLink · TCP · TUIO Output · UDP Input · UDP Output · Watchout Media Server
Objects LED Tile Layout · List · Map · Random Number · Simulated Touch · Timer · Value · Wave
Operators Blend · Change · Clip · Cluster Tracker · DMX Multiverse Merge · Ease · Filter · Hold · JSON Mapper · JSON Stringify · Logic · Math · Proximity · Range · Rotate · Scale · Shear · Smooth · Touch Mapper · Translate
Scenes External Scene · Material Scene
Materials Graph · Touch Material
Scripting Script Function · Script
Comments Comment