Bitfocus AS
logo
logo
Bitfocus AS
logo
logo
Sign upSign in

Loading...

Bitfocus

Subscribe to our newsletter

The latest news, articles, and resources, sent to your inbox.

FacebookInstagramGitHubYouTubeLinkedIn

Products

  • Buttons
  • Companion

Integrations

  • Supported Devices
  • Developer Community
  • Connection Development

Support

  • Support Overview
  • Documentation
  • Video Tutorials
  • Community Forum

Sales

  • Resellers & Integrators
  • Buttons Pricing

Updates

  • Case Studies
  • Events & Trade Shows
  • Press Releases
  • Product Updates
  • Webinars

Legal

  • Legal Overview
  • Privacy Policy
  • Buttons EULA
  • Terms & Cookie Policy

Company

  • About us
  • Press kit
  • Careers

© 2026 Bitfocus AS. All rights reserved.

  1. Connections
  2. Blackmagic Design - Blackmagic Cameras API

Blackmagic Design

Blackmagic Cameras API

Communityv1.0.1Updated 6 months agoCameraVideo
DocumentationReport an issueView on GitHub

Documentation

Blackmagic Cameras

This module controls Blackmagic cameras using their built-in REST API and WebSocket notifications. On connect, the module automatically discovers what your camera supports and generates actions, variables, and feedbacks accordingly.

Requirements

  • Enable Web media manager in camera network settings (Blackmagic Camera Setup > Network Access).
  • Set the camera's IP address in the module configuration.

Tested Cameras

  • Blackmagic URSA Cine 12K LF (firmware 9.5.3)

Other compatible cameras (PYXIS 6K, Cinema Camera 6K, Studio Cameras, URSA Broadcast G2, etc.) should work but have not been tested yet. If you encounter issues with a specific model, please report them.

Configuration

SettingDefaultDescription
Camera host or IP127.0.0.1The camera's IP address
Port80Network port
Use HTTPSOffEnable HTTPS transport
Data fetch modeEagerEager: fetches all data on connect. Lazy: only fetches data for variables/feedbacks you're actually using
Unsupported endpoint handlingProbe and hideProbe and hide: checks each endpoint on connect, hides ones the camera doesn't support (501/404). Show all: shows everything, errors displayed when unsupported actions are used
Polling interval1000 msHow often to poll for updates when WebSocket is unavailable
Request timeout4000 msTimeout for HTTP requests to the camera

Actions

Actions are generated from the camera's own API specification. Only endpoints that change settings (PUT/POST) become actions — read-only endpoints are exposed as variables instead.

For endpoints with known supported values (like ISO, gain, ND filter, shutter), the action fields are populated as dropdowns with the camera's actual supported values. These update automatically when the camera's configuration changes.

Endpoints with nested data (like slate/clip metadata) support three action types:

  • Full update — set all fields at once
  • Single field — pick one field from a dropdown and set just that value

Both read the current state first and merge your changes, so unchanged fields are preserved.

Variables

Variables are generated from all readable (GET) endpoints. Values update in real-time via WebSocket when available, falling back to polling otherwise.

Object-valued properties are split into individual sub-variables (e.g., slates_nextClip_clip_clipName, slates_nextClip_clip_reel) with a _json variant containing the raw JSON.

Feedbacks

Boolean and value feedbacks are generated for all subscribable endpoints. Use boolean feedbacks to style buttons based on camera state (e.g., highlight a button when recording is active). Value feedbacks return current property values for use in expressions.

Details

Manufacturer
Blackmagic Design
Product
Blackmagic Cameras API
Latest Version
v1.0.1
Author
Companion Contributors
Contributor
willosof(33)

Open Issues and Requests

mtp9wp9k4c-cmd#23 [Feature]: what is the possiblity of being able to change off speed frame rate/HFRNOMNOMNOM117#17 [Feature]: Allow expressions or incremental values in auto-generated action fieldsNOMNOMNOM117#16 [BUG] /video/shutter does not expose shutterSpeed as a variableaniolpages#7 feat: support Blackmagic Camera App 3.4 HTTPS Camera Remote APIVoxelOne#3 [BUG] BMD Television Studio 6K Pro drops connection/slow pickup

To file a new issue, you need to sign up for a user on GitHub.

Go to GitHub issues →

In other news

Buttons v1.8 Main with text

Buttons v1.8

October 2, 2026

Buttons v1.8 IBC award win

Bitfocus wins IBC2026 Best of Show Award for latest Buttons enhancements

September 21, 2026

Buttons v1.8 grey background

Biggest functionality boost yet makes Buttons the perfect platform for broadcast and media management

September 10, 2026

Vivid Buttons on screen

Bitfocus Buttons makes complex OB production feel simple

August 10, 2026

View all news →

More from Blackmagic Design

ATEM

Blackmagic Design

Community
SwitchersVideo
View Connection

Audio Monitor

Blackmagic Design

Community
Audio
View Connection

Fairlight Live

Blackmagic Design

Vendor
Audio
View Connection

GPI and Tally Interface

Blackmagic Design

Community
GPIOTally
View Connection

Hyperdeck

Blackmagic Design

Community
RecordersVideo
View Connection

Multiview 16

Blackmagic Design

Community
View Connection