Methods
newUnixClient(optsnullable) → {StreamduckClient}
Initializes a new Unix Domain Socket based Streamduck client
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opts |
Object |
<nullable> |
Options for client. timeout - Request timeout, default 5000; reconnect - Automatically reconnects to daemon, default true |
Returns:
| Type | Description |
|---|---|
| StreamduckClient | Client that might still be connecting, check with is_connected method |
newUnixClient(optsnullable) → {StreamduckClient}
Initializes a new Unix Domain Socket based Streamduck client
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opts |
Object |
<nullable> |
Options for client. timeout - Request timeout, default 5000; reconnect - Automatically reconnects to daemon, default true |
Returns:
| Type | Description |
|---|---|
| StreamduckClient | Client that might still be connecting, check with is_connected method |
newWindowsClient(optsnullable) → {StreamduckClient}
Initializes a new Windows Named Pipes based Streamduck client
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opts |
Object |
<nullable> |
Options for client. timeout - Request timeout, default 5000; reconnect - Automatically reconnects to daemon, default true |
Returns:
| Type | Description |
|---|---|
| StreamduckClient | Client that might still be connecting, check with is_connected method |
newWindowsClient(optsnullable) → {StreamduckClient}
Initializes a new Windows Named Pipes based Streamduck client
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opts |
Object |
<nullable> |
Options for client. timeout - Request timeout, default 5000; reconnect - Automatically reconnects to daemon, default true |
Returns:
| Type | Description |
|---|---|
| StreamduckClient | Client that might still be connecting, check with is_connected method |
Type Definitions
Button
Button object
Button
Button object
DeviceConfig
Device Config object
DeviceConfig
Device Config object
EventListener(event)
Event listener
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Object | Event data |
EventListener(event)
Event listener
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Object | Event data |
Panel
Panel object
Panel
Panel object
Value
Value object
Value
Value object