Optional
bridgeOptional
lastStatic
CategoriesPlease use the Categories const enum above.
Add the given service instance to the Accessory.
Returns the service instance passed to the method call.
Adds a given service by calling the provided Service constructor with the provided constructor arguments.
Returns the constructed service instance.
Rest
...constructorArgs: ConstructorArgs<S>The arguments passed to the given constructor.
Method is used to configure an old style CameraSource. The CameraSource API was fully replaced by the new Controller API used by CameraController. The CameraStreamingDelegate used by the CameraController is the equivalent to the old CameraSource.
The new Controller API is much more refined and robust way of "grouping" services together. It especially is intended to fully support serialization/deserialization to/from persistent storage. This feature is also gained when using the old style CameraSource API. The CameraStreamingDelegate improves on the overall camera API though and provides some reworked type definitions and a refined callback interface to better signal errors to the requesting HomeKit device. It is advised to update to it.
Full backwards compatibility is currently maintained. A legacy CameraSource will be wrapped into an Adapter. All legacy StreamControllers in the "streamControllers" property will be replaced by CameraRTPManagement instances. Any services in the "services" property which are one of the following are ignored: - CameraRTPStreamManagement - CameraOperatingMode - CameraEventRecordingManagement
please refer to the new CameraController API and configureController
The instance of the legacy camera source
This method is used to set up a new Controller for this accessory. See Controller for a more detailed explanation what a Controller is and what it is capable of.
The controller can be passed as an instance of the class or as a constructor (without any necessary parameters) for a new Controller. Only one Controller of a given ControllerIdentifier can be configured for a given Accessory.
When called, it will be checked if there are any services and persistent data the Controller (for the given ControllerIdentifier) can be restored from. Otherwise, the Controller will be created with new services.
The Controller instance or constructor to the Controller with no required arguments.
Publishes this Accessory on the local network for iOS clients to communicate with.
Required info for publishing.
Optional
allowInsecureRequest: booleanWill allow unencrypted and unauthenticated access to the http server
This method will remove a given Controller from this accessory. The controller object will be restored to its initial state. This also means that any event handlers setup for the controller will be removed.
The controller which should be removed from the accessory.
use setPrimaryService directly
Static
cleanupStatic
deserializeStatic
serialize
Bridge is a special type of HomeKit Accessory that hosts other Accessories "behind" it. This way you can simply publish() the Bridge (with a single HAPServer on a single port) and all bridged Accessories will be hosted automatically, instead of needed to publish() every single Accessory as a separate server.