hs.speech.listener

Этот модуль предоставляет доступ к компоненту распознавания речи OS X.

Функции и методы распознавания речи предоставляют способ добавления команд, которые могут быть отданы Hammerspoon с помощью произнесенных слов и фраз для запуска обратного вызова.

Обзор API

Конструкторы - вызовы API, которые возвращают объект, обычно тот, который предлагает методы API

Методы - вызовы API, которые могут быть выполнены только на объекте, возвращаемом конструктором

blocksOtherRecognizers
commands
delete
foregroundOnly
isListening
setCallback
start
stop
title

Документация API

Конструкторы

new

Подпись	`hs.speech.listener.new([title]) -> recognizerObject`
Тип	Конструктор
Описание	Создает новый объект распознавания речи для использования Hammerspoon.
Параметры	title - необязательный параметр, определяющий заголовок, под которым команды, назначенные этому распознавателю речи, будут перечислены в отображении команд диктовки при его видимости. По умолчанию "Hammerspoon".
Возвращаемое значение	объект распознавания речи или nil, если система не смогла создать новый распознавателя.
Примечания	Вы можете изменить заголовок позже с помощью метода `hs.speech.listener:title`.
Источник	extensions/speech/libspeech_listener.m строка 62

Методы

blocksOtherRecognizers

Подпись	`hs.speech.listener:blocksOtherRecognizers([flag]) -> recognizerObject \| current value`
Тип	Метод
Описание	Получение или установка значения того, должен ли распознаватель речи блокировать другие распознаватели, когда он активен.
Параметры	flag - необязательный булевый параметр, указывающий, следует ли распознавателю речи блокировать другие распознаватели речи при его активности. По умолчанию false.
Возвращаемое значение	Если параметр не указан, возвращает текущее значение; в противном случае возвращает объект распознавателя.
Источник	extensions/speech/libspeech_listener.m строка 187

commands

Подпись	`hs.speech.listener:commands([commandsArray]) -> recognizerObject \| current value`
Тип	Метод
Описание	Получение или установка команд, за которыми будет следить этот распознаватель речи.
Параметры	commandsArray - необязательный массив строк, которые определяют команды, за которыми будет следить распознаватель.
Возвращаемое значение	Если параметр не указан, возвращает текущее значение; в противном случае возвращает объект распознавателя.
Примечания	Список команд появится в окне команд диктовки, если оно видимое, под заголовком этого распознавателя речи. Текст каждой команды — это возможное значение, которое может быть передано в качестве второго аргумента функции обратного вызова для этого распознавателя речи, если она определена. Установка этого значения в пустой список не отключает распознаватель речи, но делает его ограниченно полезным, кроме предоставления заголовка в окне команд диктовки. Для отключения распознавателя используйте методы `hs.speech.listener:stop` или `hs.speech.listener:delete`.
Источник	extensions/speech/libspeech_listener.m строка 97

delete

Подпись	`hs.speech.listener:delete() -> recognizerObject`
Тип	Метод
Описание	Отключает распознаватель речи и удаляет его из возможных доступных распознавателей речи.
Параметры	Нет.
Возвращаемое значение	Нет
Примечания	это отключает распознаватель речи и удаляет его из списка в окне команд диктовки. Объект фактически уничтожается, поэтому вам нужно будет создать новый с помощью `hs.speech.listener.new` , если вы хотите вернуть его. если это был единственный доступный распознаватель речи, окно команд диктовки и отображение отзывов будут удалены с экрана пользователя. Этот метод автоматически вызывается во время перезагрузки или перезапуска Hammerspoon.
Источник	extensions/speech/libspeech_listener.m строка 338

foregroundOnly

Подпись	`hs.speech.listener:foregroundOnly([flag]) -> recognizerObject \| current value`
Тип	Метод
Описание	Получение или установка значения того, активен ли распознаватель речи только когда активное приложение Hammerspoon.
Параметры	flag - необязательный булевый параметр, указывающий, следует ли распознавателю речи реагировать на команды только когда Hammerspoon является активным приложением, или нет. По умолчанию true.
Возвращаемое значение	Если параметр не указан, возвращает текущее значение; в противном случае возвращает объект распознавателя.
Источник	extensions/speech/libspeech_listener.m строка 165

isListening

Подпись	`hs.speech.listener:isListening() -> boolean`
Тип	Метод
Описание	Возвращает булевое значение, указывающее, включен ли распознаватель (запущен).
Параметры	Нет
Возвращаемое значение	true, если слушатель прослушивает (запущен), или false, если нет.
Источник	extensions/speech/libspeech_listener.m строка 250

setCallback

Подпись	`hs.speech.listener:setCallback(fn) -> recognizerObject`
Тип	Метод
Описание	Устанавливает или удаляет функцию обратного вызова для распознавателя речи.
Параметры	fn - функция, которая должна быть установлена как функция обратного вызова для этого синтезатора речи. Если предоставленное значение равно nil, любая существующая функция обратного вызова удаляется. Функция обратного вызова должна принимать два аргумента и не возвращать значение. Аргументами будут сам объект распознавателя речи и строка произнесенной команды.
Возвращаемое значение	объект распознавателя
Примечания	Возможные строковые значения для произнесенной команды устанавливаются методом `hs.speech.listener:commands`. Удаление функции обратного вызова не отключает распознаватель речи, но делает его ограниченно полезным, кроме предоставления списка в окне команд диктовки. Для отключения распознавателя используйте методы `hs.speech.listener:stop` или `hs.speech.listener:delete`.
Источник	extensions/speech/libspeech_listener.m строка 267

start

Подпись	`hs.speech.listener:start() -> recognizerObject`
Тип	Метод
Описание	Активировать распознаватель речи.
Параметры	Нет.
Возвращаемое значение	возвращает объект распознавателя.
Источник	extensions/speech/libspeech_listener.m строка 209

stop

Подпись	`hs.speech.listener:stop() -> recognizerObject`
Тип	Метод
Описание	Отключает распознаватель речи.
Параметры	Нет.
Возвращаемое значение	возвращает объект распознавателя.
Примечания	Это только отключает распознаватель речи. Для полного удаления его из списка в окне команд диктовки используйте `hs.speech.listener:delete`.
Источник	extensions/speech/libspeech_listener.m строка 228

title

Подпись	`hs.speech.listener:title([title]) -> recognizerObject \| current value`
Тип	Метод
Описание	Получение или установка заголовка для распознавателя речи.
Параметры	title - необязательный параметр, определяющий заголовок, под которым команды, назначенные этому распознавателю речи, будут перечислены в отображении команд диктовки при его видимости. Если вы укажете явное значение `nil`, оно будет сброшено до значения по умолчанию "Hammerspoon".
Возвращаемое значение	Если параметр не указан, возвращает текущее значение; в противном случае возвращает объект распознавателя.
Источник	extensions/speech/libspeech_listener.m строка 138

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.speech.listener.html