CallAdapterCallManagement interface
Предупреждение
Теперь этот API является нерекомендуемым.
CallAdapter interface will be flatten, consider using CallAdapter directly
Функции для управления текущим вызовом или запуска нового вызова
- Extends
Методы
| join |
Присоединяйтесь к звонку с микрофоном, который изначально включен или выключен. |
| start |
Начните вызов. |
Наследуемые методы
| create |
Создайте представление HTML для потока. |
| dispose |
Удалите представление HTML для потока. |
| leave |
Выйти из звонка |
| mute() | Отключение звука текущего пользователя во время вызова или локальное отключение микрофона |
| remove |
Удаление участника из вызова. |
| start |
Запуск камеры. Этот метод запускает отрисовку представления локальной камеры, если вызов неактивен |
| start |
Начните делиться экраном во время звонка. |
| stop |
Остановка камеры. Этот метод останавливает отрисовку представления локальной камеры, если вызов неактивен |
| stop |
Прекратить общий доступ к экрану |
| unmute() | Включение микрофона для текущего пользователя во время вызова или локальное включение микрофона |
Сведения о методе
joinCall(boolean)
Присоединяйтесь к звонку с микрофоном, который изначально включен или выключен.
function joinCall(microphoneOn?: boolean): undefined | CallПараметры
- microphoneOn
-
boolean
Указывает, включен ли микрофон изначально
Возвращаемое значение
undefined | Call
startCall(string[], StartCallOptions)
Начните вызов.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallПараметры
- participants
-
string[]
Массив идентификаторов участников для присоединения
- options
- StartCallOptions
Возвращаемое значение
undefined | Call
Сведения о наследуемом методе
createStreamView(string, VideoStreamOptions)
Создайте представление HTML для потока.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Параметры
- remoteUserId
-
string
Идентификатор участника для отрисовки. Оставьте его неопределенным, чтобы создать представление локальной камеры
- options
- VideoStreamOptions
Параметры для управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void | CreateVideoStreamViewResult>
Комментарии
Этот метод реализуется для составных
Наследуется отCallAdapterCallOperations.createStreamView
disposeStreamView(string, VideoStreamOptions)
Удалите представление HTML для потока.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Параметры
- remoteUserId
-
string
Идентификатор участника для отрисовки, оставьте его неопределенным, чтобы удалить представление локальной камеры
- options
- VideoStreamOptions
Параметры для управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void>
Комментарии
Этот метод реализуется для составных
Наследуется отCallAdapterCallOperations.disposeStreamView
leaveCall(boolean)
Выйти из звонка
function leaveCall(forEveryone?: boolean): Promise<void>Параметры
- forEveryone
-
boolean
Следует ли удалять всех участников при выходе
Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.leaveCall
mute()
Отключение звука текущего пользователя во время вызова или локальное отключение микрофона
function mute(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.mute
removeParticipant(string)
Удаление участника из вызова.
function removeParticipant(userId: string): Promise<void>Параметры
- userId
-
string
Идентификатор удаляемого участника
Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.removeParticipant
startCamera(VideoStreamOptions)
Запуск камеры. Этот метод запускает отрисовку представления локальной камеры, если вызов неактивен
function startCamera(options?: VideoStreamOptions): Promise<void>Параметры
- options
- VideoStreamOptions
Параметры для управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.startCamera
startScreenShare()
Начните делиться экраном во время звонка.
function startScreenShare(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.startScreenShare
stopCamera()
Остановка камеры. Этот метод останавливает отрисовку представления локальной камеры, если вызов неактивен
function stopCamera(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.stopCamera
stopScreenShare()
Прекратить общий доступ к экрану
function stopScreenShare(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.stopScreenShare
unmute()
Включение микрофона для текущего пользователя во время вызова или локальное включение микрофона
function unmute(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallAdapterCallOperations.unmute