TogetherModeCallFeature interface

パッケージ:

@azure/communication-calling

一緒モード呼び出し機能。

Extends

CallFeature

プロパティ

sceneSize	現在のシーン サイズを返します。
togetherModeSeatingMap	参加者のMRIの地図を座席位置に戻します
togetherModeStream	一緒モード ボットの構成済みビデオ ストリームのコレクション

継承されたプロパティ

name

機能名。

メソッド

off("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)
off("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)
off("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)
on("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)
on("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)
on("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)
start()	全員が一緒にモードを開始する

継承されたメソッド

dispose()

プロパティの詳細

sceneSize

現在のシーン サイズを返します。

TogetherModeSceneSize sceneSize

プロパティ値

TogetherModeSceneSize

togetherModeSeatingMap

参加者のMRIの地図を座席位置に戻します

TogetherModeSeatingMap togetherModeSeatingMap

プロパティ値

TogetherModeSeatingMap

togetherModeStream

一緒モード ボットの構成済みビデオ ストリームのコレクション

togetherModeStream: readonly TogetherModeVideoStream[]

プロパティ値

readonly TogetherModeVideoStream[]

継承されたプロパティの詳細

name

機能名。

name: string

プロパティ値

string

CallFeature.name から継承された

メソッドの詳細

off("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)

function off(event: "togetherModeSceneUpdated", listener: TogetherModeSceneUpdatedListener)

パラメーター

event

"togetherModeSceneUpdated"

イベント名。

listener

TogetherModeSceneUpdatedListener

このイベントのサブスクライブに使用されたコールバック fn。

off("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)

function off(event: "togetherModeSeatingUpdated", listener: TogetherModeSeatingUpdatedListener)

パラメーター

event

"togetherModeSeatingUpdated"

イベント名。

listener

TogetherModeSeatingUpdatedListener

このイベントのサブスクライブに使用されたコールバック fn。

off("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)

function off(event: "togetherModeStreamsUpdated", listener: CollectionUpdatedEvent<TogetherModeVideoStream>)

パラメーター

event

"togetherModeStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<TogetherModeVideoStream>

このイベントのサブスクライブに使用されたコールバック fn。

on("togetherModeSceneUpdated", TogetherModeSceneUpdatedListener)

function on(event: "togetherModeSceneUpdated", listener: TogetherModeSceneUpdatedListener)

パラメーター

event

"togetherModeSceneUpdated"

イベント名。

listener

TogetherModeSceneUpdatedListener

このコレクションが変更されたときに呼び出されるコールバック fn

on("togetherModeSeatingUpdated", TogetherModeSeatingUpdatedListener)

function on(event: "togetherModeSeatingUpdated", listener: TogetherModeSeatingUpdatedListener)

パラメーター

event

"togetherModeSeatingUpdated"

イベント名。

listener

TogetherModeSeatingUpdatedListener

このコレクションが変更されたときに呼び出されるコールバック fn

on("togetherModeStreamsUpdated", CollectionUpdatedEvent<TogetherModeVideoStream>)

function on(event: "togetherModeStreamsUpdated", listener: CollectionUpdatedEvent<TogetherModeVideoStream>)

パラメーター

event

"togetherModeStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<TogetherModeVideoStream>

このコレクションが変更されたときに呼び出されるコールバック fn

start()

全員が一緒にモードを開始する

function start(): Promise<void>

戻り値

Promise<void>

継承済みメソッドの詳細

dispose()

function dispose()

CallFeature.dispose から継承された