Spec-Zone.ru › Hammerspoon

hs.camera

Просмотр устройств камеры системы

Обзор API

  • Функции — вызовы API, предоставляемые непосредственно расширением
    • allCameras
    • isWatcherRunning
    • setWatcherCallback
    • startWatcher
    • stopWatcher
  • Методы — вызовы API, которые могут быть выполнены только с объектом, возвращаемым конструктором
    • connectionID
    • isInUse
    • isPropertyWatcherRunning
    • name
    • setPropertyWatcherCallback
    • startPropertyWatcher
    • stopPropertyWatcher
    • uid

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

Функции

allCameras
Подпись hs.camera.allCameras() -> table
Тип Функция
Описание

Получить все известные системе камеры

Параметры
  • Нет
Возвращает
  • Таблица, содержащая все известные камеры
Источник extensions/camera/libcamera.m строка 329
isWatcherRunning
Подпись hs.camera.isWatcherRunning() -> Boolean
Тип Функция
Описание

Проверка, запущен ли наблюдатель за устройствами камер

Параметры
  • Нет
Возвращает
  • Булево значение, True, если наблюдатель запущен, иначе False
Источник extensions/camera/libcamera.m строка 468
setWatcherCallback
Подпись hs.camera.setWatcherCallback(fn)
Тип Функция
Описание

Устанавливает/очищает функцию обратного вызова для наблюдателя за устройствами камер

Параметры
  • fn — функция обратного вызова или nil для удаления ранее установленного обратного вызова. Обратный вызов должен принимать два аргумента (см. Примечания ниже)
Возвращает
  • Нет
Примечания
  • Обратный вызов будет вызываться при добавлении или удалении камеры из системы
  • Для отслеживания изменений в одном устройстве камеры, см. hs.camera:newWatcher()
  • Аргументы функции обратного вызова:
  • Объект hs.camera устройства, затронутого устройством
  • Строка, либо "Added", либо "Removed", в зависимости от того, было ли устройство добавлено или удалено из системы
  • Для событий "Removed" большинство методов объекта hs.camera устройства больше не будут работать корректно, и объект устройства, переданный в обратный вызов, скорее всего, будет бесполезным. Рекомендуется повторно проверить hs.camera.allCameras() и сохранять записи о камерах, которые вас интересуют
  • Передача nil заставит наблюдатель остановиться, если он запущен
Источник extensions/camera/libcamera.m строка 486
startWatcher
Подпись hs.camera.startWatcher()
Тип Функция
Описание

Запускает наблюдатель за устройствами камер

Параметры
  • Нет
Возвращает
  • Нет
Источник extensions/camera/libcamera.m строка 378
stopWatcher
Подпись hs.camera.stopWatcher()
Тип Функция
Описание

Останавливает наблюдатель за устройствами камер

Параметры
  • Нет
Возвращает
  • Нет
Источник extensions/camera/libcamera.m строка 435

Методы

connectionID
Подпись hs.camera:connectionID() -> String
Тип Метод
Описание

Получить исходный идентификатор подключения камеры

Параметры
  • Нет
Возвращает
  • Число, содержащее идентификатор подключения камеры
Источник extensions/camera/libcamera.m строка 554
isInUse
Подпись hs.camera:isInUse() -> Boolean
Тип Метод
Описание

Получить статус использования камеры

Параметры
  • Нет
Возвращает
  • Булево значение, True, если камера используется, иначе False
Источник extensions/camera/libcamera.m строка 590
isPropertyWatcherRunning
Подпись hs.camera:isPropertyWatcherRunning() -> bool
Тип Метод
Описание

Проверка, запущен ли наблюдатель свойств объекта камеры

Параметры
  • Нет
Возвращает
  • Булево значение, True, если наблюдатель свойств запущен, иначе False
Источник extensions/camera/libcamera.m строка 691
name
Подпись hs.camera:name() -> String
Тип Метод
Описание

Получить имя камеры

Параметры
  • Нет
Возвращает
  • Строка, содержащая имя камеры
Источник extensions/camera/libcamera.m строка 572
setPropertyWatcherCallback
Подпись hs.camera:setPropertyWatcherCallback(fn) -> hs.camera object
Тип Метод
Описание

Устанавливает или очищает обратный вызов, когда свойства объекта hs.camera изменяются

Параметры
  • fn — функция, вызываемая, когда свойства камеры изменяются, или nil для очистки ранее установленного обратного вызова. Функция должна принимать следующие параметры:
    • Объект hs.camera, который изменился
    • Строка, описывающая измененное свойство. Возможные значения:
    • gone — статус "используется" устройства изменился (то есть другая программа начала использовать камеру или перестала использовать ее)
    • Строка, содержащая область события, это, вероятно, всегда "glob"
    • Число, содержащее элемент события, это, вероятно, всегда "0"
Возвращает
  • Объект hs.camera
Источник extensions/camera/libcamera.m строка 608
startPropertyWatcher
Подпись hs.camera:startPropertyWatcher()
Тип Метод
Описание

Запускает наблюдатель свойств для камеры

Параметры
  • Нет
Возвращает
  • Объект hs.camera
Источник extensions/camera/libcamera.m строка 644
stopPropertyWatcher
Подпись hs.camera:stopPropertyWatcher()
Тип Метод
Описание

Останавливает наблюдатель свойств для камеры

Параметры
  • Нет
Возвращает
  • Объект hs.camera
Источник extensions/camera/libcamera.m строка 671
uid
Подпись hs.camera:uid() -> String
Тип Метод
Описание

Получить UID камеры

Параметры
  • Нет
Возвращает
  • Строка, содержащая UID камеры
Примечания
  • UID не гарантируется, что он будет стабильным после перезагрузки
Источник extensions/camera/libcamera.m строка 533

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API