Checking remote

2026-01-30 13:18:43 +01:00
parent 6fe840c076
commit 256481a7a6
1 changed files with 72 additions and 54 deletions
--- a/ModuleServerAPI.md
+++ b/ModuleServerAPI.md
@@ -24,21 +24,7 @@ api.Libs;

 **Return** [Libs](./ModuleServerAPILibs) _Included libraries_

-## System Events
-
-### onDestroy
-
-Register a listener for when the module is destroyed from a channel. Make sure you stop your clocks and render loops here.
-
-```javascript
-api.onDestroy(callback);
-```
-
-| Argument | Type     | Description                                                  |
-| -------- | -------- | ------------------------------------------------------------ |
-| callback | ( ):void | Function that will be called when the module gets destroyed. |
-
-## Getters
+## System

 ### getModuleId

@@ -60,6 +46,16 @@ api.getChannelId();

 **Returns** string _Channel ID_

+### getChannelHostname
+
+Get the current channel hostname.
+
+```javascript
+api.getChannelHostname();
+```
+
+**Returns** string _Channel Hostname_
+
 ### inDevelopmentMode

 Check if Getiyo is running in development mode.
@@ -70,6 +66,18 @@ api.inDevelopmentMode();

 **Returns** boolean _Development mode active_

+### onDestroy
+
+Register a listener for when the module is destroyed from a channel. Make sure you stop your clocks and render loops here.
+
+```javascript
+api.onDestroy(callback);
+```
+
+| Argument | Type     | Description                                                  |
+| -------- | -------- | ------------------------------------------------------------ |
+| callback | ( ):void | Function that will be called when the module gets destroyed. |
+
 ## Communication

 ### on
@@ -111,45 +119,6 @@ api.registerWebhook(webhookId, callback);
 | webhookId | string                | The ID the webhook will use.                      |
 | callback  | (...args:any[] ):void | Callback with arguments provided through the url. |

-## Cues
-
-### 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. |
-
-### 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). |
-
 ## Clients

 ### getClients
@@ -328,6 +297,55 @@ api.hasReferenceProperty(sceneId, propertyId);

 **Returns** boolean _Has reference property_

+## Modules
+
+### sendToModule
+
+### receiveFromModule
+
+### getChannelModules
+
+### hasChannelModules
+
+## Cues
+
+### 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. |
+
+### 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). |
+
 ## Scenes

 ### getScenes