Blackmagic URSA Cine - Notification Websocket

To Next Page

To Previous Page

Notification websocket - 1.0.0

Service that notifies subscribers of device state changes.

messages

Subscribe (The messages from the server/device)

(JSON)

Name Type Description

.data object

.data.action string

Possible values are: subscribe, unsubscribe,

listSubscriptions, listProperties, websocketOpened.

.data.properties array

.data.properties[i] string

device property that the user can subscribe to. The user

can either choose a value from the predefined enum, or

provide a wildcard string. Possible values are: /media/active,

/system, /system/codecFormat, /system/videoFormat,

/system/format, /system/supportedFormats, /timelines/0,

/transports/0, /transports/0/stop, /transports/0/play,

/transports/0/playback, /transports/0/record, /transports/0/

timecode, /transports/0/timecode/source, /audio/channel/

{channelIndex}/input, /audio/channel/{channelIndex}/

supportedInputs, /audio/channel/{channelIndex}/level,

/audio/channel/{channelIndex}/phantomPower, /audio/

channel/{channelIndex}/padding, /audio/channel/

{channelIndex}/lowCutFilter, /audio/channel/{channelIndex}/

available, /colorCorrection/lift, /colorCorrection/gamma,

/colorCorrection/gain, /colorCorrection/offset,

/colorCorrection/contrast, /colorCorrection/color,

/colorCorrection/lumaContribution, /lens/iris, /lens/focus,

/lens/zoom, /presets, /presets/active, /video/iso, /video/

whiteBalance, /video/whiteBalanceTint, /video/ndFilter,

/video/videoNdFilterDisplayMode, /video/shutter, /video/

autoExposure. Must match the pattern: .*.

.data.values object

An object with property names as the key and a property

value as json. Check the next section for a the device

properties and their return values.

.data.success boolean

.data.deviceProperties array

.data.deviceProperties[i] string