TogetherModeCallFeature interface
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Together mode call feature.
- Extends
Properties
| scene |
Returns the current scene size |
| together |
Returns map of participants MRI to seating position |
| together |
Collection of composed video stream of the together mode bot |
Inherited Properties
| name | The feature name. |
Methods
Inherited Methods
| dispose() |
Property Details
sceneSize
togetherModeSeatingMap
Returns map of participants MRI to seating position
TogetherModeSeatingMap togetherModeSeatingMapProperty Value
togetherModeStream
Collection of composed video stream of the together mode bot
togetherModeStream: readonly TogetherModeVideoStream[]Property Value
readonly TogetherModeVideoStream[]
Inherited Property Details
name
Method Details
off("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)
function off(event: "togetherModeSceneUpdated", listener: TogetherModeSceneUpdatedListener)Parameters
- event
-
"togetherModeSceneUpdated"
event name.
- listener
- TogetherModeSceneUpdatedListener
callback fn that was used to subscribe to this event.
off("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)
function off(event: "togetherModeSeatingUpdated", listener: TogetherModeSeatingUpdatedListener)Parameters
- event
-
"togetherModeSeatingUpdated"
event name.
- listener
- TogetherModeSeatingUpdatedListener
callback fn that was used to subscribe to this event.
off("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)
function off(event: "togetherModeStreamsUpdated", listener: CollectionUpdatedEvent<TogetherModeVideoStream>)Parameters
- event
-
"togetherModeStreamsUpdated"
event name.
callback fn that was used to subscribe to this event.
on("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)
function on(event: "togetherModeSceneUpdated", listener: TogetherModeSceneUpdatedListener)Parameters
- event
-
"togetherModeSceneUpdated"
event name.
- listener
- TogetherModeSceneUpdatedListener
callback fn that will be called when this collection will change,
on("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)
function on(event: "togetherModeSeatingUpdated", listener: TogetherModeSeatingUpdatedListener)Parameters
- event
-
"togetherModeSeatingUpdated"
event name.
- listener
- TogetherModeSeatingUpdatedListener
callback fn that will be called when this collection will change,
on("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)
function on(event: "togetherModeStreamsUpdated", listener: CollectionUpdatedEvent<TogetherModeVideoStream>)Parameters
- event
-
"togetherModeStreamsUpdated"
event name.
callback fn that will be called when this collection will change,
start()
Starts together mode for everyone
function start(): Promise<void>Returns
Promise<void>
Inherited Method Details
dispose()
function dispose()Inherited From CallFeature.dispose