Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Updated layout of MSA

Mees van der Wijk
2025-08-09 18:32:24 +02:00
parent 4617b61b43
commit d3cb1e1183
1 changed files with 160 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

348
ModuleServerAPI.md

@@ -57,7 +57,7 @@ Environment
* [getScenes](./ModuleServerAPI#getscenes) * [getScenes](./ModuleServerAPI#getscenes)
* [getResolution](./ModuleServerAPI#getresolution) **Deprecated** --> * [getResolution](./ModuleServerAPI#getresolution) **Deprecated** -->
## Functions ## Sub Classes
### Libs ### Libs
@@ -69,6 +69,8 @@ api.Libs;
**Returns** [Libs](./ModuleServerAPILibs) _Libs object_ **Returns** [Libs](./ModuleServerAPILibs) _Libs object_
## Communication
### on ### on
Register a listener for messages from the ModuleServerAPI. Register a listener for messages from the ModuleServerAPI.
@@ -95,6 +97,103 @@ api.broadcast(header, ...args);
| header | string | The header of the message. | | header | string | The header of the message. |
| args | any[] | Data of any type. | | args | any[] | Data of any type. |
### finishServerCondition
Finish a server condition.
```javascript
api.finishServerCondition(conditionId);
```
| Argument | Type | Description |
| ----------- | ------ | ------------------------ |
| conditionId | string | The id of the condition. |
### forceClientCondition
Force a client condition.
```javascript
api.forceClientCondition(conditionId);
```
| Argument | Type | Description |
| ----------- | ------ | ------------------------ |
| conditionId | string | The id of the condition. |
## Events
### onSceneChange
Register for a listener when the module is part of a scene change.
```javascript
api.onSceneChange(callback);
```
| Argument | Type | Description |
| -------- | ------------------------------------------------------------ | ---------------------------------------------------- |
| callback | ( displayId:string, origin:string, destination:string ):void | Function will be called when a scene change occures. |
### onFileUpload
Register for a listener for when a file is uploaded through the module file upload route. To use this send a HTTP post with the files in formData as the body to `http://serverIp:4080/:CHANNELNAME/upload/:MODULEID`.
```javascript
api.onFileUpload(callback);
```
| Argument | Type | Description |
| -------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| callback | ( files: { filename:string, originalFilename:string, byUser:string, size:number }[] ):void | Function will be called when a file upload has finished. |
### onTrigger
Register a listener for when a trigger is called from a cue list.
```javascript
api.onTrigger(triggerId, callback);
```
| Argument | Type | Description |
| --------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| triggerId | string | The trigger ID that the listener will receive. |
| callback | ( finish:function, status: (text:string)=>void, ...args:any[] ):void | Function will be called when the trigger is called from a cue list. The callback will receive the arguments in the same order they are defined in the [module.json](./ModuleJSON). |
## Getters
### getModuleID
Get the current module id.
```javascript
api.getModuleID();
```
**Returns** string _Module ID_
### getScenes
Get a list of all scenes this module is a part of.
```javascript
api.getModuleID();
```
**Returns** string[] _List of scene IDs_
### getResolution **Deprecated**
**Deprecated** This will currently return the default channel resolution. This needs to be replaced by a function that can get a scene or display resolution
Get the default channel resolution.
```javascript
api.getResolution();
```
## Clients
### getClients ### getClients
Get all connected clients. Get all connected clients.
@@ -137,7 +236,7 @@ api.hasClient(clientId);
**Returns** boolean _Client connected_ **Returns** boolean _Client connected_
### onNewClient ### onClientConnects
Assigns an event to be triggered when a new ModuleClientAPI connects. Assigns an event to be triggered when a new ModuleClientAPI connects.
@@ -149,6 +248,20 @@ api.onNewClient(callback);
| -------- | ------------------------------------------------- | ------------------------------------------------------------ | | -------- | ------------------------------------------------- | ------------------------------------------------------------ |
| callback | ( client:[Client](./ModuleServerAPIClient) ):void | Function will be called when a new ModuleClientAPI connects. | | callback | ( client:[Client](./ModuleServerAPIClient) ):void | Function will be called when a new ModuleClientAPI connects. |
### onClientDisconnects
Assigns an event to be triggered when a new ModuleClientAPI disconnects.
```javascript
api.onNewClient(callback);
```
| Argument | Type | Description |
| -------- | ------------------------------------------------- | --------------------------------------------------------------- |
| callback | ( client:[Client](./ModuleServerAPIClient) ):void | Function will be called when a new ModuleClientAPI disconnects. |
## Properties
### onModulePropertyUpdate ### onModulePropertyUpdate
Register a listener for when a module property updates. Register a listener for when a module property updates.
@@ -162,6 +275,44 @@ api.onModulePropertyUpdate(propertyId, callback);
| propertyId | string | The property ID that the listener will receive. | | propertyId | string | The property ID that the listener will receive. |
| callback | ( value:any ):void | Function that receives the new property value. | | callback | ( value:any ):void | Function that receives the new property value. |
### getModuleProperties
Get all properties of the module.
```javascript
api.getModuleProperties();
```
**Returns** { [ propertyId:string ]: [Property](./ModuleServerAPIProperty) } _All module properties_
### getModuleProperty
Get a property of the module.
```javascript
api.getModuleProperty(propertyId);
```
| Argument | Type | Description |
| ---------- | ------ | --------------------------------------- |
| propertyId | string | The id of the property you want to get. |
**Returns** [Property](./ModuleServerAPIProperty) _Reference property_
### hasModuleProperty
Check if the module has a property.
```javascript
api.hasModuleProperty(propertyId);
```
| Argument | Type | Description |
| ---------- | ------ | ----------------------------------------- |
| propertyId | string | The id of the property you want to check. |
**Returns** boolean _Has module property_
### onReferencePropertyUpdate ### onReferencePropertyUpdate
Register a listener for when a reference property updates in a scene change. Register a listener for when a reference property updates in a scene change.
@@ -175,58 +326,6 @@ api.onReferencePropertyUpdate(propertyId, callback);
| propertyId | string | The property ID that the listener will receive. | | propertyId | string | The property ID that the listener will receive. |
| callback | ( value:any ):void | Function that receives the new property value. | | callback | ( value:any ):void | Function that receives the new property value. |
### onSceneChange
Register for a listener when the module is part of a scene change.
```javascript
api.onSceneChange(callback);
```
| Argument | Type | Description |
| -------- | ------------------------------------------------------------ | ---------------------------------------------------- |
| callback | ( displayId:string, origin:string, destination:string ):void | Function will be called when a scene change occures. |
### onFileUpload
Register for a listener for when a file is uploaded through the module file upload route. To use this send a HTTP post with the files in formData as the body to `http://serverIp:4080/:CHANNELNAME/upload/:MODULEID`.
```javascript
api.onFileUpload(callback);
```
| Argument | Type | Description |
| -------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| callback | ( files: { filename:string, originalFilename:string, byUser:string, size:number }[] ):void | Function will be called when a file upload has finished. |
### onTrigger
Register a listener for when a trigger is called from a cue list.
```javascript
api.onTrigger(triggerId, callback);
```
| Argument | Type | Description |
| --------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| triggerId | string | The trigger ID that the listener will receive. |
| callback | ( finish:function, status: (text:string)=>void, ...args:any[] ):void | Function will be called when the trigger is called from a cue list. The callback will receive the arguments in the same order they are defined in the [module.json](./ModuleJSON). |
### onInit **Deprecated**.
**Deprecated:** This is no longer needed, any code that needs to be run on init can be placed in the root.
Register a listener for when the module is first loaded.
```javascript
api.onInit(callback);
```
| Argument | Type | Description |
| --------- | -------- | -------------------------------------------------------- |
| triggerId | string | The trigger ID that the listener will receive. |
| callback | function | Function will be called when the module is first loaded. |
### getReferenceProperties ### getReferenceProperties
Get all properties of a module reference in a scene. Get all properties of a module reference in a scene.
@@ -271,43 +370,15 @@ api.hasReferenceProperty(sceneId, propertyId);
**Returns** boolean _Has reference property_ **Returns** boolean _Has reference property_
### getModuleProperties ## Snapshots
Get all properties of the module. ### onSnapshotRestore **(TODO)**
```javascript ### onSnapshotCreate **(TODO)**
api.getModuleProperties();
```
**Returns** { [ propertyId:string ]: [Property](./ModuleServerAPIProperty) } _All module properties_ ### getRuntimeStorage **(TODO)**
### getModuleProperty ## Last State
Get a property of the module.
```javascript
api.getModuleProperty(propertyId);
```
| Argument | Type | Description |
| ---------- | ------ | --------------------------------------- |
| propertyId | string | The id of the property you want to get. |
**Returns** [Property](./ModuleServerAPIProperty) _Reference property_
### hasModuleProperty
Check if the module has a property.
```javascript
api.hasModuleProperty(propertyId);
```
| Argument | Type | Description |
| ---------- | ------ | ----------------------------------------- |
| propertyId | string | The id of the property you want to check. |
**Returns** boolean _Has module property_
### getLastState ### getLastState
@@ -331,6 +402,8 @@ api.setLastState(state);
| -------- | ----------------------------------- | ---------------------------- | | -------- | ----------------------------------- | ---------------------------- |
| state | [ModuleData](./ModuleServerAPIData) | New laststate of the module. | | state | [ModuleData](./ModuleServerAPIData) | New laststate of the module. |
## Filesystem
### readJSON ### readJSON
Read a file as JSON. Read a file as JSON.
@@ -431,107 +504,6 @@ api.hasHost(hostId);
**Returns** boolean \*Host ID is active. **Returns** boolean \*Host ID is active.
### hostFile **Deprecated**
**Deprecated** Replaced by: [addHost](./ModuleServerAPI#addhost)
Make a file accessable through the webserver.
```javascript
api.hostFile(scope, filename);
```
| Argument | Type | Description |
| -------- | --------------------- | ------------------------------------------------------------------------ |
| scope | 'module' \| 'channel' | The scope of the file, see [file scopes](./ModuleServerAPI#file-scopes). |
| filename | string | The name of the file. |
\*_Returns_ { hostID:string, relativeUrl:string} _The data of the hosted file._
### removeHostFile **Deprecated**
**Deprecated** Replaced by: [addHost](./ModuleServerAPI#removehost)
Remove a file that is currently hosted.
```javascript
api.removeHostFile(hostId);
```
| Argument | Type | Description |
| -------- | ------ | -------------------------------------------------- |
| hostId | string | The host id of the hosted file you want to remove. |
### hasHostFile **Deprecated**
**Deprecated** Replaced by: [addHost](./ModuleServerAPI#hashost)
Check if host ID is still being hosted.
```javascript
api.hasHostFile(hostId);
```
| Argument | Type | Description |
| -------- | ------ | ------------------------------------------------- |
| hostId | string | The host id of the hosted file you want to check. |
**Returns** boolean \*Host ID is active.
### finishServerCondition
Finish a server condition.
```javascript
api.finishServerCondition(conditionId);
```
| Argument | Type | Description |
| ----------- | ------ | ------------------------ |
| conditionId | string | The id of the condition. |
### forceClientCondition
Force a client condition.
```javascript
api.forceClientCondition(conditionId);
```
| Argument | Type | Description |
| ----------- | ------ | ------------------------ |
| conditionId | string | The id of the condition. |
### getModuleID
Get the current module id.
```javascript
api.getModuleID();
```
**Returns** string _Module ID_
### getScenes
Get a list of all scenes this module is a part of.
```javascript
api.getModuleID();
```
**Returns** string[] _List of scene IDs_
### getResolution **Deprecated**
**Deprecated** This will currently return the default channel resolution. This needs to be replaced by a function that can get a scene or display resolution
Get the default channel resolution.
```javascript
api.getResolution();
```
## Information ## Information
### File Scopes ### File Scopes