# plugins.core.touchbar.virtual
Virtual Touch Bar Manager
---
## API Overview
**Constants** - _Useful values which cannot be changed_
* [LOCATION_DEFAULT_VALUE](#location_default_value)
* [LOCATION_DRAGGABLE](#location_draggable)
* [LOCATION_MOUSE](#location_mouse)
**Variables** - _Configurable values_
* [updateLocationCallback](#updatelocationcallback)
**Functions** - _API calls offered directly by the extension_
* [callback](#callback)
* [hide](#hide)
* [init](#init)
* [show](#show)
* [start](#start)
* [stop](#stop)
* [touchbar](#touchbar)
* [update](#update)
**Fields** - _Variables which can only be accessed from an object returned by a constructor_
* [enabled](#enabled)
* [isActive](#isactive)
* [lastLocation](#lastlocation)
* [macOSVersionSupported](#macosversionsupported)
* [supported](#supported)
---
## API Documentation
#### Constants
### [LOCATION_DEFAULT_VALUE](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L33) |
---
### [LOCATION_DRAGGABLE](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L23) |
---
### [LOCATION_MOUSE](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L28) |
---
#### Variables
### [updateLocationCallback](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L48) |
---
#### Functions
### [callback](#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** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 280](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L280) |
---
### [hide](#hide)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.hide() -> none` |
| **Type** | Function |
| **Description** | Hide the Virtual Touch Bar |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 265](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L265) |
---
### [init](#init)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.init() -> self` |
| **Type** | Function |
| **Description** | Initialise the module. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 319](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L319) |
---
### [show](#show)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.show() -> none` |
| **Type** | Function |
| **Description** | Show the Virtual Touch Bar |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 245](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L245) |
---
### [start](#start)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.start() -> none` |
| **Type** | Function |
| **Description** | Initialises the Virtual Touch Bar |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 118](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L118) |
---
### [stop](#stop)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.stop() -> none` |
| **Type** | Function |
| **Description** | Stops the Virtual Touch Bar |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 181](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L181) |
---
### [touchbar](#touchbar)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.touchbar() -> none` |
| **Type** | Function |
| **Description** | Returns the `hs._asm.undocumented.touchbar` object if it exists. |
| **Parameters** | |
| **Returns** | - `hs._asm.undocumented.touchbar`
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 69](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L69) |
---
### [update](#update)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.update() -> none` |
| **Type** | Function |
| **Description** | Updates the visibility and location of the Virtual Touch Bar |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 305](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L305) |
---
#### Fields
### [enabled](#enabled)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.enabled ` |
| **Type** | Field |
| **Description** | Is `true` if the plugin is enabled. |
| **Notes** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 91](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L91) |
---
### [isActive](#isactive)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.isActive ` |
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L107) |
---
### [lastLocation](#lastlocation)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.lastLocation ` |
| **Type** | Field |
| **Description** | The last known Virtual Touch Bar Location |
| **Notes** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 38](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L38) |
---
### [macOSVersionSupported](#macosversionsupported)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.macOSVersionSupported ` |
| **Type** | Field |
| **Description** | Does the macOS version support the Touch Bar? |
| **Notes** | None |
| **Source** | [src/plugins/core/touchbar/virtual/init.lua line 53](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L53) |
---
### [supported](#supported)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.touchbar.virtual.supported ` |
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/touchbar/virtual/init.lua#L61) |
---
---