TeamsCall interface

パッケージ:

@azure/communication-calling

Teams 通話を表します。

Extends

CallCommon

プロパティ

info	この Teams 通話に関する情報を取得します。

継承されたプロパティ

callEndReason	この呼び出しがどのように終了したかを示すコード/サブコードを含む。
callerInfo	この呼び出しが着信している場合の呼び出し元情報。
direction	着信か発信かを問わず、通話の方向を取得します。
id	この呼び出しの一意の ID を取得します。
isIncomingAudioMuted	ローカル ユーザーが着信オーディオをミュートしたかどうか。
isLocalVideoStarted	ローカル ビデオがオンかどうか。
isMuted	ローカル ユーザーがミュートか、ローカルかリモートか。
isScreenSharingOn	画面共有がオンになっているかどうか。
kind	呼び出しオブジェクトの種類を取得します。
lobby	Teams 会議ロビーを取得します。
localAudioStreams	通話で他の参加者に送信されるローカル オーディオ ストリームのコレクション。
localVideoStreams	通話中に他の参加者に送信されるローカル ビデオ ストリームのコレクション。
remoteAudioStreams	呼び出しから受信されるリモート オーディオ ストリームのコレクション。
remoteParticipants	この呼び出しのリモート参加者のコレクション。 100 人以上の参加者との通話の場合、このコレクションにはメディアアクティブ参加者のみが存在します。
role	通話でローカル ユーザーのロールを取得します。
state	この呼び出しの状態を取得します。
totalParticipantCount	この通話の参加者の合計数。

メソッド

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)	参加者を追加します。
removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)	この呼び出しから参加者を削除します。

継承されたメソッド

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	拡張 API を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張通話機能については、オブジェクトの機能を確認してください。* 次に例を示します。 const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	通話を切断します。
hold()	この通話を保留にしてください。
mute()	ローカル マイクをミュートします。
muteAllRemoteParticipants()	すべてのリモート参加者をミュートします。
muteIncomingAudio()	着信音声をミュートします。
off("idChanged", PropertyChangedEvent)	idChanged イベントの Unsubscribe 関数。
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	isIncomingAudioMutedChanged イベントのサブスクライブ関数。
off("isLocalVideoStartedChanged", PropertyChangedEvent)	isLocalVideoStartedChanged イベントの Unsubscribe 関数。
off("isMutedChanged", PropertyChangedEvent)	isMutedChanged イベントのサブスクライブ関数。
off("isScreenSharingOnChanged", PropertyChangedEvent)	isScreenSharingChanged イベントの Unsubscribe 関数。
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	localAudioStreamsUpdated イベントの Unsubscribe 関数。
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	localVideoStreamsUpdated イベントの Unsubscribe 関数。
off("mutedByOthers", PropertyChangedEvent)	mutedByOthers イベントの Unsubscribe 関数。
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	remoteAudioStreamsUpdated イベントの Unsubscribe 関数。
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	remoteParticipantsUpdated イベントの Unsubscribe 関数。
off("roleChanged", PropertyChangedEvent)	roleChanged イベントの Unsubscribe 関数。
off("stateChanged", PropertyChangedEvent)	stateChanged イベントの Unsubscribe 関数。
off("totalParticipantCountChanged", PropertyChangedEvent)	totalParticipantCountChanged イベントの unsubscribe 関数。
on("idChanged", PropertyChangedEvent)	idChanged イベントのサブスクライブ関数。
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	isIncomingAudioMutedChanged イベントのサブスクライブ関数。
on("isLocalVideoStartedChanged", PropertyChangedEvent)	isLocalVideoStartedChanged イベントのサブスクライブ関数。
on("isMutedChanged", PropertyChangedEvent)	isMutedChanged イベントのサブスクライブ関数。
on("isScreenSharingOnChanged", PropertyChangedEvent)	isScreenSharingChanged イベントのサブスクライブ関数。
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	localAudioStreamsUpdated イベントのサブスクライブ関数。
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	localVideoStreamsUpdated イベントのサブスクライブ関数。
on("mutedByOthers", PropertyChangedEvent)	mutedByOthers イベントのサブスクライブ関数。
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	remoteAudioStreamsUpdated イベントのサブスクライブ関数。
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	remoteParticipantsUpdated イベントのサブスクライブ関数。
on("roleChanged", PropertyChangedEvent)	roleChanged イベントのサブスクライブ関数。
on("stateChanged", PropertyChangedEvent)	stateChanged イベントのサブスクライブ関数。
on("totalParticipantCountChanged", PropertyChangedEvent)	totalParticipantCountChanged イベントのサブスクライブ関数。
resume()	"LocalHold" 状態の場合は、この呼び出しを再開します。
sendDtmf(DtmfTone)	DTMF トーンを送信します。
setConstraints(CallConstraints)	呼び出しの制約を設定します。 このメソッドは、指定された値に基づいて最大制約を設定します。 最終的に適用される制約は、このメソッドにここで指定された値以下になります。 0 の値を指定した場合、その制約には制約は適用されません。 未定義の値が指定されている場合は、その制約に使用された前の値が使用されます。
startAudio(LocalAudioStream)	カスタム オーディオを使用して通話でオーディオを開始します。 LocalAudioStream ソースは MediaStream である必要があります。
startScreenSharing()	通話で画面共有ストリームの送信を開始します。 ブラウザーは、画面、アプリ、またはブラウザー タブを選択するように求められます。 iOS および Android では、画面共有ストリームの送信はサポートされていません。 受信画面共有ストリームは、iOS および Android でサポートされています。
startScreenSharing(LocalVideoStream)	通話で生画面共有ストリームの送信を開始します。 iOS および Android では、未加工の画面共有の送信はサポートされていません。 受信生の画面共有は、iOS および Android でサポートされています。
startVideo(LocalVideoStream)	通話でビデオ ストリームの送信を開始します。 通話のリモート参加者は、ビデオ ストリームを受信して、UI でレンダリングできるようにします。
stopAudio()	通話でカスタム オーディオを停止し、デバイス マネージャーの既定のオーディオ デバイスに切り替えます。
stopScreenSharing()	ローカル画面の共有を停止します。
stopScreenSharing(LocalVideoStream)	ローカル画面の共有を停止します。
stopVideo(LocalVideoStream)	通話中のビデオ ストリームの送信を停止します。 CallAgent.startCall() API、CallAgent.join() API、IncomingCall.accept() API、または Call.startVideo() API でビデオを開始するために使用されたのと同じ LocalVideoStream オブジェクトを渡す必要があります。
unmute()	ローカル マイクのミュートを解除します。
unmuteIncomingAudio()	受信オーディオのミュートを解除します。

プロパティの詳細

info

この Teams 通話に関する情報を取得します。

info: TeamsCallInfo

プロパティ値

TeamsCallInfo

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

callEndReason

この呼び出しがどのように終了したかを示すコード/サブコードを含む。

callEndReason?: CallEndReason

プロパティ値

CallEndReason

継承CallCommon.callEndReason

callerInfo

この呼び出しが着信している場合の呼び出し元情報。

callerInfo: CallerInfo

プロパティ値

CallerInfo

CallCommon.callerInfo から継承された

direction

着信か発信かを問わず、通話の方向を取得します。

direction: CallDirection

プロパティ値

CallDirection

callCommon.direction から継承

id

この呼び出しの一意の ID を取得します。

id: string

プロパティ値

string

CallCommon.id から継承された

isIncomingAudioMuted

ローカル ユーザーが着信オーディオをミュートしたかどうか。

isIncomingAudioMuted: boolean

プロパティ値

boolean

CallCommon.isIncomingAudioMuted から継承された

isLocalVideoStarted

ローカル ビデオがオンかどうか。

isLocalVideoStarted: boolean

プロパティ値

boolean

CallCommon.isLocalVideoStarted から継承された

isMuted

ローカル ユーザーがミュートか、ローカルかリモートか。

isMuted: boolean

プロパティ値

boolean

CallCommon.isMuted から継承された

isScreenSharingOn

画面共有がオンになっているかどうか。

isScreenSharingOn: boolean

プロパティ値

boolean

CallCommon.isScreenSharingOn から継承された

kind

呼び出しオブジェクトの種類を取得します。

kind: CallKind

プロパティ値

CallKind

CallCommon.kind から継承された

lobby

Teams 会議ロビーを取得します。

lobby: Lobby

プロパティ値

Lobby

CallCommon.lobby から継承された

localAudioStreams

通話で他の参加者に送信されるローカル オーディオ ストリームのコレクション。

localAudioStreams: readonly LocalAudioStream[]

プロパティ値

readonly LocalAudioStream[]

CallCommon.localAudioStreams から継承された

localVideoStreams

通話中に他の参加者に送信されるローカル ビデオ ストリームのコレクション。

localVideoStreams: readonly LocalVideoStream[]

プロパティ値

readonly LocalVideoStream[]

CallCommon.localVideoStreams から継承された

remoteAudioStreams

呼び出しから受信されるリモート オーディオ ストリームのコレクション。

remoteAudioStreams: readonly RemoteAudioStream[]

プロパティ値

readonly RemoteAudioStream[]

CallCommon.remoteAudioStreams から継承された

remoteParticipants

この呼び出しのリモート参加者のコレクション。 100 人以上の参加者との通話の場合、このコレクションにはメディアアクティブ参加者のみが存在します。

remoteParticipants: readonly RemoteParticipant[]

プロパティ値

readonly RemoteParticipant[]

CallCommon.remoteParticipants から継承された

role

通話でローカル ユーザーのロールを取得します。

role: ParticipantRole

プロパティ値

ParticipantRole

CallCommon.role から継承された

state

この呼び出しの状態を取得します。

state: CallState

プロパティ値

CallState

CallCommon.state から継承された

totalParticipantCount

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

この通話の参加者の合計数。

totalParticipantCount: number

プロパティ値

number

CallCommon.totalParticipantCount から継承された

メソッドの詳細

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

参加者を追加します。

function addParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: AddTeamsParticipantOptions): RemoteParticipant

パラメーター

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

追加する参加者

options

AddTeamsParticipantOptions

AddTeamsParticipantOptions

戻り値

RemoteParticipant

removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

この呼び出しから参加者を削除します。

function removeParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier): Promise<void>

パラメーター

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier

削除する参加者。

戻り値

Promise<void>

継承済みメソッドの詳細

dispose()

function dispose()

CallCommon.dispose から継承された

feature<TFeature>(CallFeatureFactory<TFeature>)

拡張 API を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張通話機能については、オブジェクトの機能を確認してください。* 次に例を示します。

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

パラメーター

factory

CallFeatureFactory<TFeature>

拡張 API を提供する呼び出し機能コンストラクターのファクトリ。

戻り値

TFeature

CallCommon.feature から継承された

hangUp(HangUpOptions)

通話を切断します。

function hangUp(options?: HangUpOptions): Promise<void>

パラメーター

options

HangUpOptions

ハングアップ オプション。

戻り値

Promise<void>

CallCommon.hangUp から継承された

hold()

この通話を保留にしてください。

function hold(): Promise<void>

戻り値

Promise<void>

callCommon.hold から継承

mute()

ローカル マイクをミュートします。

function mute(): Promise<void>

戻り値

Promise<void>

CallCommon.mute から継承された

muteAllRemoteParticipants()

すべてのリモート参加者をミュートします。

function muteAllRemoteParticipants(): Promise<void>

戻り値

Promise<void>

CallCommon.muteAllRemoteParticipants から継承された

muteIncomingAudio()

着信音声をミュートします。

function muteIncomingAudio(): Promise<void>

戻り値

Promise<void>

CallCommon.muteIncomingAudio から継承された

off("idChanged", PropertyChangedEvent)

idChanged イベントの Unsubscribe 関数。

function off(event: "idChanged", listener: PropertyChangedEvent)

パラメーター

event

"idChanged"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.off から継承された

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged イベントのサブスクライブ関数。

function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isIncomingAudioMutedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.off から継承された

off("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged イベントの Unsubscribe 関数。

function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isLocalVideoStartedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.off から継承された

off("isMutedChanged", PropertyChangedEvent)

isMutedChanged イベントのサブスクライブ関数。

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isMutedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.off から継承された

off("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged イベントの Unsubscribe 関数。

function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

パラメーター

event

"isScreenSharingOnChanged"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.off から継承された

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

localAudioStreamsUpdated イベントの Unsubscribe 関数。

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

パラメーター

event

"localAudioStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<LocalAudioStream>

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

CallCommon.off から継承された

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

localVideoStreamsUpdated イベントの Unsubscribe 関数。

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

パラメーター

event

"localVideoStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<LocalVideoStream>

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

CallCommon.off から継承された

off("mutedByOthers", PropertyChangedEvent)

mutedByOthers イベントの Unsubscribe 関数。

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

パラメーター

event

"mutedByOthers"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.off から継承された

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated イベントの Unsubscribe 関数。

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

パラメーター

event

"remoteAudioStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<RemoteAudioStream>

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

CallCommon.off から継承された

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated イベントの Unsubscribe 関数。

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

パラメーター

event

"remoteParticipantsUpdated"

イベント名。

listener

CollectionUpdatedEvent<RemoteParticipant>

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

CallCommon.off から継承された

off("roleChanged", PropertyChangedEvent)

roleChanged イベントの Unsubscribe 関数。

function off(event: "roleChanged", listener: PropertyChangedEvent)

パラメーター

event

"roleChanged"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.off から継承された

off("stateChanged", PropertyChangedEvent)

stateChanged イベントの Unsubscribe 関数。

function off(event: "stateChanged", listener: PropertyChangedEvent)

パラメーター

event

"stateChanged"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.off から継承された

off("totalParticipantCountChanged", PropertyChangedEvent)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

totalParticipantCountChanged イベントの unsubscribe 関数。

function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

パラメーター

event

"totalParticipantCountChanged"

イベント名。

listener

PropertyChangedEvent

参加者数が変更されたときに呼び出されるコールバック fn。

CallCommon.off から継承された

on("idChanged", PropertyChangedEvent)

idChanged イベントのサブスクライブ関数。

function on(event: "idChanged", listener: PropertyChangedEvent)

パラメーター

event

"idChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged イベントのサブスクライブ関数。

function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isIncomingAudioMutedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged イベントのサブスクライブ関数。

function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isLocalVideoStartedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("isMutedChanged", PropertyChangedEvent)

isMutedChanged イベントのサブスクライブ関数。

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

パラメーター

event

"isMutedChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged イベントのサブスクライブ関数。

function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

パラメーター

event

"isScreenSharingOnChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

localAudioStreamsUpdated イベントのサブスクライブ関数。

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

パラメーター

event

"localAudioStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<LocalAudioStream>

このコレクションが変更されたときに呼び出されるコールバック fn は、追加および削除された要素の配列を渡します。

CallCommon.on から継承された

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

localVideoStreamsUpdated イベントのサブスクライブ関数。

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

パラメーター

event

"localVideoStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<LocalVideoStream>

このコレクションが変更されたときに呼び出されるコールバック fn は、追加および削除された要素の配列を渡します。

CallCommon.on から継承された

on("mutedByOthers", PropertyChangedEvent)

mutedByOthers イベントのサブスクライブ関数。

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

パラメーター

event

"mutedByOthers"

イベント名。

listener

PropertyChangedEvent

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

CallCommon.on から継承された

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated イベントのサブスクライブ関数。

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

パラメーター

event

"remoteAudioStreamsUpdated"

イベント名。

listener

CollectionUpdatedEvent<RemoteAudioStream>

このコレクションが変更されたときに呼び出されるコールバック fn は、追加および削除された要素の配列を渡します。

CallCommon.on から継承された

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated イベントのサブスクライブ関数。

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

パラメーター

event

"remoteParticipantsUpdated"

イベント名。

listener

CollectionUpdatedEvent<RemoteParticipant>

このコレクションが変更されたときに呼び出されるコールバック fn は、追加および削除された要素の配列を渡します。

CallCommon.on から継承された

on("roleChanged", PropertyChangedEvent)

roleChanged イベントのサブスクライブ関数。

function on(event: "roleChanged", listener: PropertyChangedEvent)

パラメーター

event

"roleChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("stateChanged", PropertyChangedEvent)

stateChanged イベントのサブスクライブ関数。

function on(event: "stateChanged", listener: PropertyChangedEvent)

パラメーター

event

"stateChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

on("totalParticipantCountChanged", PropertyChangedEvent)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

totalParticipantCountChanged イベントのサブスクライブ関数。

function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

パラメーター

event

"totalParticipantCountChanged"

イベント名。

listener

PropertyChangedEvent

参加者数が変更されたときに呼び出されるコールバック fn。

CallCommon.on から継承された

resume()

"LocalHold" 状態の場合は、この呼び出しを再開します。

function resume(): Promise<void>

戻り値

Promise<void>

CallCommon.resume から継承された

sendDtmf(DtmfTone)

DTMF トーンを送信します。

function sendDtmf(dtmfTone: DtmfTone): Promise<void>

パラメーター

dtmfTone

DtmfTone

戻り値

Promise<void>

CallCommon.sendDtmf から継承された

setConstraints(CallConstraints)

呼び出しの制約を設定します。 このメソッドは、指定された値に基づいて最大制約を設定します。 最終的に適用される制約は、このメソッドにここで指定された値以下になります。 0 の値を指定した場合、その制約には制約は適用されません。 未定義の値が指定されている場合は、その制約に使用された前の値が使用されます。

function setConstraints(constraints: CallConstraints): Promise<void>

パラメーター

constraints

CallConstraints

設定する呼び出し制約を表すオブジェクト

戻り値

Promise<void>

CallCommon.setConstraints から継承された

startAudio(LocalAudioStream)

カスタム オーディオを使用して通話でオーディオを開始します。 LocalAudioStream ソースは MediaStream である必要があります。

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

パラメーター

localAudioStream

LocalAudioStream

戻り値

Promise<void>

CallCommon.startAudio から継承された

startScreenSharing()

• 通話で画面共有ストリームの送信を開始します。 ブラウザーは、画面、アプリ、またはブラウザー タブを選択するように求められます。
• iOS および Android では、画面共有ストリームの送信はサポートされていません。
• 受信画面共有ストリームは、iOS および Android でサポートされています。

function startScreenSharing(): Promise<void>

戻り値

Promise<void>

callCommon.startScreenSharing から継承

startScreenSharing(LocalVideoStream)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

• 通話で生画面共有ストリームの送信を開始します。
• iOS および Android では、未加工の画面共有の送信はサポートされていません。
• 受信生の画面共有は、iOS および Android でサポートされています。

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

パラメーター

localVideoStream

LocalVideoStream

コンストラクターで MediaStream を受け取るローカルの生画面共有ストリームを表します。

戻り値

Promise<void>

callCommon.startScreenSharing から継承

startVideo(LocalVideoStream)

通話でビデオ ストリームの送信を開始します。 通話のリモート参加者は、ビデオ ストリームを受信して、UI でレンダリングできるようにします。

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

パラメーター

localVideoStream

LocalVideoStream

コンストラクターでカメラ ソースを受け取るローカル ビデオ ストリームを表します。

戻り値

Promise<void>

CallCommon.startVideo から継承された

stopAudio()

通話でカスタム オーディオを停止し、デバイス マネージャーの既定のオーディオ デバイスに切り替えます。

function stopAudio()

CallCommon.stopAudio から継承された

stopScreenSharing()

ローカル画面の共有を停止します。

function stopScreenSharing(): Promise<void>

戻り値

Promise<void>

callCommon.stopScreenSharing から継承

stopScreenSharing(LocalVideoStream)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

ローカル画面の共有を停止します。

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

パラメーター

localVideoStream

LocalVideoStream

ストリーミングを停止するローカル画面共有ストリーム。

戻り値

Promise<void>

callCommon.stopScreenSharing から継承

stopVideo(LocalVideoStream)

通話中のビデオ ストリームの送信を停止します。 CallAgent.startCall() API、CallAgent.join() API、IncomingCall.accept() API、または Call.startVideo() API でビデオを開始するために使用されたのと同じ LocalVideoStream オブジェクトを渡す必要があります。

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

パラメーター

localVideoStream

LocalVideoStream

ストリーミングを停止するローカル ビデオ ストリーム。

戻り値

Promise<void>

CallCommon.stopVideo から継承された

unmute()

ローカル マイクのミュートを解除します。

function unmute(): Promise<void>

戻り値

Promise<void>

CallCommon.unmute から継承された

unmuteIncomingAudio()

受信オーディオのミュートを解除します。

function unmuteIncomingAudio(): Promise<void>

戻り値

Promise<void>

CallCommon.unmuteIncomingAudio から継承された