#plugins.core.loupedeckctandlive.manager

Manager Plugin for Loupedeck CT, Loupedeck Live, Loupedeck Live-S and Razer Stream Controller.

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

Fields - Variables which can only be accessed from an object returned by a constructor

Methods - API calls which can only be made on an object returned by a constructor

#API Documentation

#Constants

Signatureplugins.core.loupedeckctandlive.manager.NUMBER_OF_DEVICES -> number
TypeConstant
DescriptionThe number of devices of the same type supported.
NotesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 69

#Functions

Signatureplugins.core.loupedeckctandlive.manager:executeAction(thisAction, deviceNumber) -> boolean
TypeFunction
DescriptionExecutes an action.
Parameters
  • thisAction - The action to execute
  • deviceNumber - The device number
Returns
  • true if successful otherwise false
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1748

#Constructors

Signatureplugins.core.loupedeckctandlive.manager.new() -> Loupedeck
TypeConstructor
DescriptionCreates a new Loupedeck object.
Parameters
  • deviceType - The device type defined in hs.loupedeck.deviceTypes
Returns
  • None
Notes
  • The deviceType should be either hs.loupedeck.deviceTypes.LIVE
  • or hs.loupedeck.deviceTypes.CT.
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 126

#Fields

Signatureplugins.core.loupedeckctandlive.manager.lastApplication <cp.prop: boolean>
TypeField
DescriptionThe last application
NotesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 59
Signatureplugins.core.loupedeckctandlive.manager.lastBank <cp.prop: boolean>
TypeField
DescriptionThe last bank
NotesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 64
Signatureplugins.core.loupedeckctandlive.manager.previewSelectedApplicationAndBankOnHardware <cp.prop: boolean>
TypeField
DescriptionShould we preview the selected application and bank on hardware?
NotesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 54

#Methods

Signatureplugins.core.loupedeckctandlive.manager:callback(data, deviceNumber) -> none
TypeMethod
DescriptionThe Loupedeck callback.
Parameters
  • data - The callback data.
  • deviceNumber - The device number.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1842
Signatureplugins.core.loupedeckctandlive.manager:clearCache(deviceNumber) -> none
TypeMethod
DescriptionClears the cache.
Parameters
  • deviceNumber - The device number.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1781
Signatureplugins.core.loupedeckctandlive.manager:getFlashDrivePath() -> string
TypeMethod
DescriptionGets the Loupedeck Flash Drive path.
Parameters
  • None
Returns
  • The Loupedeck Flash Drive path as a string
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1028
Signatureplugins.core.loupedeckctandlive.manager:refresh(dueToAppChange, deviceNumber)
TypeMethod
DescriptionRefreshes the Loupedeck screens and LED buttons.
Parameters
  • dueToAppChange - A optional boolean to specify whether the refresh is due to an application focus change.
  • deviceNumber - The device number.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1152
Signatureplugins.core.loupedeckctandlive.manager:refreshItems() -> self
TypeMethod
DescriptionRefreshes the items to either either local drive or the Loupedeck Flash Drive.
Parameters
  • None
Returns
  • Self
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1050
Signatureplugins.core.loupedeckctandlive.manager:reset()
TypeMethod
DescriptionResets the config back to the default layout.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1139
Signatureplugins.core.loupedeckctandlive.manager:updateBacklightLevel(deviceNumber, value) -> none
TypeMethod
DescriptionUpdate the backlight level for a Loupedeck device.
Parameters
  • deviceNumber - The device number.
  • value - The backlight level
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/loupedeckctandlive/manager/init.lua line 1825

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.