Constructor
new CameraViews(webrtc, optionsopt)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
webrtc |
WebRTC | The WebRTC Implementation to display |
|
options |
ApplicationOptions |
<optional> |
Application configuration options. |
Members
(static) defaultOptions
webrtc :AVMaster
A reference to the master AV orchestrator instance
Type:
Methods
(async) _render()
activateListeners()
getData()
getUserCameraView(userId) → {HTMLElement|null}
Obtain a reference to the div.camera-view which is used to portray a given Foundry User.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The ID of the User document |
Returns:
- Type
- HTMLElement | null
getUserVideoElement(userId) → {HTMLVideoElement|null}
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.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The ID of the User document |
Returns:
- Type
- HTMLVideoElement | null
render()
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
setUserIsSpeaking(userId, speaking)
Sets whether a user is currently speaking or not
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The ID of the user |
speaking |
boolean | Whether the user is speaking |