Труконф

# Функции Android

Далее идёт список функций, которые применяются при разработке на IDE Android Studio.

# Функции экземпляра SDK

Вызываются на уровне экземпляра TrueConf Mobile SDK, получаемого функцией TrueConfSDK.getInstance(). Например, TrueConfSDK.getInstance().registerApp(this).

# registerApp

Записывает класс-наследник от Application. Этот метод нужно обязательно вызвать до start.

Параметры:

  • application – класс Application (Class).

# addTrueconfListener

Подключение слушателя.

Параметры:

  • listener – класс слушатель (TrueconfListener).

# removeTrueconfListener

Отключение слушателя.

Параметры:

  • listener – класс слушатель (TrueconfListener).

# setFallbackActivity

Записывает класс Activity, к которому нужно вернуться в случае завершения звонка. Этот метод нужно вызвать обязательно.

Параметры:

  • activity – класс Activity (Class).

# start

Запуск SDK.

Параметры:

  • serverList – список серверов (String) (необязательный параметр);

  • checkPermissions – проверять ли разрешения при необходимости (boolean).

# stop

Остановка работы экземпляра SDK и освобождение ресурсов.

# isStarted

Проверка состояния работы экземпляра SDK, результат типа boolean.

# IServerManager

Данные функции вызываются на уровне интерфейса IServerManager, который получаем вызовом функции TrueConfSDK.getServerManager().

# isConnectedToServer

Проверка соединения с сервером.

Возвращаемое значение (булевое) – true, если есть соединение с сервером, false – соединение отсутствует.

# isLoggedIn

Проверка состояния авторизации.

Возвращаемое значение (булевое) – true, пользователь авторизован на сервере, false – пользователь не авторизован.

# loginAs

Авторизация под определённым пользователем с указанными параметрами на сервере.

Параметры:

  • user – идентификатор пользователя (строка);

  • pwd – пароль (строка);

  • encryptPassword – true, если пароль передается в открытом виде (и SDK требуется его зашифровать), false, если он уже в зашифрованном виде (булевая);

  • enableAutoLogin – нужно ли автоматически авторизовать пользователя этим идентификатором при повторном запуске (булевая).

Возвращаемое значение (булевое) – true, если запрос на авторизации отправлен на сервер, false – если авторизацию невозможно произвести.

# scheduleLoginAs

Получение списка операций, которые должны осуществиться последовательно, в том числе сервер для присоединения, идентификационные данные аккаунта и адресата звонка. Является эквивалентом функции parseProtocolLink, в которой параметры передаются не в виде строки протокола, а по отдельности. Строковые параметры могут быть пустыми.

Параметры:

  • login – идентификатор пользователя (строка);

  • pwd – пароль (строка);

  • encryptPassword – true, если пароль передается в открытом виде (и SDK требуется его зашифровать), false, если он уже в зашифрованном виде (булевая);

  • callToUser – идентификатор вызываемого абонента (строка);

  • autoClose – нужно ли закрывать сеанс работы с сервером после выполнения звонка или прерывания выполнения (булевая);

  • loginTemp – признак временного логина. Означает, что после звонка нужно деавторизовать клиент (булевая);

  • loginForce – принудительный логин. Авторизация будет произведена даже в том случае, если клиент уже авторизован на сервере (булевая);

  • domain – домен, в котором будет осуществляться автоматический поиск сервера (строка);

  • serversList – список серверов, к которым необходимо подключиться (строка);

  • isPublic – параметр, указывающий, что callToUser является именем конференции, а не именем пользователя. При неверном значении этого параметра звонок пользователю или подключение к конференции не выполнится (булевая).

# logout

Деавторизация (выход из системы) аккаунта без отключения SDK от сервера видеосвязи.

Возвращаемое значение (булевое) – true, если запрос на деавторизации отправлен на сервер, false – если деавторизацию невозможно произвести.

# IConferenceManager

Данные функции вызываются на уровне интерфейса IConferenceManager, который получаем вызовом функции TrueConfSDK.getConferenceManager().

# isInConference

Проверка нахождения в конференции.

Возвращаемое значение (булевое) – true, клиент находится в конференции, false – клиент вне конференции.

# callTo

Звонок указанном абоненту.

Параметры:

  • user – TrueConf ID вызываемого абонента (строка).

Возвращаемое значение (булевое) – true, если звонок отправлен на сервер, false – если звонок невозможно произвести.

# joinConf

Подключение к групповой конференции.

Параметры:

Возвращаемое значение (булевое) – true, если звонок отправлен на сервер, false – если звонок невозможно произвести.

# hangup

Завершение текущего звонка или конференции.

Параметры:

  • forAll (опциональный) – в случае конференции завершать ли её для всех участников при наличии полномочий (булевое). По умолчанию true.

Возвращаемое значение (булевое) – true, если звонок завершить возможно, false – если звонок завершить невозможно (обычно по причине неверного состояния).

# acceptCall

Ответ на входящий звонок.

Параметры:

  • accept – принять или отклонить вызов (булевое).

Возвращаемое значение (булевое) – true, если ответ на запрос можно произвести, false – если ответ невозможен.

# acceptRecord

Ответ на входящий запрос на видеозапись.

Параметры:

  • accept – принять или отклонить запрос на видеозапись (булевое);

  • userID – TrueConf ID пользователя, которому даётся ответ на запрос (строка).

# returnToCall

Возврат к activity конференции.

Параметры:

  • currentContext – текущий контекст (Context).

# sendPincode

Отправка пин-кода для доступа к конференции с пин-кодом.

Параметры:

  • confId – ID конференции (String);

  • pin - пин-код (String).

# IVideoDeviceController

Данные функции вызываются на уровне интерфейса IVideoDeviceController, который получаем вызовом функции TrueConfSDK.getVideoDeviceController().

# isCameraMuted

Проверка состояния камеры.

Возвращаемое значение (булевое) – true, когда камера отключена, false – камера включена.

# muteCamera

Изменение состояния камеры.

Параметры:

  • mute – состояние, в которое требуется перевести камеру: true – камера выключена, false – камера включена (булевая).

# isCameraEnabledByDefault

Возвращает статус камеры по умолчанию (boolean)

# setDefaultCameraEnabled

Установка состояния камеры по умолчанию.

Параметры:

  • isEnabled – true включает захват видео, false выключает (boolean).

# IAudioDeviceController

Данные функции вызываются на уровне интерфейса IAudioDeviceController, который получаем вызовом функции TrueConfSDK.getAudioDeviceController().

# muteMicrophone

Изменение состояния микрофона.

Параметры:

  • mute – состояние, в которое требуется перевести микрофон: true – микрофон выключен, false – микрофон включен (булевая).

# isMicrophoneMuted

Проверка состояния микрофона.

Возвращаемое значение (булевое) – true, когда микрофон отключен, false – микрофон включен.

# muteSpeaker

Включает либо отключает звук из динамиков.

Параметры:

  • mute – true выключает звук, false включает (boolean).

# requestAudioState

Запрос текущего состояния аудио устройств. В свою очередь вызывает метод onAudioDeviceResponse из AudioDeviceCallback.

# isMicEnabledByDefault

Возвращает статус микрофона по умолчанию (boolean).

# setDefaultMicEnabled

Установка состояния микрофона по умолчанию.

Параметры:

  • isEnabled – true включает захват звука, false выключает (boolean).

# isSpeakerEnabledByDefault

Возвращает статус динамика по умолчанию (boolean).

# setDefaultSpeakerEnabled

Установка состояния динамика по умолчанию.

Параметры:

  • isEnabled – true включает вывод звука, false выключает (boolean).

# setDefaultAudioDevice

Установка устройства вывода звука по умолчанию.

Параметры:

  • audioDeviceInfo – устройство вывода (AudioDeviceInfo).

# changeAudioDevice

Меняет устройство вывода звука во время конференции.

Параметры:

  • audioDeviceInfo – устройство вывода (AudioDeviceInfo).

# IChatManager

Данные функции вызываются на уровне интерфейса IChatManager, который получаем вызовом функции TrueConfSDK.getChatManager().

# sendChatMessage

Отправка текстового сообщения.

Параметры:

  • toID – (строка) TrueConf ID пользователя, которому отправляется сообщение (рекомендуется использовать полный ID вида user@server.name). Для отправки сообщения в чат текущей групповой конференции этот параметр должен быть пустым.

  • text – (строка) текст сообщения.

# IContactsManager

Данные функции вызываются на уровне интерфейса IContactsManager, который получаем вызовом функции TrueConfSDK.getContactsManager().

# getMyId

Получение собственного идентификатора.

Возвращаемое значение (строка) – идентификатор текущего пользователя в системе. Если пользователь не авторизован на сервере, возвращается Nil.

# getMyName

Получение собственного имени для показа в интерфейсе.

Возвращаемое значение (строка) – имя текущего пользователя. Содержит Nil если пользователь не авторизован на сервере, или строку, равную идентификатору пользователя, если пользователь не имеет собственного имени.

# getUserStatus

Получение статуса другого пользователя. Если статус известен, он возвращается немедленно. Если нет – статус запрашивается на сервере, а клиент подписывается на получение уведомлений о его изменении.

Параметры:

  • user – TrueConf ID пользователя, статус которого запрашивается (строка).

Возвращаемое значение (UserPresStatus) – текущий статус пользователя.

# getUsers

Получение списка абонентов из адресной книги пользователя, под которым авторизованы в SDK. Возвращает массив объектов типа ContactInfo, каждый объект содержит userId (String, TrueConf ID пользователя) и его текущий статус (PresenceStatus).

# IVisicallManager

Данные функции вызываются на уровне интерфейса IVisicallManager, который получаем вызовом функции TrueConfSDK.getVisicallManager().

Функция получает в виде строки команду, содержащую указания каким аккаунтом авторизоваться и какой звонок осуществить. После чего автоматически выполняет все эти операции. В случае, если на какой-то стадии происходит остановка выполнения команды.

Параметры:

  • cmd – обрабатываемая строка (строка).

# IExtraButtonController

Данные функции вызываются на уровне интерфейса IExtraButtonController, который получаем вызовом функции TrueConfSDK.getExtraButtonController().

# setNewExtraButtons

Добавить дополнительные кнопки в панель управления конференцией. Кнопки будут добавлены в порядке расположения их в переданном массиве в список, который открывается по тапу на кнопку "троеточия" (правая кнопка в панели). Смотрите Пример 5.

Параметры:

  • btns – массив из объектов типа TCExtraButton.

# ICallScreenController

Данные функции вызываются на уровне интерфейса ICallScreenController, который получаем вызовом функции TrueConfSDK.getCallScreenController().

# setReciveCallFragment

Переопределить экран входящего вызова.

Параметры:

  • fragment – кастомный фрагмент входящего вызова (Fragment)

# setPlaceCallFragment

Переопределить экран исходящего вызова.

Параметры:

  • fragment – кастомный фрагмент исходящего вызова (Fragment)

# setConferenceFragment

Переопределить экран конференции.

Параметры:

  • fragment – кастомный фрагмент конференции (Fragment)
Обновлено: 19.01.2025

← События для Android →