CallClient class

パッケージ:

@azure/communication-calling

CallClient は、SDK のメイン エントリ ポイントです。 CallClient は、CallAgent を作成し、DeviceManager を取得するために使用されます。

コンストラクター

CallClient(CallClientOptions)

CallClient を作成します。

メソッド

createCallAgent(CommunicationTokenCredential, CallAgentOptions)	CallAgent は、呼び出しを処理するために使用されます。 CallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。 CallClient は、アクティブな CallAgent インスタンスを一度に 1 つだけ持つことができます。 新しい CallClient インスタンスを作成して、新しい CallAgent を作成できます。 CallClient の現在のアクティブな CallAgent を破棄し、CallClient の createCallAgent() メソッドをもう一度呼び出して、新しい CallAgent を作成できます。
createTeamsCallAgent(CommunicationTokenCredential, TeamsCallAgentOptions)	TeamsCallAgent は、Teams の呼び出しを処理するために使用されます。 TeamsCallAgent を作成するには、SDK から提供される CommunicationTokenCredential オブジェクトを渡します。 CallClient は、アクティブな TeamsCallAgent インスタンスを一度に 1 つだけ持つことができます。 新しい CallClient インスタンスを作成して、新しい TeamsCallAgent を作成できます。 CallClient の現在アクティブな TeamsCallAgent を破棄し、CallClient の createTeamsCallAgent() メソッドをもう一度呼び出して、新しい TeamsCallAgent を作成できます。
feature<TFeature>(CallClientFeatureFactory<TFeature>)	拡張 API を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張呼び出しクライアント機能については、オブジェクトの機能を確認してください。*
getDeviceManager()	DeviceManager は、カメラ、マイク、スピーカーなどのメディア デバイスを処理するために使用されます。

コンストラクターの詳細

CallClient(CallClientOptions)

CallClient を作成します。

new CallClient(options?: CallClientOptions)

パラメーター

options

CallClientOptions

メソッドの詳細

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>

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>

feature<TFeature>(CallClientFeatureFactory<TFeature>)

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

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

パラメーター

factory

CallClientFeatureFactory<TFeature>

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

戻り値

TFeature

getDeviceManager()

DeviceManager は、カメラ、マイク、スピーカーなどのメディア デバイスを処理するために使用されます。

function getDeviceManager(): Promise<DeviceManager>

戻り値

Promise<DeviceManager>