# 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

  • NUMBER_OF_DEVICES

Functions - API calls offered directly by the extension

  • executeAction

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

  • new

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

  • lastApplication
  • lastBank
  • previewSelectedApplicationAndBankOnHardware

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

  • callback
  • clearCache
  • getFlashDrivePath
  • refresh
  • refreshItems
  • reset
  • updateBacklightLevel

# API Documentation

# Constants

# NUMBER_OF_DEVICES

Signature plugins.core.loupedeckctandlive.manager.NUMBER_OF_DEVICES -> number
Type Constant
Description The number of devices of the same type supported.
Notes None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 69

# Functions

# executeAction

Signature plugins.core.loupedeckctandlive.manager:executeAction(thisAction, deviceNumber) -> boolean
Type Function
Description Executes an action.
Parameters
  • thisAction - The action to execute
  • deviceNumber - The device number
Returns
  • true if successful otherwise false
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1748

# Constructors

# new

Signature plugins.core.loupedeckctandlive.manager.new() -> Loupedeck
Type Constructor
Description Creates 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.
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 126

# Fields

# lastApplication

Signature plugins.core.loupedeckctandlive.manager.lastApplication <cp.prop: boolean>
Type Field
Description The last application
Notes None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 59

# lastBank

Signature plugins.core.loupedeckctandlive.manager.lastBank <cp.prop: boolean>
Type Field
Description The last bank
Notes None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 64

# previewSelectedApplicationAndBankOnHardware

Signature plugins.core.loupedeckctandlive.manager.previewSelectedApplicationAndBankOnHardware <cp.prop: boolean>
Type Field
Description Should we preview the selected application and bank on hardware?
Notes None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 54

# Methods

# callback

Signature plugins.core.loupedeckctandlive.manager:callback(data, deviceNumber) -> none
Type Method
Description The Loupedeck callback.
Parameters
  • data - The callback data.
  • deviceNumber - The device number.
Returns
  • None
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1842

# clearCache

Signature plugins.core.loupedeckctandlive.manager:clearCache(deviceNumber) -> none
Type Method
Description Clears the cache.
Parameters
  • deviceNumber - The device number.
Returns
  • None
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1781

# getFlashDrivePath

Signature plugins.core.loupedeckctandlive.manager:getFlashDrivePath() -> string
Type Method
Description Gets the Loupedeck Flash Drive path.
Parameters
  • None
Returns
  • The Loupedeck Flash Drive path as a string
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1028

# refresh

Signature plugins.core.loupedeckctandlive.manager:refresh(dueToAppChange, deviceNumber)
Type Method
Description Refreshes 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
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1152

# refreshItems

Signature plugins.core.loupedeckctandlive.manager:refreshItems() -> self
Type Method
Description Refreshes the items to either either local drive or the Loupedeck Flash Drive.
Parameters
  • None
Returns
  • Self
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1050

# reset

Signature plugins.core.loupedeckctandlive.manager:reset()
Type Method
Description Resets the config back to the default layout.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1139

# updateBacklightLevel

Signature plugins.core.loupedeckctandlive.manager:updateBacklightLevel(deviceNumber, value) -> none
Type Method
Description Update the backlight level for a Loupedeck device.
Parameters
  • deviceNumber - The device number.
  • value - The backlight level
Returns
  • None
Notes None
Examples None
Source src/plugins/core/loupedeckctandlive/manager/init.lua line 1825

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