Header Image

BMD Camera Control Rest

(Version v0.0.3-pre3)

Development status: concept

Core for Bmd cameras using REST Api protocol

ParameterCount: 59

Model:
ParameterClass:
ParameterPocket Cinema Camera 4K (41)
Blackmagic Pocket Cinema Camera 4K
Supports Discovery
Development Status: concept
(59 params)
Audio
Audio Input
Set Audio Channel Input
audioChannelInput
Control:
(has dynamic options)
Feedback:
Normal (Same)
Dimensions:
Channel: (2)
-----
SimpleParam
Audio Channel Level
Set Audio Channel Level
audioChannelLevel
Control:
Floating [-6.0:6.0]dB
Feedback:
Normal (Same)
Dimensions:
Channel: (2)
-----
SimpleParam
Audio Channel LowCut Filter
Set Audio Channel Filter
audioChannelLowCutFilter
Control:
Binary
Feedback:
Normal (Same)
Dimensions:
Channel: (2)
-----
SimpleParam
Audio Channel Padding
Set Audio Channel Padding
audioChannelPadding
Control:
Binary
Feedback:
Normal (Same)
Dimensions:
Channel: (2)
-----
SimpleParam
BMD Preset
ParameterPocket Cinema Camera 4K
BMD Preset Active
BMD Camera Preset Number Curently Active (0 == none, These are the presets that are stored in the camera, under the preset tab)
activeBmdPreset
Control:
-
Feedback:
Integer [0:20]
EXPERIMENTAL
Helper
BMD Preset Delete
Delete BMD Camera Preset (These are the presets that are stored in the camera, under the preset tab)
deleteBmdPreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
BMD Preset: (20)
-----
EXPERIMENTAL
BMD Preset Exists
BMD Camera Preset Exists (These are the presets that are stored in the camera, under the preset tab)
existsBmdPreset
Control:
-
Feedback:
Binary
Dimensions:
Lens Preset: (20)
-----
EXPERIMENTAL
Helper
BMD Preset Name
BMD Camera Preset Name (These are the presets that are stored in the camera, under the preset tab)
nameBmdPreset
Control:
-
Feedback:
String
Dimensions:
Lens Preset: (20)
-----
EXPERIMENTAL
Helper
BMD Preset Recall
Recall BMD Camera Preset (These are the presets that are stored in the camera, under the preset tab)
recallBmdPreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
BMD Preset: (20)
-----
EXPERIMENTAL
BMD Preset Store
Store BMD Camera Preset (These are the presets that are stored in the camera, under the preset tab)
storeBmdPreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
BMD Preset: (20)
-----
EXPERIMENTAL
Camera (Firmware 8.7+)
ParameterPocket Cinema Camera 4K
Color Bars
Enable and Disable Color Bars (Only Supported on cameras on firmware 8.7 or above)
colorBars
Control:
Binary
Feedback:
Normal (Same)
SimpleParam
Program Feed Display
Enable and Disable Program Feed Display (Only Supported on cameras on firmware 8.7 or above)
programFeedDisplay
Control:
Binary
Feedback:
Normal (Same)
SimpleParam
Tally Status
Get Current Tally State (Only Supported on cameras on firmware 8.7 or above)
tallyStatus
Control:
-
Feedback:
0:None
1:Preview
2:Program
SimpleParam
Color Correction
ParameterPocket Cinema Camera 4K
Color Correction Color Hue
Set Color Correction Color Hue
colorCorrectionColorHue
Control:
Floating [-1.00:1.00]
Feedback:
Normal (Same)
SimpleParam
Color Correction Color Saturation
Set Color Correction Saturation
colorCorrectionColorSaturation
Control:
Floating [0.00:2.00]
Feedback:
Normal (Same)
SimpleParam
Color Correction Contrast Adjust
Set Color Correction Contrast Adjust
colorCorrectionContrastAdjust
Control:
Floating [0.00:2.00]
Feedback:
Normal (Same)
SimpleParam
Color Correction Contrast Pivot
Set Color Correction Contrast Pivot
colorCorrectionContrastPivot
Control:
Floating [0.00:1.00]
Feedback:
Normal (Same)
SimpleParam
Color Correction Gain
Set Color Correction Gain
colorCorrectionGain
Control:
Floating [0.00:16.00]
Feedback:
Normal (Same)
Dimensions:
Color: (4)
1: Red
2: Green
3: Blue
4: Luma
-----
SimpleParam
Color Correction Gamma
Set Color Correction Gamma
colorCorrectionGamma
Control:
Floating [-4.00:4.00]
Feedback:
Normal (Same)
Dimensions:
Color: (4)
1: Red
2: Green
3: Blue
4: Luma
-----
SimpleParam
Color Correction Lift
Set Color Correction Lift
colorCorrectionLift
Control:
Floating [-2.00:2.00]
Feedback:
Normal (Same)
Dimensions:
Color: (4)
1: Red
2: Green
3: Blue
4: Luma
-----
SimpleParam
Color Correction Luma Contribution
Set Color Correction Luma Contribution
colorCorrectionLuma
Control:
Floating [0.00:1.00]
Feedback:
Normal (Same)
SimpleParam
Color Correction Offset
Set Color Correction Offset
colorCorrectionOffset
Control:
Floating [-8.00:8.00]
Feedback:
Normal (Same)
Dimensions:
Color: (4)
1: Red
2: Green
3: Blue
4: Luma
-----
SimpleParam
Lens
ParameterPocket Cinema Camera 4K
Auto Focus
Set Auto Focus
doAutoFocus
Control:
One-Shot Trigger
Feedback:
-
SimpleParam
Focus
Set Focus
focus
Control:
Floating [0.00:1.00]
Feedback:
Normal (Same)
Iris Aperture Number
Set Iris Apereture number value (0-1000 Normalized)
irisNumber
Control:
Integer [0:1000]
Feedback:
-
SimpleParam
Iris Aperture Stop
Get Iris Apereture stop value (F-Stop)
irisStop
Control:
-
Feedback:
Delayed Feedback
Helper
Zoom Focal Length
Get/Set Zoom
zoomFocalLength
Control:
Integer [0:10000]
Feedback:
Delayed Feedback
SimpleParam
Zoom Normalaized Value
Get/Set Zoom normalized zoon value
zoomValue
Control:
Floating [0.000:1.000]
Feedback:
Delayed Feedback
SimpleParam
Lens Preset
ParameterPocket Cinema Camera 4K
Preset Recall Mode
Preset recall mode (Zoom+Focus(FZ) or Zoom+Focus and Iris(FIZ))
presetRecallMode
Control:
0:FIZ
1:FZ
Feedback:
Normal (Same)
Dimensions:
Preset: (128)
-----
Preset Status
Show Preset Status (Ready, Empty, In Progress)
presetStatus
Control:
-
Feedback:
0:Ready
1:Empty
2:In Progress
Dimensions:
Preset: (128)
-----
Recall Preset
Recall Preset (Recall Zoom+Focus(FZ) or Zoom+Focus and Iris(FIZ) depens on parameter recall mode)
recallPreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
Preset: (128)
-----
Reset Preset
Reset Preset (Reset Zoom+Focus(FZ) or Zoom+Focus and Iris(FIZ) depens on parameter recall mode)
resetPreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
Preset: (128)
-----
Store Preset
Store Preset (store Zoom+Focus(FZ) or Zoom+Focus and Iris(FIZ) depens on parameter recall mode)
storePreset
Control:
One-Shot Trigger
Feedback:
-
Dimensions:
Preset: (128)
-----
System
ParameterPocket Cinema Camera 4K
Video Codec
Set Video Codec (The BMD Rest API, has a bug atm that only allows us to see the current value if it's a BRAW codec)
videoCodec
Control:
1:H264 Low
2:H264 Medium
3:H264 High
4:H264 High10:422
5:ProRes Proxy
6:ProRes LT
7:ProRes Original
8:ProRes HQ
9:BRaw Q0
10:BRaw Q1
11:BRaw Q3
12:BRaw Q5
13:BRaw 3:1
14:BRaw 4:1
15:BRaw 5:1
16:BRaw 6:1
17:BRaw 8:1
18:BRaw 12:1
19:BRaw 18:1
(has dynamic options)
Feedback:
Normal (Same)
SimpleParam
Video Recording Format
Set Video Recording Format (The BMD Rest API, has a bug atm that only allows us to see the current Recording format if it's a BRAW codec)
videoFormat
Control:
1080:1920x1080 fps
1512:2688x1512 fps
2160:3840x2160 fps
2560:6144x2560 fps
3024:5376x3024 fps
3104:3728x3104 fps
3456:6144x3456 fps
(has dynamic options)
Feedback:
Normal (Same)
SimpleParam
Video Frame Rate
Set Video Frame Rate
videoFramerate
Control:
23:23.98 fps
24:24 fps
25:25 fps
29:29.97 fps
30:30 fps
47:47.95 fps
48:48 fps
50:50 fps
59:59.94 fps
60:60 fps
119:119.88 fps
120:120 fps
(has dynamic options)
Feedback:
Normal (Same)
SimpleParam
Video Sensor Size
Set Video Sensor Size (The BMD Rest API, has a bug atm that only allows us to see the current Sensor Size if it's a BRAW codec)
videoSensorSize
Control:
-
Feedback:
2560:6144x2560 fps
3456:6144x3456 fps
1080:1920x1080 fps
1512:2688x1512 fps
2160:3840x2160 fps
3104:3728x3104 fps
3024:5376x3024 fps
SimpleParam
Transport
ParameterPocket Cinema Camera 4K
Transport
Set Transport
transport
Control:
0:InputPreview
1:InputRecord
2:Output
Feedback:
Normal (Same)
SimpleParam
Transport Loop
Set Transport Loop
transportLoop
Control:
Binary
Feedback:
Normal (Same)
SimpleParam
Transport Single Clip
Set Transport Single Clip
transportLoopSingleClip
Control:
Binary
Feedback:
Normal (Same)
SimpleParam
Transport Play
Set Transport Play
transportPlay
Control:
One-Shot Trigger
Feedback:
-
SimpleParam
Transport Position
Set Transport Position
transportPosition
Control:
Integer [0:1000000]
Feedback:
Normal (Same)
SimpleParam
Transport Record
Set Transport Record
transportRecord
Control:
Binary
Feedback:
Normal (Same)
SimpleParam
Transport Speed
Set Transport Speed
transportSpeed
Control:
Floating [0:200]
Feedback:
Normal (Same)
SimpleParam
Transport Stop
Set Transport Stop
transportStop
Control:
One-Shot Trigger
Feedback:
-
SimpleParam
Transport Timecode
Get Transport Timecode Day
transportTimecode
Control:
-
Feedback:
String
SimpleParam
Transport Clip Timecode
Get Transport Timecode Clip
transportTimecodeClip
Control:
-
Feedback:
String
SimpleParam
Transport Type
Get/Set Transport Type
transportType
Control:
0:Play
1:Jog
2:Shuttle
3:Var
Feedback:
Normal (Same)
SimpleParam
Video
ParameterPocket Cinema Camera 4K
Auto Exposure
Set Auto Exposure
autoExposureMode
Control:
-
Feedback:
0:Off
1:Continuous
2:OneShot
SimpleParam
Auto Exposure Type
Set Auto Exposure Type
autoExposureType
Control:
0:Off
1:Iris
2:Shutter
3:Iris,Shutter
4:Shutter,Iris
Feedback:
Normal (Same)
SimpleParam
Gain
Set Gain
gain
Control:
Integer [-12:36]dB
Feedback:
Normal (Same)
SimpleParam
Iso
Set Isos
iso
Control:
100:100
125:125
160:160
200:200
250:250
320:320
400:400
500:500
640:640
800:800
1000:1000
1250:1250
1600:1600
2000:2000
2500:2500
3200:3200
4000:4000
5000:5000
6400:6400
8000:8000
10000:10000
12800:12800
16000:16000
20000:20000
25600:25600
Feedback:
Normal (Same)
SimpleParam
Shutter Angle
Set Shutter Angle
shutterAngle
Control:
1125:11.2 dg
1500:15 dg
1800:18 dg
2250:22.5 dg
3000:30 dg
8630:86.3 dg
9000:90 dg
10800:108 dg
12000:120 dg
14400:144 dg
15000:150 dg
17280:172.8 dg
18000:180 dg
21600:216 dg
27000:270 dg
32400:324 dg
36000:360 dg
Feedback:
Normal (Same)
SimpleParam
Shutter Speed
Set Shutter Speed
shutterSpeed
Control:
24:1/24
25:1/25
30:1/30
50:1/50
60:1/60
100:1/100
125:1/125
200:1/200
250:1/250
500:1/500
1000:1/1000
2000:1/2000
Feedback:
Normal (Same)
SimpleParam
Video/White Balance
ParameterPocket Cinema Camera 4K
White Balance
set White Balance
whiteBalance
Control:
Integer [2500:10000]
Feedback:
Normal (Same)
SimpleParam
White Balance Auto
Set White Balance Auto
whiteBalanceAuto
Control:
One-Shot Trigger
Feedback:
-
SimpleParam
White Balance Tint
set White Balance Tint
whiteBalanceTint
Control:
Integer [-50:50]
Feedback:
Normal (Same)
SimpleParam
config
ParameterPocket Cinema Camera 4K
Connected
Connection status of device
connection
Control:
-
Feedback:
Binary
tests
ParameterPocket Cinema Camera 4K
Device Test
Test Go thru white balance with increment 1000 and return to initial value
device_test
Control:
One-Shot Trigger
Feedback:
-
Helper