Connection Module Basic API
This section describes the basic elements of the Companion connection-module API.
Overview
- Exposing your module class
- Define the module class
- Methods called from Companion
- Methods you call directly
- Further Reading
Logging
Connecting to the device
User-Config Definitions
Action Definitions
Feedback Definitions
- API call:
setFeedbackDefinitions() - API calls:
checkFeedbacks(...),checkAllFeedbacks()&checkFeedbacksById(...) - Feedback types
- Feedback definitions
- TypeScript typings
- Further Reading
Input Fields (Options)
Variables
- API call:
setVariableDefinitions() - Variable definitions
- API call:
setVariableValues() - TypeScript typings
- Further Reading
Presets (API 2.x)
- API call:
setPresetDefinitions() - Preset types
- Simple button preset definitions
- Internal actions and feedbacks in presets
- Layered button presets
- Preset alternatives
- Preset Structure
- TypeScript typings
- Standard Colors
- Icons
- Further Reading
Graphics Elements
- The coordinate model
- Values and expressions
- Properties common to all elements
- Element types
- Border properties
- The canvas
- Further Reading
Composite Elements
- API call:
setCompositeElementDefinitions() - Definition fields
- Using a composite element
- Validation
- TypeScript typings
- Further Reading
Presets (API 1.x)
- API call:
setPresetDefinitions() - Preset types
- Button preset definitions
- Standard Colors
- Icons
- Further Reading