StatefulCallClient interface
CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> をステートフルに使用できるようにするメソッドを定義します。 インターフェイスは、プロキシされた状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。 状態定義については、「 CallClientState」を参照してください。
状態変更イベントは、次の方法で実行されます。
- API から <xref:%40azure%2Fcommunication-calling%23DeviceManager> 返されたデータ。
- API から <xref:%40azure%2Fcommunication-calling%23CallAgent> 返されたデータ。
- さまざまな Azure 通信呼び出しオブジェクトに自動的にアタッチされるリスナー:
- CallAgent 'incomingCall'
- CallAgent 'callsUpdated'
- DeviceManager 'videoDevicesUpdated'
- DeviceManager 'audioDevicesUpdated
- DeviceManager 'selectedMicrophoneChanged'
- DeviceManager 'selectedSpeakerChanged'
- 'stateChanged' を呼び出す
- 'idChanged' を呼び出す
- 'isMutedChanged' を呼び出す
- 'isScreenSharingOnChanged' を呼び出す
- 'remoteParticipantsUpdated' を呼び出す
- 'localVideoStreamsUpdated' を呼び出す
- IncomingCall 'callEnded'
- RemoteParticipant 'stateChanged'
- RemoteParticipant 'isMutedChanged'
- RemoteParticipant 'displayNameChanged'
- RemoteParticipant 'isSpeakingChanged'
- RemoteParticipant 'videoStreamsUpdated'
- RemoteVideoStream 'isAvailableChanged'
- TranscriptionCallFeature 'isTranscriptionActiveChanged'
- RecordingCallFeature 'isRecordingActiveChanged'
- Extends
メソッド
| create |
RemoteVideoStreamState または LocalVideoStreamState をレンダリングし、結果の VideoStreamRendererViewState を関連する RemoteVideoStreamState または LocalVideoStreamState の下に格納するか、状態の親のないビューとして格納します。 内部では を呼び出します <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>。 シナリオ 1: RemoteVideoStreamState をレンダリングする
シナリオ 2: 呼び出しの LocalVideoStreamState をレンダリングする
|
| dispose |
RemoteVideoStreamState または LocalVideoStreamState のレンダリングを停止し、CallClientState または CallClientState または<xref:LocalVideoStream>適切な<xref:CallClientState.deviceManager.unparentedViews>内部呼び出し<xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>で関連する RemoteVideoStreamState から を削除<xref:VideoStreamRendererView>します。 リソースを適切にクリーンするには、DisposeView が重要です。 シナリオ 1: RemoteVideoStreamState を破棄する
シナリオ 2: 呼び出し用に LocalVideoStreamState を破棄する
|
| get |
CallClientState CallClientState として CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> からプロキシできるすべての状態を保持します。 |
| off |
'stateChanged' イベントの登録解除を許可します。 |
| on |
ハンドラーを 'stateChanged' イベントに登録できるようにします。 |
継承されたメソッド
| create |
CallAgent は、呼び出しを処理するために使用されます。 CallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。
|
| create |
TeamsCallAgent は、Teams 呼び出しを処理するために使用されます。 TeamsCallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。
|
| feature<TFeature>(Call |
拡張 API を使用して初期化およびメモ済みの Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張呼び出しクライアント機能については、オブジェクトの Features.* を確認してください。 |
| get |
DeviceManager は、カメラ、マイク、スピーカーなどのメディア デバイスを処理するために使用されます。 |
メソッドの詳細
createView(undefined | string, undefined | CommunicationIdentifier, LocalVideoStreamState | RemoteVideoStreamState, CreateViewOptions)
RemoteVideoStreamState または LocalVideoStreamState をレンダリングし、結果の VideoStreamRendererViewState を関連する RemoteVideoStreamState または LocalVideoStreamState の下に格納するか、状態の親のないビューとして格納します。 内部では を呼び出します <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>。
シナリオ 1: RemoteVideoStreamState をレンダリングする
- CallId が必要、participantId が必要、RemoteVideoStreamState 型のストリームが必要です
- 結果の VideoStreamRendererViewState は、CallClientState の指定された callId と participantId に格納されます
シナリオ 2: 呼び出しの LocalVideoStreamState をレンダリングする
CallId は必須、participantId は未定義である必要があり、LocalVideoStreamState 型のストリームが必要です。
は <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> 、 を使用して <xref:%40azure%2Fcommunication-calling%23Call.startVideo>既に開始されている必要があります。
結果の VideoStreamRendererViewState は、CallClientState の指定された callId localVideoStreams に格納されます。
シナリオ 2: 呼び出しの一部ではない LocalVideoStreamState をレンダリングする (ローカル プレビュー用のレンダリング カメラの例)
CallId は未定義、participantId は未定義、LocalVideoStreamState 型のストリームが必要です。
結果の VideoStreamRendererViewState は、 の指定された LocalVideoStreamState の下に格納されます。 <xref:CallClientState.deviceManager.unparentedViews>
function createView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: LocalVideoStreamState | RemoteVideoStreamState, options?: CreateViewOptions): Promise<undefined | CreateViewResult>パラメーター
- callId
-
undefined | string
指定されたストリームの CallId。 ストリームが呼び出しの一部でない場合は、未定義にすることができます。
- participantId
-
undefined | CommunicationIdentifier
<xref:RemoteParticipant.identifier> 指定された RemoteVideoStreamState に関連付けられています。 LocalVideoStreamState をレンダリングする場合、未定義になる可能性があります。
レンダリングを開始する LocalVideoStreamState または RemoteVideoStreamState。
- options
- CreateViewOptions
に <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer>渡されるオプション。
戻り値
Promise<undefined | CreateViewResult>
disposeView(undefined | string, undefined | CommunicationIdentifier, LocalVideoStreamState | RemoteVideoStreamState)
RemoteVideoStreamState または LocalVideoStreamState のレンダリングを停止し、CallClientState または CallClientState または<xref:LocalVideoStream>適切な<xref:CallClientState.deviceManager.unparentedViews>内部呼び出し<xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>で関連する RemoteVideoStreamState から を削除<xref:VideoStreamRendererView>します。
リソースを適切にクリーンするには、DisposeView が重要です。
シナリオ 1: RemoteVideoStreamState を破棄する
- CallId が必要、participantId が必要、RemoteVideoStreamState 型のストリームが必要です
シナリオ 2: 呼び出し用に LocalVideoStreamState を破棄する
CallId は必須、participantId は未定義である必要があり、LocalVideoStreamState 型のストリームが必要です。
シナリオ 2: 呼び出しの一部ではない LocalVideoStreamState を破棄する
CallId は未定義、participantId は未定義、LocalVideoStreamState 型のストリームが必要です。
LocalVideoStreamState は、createView に渡される元のデータである必要があります。
function disposeView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: LocalVideoStreamState | RemoteVideoStreamState)パラメーター
- callId
-
undefined | string
指定されたストリームの CallId。 ストリームが呼び出しの一部でない場合は、未定義にすることができます。
- participantId
-
undefined | CommunicationIdentifier
<xref:RemoteParticipant.identifier> 指定された RemoteVideoStreamState に関連付けられています。 LocalVideoStreamState を破棄する場合は未定義の可能性があります。
破棄する LocalVideoStreamState または RemoteVideoStreamState。
getState()
CallClientState CallClientState として CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> からプロキシできるすべての状態を保持します。
function getState(): CallClientState戻り値
offStateChange((state: CallClientState) => void)
'stateChanged' イベントの登録解除を許可します。
function offStateChange(handler: (state: CallClientState) => void)パラメーター
- handler
-
(state: CallClientState) => void
登録を解除する元のコールバック。
onStateChange((state: CallClientState) => void)
ハンドラーを 'stateChanged' イベントに登録できるようにします。
function onStateChange(handler: (state: CallClientState) => void)パラメーター
- handler
-
(state: CallClientState) => void
状態を受信するためのコールバック。
継承済みメソッドの詳細
createCallAgent(CommunicationTokenCredential, CallAgentOptions)
CallAgent は、呼び出しを処理するために使用されます。 CallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。
- CallClient は、アクティブな CallAgent インスタンスを一度に 1 つだけ持つことができます。
- 新しい CallClient インスタンスを作成して、新しい CallAgent を作成できます。
- CallClient の現在アクティブな CallAgent を破棄し、CallClient の createCallAgent() メソッドをもう一度呼び出して、新しい CallAgent を作成できます。
function createCallAgent(tokenCredential: CommunicationTokenCredential, options?: CallAgentOptions): Promise<CallAgent>パラメーター
- tokenCredential
- CommunicationTokenCredential
トークン資格情報。 資格情報を作成するには、 から @azure/communication-common AzureCommunicationTokenCredential を使用します。
- options
- CallAgentOptions
表示名などの追加オプションの CallAgentOptions。
戻り値
Promise<CallAgent>
継承元 CallClient.createCallAgent
createTeamsCallAgent(CommunicationTokenCredential, TeamsCallAgentOptions)
TeamsCallAgent は、Teams 呼び出しを処理するために使用されます。 TeamsCallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。
- CallClient は、アクティブな TeamsCallAgent インスタンスを一度に 1 つだけ持つことができます。
- 新しい CallClient インスタンスを作成して、新しい TeamsCallAgent を作成できます。
- CallClient の現在アクティブな TeamsCallAgent を破棄し、CallClient の createTeamsCallAgent() メソッドをもう一度呼び出して、新しい TeamsCallAgent を作成できます。
function createTeamsCallAgent(tokenCredential: CommunicationTokenCredential, options?: TeamsCallAgentOptions): Promise<TeamsCallAgent>パラメーター
- tokenCredential
- CommunicationTokenCredential
トークン資格情報。 資格情報を作成するには、 から @azure/communication-common AzureCommunicationTokenCredential を使用します。
- options
- TeamsCallAgentOptions
表示名などの追加オプションの CallAgentOptions。
戻り値
Promise<TeamsCallAgent>
継承元 CallClient.createTeamsCallAgent
feature<TFeature>(CallClientFeatureFactory<TFeature>)
拡張 API を使用して初期化およびメモ済みの Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張呼び出しクライアント機能については、オブジェクトの Features.* を確認してください。
function feature<TFeature>(factory: CallClientFeatureFactory<TFeature>): TFeatureパラメーター
- factory
-
CallClientFeatureFactory<TFeature>
拡張 API を提供する呼び出しクライアント機能コンストラクターのファクトリ。
戻り値
TFeature
継承元 CallClient.feature
getDeviceManager()
DeviceManager は、カメラ、マイク、スピーカーなどのメディア デバイスを処理するために使用されます。
function getDeviceManager(): Promise<DeviceManager>戻り値
Promise<DeviceManager>
継承元 CallClient.getDeviceManager