companion-module-requests icon indicating copy to clipboard operation
companion-module-requests copied to clipboard

Blackmagic Camera Control REST Api

Open Julusian opened this issue 5 months ago • 8 comments

The name of the device, hardware, or software you would like to control:

Blackmagic design camera REST api

Perhaps related to #719 and https://github.com/bitfocus/companion-module-bmd-atem/issues/94

What you would like to be able to make it do from Companion:

For someone who intends to use this to define

Direct links or attachments to the ethernet control protocol or API:

There is a text description of it in the manual for the cameras, for example: https://documents.blackmagicdesign.com/UserManuals/BlackmagicMicroStudioCamera4KG2Manual.pdf?_v=1701331211000

The cameras also serve an openapi definition, which could be used to auto-generate a basic client library. A copy of this from firmware 8.4 (provided by a Micro Studio Camera G2) is bm-msc-g2-8.4.zip. When implementing, make sure to work from an updated copy as there could be changes.
It looks like the this schema defines all the functionality possible in the api, various methods fail on my camera as they are not supported on this model.

Julusian avatar Jan 30 '24 10:01 Julusian