Skip to end of metadata
Go to start of metadata

В данном разделе описаны функции по управлению доступными на компьютере звуковыми устройствами, такими как динамики и микрофоны. Все описанные функции работают только в том случае, если предварительно был включен встроенный софтфон (см. функцию ВключитьСофтфон в разделе Управление звонками)

Методы

ПолучитьСписокМикрофонов / GetMicrophones

Получает список всех доступных устройств аудиоввода (микрофонов).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение:

Список устройств аудиоввода

Исключения: нет

Доступность:

Доступен с 1.27.

Пример:

ПолучитьСписокДинамиков / GetSpeakers

Получает список всех доступных устройств аудиовывода (динамиков).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение:

Список устройств аудиовывода

Исключения: нет

Доступность:

Доступен с 1.27.

Пример:

ПолучитьТекущийМикрофон / GetCurrentMicrophone

Получает значение текущего устройства аудиоввода (микрофона).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение:

Текущее устройство аудиоввода

Исключения: нет

Доступность:

Доступен с 1.27.

Пример:

ПолучитьТекущийДинамик / GetCurrentSpeaker

Получает значение текущего устройства аудиовывода (динамика).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение:

Текущее устройство аудиовывода

Исключения: нет

Доступность:

Доступен с 1.27.

Пример:

ЗадатьМикрофон / SetMicrophone

Задаёт текущее устройства аудиоввода (микрофона), которое будет использоваться софтфоном.

Список доступных идентификаторов устройств аудиоввода можно извлечь при помощи вызова метода ПолучитьСписокМикрофонов.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры:

  • deviceId - уникальный идентификатор устройства аудиоввода

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.InvalidArgumentException - указан неверный идентификатор устройства (например, такого устройства уже нет среди доступных)
  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.27.

Пример:

ЗадатьДинамик / SetSpeaker

Задаёт текущее устройства аудиовывода (динамик), которое будет использоваться софтфоном.

Список доступных идентификаторов устройств аудиовывода можно извлечь при помощи вызова метода ПолучитьСписокДинамиков.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры:

  • deviceId - уникальный идентификатор устройства аудиовывода

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.InvalidArgumentException - указан неверный идентификатор устройства (например, такого устройства уже нет среди доступных)
  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.27.

Пример:

ПроверитьУсилениеМикрофона / IsGainControlEnabled

Проверяет, включено ли автоматическое регулирование усиления микрофона (Automatic gain control).
По умолчанию включено.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: true или false

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ВключитьУсилениеМикрофона / EnableGainControl

Включить или отключить усиление микрофона.
По умолчанию включено.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • enabled - строковое представление true или false. true, если необходимо включить усиление. Иначе false.

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.InvalidArgumentException - было передано неверное значение параметра enabled (должно быть true или false)
  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьУровеньУсиленияМикрофона / SetGainControlLevel

Задать уровень усиления микрофона.

По умолчанию равно 30 децибел.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • decibel - Число децибел, определяющее уровень усиления. По умолчанию 30.

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьУровеньУсиленияМикрофона / GetGainControlLevel

Получить текущее значение уровня усиления микрофона (в децибелах).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: число децибел

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПроверитьЭхоПодавление / IsEchoCancellationEnabled

Проверяет, включено ли эхоподавление (Echo cancellation).
По умолчанию включено.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: true или false

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ВключитьЭхоПодавление / EnableEchoCancellation

Включить или отключить эхоподавление.
По умолчанию включено.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • enabled - строковое представление true или false. true, если необходимо включить эхоподавление. Иначе false.

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.InvalidArgumentException - было передано неверное значение параметра enabled (должно быть true или false)
  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьЗадержкуЭхоПодавления / GetEchoDelay

Получить текущее значение задержки эхоподавления (в миллисекундах).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: Задержка эхоподавления в миллисекундах

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьЗадержкуЭхоПодавления / SetEchoDelay

Задать задержку эхоподавления.

По умолчанию равно 250 миллисекунд.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • delay - Число децибел, определяющее уровень усиления. По умолчанию 250.

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьУровеньШумоподавления / GetNoiseReductionLevel

Доступные значения: 0 (no reduction), 1 (low), 2 (medium), 3 (high)

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: 0, 1, 2 или 3

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьУровеньШумоподавления / SetNoiseReductionLevel

Задать уровень шумоподавления.

По умолчанию равен 2 (medium)

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • level - от 0 (no reduction) до 3 (high).

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПроверитьВключенностьМикрофона / IsMutedMicrophone

Проверяет, включен ли микрофон.
По умолчанию включен.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: true или false

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПроверитьВключенностьДинамика / IsMutedSpeaker

Проверяет, включены ли динамики (или наушники).
По умолчанию включены.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: true или false

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ОтключитьМикрофон / MuteMicrophone

Выключить микрофон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ВключитьМикрофон / UnMuteMicrophone

Включить микрофон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ОтключитьДинамик / MuteSpeaker

Отключить динамик.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ВключитьДинамик / UnMuteSpeaker

Включить динамик.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьУровеньГромкостиМикрофона / GetMicrophoneVolume

Получить текущее значение громкости микрофона (0-100).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: значение от 0 до 100

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьУровеньГромкостиМикрофона / SetMicrophoneVolume

Задать значение громкости микрофона (0-100).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • level - значение громкости микрофона (0-100).

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьУровеньГромкостиДинамика / GetSpeakerVolume

Получить текущее значение громкости динамика (0-100).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: значение от 0 до 100

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьУровеньГромкостиДинамика / SetSpeakerVolume

Задать значение громкости динамиков (0-100).

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • level - значение громкости динамиков (0-100).

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьДинамикРингтона / GetRingtoneSpeaker

Возвращает текущее устройство вывода аудио (динамик) для воспроизведения рингтона.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение:

текущее устройство вывода аудио (динамик) для воспроизведения рингтона

Исключения: нет

Доступность:

Доступен с 1.29.

Пример:

ЗадатьДинамикРингтона / SetRingtoneSpeaker

Задать устройство аудио вывода (динамик) для воспроизведения рингтона.

Список доступных идентификаторов устройств аудиовывода можно извлечь при помощи вызова метода ПолучитьСписокДинамиков.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры:

  • deviceId - уникальный идентификатор устройства аудиовывода

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.InvalidArgumentException - указан неверный идентификатор устройства (например, такого устройства уже нет среди доступных)
  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ОтключитьДинамикРингтона / MuteRingtoneSpeaker

Отключить динамик, проигрывающий рингтон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ВключитьДинамикРингтона / UnMuteRingtoneSpeaker

Включить динамик, проигрывающий рингтон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ПолучитьУровеньГромкостиДинамикаРингтона / GetRingtoneSpeakerVolume

Получить текущее значение громкости динамика (0-100), проигрывающего рингтон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: нет

Возвращаемое значение: значение от 0 до 100

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьУровеньГромкостиДинамикаРингтона / SetRingtoneSpeakerVolume

Задать значение громкости динамиков (0-100), проигрывающих рингтон.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • level - значение громкости динамиков (0-100).

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

ЗадатьМузыкуРингтона / SetRingtone

Задать музыку для рингтона. Поддерживается только формат wav.

Метод должен вызываться после того, как был вызван метод ВключитьСофтфон.

Синтаксис:

Параметры: 

  • path - абсолютный путь к файлу рингтона в формате wav.

Возвращаемое значение: нет

Исключения: 

  • com.orangeuce.pbx.api.exception.IllegalStateException - не был проинициализирован софтфон (не был вызван метод ВключитьСофтфон)

Доступность:

Доступен с 1.29.

Пример:

События

Softphone.SpeakerVolume

Изменился уровень громкости динамика или устройства воспроизведения рингтона.

Данное уведомление следует обрабатывать для отображения актуальной информации о состоянии включенности и текущего уровня громкости динамика.

Сообщение:

Доступность: 

Доступно с 1.29.

Softphone.MicrophoneVolume

Изменился уровень громкости микрофона.

Данное уведомление следует обрабатывать для отображения актуальной информации о состоянии включенности и текущего уровня громкости микрофона.

Сообщение:

Доступность: 

Доступно с 1.29.

  • No labels