Skip to content

Commit

Permalink
Add manual section on queue interaction
Browse files Browse the repository at this point in the history
  • Loading branch information
gbl08ma committed Feb 15, 2024
1 parent 0085d69 commit 7e8ec96
Show file tree
Hide file tree
Showing 5 changed files with 265 additions and 0 deletions.
1 change: 1 addition & 0 deletions _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [Client-server communication](/manual/rpc.md)
- [Data storage](/manual/storage.md)
- [Chat interaction](/manual/chat.md)
- [Queue interaction](/manual/queue.md)
- [JP interaction](/manual/jp.md)
- [Testing](/manual/testing.md)
- [Review and deployment](/manual/review_deployment.md)
Expand Down
1 change: 1 addition & 0 deletions manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The manual takes a less hands-on approach, describing how the system works throu
- [Client-server communication](/manual/rpc.md) - Details on how application pages can communicate with server scripts and vice-versa.
- [Data storage](/manual/storage.md) - Methods for longer-term storage of application data and state.
- [Chat interaction](/manual/chat.md) - Information and guidelines on how applications should interact with the JungleTV chat.
- [Queue interaction](/manual/queue.md) - Details on how applications may interact with the JungleTV media queue.
- [JP interaction](/manual/jp.md) - Information and guidelines on how applications should interact with the JP (JungleTV Points) system.
- [Testing](/manual/testing.md) - Tips on how to test JAF applications.
- [Review and deployment](/manual/review_deployment.md) - Information on the scrutiny JAF applications go through before being approved and deployed for production use.
Expand Down
3 changes: 3 additions & 0 deletions manual/pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ Application pages may also be included as chat message attachments.
In such cases, it is necessary to specify how tall the area reserved for the application page should be.
See the [Chat interaction](./chat.md#attaching-application-pages) section for details.

Finally, application pages may be enqueued and "play" like any other form of media would.
See the [Queue interaction](./queue.md#enqueuing-pages) section for more information.

When an application unpublishes a page that is being used in these integrated contexts, or when the application is terminated, typically the UI will revert to a state similar to the one preceding the UI reconfiguration.
In other words, sidebar tabs will disappear and so will the attachment portion of chat messages.
In the case of chat messages, the attached page may reappear if the same application later publishes a page with the same ID.
Loading

0 comments on commit 7e8ec96

Please sign in to comment.