The Host contains references to local components and Engine commands.
Host | |||
---|---|---|---|
Properties | |||
Property Name | Return Data Type | Description | |
Name | String | Returns the name of this Host | |
ProductName | String | Returns the string name of the product that the host is running on eg. | |
IpAddress | String | Returns a string representation of the IP address of this Host in the form of xxx.xxx.xxx.xxx | |
ComponentNames | Lua Table [Number,String] | Returns a table of the names of all the components running on this Host indexed by increasing integer | |
StoppedComponentNames | Lua Table [Number,String] | Returns a table of the names of all the components on this host that are not currently running indexed by increasing integer | |
Engine | Engine Component Object or Nil | Returns the Engine Component Object running on this host if it exists or Nil if it does not or is stopped | |
DMX | DMX Component Object or Nil | Returns the DMX2 Component Object running on this host if it exists or nil if it does not or is stopped | |
MediaManager | MediaManager Component Object or Nil | Returns the MediaManager Component Object running on this host if it exists or nil if it does not or is stopped | |
MacroManager | MacroManager Component Object or Nil | Returns the MacroManager Component Object running on this host if it exists or nil if it does not or is stopped | |
PresetManager | PresetManager Component Object or Nil | Returns the PresetManager Component Object running on this host if it exists or nil if it does not or is stopped | |
Timeline | Timeline Object | Returns the Timeline Component Object running on this host if it exists or nil if it does not or is stopped | |
AvailableComponents | Lua Table | This returns an indexed lua table of names of components available to be added to the host | |
Functions | |||
Function Name | Parameters | Return Data Type | Description |
FindComponent | (String Name) | Component Object or Nuil | Returns the Component Object called running on this host or Nil if it cannot be found |
SearchComponentNames | (String Pattern) | Lua Table [Number, Component Object] | Returns a table of all the Components running on this host whose name includes indexed by increasing integer |
ShutdownHostSoftware | () | Nothing | Attempts to shutdown Hippotizer software on this machine, returns nothing |
ShutdownHostMachine | () | Nothing | Attempts to shutdown this machine and all the software running on it, returns nothing |
RestartHostMachine | () | Nothing | Attempts to restart this machine , returns nothing |
StartComponent | (String ComponentName) | Boolean | Attempts to start Component with name if it is stopped, returns True if successful or False if it failed |
StopComponent | (String ComponentName) | Boolean | Attempts to stop Component with name if it is running, returns True if successful or False if it failed |
AddComponent | () | String | This adds a new component to the host of type “XXX’ with name of “XXX”, respects component install limits. |
DeleteComponent | () | String | This stops and deletes the first component that it finds on the host with the name “XXX”, respects Component rules so you cannot delete reserved components such as Engine. |
Hinterlasse einen Kommentar.