plugins.core.touchbar.virtual

Virtual Touch Bar Manager

API Overview

Constants - Useful values which cannot be changed

  • LOCATION_DEFAULT_VALUE
  • LOCATION_DRAGGABLE
  • LOCATION_MOUSE

Variables - Configurable values

  • updateLocationCallback

Functions - API calls offered directly by the extension

  • callback
  • hide
  • init
  • show
  • start
  • stop
  • touchbar
  • update

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

  • enabled
  • isActive
  • lastLocation
  • macOSVersionSupported
  • supported

API Documentation

Constants

LOCATION_DEFAULT_VALUE

   
Signature plugins.core.touchbar.virtual.LOCATION_DEFAULT_VALUE -> string
Type Constant
Description Default location value.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 33

LOCATION_DRAGGABLE

   
Signature plugins.core.touchbar.virtual.LOCATION_DRAGGABLE -> string
Type Constant
Description Location is Draggable.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 23

LOCATION_MOUSE

   
Signature plugins.core.touchbar.virtual.LOCATION_MOUSE -> string
Type Constant
Description Location is Mouse.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 28

Variables

updateLocationCallback

   
Signature plugins.core.touchbar.virtual.updateLocationCallback -> table
Type Variable
Description Update Location Callback
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 48

Functions

callback

   
Signature plugins.core.touchbar.virtual.callback(_, message) -> none
Type Function
Description Callback Function for the Virtual Touch Bar
Parameters
  • obj - the touchbarObject the callback is for
  • message - the message to the callback, either "didEnter" or "didExit"
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 280

hide

   
Signature plugins.core.touchbar.virtual.hide() -> none
Type Function
Description Hide the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 265

init

   
Signature plugins.core.touchbar.virtual.init() -> self
Type Function
Description Initialise the module.
Parameters
  • None
Returns
  • Self
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 319

show

   
Signature plugins.core.touchbar.virtual.show() -> none
Type Function
Description Show the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 245

start

   
Signature plugins.core.touchbar.virtual.start() -> none
Type Function
Description Initialises the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 118

stop

   
Signature plugins.core.touchbar.virtual.stop() -> none
Type Function
Description Stops the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 181

touchbar

   
Signature plugins.core.touchbar.virtual.touchbar() -> none
Type Function
Description Returns the hs._asm.undocumented.touchbar object if it exists.
Parameters
  • None
Returns
  • hs._asm.undocumented.touchbar
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 69

update

   
Signature plugins.core.touchbar.virtual.update() -> none
Type Function
Description Updates the visibility and location of the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 305

Fields

enabled

   
Signature plugins.core.touchbar.virtual.enabled <cp.prop: boolean>
Type Field
Description Is true if the plugin is enabled.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 91

isActive

   
Signature plugins.core.touchbar.virtual.isActive <cp.prop: boolean; read-only>
Type Field
Description Is true if the plugin is enabled and the TouchBar is supported on this OS.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 107

lastLocation

   
Signature plugins.core.touchbar.virtual.lastLocation <cp.prop: point table>
Type Field
Description The last known Virtual Touch Bar Location
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 38

macOSVersionSupported

   
Signature plugins.core.touchbar.virtual.macOSVersionSupported <cp.prop: boolean>
Type Field
Description Does the macOS version support the Touch Bar?
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 53

supported

   
Signature plugins.core.touchbar.virtual.supported <cp.prop: boolean; read-only>
Type Field
Description Is true if the Touch Bar is supported on this version of macOS.
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 61

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