A reference to the master AV orchestrator instance
If all camera views are popped out, hide the dock.
Return the CSS application ID which uniquely references this UI element
Return the active application element, if it currently exists in the DOM
The path to the HTML template file which should be used to render the inner content of the app
Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered
Return a flag for whether the Application instance is currently rendered
Whether the Application is currently closing.
An Application window should define its own title definition logic which may be dynamic depending on its data
Obtain a reference to the div.camera-view which is used to portray a given Foundry User.
The ID of the User document
Obtain a reference to the video.user-camera which displays the video channel for a requested Foundry User. If the user is not broadcasting video this will return null.
The ID of the User document
Sets whether a user is currently speaking or not
The ID of the user
Whether the user is speaking
Extend the render logic to first check whether a render is necessary based on the context If a specific context was provided, make sure an update to the navigation is necessary before rendering
Set the application position and store its new location. Returns the updated position object for the application containing the new values.
Positional data
|void}
Change the currently active tab
The target tab name to switch to
Options which configure changing the tab
A specific named tab group, useful if multiple sets of tabs are present
Whether to trigger tab-change callback functions
Bring the application to the top of the rendering stack
Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes
A Promise which resolves once the application is closed
Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized
A Promise which resolves once the minimization action has completed
Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized
A Promise which resolves once the maximization action has completed
Dynamically refresh the state of a single camera view
The ID of the user whose view we want to refresh.
Get the icon class that should be used for various action buttons with different toggled states. The returned icon should represent the visual status of the NEXT state (not the CURRENT state).
The named av-control button action
The CURRENT action state.
The icon that represents the NEXT action state.
Get the text title that should be used for various action buttons with different toggled states. The returned title should represent the tooltip of the NEXT state (not the CURRENT state).
The named av-control button action
The CURRENT action state.
The icon that represents the NEXT action state.
Persist the scroll positions of containers within the app before re-rendering the content
The HTML object being traversed
Restore the scroll positions of containers within the app after re-rendering the content
The HTML object being traversed
Render the outer application wrapper
A promise resolving to the constructed jQuery object
Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
Handle changes to search filtering controllers which are bound to the Application
The key-up event from keyboard input
The raw string input to the search field
The regular expression to test against
The HTML element which should be filtered
Define whether a user is able to begin a dragstart workflow for a given drag selector
The candidate HTML selector for dragging
Can the current user drag this selector?
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
The candidate HTML selector for the drop target
Can the current user drop on this selector?
Callback actions which occur at the beginning of a drag start workflow.
The originating DragEvent
Callback actions which occur when a dragged element is over a drop target.
The originating DragEvent
Callback actions which occur when a dragged element is dropped on a target.
The originating DragEvent
Wait for any images present in the Application to load.
A Promise that resolves when all images have loaded.
Prepare rendering data for a single user
Change volume control for a stream
The originating change event from interaction with the range input
Render changes needed to the PlayerList ui. Show/Hide players depending on option.
Show or hide UI control elements This replaces the use of jquery.show/hide as it simply adds a class which has display:none which allows us to have elements with display:flex which can be hidden then shown without breaking their display style. This will show/hide the toggle buttons, volume controls and overlay sidebars
The container for which to show/hide control elements
Whether to show or hide the controls
Override selector to specify which controls to show or hide
A custom sorting function that orders/arranges the user display frames
The options provided to this application upon initialization
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
An internal reference to the HTML element this application renders
Track the current position and dimensions of the Application UI
DragDrop workflow handlers which are active for this Application
Tab navigation handlers which are active for this Application
SearchFilter handlers which are active for this Application
Track whether the Application is currently minimized
Track the most recent scroll positions for any vertically scrolling containers
The current render state of the Application
The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
The sequence of rendering states that track the Application life-cycle.
On hover in a camera container, show/hide the controls.
On clicking on a toggle, disable/enable the audio or video stream.
The Camera UI View that displays all the camera feeds as individual video elements.
The WebRTC Implementation to display
Application configuration options.