Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@BryanChrisBrown
BryanChrisBrown committed Jul 3, 2023
1 parent 41031ad commit e26b248
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 16 deletions.
2 changes: 2 additions & 0 deletions docs/classes/client.BridgeClient.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,8 @@ ___

▸ **deletePlaylist**(`playlist`): `Promise`<{ `response`: ``null`` \| { `name`: `string` = schema.name; `orchestration`: { value: string; type: "WSTRING"; name: string; } ; `payload`: { value: { name: { value: string; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: string; } ; `status`: { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } = schema.status } ; `success`: `boolean` }\>

Delete the instance of the playlist from Bridge, this will stop the playlist from playing if it's active.

#### Parameters

| Name | Type |
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.MonitorConnectedMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; head\_index: { value: number; type: "UNSIGNED\_INT"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| ... 9 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; ..... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; head\_index: { value: number; type: "UNSIGNED\_INT"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; ... 7 ... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.MonitorDisconnectedMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.PlaylistDeleteMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 7 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: str... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.PlaylistInsertMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; uri: { value: string; type: "WSTRING"; name: string; }; index: { value: number; type: "UNSIGNED\_INT"; name: string; }; event: { value: "Monitor Connect" \| ... 9 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; }; type:... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; uri: { value: string; type: "WSTRING"; name: string; }; index: { value: number; type: "UNSIGNED\_INT"; name: string; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VA... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.PlaylistInstanceMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 7 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: str... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.ProgressCompletionMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.ProgressStartMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.ProgressUpdateMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.SyncPlayPlaylistCancelledMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.SyncPlayPlaylistCompleteMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/components_messageHandler.SyncPlayPlaylistMessageHandler.md
View file
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; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 5 more ... \| "Sync/Play Playlist Cancelled"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...;... | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |

#### Returns
Expand Down
Loading

0 comments on commit e26b248

Please sign in to comment.