SpotlightCallFeature interface
スポットライト呼び出し機能。
- Extends
プロパティ
| max |
スポットライトを当てることができる参加者の最大数を返します。 |
継承されたプロパティ
| name | 機能名。 |
メソッド
| get |
|
| off("spotlight |
SpotlightUpdated イベントのサブスクライブ関数 |
| on("spotlight |
SpotlightUpdated イベントのサブスクライブ関数 |
| start |
|
| stop |
すべての参加者のスポットライトを停止します。 |
| stop |
継承されたメソッド
| dispose() |
プロパティの詳細
maxParticipantsToSpotlight
スポットライトを当てることができる参加者の最大数を返します。
maxParticipantsToSpotlight: numberプロパティ値
number
継承されたプロパティの詳細
name
機能名。
name: stringプロパティ値
string
メソッドの詳細
getSpotlightedParticipants()
function getSpotlightedParticipants(): SpotlightedParticipant[]戻り値
現在スポットライトを浴びているすべての参加者の一覧を返します
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
SpotlightUpdated イベントのサブスクライブ関数
function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)パラメーター
- event
-
"spotlightChanged"
イベント名
- listener
このイベントのサブスクライブに使用されたコールバック関数
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
SpotlightUpdated イベントのサブスクライブ関数
function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)パラメーター
- event
-
"spotlightChanged"
イベント名
- listener
このイベントのサブスクライブに使用されたコールバック関数
startSpotlight(CommunicationIdentifier[])
function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>パラメーター
- participants
は、参加者配列が渡されない場合にローカル参加者とリモート参加者のスポットライトを開始し、ローカル参加者に対してアクションが実行されます
戻り値
Promise<void>
startParticipantSpotlight 操作の完了を表す Promise。 startParticipantSpotlight が正常に開始されると、'SpotlightUpdated' イベントが生成されます。
stopAllSpotlight()
すべての参加者のスポットライトを停止します。
function stopAllSpotlight(): Promise<void>戻り値
Promise<void>
stopAllSpotlight 操作の完了を表す Promise。 stopAllSpotlight が正常に停止すると、'SpotlightUpdated' イベントが生成されます。
stopSpotlight(CommunicationIdentifier[])
function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>パラメーター
- participants
は、参加者配列が渡されない場合にローカル参加者とリモート参加者のスポットライトを停止し、ローカル参加者に対してアクションが実行されます
戻り値
Promise<void>
stopParticipantSpotlight 操作の完了を表す Promise。 stopParticipantSpotlight が正常に停止すると、'SpotlightUpdated' イベントが生成されます。
継承済みメソッドの詳細
dispose()
function dispose()