CallClient
Регистрация SIP-аккаунта и управление вызовами.
Методы регистрации SIP-аккаунта
register
Регистрация нового аккаунта и установка его текущим.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| login | string | юзернейим SIP ID |
| password | string | пароль SIP ID |
setOffline
Регистрация или снятие регистрации аккаунта, оставляя его текущим.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| offline | boolean | True — зарегистрировать, False— снять регистрацию |
unregister
Снятие регистрации аккаунта.
getRegistrationState
Получение статуса регистрации текущего аккаунта.
Выходные параметры
| Тип | Описание |
|---|---|
| enum RegistrationState | текущий статус процесса регистрации аккаунта |
RegistrationState
| Значение | Описание |
|---|---|
| NOT_REGISTERED | не зарегистрирован |
| REGISTERING | в процессе регистрации |
| REGISTERED | зарегистрирован в сети |
| OFFLINE | разрегистрирован в сети |
| NO_CONNECTION | нет подключения к сети во время регистрации аккаунта |
| ERROR | произошла ошибка во время регистрации аккаунта |
Методы управления вызовами
placeCall
Совершение нового исходящего вызова на заданный номер.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| number | string | номер, на который нужно позвонить |
placeCall
Совершение нового исходящего вызова из заданной геолокации. Используется в случае реализации определения геолокации на стороне приложения с последующей передачей координат в сторону Voice SDK.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| number | string | номер, на который нужно позвонить |
| location | Location | местоположение вызова |
getCalls
Получение всех текущих вызовов.
Выходные параметры
| Тип | Описание |
|---|---|
| Call[] | массив текущих вызовов |
getCallById
Получение вызова по его идентификатору.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| id | string | идентификатор звонка |
Выходные параметры
| Тип | Описание |
|---|---|
| Call | найденный вызов или null, если вызов не был найден |
isSpeakerOn
Проверка включения/выключения громкой связи во время звонков.
Выходные параметры
| Тип | Описание |
|---|---|
| boolean | True — громкая связь включена, False — громкая связь выключена |
setSpeakerOn
Включение/выключение громкой связи во время звонков.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| speakerOn | boolean | True — включить громкую связь, False — выключить громкую связь |
getAudioRoutes
Получение списка доступных аудиомаршрутов для вывода звука.
Выходные параметры
| Тип | Описание |
|---|---|
| ArrayList AudioRouteData | список аудиомаршрутов |
setAudioRoute
Настройка аудиомаршрута для вывода звука: на наушники, динамик, проводную или bluetooth-гарнитуру. Асинхронный режим работы.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| route | enum AudioRoute | тип аудиомаршрута |
AudioRoute
| Значение | Описание |
|---|---|
| BLUETOOTH | bluetooth-гарнитура |
| EARPIECE | наушники |
| HEADSET | проводная гарнитура |
| SPEAKER | динамик |
| UNKNOWN | тип аудиомаршрута неизвестен |
Методы установки слушателей событий
setRegistrationListener
Установка слушателя для отслеживания состояний регистрации аккаунта.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| listener | IRegistrationListener | интерфейс событий состояний регистрации аккаунта |
| looper | Looper | лупер, где вызывается метод слушателя событий |
removeRegistrationListener
Удаление слушателя для отслеживания состояний регистрации аккаунта.
setCallsListener
Установка слушателя для новых и текущих звонков.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| listener | ICallsListener | интерфейс событий состояний вызова |
| looper | Looper | лупер, где вызывается метод слушателя событий |
removeCallsListener
Удаление слушателя для новых и текущих звонков.
setAudioRouteListener
Установка слушателя для отслеживания добавления или удаления аудиомаршрута, а также активации конкретного маршрута.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| listener | IAudioRouteListener | интерфейс получения информации об изменении доступных аудиомаршрутов |
| looper | Looper | лупер, где вызывается метод слушателя событий |
removeAudioRouteListener
Удаление слушателя из аудиомаршрута.
setCallLocationRequester
Установка обработчика для запроса местоположения вызова. Используется в случае реализации определения геолокации на стороне приложения с последующей передачей координат в сторону Voice SDK.
Входные параметры
| Параметр | Тип | Описание |
|---|---|---|
| requester | ICallLocationRequester | экземпляр обработчика |
| looper | Looper | лупер, где вызывается метод слушателя событий |