Still image input
Still Image input properties for Script Engine. Loads a single still image (PNG, JPEG, BMP, etc.) and presents it as a video source. Supports auto-reloading when the file is changed on disk and can act as a clickable element when the project is running in Interactive Mode, calling a Script Engine function on click.
| Property | Type | Access | Description |
|---|---|---|---|
ShowAdvancedOptions |
bool |
get/set |
Show or hide the input's advanced settings in the editor UI. [default=false]. |
SourceUrl |
Uri |
get/set |
Path or URL to the image file to display. Accepts a local file path or a remote URL pointing at any common image format (PNG, JPEG, BMP, GIF, TIFF, etc.). Clearing this leaves the input blank. Set this from a script to swap the displayed image at runtime. |
AutoReloadOnFileUpdated |
bool |
get/set |
Whether the image is automatically reloaded when the source file changes on disk. [default=false]. When true, the input checks the file roughly every 5 seconds and refreshes the picture if it has been modified. Useful when the image is being edited live in another tool, or when the file is updated by an external process — for example a scoreboard graphic that's re-saved on every change. |
IsInteractive |
bool |
get/set |
Whether the image becomes a clickable element. [default=false]. When enabled, and the project is running in Interactive Mode, clicking the image fires the Script Engine function named in OnClickFunction, optionally with ScriptParameter. Disable for a normal, non-interactive image. |
OnClickFunction |
string |
get/set |
Name of the Script Engine function to call when the image is clicked. Only used when IsInteractive is true. Set this to the exact name of a function defined in your Script Engine project. Leave blank to skip the callback. |
ScriptParameter |
string |
get/set |
Optional value passed to the click-handler function as an argument. Only used when IsInteractive is true and OnClickFunction is set. Useful for reusing the same handler across several still-image inputs and telling them apart by parameter (for example, the name of the button that was clicked). |
Width |
int |
get |
Width of the loaded image, in pixels (read-only). |
Height |
int |
get |
Height of the loaded image, in pixels (read-only). |
Minilog |
FormattedMessage |
get |
Most recent status, info, or error message from the input (read-only). The input writes here when an image loads, when auto-reload picks up a change, or when the file can't be found. Read this from a script to surface the latest event. |
Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.
See also: Still image input in Inputs — user-facing introduction, screenshots, and section summaries.