CallClient class
CallClient 是 SDK 的主要進入點。 CallClient 可用來建立 CallAgent 並取得 DeviceManager。
建構函式
Call |
建立 CallClient。 |
方法
create |
CallAgent 可用來處理呼叫。 若要建立 CallAgent,請傳遞從 SDK 提供的 CommunicationTokenCredential 物件。
|
create |
TeamsCallAgent 可用來處理 Teams 通話。 若要建立 TeamsCallAgent,請傳遞從 SDK 提供的 CommunicationTokenCredential 物件。
|
feature<TFeature>(Call |
擷取具有擴充 API 的初始化和備忘功能物件。 檢查物件 Features.* ,以取得此套件中所有可用的擴充呼叫用戶端功能。 |
get |
DeviceManager 可用來處理媒體裝置,例如相機、麥克風和喇叭。 |
建構函式詳細資料
CallClient(CallClientOptions)
方法詳細資料
createCallAgent(CommunicationTokenCredential, CallAgentOptions)
CallAgent 可用來處理呼叫。 若要建立 CallAgent,請傳遞從 SDK 提供的 CommunicationTokenCredential 物件。
- CallClient 一次只能有一個作用中的 CallAgent 實例。
- 您可以建立新的 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 實例。
- 您可以建立新的 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 的初始化和備忘功能物件。 檢查物件 Features.* ,以取得此套件中所有可用的擴充呼叫用戶端功能。
function feature<TFeature>(factory: CallClientFeatureFactory<TFeature>): TFeature
參數
- factory
-
CallClientFeatureFactory<TFeature>
提供擴充 API 之呼叫用戶端功能建構函式的 Factory。
傳回
TFeature
getDeviceManager()
DeviceManager 可用來處理媒體裝置,例如相機、麥克風和喇叭。
function getDeviceManager(): Promise<DeviceManager>
傳回
Promise<DeviceManager>