hs.streamdeck

Настройка/управление Elgato Stream Deck.

Обратите внимание, что для работы этого модуля приложение Elgato Stream Deck не должно быть запущено.

Этот расширение поддерживает следующие устройства:

Stream Deck (Оригинальный)
Stream Deck (Оригинальный V2)
Stream Deck Plus
Stream Deck Mini
Stream Deck Mini (V2)
Stream Deck XL
Stream Deck XL (Mk2)
Stream Deck Pedal

Этот модуль был бы невозможен без поддержки других:

https://github.com/OpenStreamDeck/StreamDeckSharp
https://github.com/Lange/node-elgato-stream-deck
Hopper

Обзор API

Функции - API-вызовы, предлагаемые непосредственно расширением

discoveryCallback
getDevice
init
numDevices

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

buttonCallback
buttonLayout
encoderCallback
firmwareVersion
imageSize
reset
screenCallback
serialNumber
setBrightness
setButtonColor
setButtonImage
setScreenImage

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

Функции

discoveryCallback

Подпись	`hs.streamdeck.discoveryCallback(fn)`
Тип	Функция
Описание	Устанавливает/очищает обратный вызов для реагирования на события обнаружения устройств
Параметры	fn - Функция, которая будет вызвана при подключении или отключении Stream Deck. Она должна принимать следующие аргументы: Логическое значение, true, если устройство было подключено, false, если устройство было отключено Объект hs.streamdeck, представляющий устройство, которое было подключено/отключено
Возвращает	None
Источник	extensions/streamdeck/libstreamdeck.m строка 51

getDevice

Подпись	`hs.streamdeck.getDevice(num)`
Тип	Функция
Описание	Получает объект hs.streamdeck для указанного устройства
Параметры	num - Число, которое должно быть в пределах границ количества подключенных устройств
Возвращает	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 92

init

Подпись	`hs.streamdeck.init(fn)`
Тип	Функция
Описание	Инициализирует драйвер Stream Deck и устанавливает обратный вызов обнаружения
Параметры	fn - Функция, которая будет вызвана при подключении или отключении Stream Deck. Она должна принимать следующие аргументы: Логическое значение, true, если устройство было подключено, false, если устройство было отключено Объект hs.streamdeck, представляющий устройство, которое было подключено/отключено
Возвращает	None
Примечания	Эта функция должна быть вызвана перед использованием других частей этого модуля
Источник	extensions/streamdeck/libstreamdeck.m строка 25

numDevices

Подпись	`hs.streamdeck.numDevices()`
Тип	Функция
Описание	Получает количество подключенных устройств Stream Deck
Параметры	None
Возвращает	Число, содержащее количество устройств Stream Deck, подключенных к системе
Источник	extensions/streamdeck/libstreamdeck.m строка 75

Методы

buttonCallback

Подпись	`hs.streamdeck:buttonCallback(fn)`
Тип	Метод
Описание	Устанавливает/очищает функцию обратного вызова для кнопки устройства Stream Deck
Параметры	fn - Функция, которая вызывается при нажатии/отпускании кнопки на Stream Deck. Она должна принимать три аргумента: Объект hs.streamdeck userdata Число, представляющее нажатую/отпущенную кнопку Булево значение, указывающее на нажатие (true) или отпускание (false) кнопки
Возвращаемое значение	Устройство hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 109

buttonLayout

Подпись	`hs.streamdeck:buttonLayout()`
Тип	Метод
Описание	Получает макет кнопок устройства Stream Deck
Параметры	Нет
Возвращаемое значение	Количество столбцов Количество строк
Источник	extensions/streamdeck/libstreamdeck.m строка 274

encoderCallback

Подпись	`hs.streamdeck:encoderCallback(fn)`
Тип	Метод
Описание	Устанавливает/очищает функцию обратного вызова для регулятора/кодировщика Stream Deck Plus.
Параметры	fn - Функция, вызываемая при нажатии/отпускании/вращении регулятора Stream Deck Plus. Она должна принимать пять аргументов: Объект hs.streamdeck userdata Число, представляющее нажатую/отпущенную/повернутую кнопку Булево значение, указывающее на нажатие (true) или отпускание (false) кнопки Булево значение, указывающее на поворот влево Булево значение, указывающее на поворот вправо
Возвращаемое значение	Устройство hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 136

firmwareVersion

Подпись	`hs.streamdeck:firmwareVersion()`
Тип	Метод
Описание	Получает версию прошивки устройства Stream Deck
Параметры	Нет
Возвращаемое значение	Строка, содержащая версию прошивки устройства
Источник	extensions/streamdeck/libstreamdeck.m строка 255

imageSize

Подпись	`hs.streamdeck:imageSize()`
Тип	Метод
Описание	Получает ширину и высоту кнопок в пикселях
Параметры	Нет
Возвращаемое значение	Таблица с ключами `w` и `h` содержащими ширину и высоту, соответственно, изображений, ожидаемых Stream Deck
Источник	extensions/streamdeck/libstreamdeck.m строка 295

reset

Подпись	`hs.streamdeck:reset()`
Тип	Метод
Описание	Сбрасывает устройство Stream Deck
Параметры	Нет
Возвращаемое значение	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 216

screenCallback

Подпись	`hs.streamdeck:screenCallback(fn)`
Тип	Метод
Описание	Устанавливает/очищает функцию обратного вызова для сенсорного экрана Stream Deck Plus (над регуляторами).
Параметры	fn - Функция, вызываемая при нажатии/отпускании/проведении по экрану Stream Deck Plus. Она должна принимать шесть аргументов: Объект hs.streamdeck userdata Строка, содержащая "shortPress", "longPress" или "swipe" Координата X первого касания экрана Координата Y первого касания экрана Координата X последнего касания экрана (при проведении) Координата Y последнего касания экрана (при проведении)
Возвращаемое значение	Устройство hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 165

serialNumber

Подпись	`hs.streamdeck:serialNumber()`
Тип	Метод
Описание	Получает серийный номер устройства Stream Deck
Параметры	Нет
Возвращаемое значение	Строка, содержащая серийный номер устройства
Источник	extensions/streamdeck/libstreamdeck.m строка 236

setBrightness

Подпись	`hs.streamdeck:setBrightness(brightness)`
Тип	Метод
Описание	Устанавливает яркость устройства Stream Deck
Параметры	brightness - Целое число от 0 до 100, обозначающее процентную яркость
Возвращаемое значение	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 195

setButtonColor

Подпись	`hs.streamdeck:setButtonColor(button, color)`
Тип	Метод
Описание	Устанавливает цвет кнопки на устройстве Stream Deck
Параметры	button - Число (от 1 до 15), определяющее кнопку, цвет которой необходимо установить color - Объект hs.drawing.color
Возвращаемое значение	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 359

setButtonImage

Подпись	`hs.streamdeck:setButtonImage(button, image)`
Тип	Метод
Описание	Устанавливает изображение на кнопке устройства Stream Deck
Параметры	button - Число (от 1 до 15), определяющее кнопку, для которой необходимо установить изображение image - Объект hs.image
Возвращаемое значение	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 315

setScreenImage

Подпись	`hs.streamdeck:setScreenImage(encoder, image)`
Тип	Метод
Описание	Устанавливает изображение на экране устройства Stream Deck
Параметры	encoder - Число (от 1 до 4), определяющее кодер, для которого необходимо установить изображение image - Объект hs.image
Возвращаемое значение	Объект hs.streamdeck
Источник	extensions/streamdeck/libstreamdeck.m строка 337

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

спецификации, руководства, описания, API

free hit counter