Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 2.68 KB

File metadata and controls

34 lines (29 loc) · 2.68 KB
sidebar_position 1

Host Overview

The Host namespace is the top-level entry point for all host services — command execution, dialog management, object access, engine services, file I/O, signals, and more.

Properties

Property Type Writable Example Description
Classes object No Host.Classes.createInstance(id) Class factory and inspection
Console object No Host.Console.writeLine(text) Console output for debugging
Engine object No Host.Engine.TrackFormats Track format, color, speaker, and formatter helpers
GUI object No Host.GUI.Commands.interpretCommand(...) Command execution, dialogs, clipboard, themes, URL handling
Interfaces object No Host.Interfaces.IEditTask Interface capability markers for this.interfaces
IO object No Host.IO.openTextFile(path) File read/write, JSON, XML, Base64
Objects object No Host.Objects.getObjectByUrl(url) URL-based host object access
Results object No Host.Results.kResultOk Standard result code constants
Services object No Host.Services.getInstance(id) Service locator for inter-script singleton access
Settings object No Host.Settings.getAttributes() Script-local key-value persistence between phases
Signals object No Host.Signals.signal(ch, name, payload) Pub/sub messaging between scripts
SystemInfo object No Host.SystemInfo.getLocalTime() System time access
studioapp object No Host.studioapp.interpretCommand(...) Root URL object, same as ://hostapp

Methods

Method Returns Parameters Description
Host.Attributes(array) object array — flat key-value array (["key", "val", ...]) Wrap a key-value array into an Attributes object
Host.DateTime(date) object date — date string (e.g. "2026/01/01") Parse a date string into a DateTime object
Host.Url(path) object path — URL string (e.g. "local://$USERCONTENT/...") Construct a URL path object
Host.getPlatform() string none Detect current platform ("win" or "mac")
Host.sleep(ms) ms — milliseconds to sleep Sleep for a given duration