CallClient class
CallClient — это основная точка входа в пакет SDK. CallClient используется для создания CallAgent и получения DeviceManager.
Конструкторы
| Call |
Создайте CallClient. |
Методы
| create |
CallAgent используется для обработки вызовов. Чтобы создать CallAgent, передайте объект CommunicationTokenCredential, предоставленный из пакета SDK.
|
| create |
TeamsCallAgent используется для обработки вызовов Teams. Чтобы создать TeamsCallAgent, передайте объект CommunicationTokenCredential, предоставленный из пакета SDK.
|
| feature<TFeature>(Call |
Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций клиента вызова в этом пакете. |
| get |
DeviceManager используется для обработки устройств мультимедиа, таких как камеры, микрофоны и динамики. |
Сведения о конструкторе
CallClient(CallClientOptions)
Создайте CallClient.
new CallClient(options?: CallClientOptions)Параметры
- options
- CallClientOptions
Сведения о методе
createCallAgent(CommunicationTokenCredential, CallAgentOptions)
CallAgent используется для обработки вызовов. Чтобы создать CallAgent, передайте объект CommunicationTokenCredential, предоставленный из пакета SDK.
- CallClient может одновременно иметь только один активный экземпляр CallAgent.
- Можно создать новый экземпляр CallClient, чтобы создать новый CallAgent.
- Вы можете удалить текущий активный CallClient CallAgent и снова вызвать метод CallClient createCallAgent(), чтобы создать новый CallAgent.
function createCallAgent(tokenCredential: CommunicationTokenCredential, options?: CallAgentOptions): Promise<CallAgent>Параметры
- tokenCredential
- CommunicationTokenCredential
Учетные данные маркера. Используйте AzureCommunicationTokenCredential из @azure/communication-common для создания учетных данных.
- options
- CallAgentOptions
CallAgentOptions для дополнительных параметров, таких как отображаемое имя.
Возвращаемое значение
Promise<CallAgent>
createTeamsCallAgent(CommunicationTokenCredential, TeamsCallAgentOptions)
TeamsCallAgent используется для обработки вызовов Teams. Чтобы создать TeamsCallAgent, передайте объект CommunicationTokenCredential, предоставленный из пакета SDK.
- CallClient может одновременно иметь только один активный экземпляр TeamsCallAgent.
- Вы можете создать новый экземпляр CallClient, чтобы создать новый TeamsCallAgent.
- Вы можете удалить текущий активный TeamsCallAgent в CallClient и снова вызвать метод CallClient createTeamsCallAgent(), чтобы создать новый TeamsCallAgent.
function createTeamsCallAgent(tokenCredential: CommunicationTokenCredential, options?: TeamsCallAgentOptions): Promise<TeamsCallAgent>Параметры
- tokenCredential
- CommunicationTokenCredential
Учетные данные маркера. Используйте AzureCommunicationTokenCredential из @azure/communication-common для создания учетных данных.
- options
- TeamsCallAgentOptions
CallAgentOptions для дополнительных параметров, таких как отображаемое имя.
Возвращаемое значение
Promise<TeamsCallAgent>
feature<TFeature>(CallClientFeatureFactory<TFeature>)
Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций клиента вызова в этом пакете.
function feature<TFeature>(factory: CallClientFeatureFactory<TFeature>): TFeatureПараметры
- factory
-
CallClientFeatureFactory<TFeature>
Фабрика для конструктора функций клиента вызова, предоставляющего расширенный API.
Возвращаемое значение
TFeature
getDeviceManager()
DeviceManager используется для обработки устройств мультимедиа, таких как камеры, микрофоны и динамики.
function getDeviceManager(): Promise<DeviceManager>Возвращаемое значение
Promise<DeviceManager>