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
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 | |
| 108 | 4K | |
| 109 | 4K | |
| 110 | 1080 | |
| 111 | 2.7K | |
Frames Per Second (3)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | 240 |
|
| 1 | 120 |
|
| 2 | 100 |
|
| 5 | 60 |
|
| 6 | 50 |
|
| 8 | 30 |
|
| 9 | 25 |
|
| 10 | 24 |
|
| 13 | 200 |
|
FOV (43)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Wide |
|
| 2 | Narrow |
|
| 3 | Superview |
|
| 4 | Linear |
|
Auto Off (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 | |
GPS (83)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | OFF |
|
| 1 | ON |
|
Aspect Ratio (108)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | 4:3 | |
| 1 | 16:9 | |
| 3 | 8:7 | |
| 4 | 9:16 | |
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 | |
Lens (122)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 19 | Narrow |
|
| 100 | Max SuperView |
|
| 101 | Wide |
|
| 102 | Linear |
|
Lens (123)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 19 | Narrow |
|
| 100 | Max SuperView | |
| 101 | Wide |
|
| 102 | Linear |
|
Format (128)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 13 | Video |
|
| 20 | Photo |
|
| 21 | Photo |
|
| 26 | Video |
|
Anti-Flicker (134)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 2 | 60Hz |
|
| 3 | 50Hz |
|
Hypersmooth (135)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Off |
|
| 1 | On |
|
| 2 | High |
|
| 3 | Boost |
|
| 4 | Auto Boost |
|
| 100 | Standard | |
Horizon Leveling (150)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Off | |
| 2 | Locked | |
Horizon Leveling (151)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Off | |
| 2 | Locked | |
Max Lens Mod Enable (162)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | OFF |
|
| 1 | ON |
|
HindSight (167)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 2 | 15 Seconds |
|
| 3 | 30 Seconds |
|
| 4 | Off |
|
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 | |
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 | |
Video Performance Modes (173)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Maximum Video Performance | |
| 1 | Extended Battery | |
| 2 | Tripod / Stationary Video | |
Controls (175)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Easy |
|
| 1 | Pro |
|
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 | |
| 5 | 2x Slo-Mo | |
| 6 | 1x Speed / Low Light | |
| 7 | 8x Ultra Slo-Mo | |
| 8 | 4x Super Slo-Mo | |
| 9 | 2x Slo-Mo | |
| 10 | 1x Speed / Low Light | |
| 11 | 4x Super Slo-Mo | |
| 12 | 2x Slo-Mo | |
| 13 | 1x Speed / Low Light | |
| 14 | 8x Ultra Slo-Mo | |
| 15 | 8x Ultra Slo-Mo | |
| 16 | 8x Ultra Slo-Mo | |
| 17 | 4x Super Slo-Mo | |
| 18 | 2x Slo-Mo | |
| 19 | 1x Speed / Low Light | |
| 20 | 8x Ultra Slo-Mo | |
| 21 | 4x Super Slo-Mo | |
| 22 | 2x Slo-Mo | |
| 23 | 1x Speed / Low Light | |
| 24 | 2x Slo-Mo | |
| 25 | 4x Super Slo-Mo | |
| 26 | 2x Slo-Mo | |
| 27 | 4x Super Slo-Mo | |
| 100 | 8X Ultra Slo-Mo | |
| 101 | 4X Super Slo-Mo | |
| 102 | 2X Slo-Mo | |
| 103 | 1X Speed / Low Light | |
| 104 | 8X Ultra Slo-Mo | |
| 105 | 4X Super Slo-Mo | |
| 106 | 2X Slo-Mo | |
| 107 | 1X Speed / Low Light | |
| 108 | 8X Ultra Slo-Mo | |
| 109 | 4X Super Slo-Mo | |
| 110 | 2X Slo-Mo | |
| 111 | 1X Speed / Low Light | |
| 112 | 8X Ultra Slo-Mo | |
| 113 | 4X Super Slo-Mo | |
| 114 | 2X Slo-Mo | |
| 115 | 1X Speed / Low Light | |
| 116 | 2X Slo-Mo | |
| 117 | 2X Slo-Mo | |
| 118 | 1X Speed / Low Light | |
| 119 | 1X Speed / Low Light | |
| 120 | 2X Slo-Mo | |
| 121 | 2X Slo-Mo | |
| 122 | 1X Speed / Low Light | |
| 123 | 1X Speed / Low Light | |
| 124 | 2X Slo-Mo | |
| 125 | 2X Slo-Mo | |
| 126 | 1X Speed / Low Light | |
| 127 | 1X Speed / Low Light | |
| 128 | 1X Speed / Low Light | |
| 129 | 1X Speed / Low Light | |
| 130 | 2X Slo-Mo | |
| 131 | 2X Slo-Mo | |
| 132 | 2X Slo-Mo | |
| 133 | 2X Slo-Mo | |
| 134 | 1X Speed / Low Light | |
| 135 | 1X Speed / Low Light | |
| 136 | 1X Speed / Low Light | |
| 137 | 1X Speed / Low Light | |
Night Photo (177)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Off | |
| 1 | On | |
Wi-fi Band (178)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | 2.4GHz |
|
| 1 | 5GHz |
|
Trail Length (179)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 1 | Short |
|
| 2 | Long |
|
| 3 | Max |
|
Video Mode (180)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Highest Quality | |
| 101 | Extended Battery | |
| 102 | Longest Battery | |
Bit Rate (182)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Standard | |
| 1 | High | |
Bit Depth (183)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | 8-Bit | |
| 2 | 10-Bit | |
Profiles (184)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Standard | |
| 1 | HDR | |
| 2 | Log | |
Video Mode (186)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Highest Quality | |
| 1 | Standard Quality | |
| 2 | Basic Quality | |
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 | |
Max Lens Mod (189)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | None | |
| 1 | Max Lens 1.0 | |
| 2 | Max Lens 2.0 | |
Max Lens Mod Enable (190)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Off | |
| 1 | On | |
Photo Mode (191)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Super Photo | |
| 1 | Night Photo | |
Aspect Ratio (192)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | 4:3 | |
| 1 | 16:9 | |
| 3 | 8:7 | |
Framing (193)
| ID | Option Name | Supported Cameras |
|---|---|---|
| 0 | Widescreen | |
| 1 | Vertical | |
| 2 | Full Frame | |