Description
Is this a feature relevant to companion itself, and not a module?
- I believe this to be a feature for companion, not a module
Is there an existing issue for this?
- I have searched the existing issues
Describe the feature
Add a small extension to the API to provide button information, similar to the existing export function but accessible via API.
Proposed Endpoints:
- Retrieve Specific Page by Number:
Method: GET
Path: /api/pages/{pageNumber}
Functionality: Returns a JSON object for the specified page number.
- Retrieve All Pages with Content:
Method: GET
Path: /api/pages
Functionality: Returns a JSON array of all pages that contain content, similar to the current export function.
Usecases
We are developing a timeline based execution software and aim to incorporate simple remote control support for Companion. To enhance clarity and user experience, we need to access information about the currently defined buttons and display their appearance within our interface, which will then interact directly with Companion. We'll also use the existing Remote Control API triggers.