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 的调用客户端功能构造函数的工厂。
返回
TFeature
getDeviceManager()
DeviceManager 用于处理媒体设备,例如相机、麦克风和扬声器。
function getDeviceManager(): Promise<DeviceManager>
返回
Promise<DeviceManager>