docs » hs.camera

Get all the cameras known to the system

• None

• A table containing all of the known cameras

Checks if the camera devices watcher is running

• None

• A boolean, True if the watcher is running, otherwise False

Sets/clears the callback function for the camera devices watcher

• fn - A callback function, or nil to remove a previously set callback. The callback should accept a two arguments (see Notes below)

• None

• The callback will be called when a camera is added or removed from the system
• To watch for changes within a single camera device, see hs.camera:newWatcher()
• The callback function arguments are:
• An hs.camera device object for the affected device
• A string, either "Added" or "Removed" depending on whether the device was added or removed from the system
• For "Removed" events, most methods on the hs.camera device object will not function correctly anymore and the device object passed to the callback is likely to be useless. It is recommended you re-check hs.camera.allCameras() and keep records of the cameras you care about
• Passing nil will cause the watcher to stop if it is running

Starts the camera devices watcher

• None

• None

Stops the camera devices watcher

• None

• None

Get the raw connection ID of the camera

• None

• A number containing the connection ID of the camera

Get the usage status of the camera

• None

• A boolean, True if the camera is in use, otherwise False

Checks if the property watcher on a camera object is running

• None

• A boolean, True if the property watcher is running, otherwise False

Get the name of the camera

• None

• A string containing the name of the camera

Sets or clears a callback for when the properties of an hs.camera object change

• fn - A function to be called when properties of the camera change, or nil to clear a previously set callback. The function should accept the following parameters:
  • The hs.camera object that changed
  • A string describing the property that changed. Possible values are:
  • gone - The device's "in use" status changed (ie another app started using the camera, or stopped using it)
  • A string containing the scope of the event, this will likely always be "glob"
  • A number containing the element of the event, this will likely always be "0"

• The hs.camera object

Starts the property watcher on a camera

• None

• The hs.camera object

Stops the property watcher on a camera

• None

• The hs.camera object

Get the UID of the camera

• None

• A string containing the UID of the camera

• The UID is not guaranteed to be stable across reboots