Skip to content

Latest commit

 

History

History
82 lines (70 loc) · 4.33 KB

File metadata and controls

82 lines (70 loc) · 4.33 KB

API Index

Setup & Packaging

Page Description
Package Structure Required/optional files in a .package
metainfo.xml Package identity and metadata
classfactory.xml Script registration and categories
Resources Runtime resource access via package://
Installation Scripts folder locations and hot-reloading
Creating a .package File Zip-based packaging for distribution
Script Interface Task lifecycle, execution phases, factory functions

Host API

Page Description
Host Overview Top-level Host object and platform access
Attributes Key-value attribute read/write and iteration
Classes Built-in class instantiation
Command Reference All host commands by category
DateTime Date string parsing and formatting
Engine Formatters and track presentation helpers
GUI Dialog, command, and theme management
Interfaces Required interface tokens for script lifecycle
IO File and package I/O operations
Objects Object lookup and registration
Results Standard result code constants
Services Host service instance lookup
Settings Session-level persistent attributes
Signals Pub/sub messaging between scripts and observers
URL Host path manipulation and display
Utilities Console logging, platform detection, sleep

SDK Files

Page Description
CCL.JS Application and window manager API wrappers
Engine.JS Track class and media pool constants
Devices.JS Port type and device constants
HostUtils Package, mixer, and document utility accessors

Context & Objects

Page Description
Context Object Script execution entry point
Context Methods Context state and attribute management
Editor Active editor surface and operations
Functions Document edit operation dispatch
Iterator Selected event iteration
mainTrackList Track selection and indexing
Parameters Dialog parameter creation and bindings
Event Object Event types and common properties
Region Object Part/region hierarchy and iteration
Track Object Track properties and channel access
Channel Object Channel strip controls and routing
Mixer Channels Channel list access and mixer navigation
Time Object Time representation and conversions

Skin XML Reference

Page Description
Document Structure Skin file structure and top-level elements
Layout Containers All layout and container elements
Control Flow Template, conditional, and delegate elements
Text & Display Read-only display and content elements
Input Controls All interactive input widget elements
List Controls List view element
Style Helpers Visual property and metric definition elements
Image & Shape Resources Image and geometric resource elements
Skin.xml Index Complete element table and attribute index

Utilities & Tools

Page Description
Utilities & Conversions Unit conversion and utility helpers
Debugging Utilities Runtime introspection and probe utilities