Skip to content

Commit

Permalink
update builds
Browse files Browse the repository at this point in the history
  • Loading branch information
BryanChrisBrown committed Mar 12, 2024
1 parent b8fb10a commit 4c0ef6c
Show file tree
Hide file tree
Showing 28 changed files with 556 additions and 26 deletions.
2 changes: 1 addition & 1 deletion dist/tsconfig.tsbuildinfo

Large diffs are not rendered by default.

36 changes: 35 additions & 1 deletion docs/classes/client_BridgeClient.BridgeClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
- [showWindow](client_BridgeClient.BridgeClient.md#showwindow)
- [status](client_BridgeClient.BridgeClient.md#status)
- [stopStudioPlaylist](client_BridgeClient.BridgeClient.md#stopstudioplaylist)
- [time](client_BridgeClient.BridgeClient.md#time)
- [timeEnd](client_BridgeClient.BridgeClient.md#timeend)
- [updateCurrentHologram](client_BridgeClient.BridgeClient.md#updatecurrenthologram)
- [warn](client_BridgeClient.BridgeClient.md#warn)
- [getInstance](client_BridgeClient.BridgeClient.md#getinstance)
Expand Down Expand Up @@ -120,7 +122,7 @@ ___

### playState

**playState**: ``"PLAYING"`` \| ``"PAUSED"`` \| ``"STOPPED"`` = `'STOPPED'`
**playState**: ``"PLAYING"`` \| ``"PAUSED"`` \| ``"STOPPED"`` = `"STOPPED"`

___

Expand Down Expand Up @@ -621,6 +623,38 @@ stop playing the studio playlist

___

### time

**time**(`label`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `label` | `string` |

#### Returns

`void`

___

### timeEnd

**timeEnd**(`label`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `label` | `string` |

#### Returns

`void`

___

### updateCurrentHologram

**updateCurrentHologram**<`T`\>(`«destructured»`): `Promise`<{ `response`: ``null`` \| { `name`: `string` = schema.name; `orchestration`: { value: string; name: string; type: "WSTRING"; } ; `status`: { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } = schema.status } ; `success`: `boolean` }\>
Expand Down
2 changes: 2 additions & 0 deletions docs/classes/components_hologram.QuiltHologram.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Create a new Quilt Hologram
| `args.settings.columns` | `number` |
| `args.settings.focus?` | `number` |
| `args.settings.rows` | `number` |
| `args.settings.tag?` | `string` |
| `args.settings.viewCount` | `number` |
| `args.uri` | `string` |

Expand All @@ -51,6 +52,7 @@ Create a new Quilt Hologram
| `columns` | `number` |
| `focus?` | `number` |
| `rows` | `number` |
| `tag?` | `string` |
| `viewCount` | `number` |

___
Expand Down
2 changes: 2 additions & 0 deletions docs/classes/components_hologram.RGBDHologram.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Create a new RGBD Hologram
| `args.settings.depth_loc` | ``0`` \| ``2`` \| ``1`` \| ``3`` | `undefined` | Where are the holograms located? 0 Top 1 Bottom 2 Right 3 Left |
| `args.settings.depthiness` | `number` | `DEPTHINESS.range` | Depthiness can be a value between 0.1 and 2 |
| `args.settings.focus?` | `number` | `undefined` | Controls the Focus of the hologram |
| `args.settings.tag?` | `string` | `undefined` | - |
| `args.settings.zoom` | `number` | `ZOOM.range` | Zoom can be between 0.1 and 2 |
| `args.uri` | `string` | `undefined` | - |

Expand All @@ -57,6 +58,7 @@ Create a new RGBD Hologram
| `depth_loc` | ``0`` \| ``2`` \| ``1`` \| ``3`` | Where are the holograms located? 0 Top 1 Bottom 2 Right 3 Left |
| `depthiness` | `number` | Depthiness can be a value between 0.1 and 2 |
| `focus?` | `number` | Controls the Focus of the hologram |
| `tag?` | `string` | - |
| `zoom` | `number` | Zoom can be between 0.1 and 2 |

___
Expand Down
87 changes: 87 additions & 0 deletions docs/classes/components_messageHandler.AllEventsMessageHandler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
[@lookingglass/bridge](../README.md) / [components/messageHandler](../modules/components_messageHandler.md) / AllEventsMessageHandler

# Class: AllEventsMessageHandler

[components/messageHandler](../modules/components_messageHandler.md).AllEventsMessageHandler

## Hierarchy

- [`MessageHandler`](components_messageHandler.MessageHandler.md)<keyof [`BridgeEventMap`](../modules/schemas_schema_events.md#bridgeeventmap)\>

**`AllEventsMessageHandler`**

## Table of contents

### Constructors

- [constructor](components_messageHandler.AllEventsMessageHandler.md#constructor)

### Properties

- [bridgeEventName](components_messageHandler.AllEventsMessageHandler.md#bridgeeventname)
- [client](components_messageHandler.AllEventsMessageHandler.md#client)

### Methods

- [handle](components_messageHandler.AllEventsMessageHandler.md#handle)

## Constructors

### constructor

**new AllEventsMessageHandler**(`args`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

[MessageHandler](components_messageHandler.MessageHandler.md).[constructor](components_messageHandler.MessageHandler.md#constructor)

## Properties

### bridgeEventName

**bridgeEventName**: keyof [`BridgeEventMap`](../modules/schemas_schema_events.md#bridgeeventmap)

#### Inherited from

[MessageHandler](components_messageHandler.MessageHandler.md).[bridgeEventName](components_messageHandler.MessageHandler.md#bridgeeventname)

___

### client

**client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

[MessageHandler](components_messageHandler.MessageHandler.md).[client](components_messageHandler.MessageHandler.md#client)

## Methods

### handle

**handle**(`message`): `void`

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

`void`

#### Overrides

[MessageHandler](components_messageHandler.MessageHandler.md).[handle](components_messageHandler.MessageHandler.md#handle)
10 changes: 10 additions & 0 deletions docs/classes/components_messageHandler.MessageHandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@

[`MonitorDisconnectedMessageHandler`](components_messageHandler.MonitorDisconnectedMessageHandler.md)

[`TransportControlPauseMessageHandler`](components_messageHandler.TransportControlPauseMessageHandler.md)

[`TransportControlPlayMessageHandler`](components_messageHandler.TransportControlPlayMessageHandler.md)

[`TransportControlNextMessageHandler`](components_messageHandler.TransportControlNextMessageHandler.md)

[`TransportControlPreviousMessageHandler`](components_messageHandler.TransportControlPreviousMessageHandler.md)

[`ProgressStartMessageHandler`](components_messageHandler.ProgressStartMessageHandler.md)

[`ProgressCompletionMessageHandler`](components_messageHandler.ProgressCompletionMessageHandler.md)
Expand All @@ -38,6 +46,8 @@

[`NewItemPlayingMessageHandler`](components_messageHandler.NewItemPlayingMessageHandler.md)

[`AllEventsMessageHandler`](components_messageHandler.AllEventsMessageHandler.md)

## Table of contents

### Constructors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { index: { value: number; name: string; type: "UNSIGNED\_INT"; }; playlist\_name: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| ... 9 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.payload` | { value: { index: { value: number; name: string; type: "UNSIGNED\_INT"; }; playlist\_name: { value: string; name: string; type: "WSTRING"; }; tag: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| ... 14 more ... \| "All Events"; name: string; type: "WSTRING"; }; }; name: string; ty... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_M... | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 12 more ... \| "All Events"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; index: { value: number; name: string; type: "UNSIGNED\_INT"; }; uri: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: str... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; index: { value: number; name: string; type: "UNSIGNED\_INT"; }; uri: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| ... 14 more ... \| "All Events"; name: string; type: "WSTRING"; }; }; name: string; type: "V... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_M... | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 12 more ... \| "All Events"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 10 more ... \| "All Events"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }; name: stri... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns
Expand Down
Loading

0 comments on commit 4c0ef6c

Please sign in to comment.