CommonCallAdapter interface
CallComposite アダプター インターフェイスを します。
- Extends
継承されたプロパティ
| send |
リアルタイムのテキストを送信 |
メソッド
| join |
最初にマイクをオン/オフにして通話に参加します。 |
| join |
通話に参加するときにマイク/カメラの初期状態を設定するオプションバッグを使用して通話に参加します true = 通話に参加するときにデバイスをオンにします false = 通話に参加するときにデバイスの電源を切ります 'keep'/undefined = デバイスの事前通話状態を保持します |
| start |
呼び出しを開始します。 |
| start |
呼び出しを開始します。 |
継承されたメソッド
継承されたプロパティの詳細
sendRealTimeText
リアルタイムのテキストを送信
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>プロパティ値
(text: string, isFinalized: boolean) => Promise<void>
CallAdapterCallOperations.sendRealTimeTextから継承
メソッドの詳細
joinCall(boolean)
警告
この API は非推奨になりました。
Use joinCall(options?:JoinCallOptions) instead.
最初にマイクをオン/オフにして通話に参加します。
function joinCall(microphoneOn?: boolean)パラメーター
- microphoneOn
-
boolean
マイクが最初に有効になっているかどうか
joinCall(JoinCallOptions)
通話に参加するときにマイク/カメラの初期状態を設定するオプションバッグを使用して通話に参加します true = 通話に参加するときにデバイスをオンにします false = 通話に参加するときにデバイスの電源を切ります 'keep'/undefined = デバイスの事前通話状態を保持します
function joinCall(options?: JoinCallOptions)パラメーター
- options
- JoinCallOptions
マイク/カメラを最初にオン/オフ/使用プレコール状態に設定するパラメータ。
startCall(CommunicationIdentifier[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)パラメーター
- participants
呼び出される <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> の配列
- options
- StartCallOptions
startCall(string[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: string[], options?: StartCallOptions)パラメーター
- participants
-
string[]
参加する参加者 ID の配列
- options
- StartCallOptions
継承済みメソッドの詳細
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>パラメーター
- participant
- CommunicationUserIdentifier
戻り値
Promise<void>
CallAdapterCallOperations.addParticipantから継承
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
通話に参加者を追加します。
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>パラメーター
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
戻り値
Promise<void>
CallAdapterCallOperations.addParticipantから継承
askDevicePermission(PermissionConstraints)
デバイスのアクセス許可を要求します。
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>パラメーター
- constrain
- PermissionConstraints
ローカル デバイスにアクセスするための制約を定義 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
戻り値
Promise<DeviceAccess>
注釈
アクセス許可がまだ付与されていない場合は、ブラウザーのアクセス許可ウィンドウが表示されます
CallAdapterDeviceManagement.askDevicePermissionから継承
createStreamView(string, VideoStreamOptions)
ストリームの HTML ビューを作成します。
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを作成するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void | CreateVideoStreamViewResult>
注釈
このメソッドは複合用に実装されています。
createTogetherModeStreamView(TogetherModeStreamOptions)
ストリームの HTML ビューを作成します。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>パラメーター
- options
- TogetherModeStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void | TogetherModeStreamViewResult>
注釈
このメソッドは複合用に実装されています。
CallAdapterCallOperations.createTogetherModeStreamViewから継承されます
dispose()
disposeLocalVideoStreamView()
ローカルビデオストリームの html ビューを破棄します
function disposeLocalVideoStreamView(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.disposeLocalVideoStreamViewから継承
disposeRemoteVideoStreamView(string)
リモートビデオストリームのhtmlビューを破棄します
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>パラメーター
- remoteUserId
-
string
廃棄する参加者のID
戻り値
Promise<void>
CallAdapterCallOperations.disposeRemoteVideoStreamViewから継承
disposeScreenShareStreamView(string)
画面共有ストリームの html ビューを破棄します
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>パラメーター
- remoteUserId
-
string
画面共有ストリーム ビューを破棄する参加者の ID。
戻り値
Promise<void>
注釈
このメソッドは、複合
CallAdapterCallOperations.disposeScreenShareStreamViewから継承
disposeStreamView(string, VideoStreamOptions)
警告
この API は非推奨になりました。
Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.
ストリームの html ビューを破棄します。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを破棄するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
注釈
このメソッドは複合用に実装されています。
disposeTogetherModeStreamView()
ストリームの html ビューを破棄します。
function disposeTogetherModeStreamView(): Promise<void>戻り値
Promise<void>
注釈
このメソッドは複合用に実装されています。
CallAdapterCallOperations.disposeTogetherModeStreamViewから継承
forbidAudio(string[])
Teams 会議の出席者の音声をユーザー ID で禁止します。
function forbidAudio(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
CallAdapterCallOperations.forbidAudioから継承されます
forbidOthersAudio()
Teamsの会議の音声を禁止します。
function forbidOthersAudio(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.forbidOthersAudioから継承
forbidOthersVideo()
Teamsの会議ビデオを禁止します。
function forbidOthersVideo(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.forbidOthersVideoから継承
forbidVideo(string[])
Teams 会議の出席者のビデオをユーザー ID で禁止します。
function forbidVideo(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
CallAdapterCallOperations.forbidVideoから継承
getState()
holdCall()
通話を保留にします。
function holdCall(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.holdCallから継承されます
leaveCall(boolean)
通話を終了する
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
戻り値
Promise<void>
lowerHand()
現在のユーザーのローハンド
function lowerHand(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.lowerHandから継承されます
mute()
通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にする
function mute(): Promise<void>戻り値
Promise<void>
muteAllRemoteParticipants()
すべての参加者をミュート
function muteAllRemoteParticipants(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.muteAllRemoteParticipantsから継承
muteParticipant(string)
参加者をミュートする
function muteParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
ミュートする参加者のID
戻り値
Promise<void>
CallAdapterCallOperations.muteParticipantから継承されます
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
「breakoutRoomsUpdated」イベントの購読解除機能。
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)パラメーター
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
CallAdapterSubscribers.offから継承
off("callEnded", CallEndedListener)
'callEnded' イベントの Unsubscribe 関数。
function off(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
CallAdapterSubscribers.offから継承
off("callIdChanged", CallIdChangedListener)
'callIdChanged' イベントの Unsubscribe 関数。
function off(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
CallAdapterSubscribers.offから継承
off("capabilitiesChanged", CapabilitiesChangedListener)
'capabilitiesChanged' イベントのサブスクライブ解除関数。
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)パラメーター
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
CallAdapterSubscribers.offから継承
off("captionsReceived", CaptionsReceivedListener)
'captionsReceived' イベントの購読解除機能。
function off(event: "captionsReceived", listener: CaptionsReceivedListener)パラメーター
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
CallAdapterSubscribers.offから継承
off("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' イベントの Unsubscribe 関数。
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)パラメーター
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
CallAdapterSubscribers.offから継承
off("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' イベントの Unsubscribe 関数。
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
CallAdapterSubscribers.offから継承
off("error", (e: AdapterError) => void)
'error' イベントの Unsubscribe 関数。
function off(event: "error", listener: (e: AdapterError) => void)パラメーター
- event
-
"error"
- listener
-
(e: AdapterError) => void
CallAdapterSubscribers.offから継承
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
'isCaptionLanguageChanged' イベントのサブスクライブ解除関数。
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)パラメーター
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
CallAdapterSubscribers.offから継承
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
'isCaptionsActiveChanged' イベントのサブスクライブ解除関数。
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)パラメーター
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
CallAdapterSubscribers.offから継承
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' イベントの Unsubscribe 関数。
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
CallAdapterSubscribers.offから継承
off("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' イベントの Unsubscribe 関数。
function off(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
CallAdapterSubscribers.offから継承
off("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' イベントの Unsubscribe 関数。
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
CallAdapterSubscribers.offから継承
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
'isSpokenLanguageChanged' イベントのサブスクライブ解除関数。
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)パラメーター
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
CallAdapterSubscribers.offから継承
off("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' イベントのサブスクライブ解除機能。
function off(event: "mutedByOthers", listener: PropertyChangedEvent)パラメーター
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.offから継承
off("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' イベントの Unsubscribe 関数。
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
CallAdapterSubscribers.offから継承
off("participantsLeft", ParticipantsLeftListener)
'participantsLeft' イベントの Unsubscribe 関数。
function off(event: "participantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
CallAdapterSubscribers.offから継承
off("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' イベントのサブスクライブ解除関数。
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)パラメーター
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
CallAdapterSubscribers.offから継承
off("roleChanged", PropertyChangedEvent)
'roleChanged' イベントのサブスクライブ解除関数。
function off(event: "roleChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.offから継承
off("selectedMicrophoneChanged", PropertyChangedEvent)
'selectedMicrophoneChanged' イベントの Unsubscribe 関数。
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.offから継承
off("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' イベントの Unsubscribe 関数。
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.offから継承
off("spotlightChanged", SpotlightChangedListener)
'spotlightChanged' イベントの購読解除機能。
function off(event: "spotlightChanged", listener: SpotlightChangedListener)パラメーター
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
CallAdapterSubscribers.offから継承
off("transferAccepted", TransferAcceptedListener)
'transferRequested' イベントの購読解除関数。
function off(event: "transferAccepted", listener: TransferAcceptedListener)パラメーター
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
CallAdapterSubscribers.offから継承
offStateChange((state: CallAdapterState) => void)
ハンドラーを stateChanged イベントの登録を解除します。
function offStateChange(handler: (state: CallAdapterState) => void)パラメーター
- handler
-
(state: CallAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
「breakoutRoomsUpdated」イベントの購読機能。
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)パラメーター
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
CallAdapterSubscribers.onから継承
on("callEnded", CallEndedListener)
'callEnded' イベントのサブスクライブ関数。
function on(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
CallAdapterSubscribers.onから継承
on("callIdChanged", CallIdChangedListener)
'callIdChanged' イベントのサブスクライブ関数。
function on(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
注釈
イベントは、現在のユーザーの callId が変更されたときにトリガーされます。
CallAdapterSubscribers.onから継承
on("capabilitiesChanged", CapabilitiesChangedListener)
'capabilitiesChanged' イベントのサブスクライブ関数。
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)パラメーター
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
CallAdapterSubscribers.onから継承
on("captionsReceived", CaptionsReceivedListener)
'captionsReceived' イベントのサブスクライブ関数。
function on(event: "captionsReceived", listener: CaptionsReceivedListener)パラメーター
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
CallAdapterSubscribers.onから継承
on("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' イベントのサブスクライブ関数。
このイベントは、進行中の呼び出しに関する診断にユーザーが変更があった場合に発生します。
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)パラメーター
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
CallAdapterSubscribers.onから継承
on("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' イベントのサブスクライブ関数。
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
CallAdapterSubscribers.onから継承
on("error", (e: AdapterError) => void)
'error' イベントのサブスクライブ関数。
function on(event: "error", listener: (e: AdapterError) => void)パラメーター
- event
-
"error"
- listener
-
(e: AdapterError) => void
CallAdapterSubscribers.onから継承
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
'isCaptionLanguageChanged' イベントのサブスクライブ関数。
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)パラメーター
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
CallAdapterSubscribers.onから継承
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
'isCaptionsActiveChanged' イベントのサブスクライブ関数。
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)パラメーター
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
CallAdapterSubscribers.onから継承
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' イベントのサブスクライブ関数。
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
CallAdapterSubscribers.onから継承
on("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' イベントのサブスクライブ関数。
function on(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
注釈
イベントは、現在のユーザーまたはリモート ユーザーのミュート状態が変更されるたびにトリガーされます
CallAdapterSubscribers.onから継承
on("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' イベントのサブスクライブ関数。
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
CallAdapterSubscribers.onから継承
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
'isSpokenLanguageChanged' イベントのサブスクライブ関数。
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)パラメーター
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
CallAdapterSubscribers.onから継承
on("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' イベントのサブスクライブ関数。
function on(event: "mutedByOthers", listener: PropertyChangedEvent)パラメーター
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.onから継承
on("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' イベントのサブスクライブ関数。
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
CallAdapterSubscribers.onから継承
on("participantsLeft", ParticipantsLeftListener)
'participantsLeft' イベントのサブスクライブ関数。
function on(event: "participantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
CallAdapterSubscribers.onから継承
on("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' イベントのサブスクライブ関数。
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)パラメーター
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
CallAdapterSubscribers.onから継承
on("roleChanged", PropertyChangedEvent)
'roleChanged' イベントのサブスクライブ関数。
function on(event: "roleChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.onから継承
on("selectedMicrophoneChanged", PropertyChangedEvent)
'selectedMicrophoneChanged' イベントのサブスクライブ関数。
このイベントは、ユーザーが新しいマイク デバイスを選択するたびに発生します。
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.onから継承
on("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' イベントのサブスクライブ関数。
このイベントは、ユーザーが新しいスピーカー デバイスを選択するたびに発生します。
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
CallAdapterSubscribers.onから継承
on("spotlightChanged", SpotlightChangedListener)
'spotlightChanged' イベントの購読機能。
function on(event: "spotlightChanged", listener: SpotlightChangedListener)パラメーター
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
CallAdapterSubscribers.onから継承
on("transferAccepted", TransferAcceptedListener)
'transferRequested' イベントのサブスクライブ関数。
function on(event: "transferAccepted", listener: TransferAcceptedListener)パラメーター
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
CallAdapterSubscribers.onから継承
onReactionClick(Reaction)
onStateChange((state: CallAdapterState) => void)
ハンドラーを stateChanged イベントにサブスクライブします。
function onStateChange(handler: (state: CallAdapterState) => void)パラメーター
- handler
-
(state: CallAdapterState) => void
permitAudio(string[])
Teams 会議の出席者にユーザー ID による音声を許可します。
function permitAudio(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
CallAdapterCallOperations.permitAudioから継承されます
permitOthersAudio()
Teams 会議の音声を許可します。
function permitOthersAudio(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.permitOthersAudioから継承されます
permitOthersVideo()
Teams 会議のビデオを許可します。
function permitOthersVideo(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.permitOthersVideoから継承
permitVideo(string[])
Teams 会議の出席者にユーザー ID による音声を許可します。
function permitVideo(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
CallAdapterCallOperations.permitVideoから継承
queryCameras()
使用可能なカメラ デバイスのクエリを実行します。
function queryCameras(): Promise<VideoDeviceInfo[]>戻り値
Promise<VideoDeviceInfo[]>
ビデオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
CallAdapterDeviceManagement.queryCamerasから継承
queryMicrophones()
使用可能なマイク デバイスのクエリを実行します。
function queryMicrophones(): Promise<AudioDeviceInfo[]>戻り値
Promise<AudioDeviceInfo[]>
オーディオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
CallAdapterDeviceManagement.queryMicrophonesから継承
querySpeakers()
使用可能なスピーカー デバイスを照会します。
function querySpeakers(): Promise<AudioDeviceInfo[]>戻り値
Promise<AudioDeviceInfo[]>
オーディオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
CallAdapterDeviceManagement.querySpeakersから継承
raiseHand()
現在のユーザーの手を挙げる
function raiseHand(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.raiseHandから継承
removeParticipant(CommunicationIdentifier)
通話から参加者を削除します。
function removeParticipant(participant: CommunicationIdentifier): Promise<void>パラメーター
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 除名される参加者の
戻り値
Promise<void>
removeParticipant(string)
通話から参加者を削除します。
function removeParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
削除する参加者の ID
戻り値
Promise<void>
resumeCall()
LocalHold状態から通話を再開します。
function resumeCall(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.resumeCallから継承されます
returnFromBreakoutRoom()
ブレイクアウトルームの発信元に戻る
function returnFromBreakoutRoom(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.returnFromBreakoutRoomから継承
sendDtmfTone(DtmfTone)
setCamera(VideoDeviceInfo, VideoStreamOptions)
通話で使用するカメラを設定します。
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>パラメーター
- sourceInfo
- VideoDeviceInfo
選択するカメラ デバイスで、queryCameras によって返されたものを選択します
- options
- VideoStreamOptions
カメラ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
CallAdapterDeviceManagement.setCameraから継承
setCaptionLanguage(string)
キャプション言語を設定する機能
function setCaptionLanguage(language: string): Promise<void>パラメーター
- language
-
string
キャプションの言語セット
戻り値
Promise<void>
CallAdapterCallOperations.setCaptionLanguageから継承
setMicrophone(AudioDeviceInfo)
通話で使用するマイクを設定します。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
選択するマイクデバイスは、queryMicrophones によって返されたものを選択
戻り値
Promise<void>
CallAdapterDeviceManagement.setMicrophoneから継承されます
setSpeaker(AudioDeviceInfo)
通話で使用するスピーカーを設定します。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
選択するスピーカー デバイスで、querySpeakers によって返されたものを選択します
戻り値
Promise<void>
setSpokenLanguage(string)
音声言語を設定する機能
function setSpokenLanguage(language: string): Promise<void>パラメーター
- language
-
string
話し言葉
戻り値
Promise<void>
CallAdapterCallOperations.setSpokenLanguageから継承されます
setTogetherModeSceneSize(number, number)
Together モードの着座位置を再計算します。
function setTogetherModeSceneSize(width: number, height: number)パラメーター
- width
-
number
コンテナの幅
- height
-
number
コンテナの高さ
注釈
このメソッドは複合用に実装されています。
CallAdapterCallOperations.setTogetherModeSceneSizeから継承されます
startCamera(VideoStreamOptions)
カメラの起動 このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します
function startCamera(options?: VideoStreamOptions): Promise<void>パラメーター
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
キャプションを開始する機能
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>パラメーター
- options
- StartCaptionsAdapterOptions
開始キャプションのオプション
戻り値
Promise<void>
CallAdapterCallOperations.startCaptionsから継承されます
startNoiseSuppressionEffect()
ノイズ抑制効果を開始します。
function startNoiseSuppressionEffect(): Promise<void>戻り値
Promise<void>
startScreenShare()
通話中に画面の共有を開始します。
function startScreenShare(): Promise<void>戻り値
Promise<void>
startSpotlight(string[])
ローカル参加者とリモート参加者のスポットライトをユーザー ID で開始します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。
function startSpotlight(userIds?: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
startTogetherMode()
「一緒に開始」モード。
function startTogetherMode(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.startTogetherModeから継承されます
startVideoBackgroundEffect(VideoBackgroundEffect)
ビデオの背景効果を開始します。
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>パラメーター
- videoBackgroundEffect
- VideoBackgroundEffect
戻り値
Promise<void>
stopAllSpotlight()
すべてのスポットライトを止める
function stopAllSpotlight(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.stopAllSpotlightから継承
stopCamera()
カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します
function stopCamera(): Promise<void>戻り値
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
キャプションを停止する機能
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>パラメーター
- options
- StopCaptionsAdapterOptions
戻り値
Promise<void>
CallAdapterCallOperations.stopCaptionsから継承されます
stopNoiseSuppressionEffect()
ノイズ抑制効果を停止します。
function stopNoiseSuppressionEffect(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.stopNoiseSuppressionEffectから継承されます
stopScreenShare()
画面の共有を停止する
function stopScreenShare(): Promise<void>戻り値
Promise<void>
stopSpotlight(string[])
ローカル参加者とリモート参加者のスポットライトを、ユーザー ID で停止します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。
function stopSpotlight(userIds?: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
CallAdapterCallOperations.stopSpotlightから継承
stopVideoBackgroundEffects()
ビデオの背景効果を停止します。
function stopVideoBackgroundEffects(): Promise<void>戻り値
Promise<void>
CallAdapterCallOperations.stopVideoBackgroundEffectsから継承
submitSurvey(CallSurvey)
通話終了の調査結果を送信する
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>パラメーター
- survey
- CallSurvey
戻り値
Promise<undefined | CallSurveyResponse>
CallAdapterCallOperations.submitSurveyから継承されます
unmute()
通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にする
function unmute(): Promise<void>戻り値
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
背景ピッカーの画像を上書きして、背景の置換効果を得ます。
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])パラメーター
- backgroundImages
カスタム背景画像の配列。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
選択したビデオの背景効果を更新します。
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)パラメーター
- selectedVideoBackground
- VideoBackgroundEffect
CallAdapterCallOperations.updateSelectedVideoBackgroundEffectから継承