Settings
Camera Capabilities
Camera capabilities usually change from one camera to another and often change from one release to the next. Below are documents that detail whitelists for basic video settings for every supported camera release.
These capability documents define supported camera states. Each state is comprised of a set of setting options that are
presented in dependency order. This means each state is guaranteed to be attainable if and only if the setting options
are set in the order presented. Failure to adhere to dependency ordering may result in the camera’s blacklist rules
rejecting a Set Setting
command.
Camera | Command 1 | Command 2 | Command 3 | Command 4 | Command 5 | Guaranteed Valid? |
---|---|---|---|---|---|---|
Hero 10 Black | Res: 1080 | Anti-Flicker: 60 Hz | FPS: 240 | FOV: Wide | Hypersmooth: Off | ✔ |
Hero 10 Black | Res: 240 | Anti-Flicker: 60 Hz | RES: 1080 | FOV: Wide | Hypersmooth: off | ❌ |
In the example above, the first set of commands will always work for basic video presets such as Standard.
In the second example, suppose the camera’s Video Resolution was previously set to 4K. If the user tries to set Video FPS to 240, it will fail because 4K/240fps is not supported.
Capability documents for each camera / firmware version can be found in the following file formats:
XLSX
An XLSX file can be found here.
The capabilities spreadsheet contains worksheets for every supported release. Each row in a worksheet represents a whitelisted state and is presented in dependency order as outlined above.
JSON
A JSON file can be found here.
The capabilities JSON contains a set of whitelist states for every supported release. Each state is comprised of a list
of objects that contain setting and option IDs necessary to construct
Set Setting
commands and are given in dependency
order as outlined above. For more information on the object format, see the
JSON schema.
Operations
- Set Setting
-
- Type:
- ID:
- SettingID
Set an individual Setting ID to a given value.
The superset of per-setting values can be found in the Setting ID documentation. Alternatively, the currently supported setting values can be dynamically queried via
Get Setting Capabilities
- UUID:
- Parameters:
-
- value_length (uint8) - length of value
- value (variable length and type) - value to set, of length value_length
- UUID:
Setting IDs
Video Resolution (2)
ID | Option Name | Supported Cameras |
---|---|---|
1 | 4K |
|
4 | 2.7K |
|
6 | 2.7K 4:3 |
|
7 | 1440 | |
9 | 1080 |
|
18 | 4K 4:3 |
|
24 | 5K | |
25 | 5K 4:3 | |
26 | 5.3K 8:7 |
|
27 | 5.3K 4:3 |
|
28 | 4K 8:7 |
|
100 | 5.3K |
|
107 | 5.3K 8:7 V2 | |
108 | 4K 8:7 V2 | |
109 | 4K 9:16 V2 | |
110 | 1080 9:16 V2 | |
111 | 2.7K 4:3 V2 |
This is a integer value formatted as int8ub.
Frames Per Second (3)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 240.0 |
|
1 | 120.0 |
|
2 | 100.0 |
|
5 | 60.0 |
|
6 | 50.0 |
|
8 | 30.0 |
|
9 | 25.0 |
|
10 | 24.0 |
|
13 | 200.0 |
|
This is a integer value formatted as int8ub.
Video Timelapse Rate (5)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 0.5 Seconds |
|
1 | 1 Second |
|
2 | 2 Seconds |
|
3 | 5 Seconds |
|
4 | 10 Seconds |
|
5 | 30 Seconds |
|
6 | 60 Seconds |
|
7 | 2 Minutes |
|
8 | 5 Minutes |
|
9 | 30 Minutes |
|
10 | 60 Minutes |
|
11 | 3 Seconds |
This is a integer value formatted as int8ub.
How frequently to take a video when performing a Video Timelapse
Photo Timelapse Rate (30)
ID | Option Name | Supported Cameras |
---|---|---|
11 | 3 Seconds | |
100 | 60 Minutes |
|
101 | 30 Minutes |
|
102 | 5 Minutes |
|
103 | 2 Minutes |
|
104 | 60 Seconds |
|
105 | 30 Seconds |
|
106 | 10 Seconds |
|
107 | 5 Seconds |
|
108 | 2 Seconds |
|
109 | 1 Second |
|
110 | 0.5 Seconds |
|
This is a integer value formatted as int64ub.
How frequently to take a photo when performing a Photo Timelapse.
Nightlapse Rate (32)
ID | Option Name | Supported Cameras |
---|---|---|
4 | 4 Seconds |
|
5 | 5 Seconds |
|
10 | 10 Seconds |
|
15 | 15 Seconds |
|
20 | 20 Seconds |
|
30 | 30 Seconds |
|
100 | 60 Seconds |
|
120 | 2 Minutes |
|
300 | 5 Minutes |
|
1800 | 30 Minutes |
|
3600 | 60 Minutes |
|
3601 | Auto |
|
This is a integer value formatted as int64ub.
How frequently to take a video or photo when performing a Nightlapse.
This controls the Video or Photo Nightlapse rate if Setting 128 is set to 21 or 26 respectively.
Webcam Digital Lenses (43)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Wide |
|
2 | Narrow |
|
3 | Superview |
|
4 | Linear |
|
This is a integer value formatted as int8ub.
Auto Power Down (59)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Never |
|
1 | 1 Min |
|
4 | 5 Min |
|
6 | 15 Min |
|
7 | 30 Min |
|
11 | 8 Seconds | |
12 | 30 Seconds |
This is a integer value formatted as int8ub.
GPS (83)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off |
|
1 | On |
|
This is a integer value formatted as int8ub.
Video Aspect Ratio (108)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 4:3 | |
1 | 16:9 | |
3 | 8:7 | |
4 | 9:16 |
This is a integer value formatted as int8ub.
Video Lens (121)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Wide |
|
2 | Narrow |
|
3 | Superview |
|
4 | Linear |
|
7 | Max SuperView |
|
8 | Linear + Horizon Leveling |
|
9 | HyperView |
|
10 | Linear + Horizon Lock |
|
11 | Max HyperView |
This is a integer value formatted as int8ub.
Photo Lens (122)
ID | Option Name | Supported Cameras |
---|---|---|
19 | Narrow |
|
100 | Max SuperView |
|
101 | Wide |
|
102 | Linear |
|
This is a integer value formatted as int8ub.
Time Lapse Digital Lenses (123)
ID | Option Name | Supported Cameras |
---|---|---|
19 | Narrow |
|
100 | Max SuperView | |
101 | Wide |
|
102 | Linear |
|
This is a integer value formatted as int8ub.
Photo Output (125)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Standard |
|
1 | Raw |
|
2 | HDR |
|
3 | SuperPhoto |
|
This is a integer value formatted as int8ub.
Media Format (128)
ID | Option Name | Supported Cameras |
---|---|---|
13 | Time Lapse Video |
|
20 | Time Lapse Photo |
|
21 | Night Lapse Photo |
|
26 | Night Lapse Video |
|
This is a integer value formatted as int8ub.
Anti-Flicker (134)
ID | Option Name | Supported Cameras |
---|---|---|
2 | 60Hz |
|
3 | 50Hz |
|
This is a integer value formatted as int8ub.
Hypersmooth (135)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off |
|
1 | Low |
|
2 | High |
|
3 | Boost |
|
4 | Auto Boost |
|
100 | Standard |
This is a integer value formatted as int8ub.
Video Horizon Leveling (150)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
2 | Locked |
This is a integer value formatted as int8ub.
Photo Horizon Leveling (151)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
2 | Locked |
This is a integer value formatted as int8ub.
Max Lens (162)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off |
|
1 | On |
|
This is a integer value formatted as int8ub.
HindSight (167)
ID | Option Name | Supported Cameras |
---|---|---|
2 | 15 Seconds |
|
3 | 30 Seconds |
|
4 | Off |
|
This is a integer value formatted as int8ub.
Photo Single Interval (171)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
2 | 0.5s | |
3 | 1s | |
4 | 2s | |
5 | 5s | |
6 | 10s | |
7 | 30s | |
8 | 60s | |
9 | 120s | |
10 | 3s |
This is a integer value formatted as int8ub.
Photo Interval Duration (172)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
1 | 15 Seconds | |
2 | 30 Seconds | |
3 | 1 Minute | |
4 | 5 Minutes | |
5 | 15 Minutes | |
6 | 30 Minutes | |
7 | 1 Hour | |
8 | 2 Hours | |
9 | 3 Hours |
This is a integer value formatted as int8ub.
Video Performance Mode (173)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Maximum Video Performance | |
1 | Extended Battery | |
2 | Tripod / Stationary Video |
This is a integer value formatted as int8ub.
Controls (175)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Easy |
|
1 | Pro |
|
This is a integer value formatted as int8ub.
Easy Mode Speed (176)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 8X Ultra Slo-Mo | |
1 | 4X Super Slo-Mo | |
2 | 2X Slo-Mo | |
3 | 1X Speed (Low Light) | |
4 | 4X Super Slo-Mo (Ext. Batt.) | |
5 | 2X Slo-Mo (Ext. Batt.) | |
6 | 1X Speed (Ext. Batt.) (Low Light) | |
7 | 8X Ultra Slo-Mo (50Hz) | |
8 | 4X Super Slo-Mo (50Hz) | |
9 | 2X Slo-Mo (50Hz) | |
10 | 1X Speed (50Hz) (Low Light) | |
11 | 4X Super Slo-Mo (50Hz) (Ext. Batt.) | |
12 | 2X Slo-Mo (50Hz) (Ext. Batt.) | |
13 | 1X Speed (50Hz) (Ext. Batt.) (Low Light) | |
14 | 8X Ultra Slo-Mo (Ext. Batt.) | |
15 | 8X Ultra Slo-Mo (50Hz) (Ext. Batt.) | |
16 | 8X Ultra Slo-Mo (Long. Batt.) | |
17 | 4X Super Slo-Mo (Long. Batt.) | |
18 | 2X Slo-Mo (Long. Batt.) | |
19 | 1X Speed (Long. Batt.) (Low Light) | |
20 | 8X Ultra Slo-Mo (50Hz) (Long. Batt.) | |
21 | 4X Super Slo-Mo (50Hz) (Long. Batt.) | |
22 | 2X Slo-Mo (50Hz) (Long. Batt.) | |
23 | 1X Speed (50Hz) (Long. Batt.) (Low Light) | |
24 | 2X Slo-Mo (4K) | |
25 | 4X Super Slo-Mo (2.7K) | |
26 | 2X Slo-Mo (4K) (50Hz) | |
27 | 4X Super Slo-Mo (2.7K) (50Hz) | |
100 | 8X Ultra Slo-Mo (V2) | |
101 | 4X Super Slo-Mo (V2) | |
102 | 2X Slo-Mo (V2) | |
103 | 1X Speed (Low Light) (V2) | |
104 | 8X Ultra Slo-Mo (50Hz) (V2) | |
105 | 4X Super Slo-Mo (50Hz) (V2) | |
106 | 2X Slo-Mo (50Hz) (V2) | |
107 | 1X Speed (50Hz) (Low Light) (V2) | |
108 | 8X Ultra Slo-Mo (Long. Batt.) (V2) | |
109 | 4X Super Slo-Mo (Long. Batt.) (V2) | |
110 | 2X Slo-Mo (Long. Batt.) (V2) | |
111 | 1X Speed (Long. Batt.) (Low Light) (V2) | |
112 | 8X Ultra Slo-Mo (50Hz) (Long. Batt.) (V2) | |
113 | 4X Super Slo-Mo (50Hz) (Long. Batt.) (V2) | |
114 | 2X Slo-Mo (50Hz) (Long. Batt.) (V2) | |
115 | 1X Speed (50Hz) (Long. Batt.) (Low Light) (V2) | |
116 | 2X Slo-Mo (4K) (V2) | |
117 | 2X Slo-Mo (4K) (50Hz) (V2) | |
118 | 1X Speed (Low Light) (V2) (Vertical) | |
119 | 1X Speed (50Hz) (Low Light) (V2) (Vertical) | |
120 | 2X Slo-Mo (V2) (Vertical) | |
121 | 2X Slo-Mo (50Hz) (V2) (Vertical) | |
122 | 1X Speed (Full Frame) (Low Light) (V2) | |
123 | 1X Speed (50Hz) (Full Frame) (Low Light) (V2) | |
124 | 2X Slo-Mo (Full Frame) (V2) | |
125 | 2X Slo-Mo (50Hz) (Full Frame) (V2) | |
126 | 1X Speed (4K) (Low Light) (V2) | |
127 | 1X Speed (4K) (50Hz) (Low Light) (V2) | |
128 | 1X Speed (2.7K) (Low Light) (V2) | |
129 | 1X Speed (2.7K) (50Hz) (Low Light) (V2) | |
130 | 2X Slo-Mo (2.7K) (V2) | |
131 | 2X Slo-Mo (2.7K) (50Hz) (V2) | |
132 | 2X Slo-Mo (Long. Batt.) (V2) (Vertical) | |
133 | 2X Slo-Mo (50Hz) (Long. Batt.) (V2) (Vertical) | |
134 | 1X Speed (Long. Batt.) (Low Light) (V2) (Vertical) | |
135 | 1X Speed (50Hz) (Long. Batt.) (Low Light) (V2) (Vertical) | |
136 | 1X Speed (4K) (Full Frame) (Low Light) (V2) | |
137 | 1X Speed (4K) (50Hz) (Full Frame) (Low Light) (V2) |
This is a integer value formatted as int8ub.
Enable Night Photo (177)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
1 | On |
This is a integer value formatted as int8ub.
Wireless Band (178)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 2.4GHz |
|
1 | 5GHz |
|
This is a integer value formatted as int8ub.
Star Trails Length (179)
ID | Option Name | Supported Cameras |
---|---|---|
1 | Short |
|
2 | Long |
|
3 | Max |
|
This is a integer value formatted as int8ub.
System Video Mode (180)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Highest Quality | |
101 | Extended Battery | |
102 | Longest Battery |
This is a integer value formatted as int8ub.
Video Bit Rate (182)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Standard | |
1 | High |
This is a integer value formatted as int8ub.
Bit Depth (183)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 8-Bit | |
2 | 10-Bit |
This is a integer value formatted as int8ub.
Profiles (184)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Standard | |
1 | HDR | |
2 | Log |
This is a integer value formatted as int8ub.
Video Easy Mode (186)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Highest Quality | |
1 | Standard Quality | |
2 | Basic Quality |
This is a integer value formatted as int8ub.
Lapse Mode (187)
ID | Option Name | Supported Cameras |
---|---|---|
0 | TimeWarp | |
1 | Star Trails | |
2 | Light Painting | |
3 | Vehicle Lights | |
4 | Max TimeWarp | |
5 | Max Star Trails | |
6 | Max Light Painting | |
7 | Max Vehicle Lights |
This is a integer value formatted as int8ub.
Max Lens Mod (189)
ID | Option Name | Supported Cameras |
---|---|---|
0 | None | |
1 | Max Lens 1.0 | |
2 | Max Lens 2.0 |
This is a integer value formatted as int8ub.
Max Lens Mod Enable (190)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Off | |
1 | On |
This is a integer value formatted as int8ub.
Easy Night Photo (191)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Super Photo | |
1 | Night Photo |
This is a integer value formatted as int8ub.
Multi Shot Aspect Ratio (192)
ID | Option Name | Supported Cameras |
---|---|---|
0 | 4:3 | |
1 | 16:9 | |
3 | 8:7 |
This is a integer value formatted as int8ub.
Framing (193)
ID | Option Name | Supported Cameras |
---|---|---|
0 | Widescreen | |
1 | Vertical | |
2 | Full Frame |
This is a integer value formatted as int8ub.