# plugins.core.controlsurfaces.resolve.manager

Blackmagic DaVinci Resolve Control Surface Support.

# API Overview

Constants - Useful values which cannot be changed

  • DEFAULT_JOG_MODE
  • DEFAULT_SENSITIVITY
  • LONG_PRESS_DURATION

Variables - Configurable values

  • defaultLayout
  • repeatTimers

Functions - API calls offered directly by the extension

  • batteryStatus
  • buttonCallback
  • discoveryCallback
  • start
  • update

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

  • activeBanks
  • automaticallySwitchApplications
  • enabled
  • items
  • lastApplication
  • lastBundleID

# API Documentation

# Constants

# DEFAULT_JOG_MODE

Signature plugins.core.controlsurfaces.resolve.manager.DEFAULT_JOG_MODE -> string
Type Constant
Description The default Jog Wheel Mode.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 101

# DEFAULT_SENSITIVITY

Signature plugins.core.controlsurfaces.resolve.manager.DEFAULT_SENSITIVITY -> number
Type Constant
Description The default sensitivity used for Blackmagic Resolve Control Surfaces.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 96

# LONG_PRESS_DURATION

Signature plugins.core.controlsurfaces.resolve.manager.LONG_PRESS_DURATION -> number
Type Constant
Description How long a button needs to be pressed before it's considered a long press (in seconds).
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 91

# Variables

# defaultLayout

Signature plugins.core.controlsurfaces.resolve.manager.defaultLayout -> table
Type Variable
Description Default Layout
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 146

# repeatTimers

Signature plugins.core.controlsurfaces.resolve.manager.repeatTimers -> table
Type Variable
Description A table containing hs.timer objects.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 116

# Functions

# batteryStatus

Signature plugins.core.controlsurfaces.resolve.manager.batteryStatus(deviceType, deviceID) -> none
Type Function
Description Gets the Battery Status for a specific device
Parameters
  • deviceType - A string, either "Speed Editor" or "Editor Keyboard"
  • deviceID - A string with the device ID
Returns
  • charging - A boolean
  • level - The battery level as a number
Notes None
Examples None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 247

# buttonCallback

Signature plugins.core.controlsurfaces.resolve.manager.buttonCallback(object, buttonID, pressed) -> none
Type Function
Description Control Surface Button Callback
Parameters
  • object - The hs.resolve userdata object
  • buttonID - A number containing the button that was pressed/released
  • pressed - A boolean indicating whether the button was pressed (true) or released (false)
Returns
  • None
Notes None
Examples None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 318

# discoveryCallback

Signature plugins.core.controlsurfaces.resolve.manager.discoveryCallback(connected, object) -> none
Type Function
Description Control Surface Discovery Callback
Parameters
  • connected - A boolean, true if a device was connected, false if a device was disconnected
  • object - An hs.speededitor object, being the device that was connected/disconnected
Returns
  • None
Notes None
Examples None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 962

# start

Signature plugins.core.controlsurfaces.resolve.manager.start() -> boolean
Type Function
Description Stops DaVinci Resolve Control Surface Support.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 1085

# update

Signature plugins.core.controlsurfaces.resolve.manager.update() -> none
Type Function
Description Updates all the control surface LEDs.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 780

# Fields

# activeBanks

Signature plugins.core.controlsurfaces.resolve.manager.activeBanks <cp.prop: table>
Type Field
Description Table of active banks for each application.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 164

# automaticallySwitchApplications

Signature plugins.core.controlsurfaces.resolve.manager.automaticallySwitchApplications <cp.prop: boolean>
Type Field
Description Enable or disable the automatic switching of applications.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 131

# enabled

Signature plugins.core.controlsurfaces.resolve.manager.enabled <cp.prop: boolean>
Type Field
Description Enable or disable DaVinci Resolve Control Surface support
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 1163

# items

Signature plugins.core.controlsurfaces.resolve.manager.items <cp.prop: table>
Type Field
Description A table containing the control surface layout.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 151

# lastApplication

Signature plugins.core.controlsurfaces.resolve.manager.lastApplication <cp.prop: string>
Type Field
Description Last Bank used in the Preferences Panel.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 111

# lastBundleID

Signature plugins.core.controlsurfaces.resolve.manager.lastBundleID <cp.prop: string>
Type Field
Description The last Bundle ID.
Notes None
Source src/plugins/core/controlsurfaces/resolve/manager/init.lua line 136

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