diff --git a/assets/images/openapi/global_behaviors.png b/assets/images/openapi/global_behaviors.png new file mode 100644 index 00000000..746ff999 Binary files /dev/null and b/assets/images/openapi/global_behaviors.png differ diff --git a/assets/images/openapi/resumeable_ota.png b/assets/images/openapi/resumeable_ota.png new file mode 100644 index 00000000..1e4ea644 Binary files /dev/null and b/assets/images/openapi/resumeable_ota.png differ diff --git a/assets/images/openapi/simple_ota.png b/assets/images/openapi/simple_ota.png new file mode 100644 index 00000000..b6e6b721 Binary files /dev/null and b/assets/images/openapi/simple_ota.png differ diff --git a/assets/images/openapi/webcam.png b/assets/images/openapi/webcam.png new file mode 100644 index 00000000..47506143 Binary files /dev/null and b/assets/images/openapi/webcam.png differ diff --git a/assets/js/lunr/lunr-store.js b/assets/js/lunr/lunr-store.js index a8c86125..60173f84 100644 --- a/assets/js/lunr/lunr-store.js +++ b/assets/js/lunr/lunr-store.js @@ -1,18 +1,11 @@ var store = [ { "title": "Bluetooth Low Energy (BLE) Specification v2.0: ", - "excerpt": "About This Page This page describes the format, capabilities, and use of Bluetooth Low Energy (BLE) as it pertains to communicating with GoPro cameras. Messages are sent using either TLV or Protobuf format. General Communicating with a GoPro camera via Bluetooth Low Energy involves writing to Bluetooth characteristics and, typically, waiting for a response notification from a corresponding characteristic. The camera organizes its Generic Attribute Profile (GATT) table by broad features: AP control, control & query, etc. Note: All byte ordering is in Big Endian unless otherwise noted. Supported Cameras Below is a table of cameras that support GoPro's public BLE API: Model ID Model Code Marketing Name Minimal Firmware Version 62 H23.01 HERO12 Black v01.10.00 60 H22.03 HERO11 Black Mini v01.10.00 58 H22.01 HERO11 Black v01.10.00 57 H21.01 HERO10 Black v01.10.00 55 HD9.01 HERO9 Black v01.70.00 Services and Characteristics Note: GP-XXXX is shorthand for GoPro's 128-bit UUIDs: b5f9xxxx-aa8d-11e3-9046-0002a5d5c51b Service UUID Service Characteristic UUID Description Permissions GP-0001 GoPro WiFi Access Point GP-0002 WiFi AP SSID Read / Write GP-0003 WiFi AP Password Read / Write GP-0004 WiFi AP Power Write GP-0005 WiFi AP State Read / Indicate GP-0090 GoPro Camera Management GP-0091 Network Management Command Write GP-0092 Network Management Response Notify FEA6 Control & Query GP-0072 Command Write GP-0073 Command Response Notify GP-0074 Settings Write GP-0075 Settings Response Notify GP-0076 Query Write GP-0077 Query Response Notify Packet Headers The Bluetooth Low Energy protocol limits messages to 20 bytes per packet. To accommodate this limitation, GoPro cameras use start packets and continuation packets. If a message is 20 bytes or fewer, it can be sent with a single packet containing the start packet header. If a message is longer than 20 bytes, it must be chunked into multiple packets with the first packet containing a start packet header and subsequent packets containing continuation packet headers. All lengths are in bytes. Packet Header Format Message sending and receiving is accomplished by prepending General (5-bit), Extended (13-bit), Extended (16-bit), or Continuation headers onto each packet depending on the message size. General (5-bit) Messages (Send and Receive) Messages that are 31 bytes or fewer can be sent or received using the following format: Byte 1 7 6 5 4 3 2 1 0 0: Start 00: General Message Length: 5 bits Extended (13-bit) Messages (Send and Receive) Messages that are 8191 bytes or fewer can be sent or received using the following format: Quickstart Tip: Always use Extended (13-bit) packet headers when sending messages to avoid having to work with multiple packet header formats. Byte 1 Byte 2 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 0: Start 01: Extended (13-bit) Message Length: 13 bits Extended (16-bit) Messages (Receive only) If a message is 8192 bytes or longer, the camera will respond using the format below. Note: This format cannot be used for sending messages to the camera. Byte 1 Byte 2 Byte 3 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 0: Start 10: Extended (16-bit) Message Length: 16 bits Continuation Packets (Send and Receive) When sending or receiving a message that is longer than 20 bytes, the message must be split into N packets with packet 1 containing a start packet header and packets 2..N containing a continuation packet header. Note: Counters start at 0x0 and reset after 0xF. Byte 1 7 6 5 4 3 2 1 0 1: Continuation Counter (4-bit) Example: Packetizing a 5-bit General Message Message Length: 17 bytes Message: 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11 Packet Type Byte(s) Description 1 Header 11 (0) start packet (00) 5-bit General message (10001) message length: 17 Payload 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11 Message Example: Packetizing a 13-bit Extended Message Message Length: 50 bytes Message: 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12:13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25:26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32 Packet Type Byte(s) Description 1 Header 20:32 (0) start packet (01) 13-bit Extended message (0000000110010) message length: 50 Payload 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12 Message (chunk 1 of 3) 2 Header 80 (1) continuation packet (000) ignored (0000) counter: 0 Payload 13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25 Message (chunk 2 of 3) 3 Header 81 (1) continuation packet (000) ignored (0001) counter: 1 Payload 26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32 Message (chunk 3 of 3) Example: Depacketizing a Multi-Packet Message Packets Received: 5 Once the packet headers are identified and removed from each packet, the complete response message can be assembled by concatenating the remaining packet data in the order it was received. Packet Byte(s) Header 1 20:57:01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12 20:57 (0) start packet (01) 13-bit Extended message (0000001010111) message length: 87 2 80:13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25 80 (1) continuation packet (000) ignored (0000) counter: 0 3 81:26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32:33:34:35:36:37:38 81 (1) continuation packet (000) ignored (0001) counter: 1 4 82:39:3A:3B:3C:3D:3E:3F:40:41:42:43:44:45:46:47:48:49:4A:4B 82 (1) continuation packet (000) ignored (0010) counter: 2 5 83:4C:4D:4E:4F:50:51:52:53:54:55:56:57 83 (1) continuation packet (000) ignored (0011) counter: 3 Discovery, Connection and Pairing Advertisements The camera will send BLE advertisements while it is ON and for the first 8 hours after the camera is put to sleep. During this time, the camera is discoverable and can be connected to. If the camera is in sleep mode, connecting to it will cause the camera to wake and boot up. Pairing In order to communicate with a GoPro camera via BLE, a client must first be paired with the camera. The pairing procedure must be done once for each new client. If the camera is factory reset, all clients will need to pair again. To pair with the camera, use the UI to put it into pairing mode, connect via BLE and then initiate pairing. The camera will whitelist the client so subsequent connections do not require pairing. Steps Discovery of and connection to the GoPro camera can be done as follows: Put the camera into pairing mode Scan to discover peripherals (which can be narrowed by limiting to peripherals that advertise service FEA6) Connect to the peripheral Finish pairing with the peripheral Discover all advertised services and characteristics Subscribe to notifications from all characteristics that have the notify flag set Sending and Receiving Messages In order to enable two-way communication with a GoPro camera, clients must connect to the camera and subscribe to characteristics that have the notify flag set. Messages are sent to the camera by writing to a write-enabled UUID and then waiting for a notification from the corresponding response UUID. Response notifications indicate whether the message was valid and will be (asynchronously) processed. For example, to send a camera control command, a client should write to GP-0072 and then wait for a response notification from GP-0073. Depending on the camera's state, it may not be ready to accept specific commands. This ready state is dependent on the System Busy and the Encoding Active status flags. For example: System Busy flag is set while loading presets, changing settings, formatting sdcard, ... Encoding Active flag is set while capturing photo/video media If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the System Busy and Encode Active flags to be unset before sending messages other than get status/setting queries. Parsing Responses In order to communicate fully with the camera, the user will need to be able to parse response and event notifications in TLV or Protobuf format as needed. TLV and Protobuf responses have very different formats. Parsing TLV data requires a parser to be written locally. Parsing Protobuf data can be done using code generated from Protobuf files linked in this document. Typically, the camera will send TLV responses/events for commands sent in TLV format and Protobuf responses/events for commands sent in Protobuf format. The pseudocode and flowcharts below refer to the following tables: Protobuf IDs Table Protobuf Commands Table Command Response Format Settings Response Format Query Response Format Pseudocode Below is pseudocode describing how to determine whether a respose is TLV or Protobuf and then parse it appropriately. Camera sends response R (array of bytes) from UUID U (string) with payload P (array of bytes) // Is it a Protobuf response? for each row in the Protobuf IDs table { F (int) = Feature ID A (array of int) = Action IDs if P[0] == F and P[1] in A { R is a protobuf message Match Feature ID P[0] and Action ID P[1] to a Response message in the Protobuf Commands Table Use matched Response message to parse payload into useful data structure Exit } } // Nope. It is a TLV response if U == GP-0072 (Command) { Parse using Command Response Format table } else if U == GP-0074 (Settings) { Parse using Settings Response Format table } else if U == GP-0076 (Query) { Parse using Query Response Format table } Exit Flowchart Below is a flowchart describing how to determine whether a respose is TLV or Protobuf and then parse it appropriately. Receive response RExtract payload P&160;P[0] == Feature ID from row N of Protobuf IDs TableANDP[1] in Action IDs list from row N of Protobuf IDs Table&160;yesnoR is a protobuf messageR is a TLV messageResponse RResponse UUIDR is a Command responseR is a Settings responseR is a Query responseParse accordinglyFeature ID = P[0]Action ID = P[1]Use: Protobuf Commands TableParse using appropriate protobuf messageKnowledge!GP-0072(Control)GP-0076(Query)GP-0074(Settings)TLV messageProtobuf message Keep Alive In order to maximize battery life, GoPro cameras automatically go to sleep after some time. This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support and a Keep Alive message that the user can regularly send to the camera. The camera will automatically go to sleep if both timers reach zero. The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or programmatically (un)sets the shutter, sets a setting, or loads a Preset. The Keep Alive timer is reset when the user sends a keep alive message. The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages every 3.0 seconds after a connection is established. Command UUID Write Response UUID Response GP-0074 03:5B:01:42 GP-0075 02:5B:00 Limitations HERO12 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO11 Black Mini The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO11 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO10 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO9 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings General Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds. In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode). Type Length Value GoPro's BLE protocol comes in two flavors: TLV (Type Length Value) and Protobuf. This section describes TLV style messaging. Note: All TLV messages (payloads) must be packetized and wrapped with Packet Headers as outlined in this document. Commands The table below contains command IDs supported by Open GoPro. Command messages are sent to GP-0072 and responses/notifications are received on GP-0073. Command ID Description 0x01 Set shutter 0x05 Sleep 0x0D Set Date/Time 0x0E Get Date/Time 0x0F Set Local Date/Time 0x10 Get Local Date/Time 0x17 AP Control 0x18 Media: HiLight Moment 0x3C Get Hardware Info 0x3E Presets: Load Group 0x40 Presets: Load 0x50 Analytics 0x51 Open GoPro Command Format Header/Length Command ID Parameter Length Parameter Value 1-2 bytes 1 byte 1 byte Variable length Command Response The GoPro camera sends responses to most commands received, indicating whether the command was valid and will be processed or not. Unless indicated otherwise in the Quick Reference table below, command responses use the format below. Command Response Format Header/Length Command ID Response Code Response 1-2 bytes 1 byte 1 byte Variable length Command Response Error Codes Error Code Description 0 Success 1 Error 2 Invalid Parameter 3..255 Reserved Commands Quick Reference Below is a table of commands that can be sent to the camera and how to send them. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ ID Command Description Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 0x01 Set shutter Shutter: off 03:01:01:00 02:01:00 ✔ ✔ ✔ ✔ ✔ 0x01 Set shutter Shutter: on 03:01:01:01 02:01:00 ✔ ✔ ✔ ✔ ✔ 0x05 Sleep Put camera to sleep 01:05 02:05:00 ✔ ✔ ✔ ✔ ✔ 0x0D Set Date/Time Set date/time to 2023-01-31 03:04:05 09:0D:07:07:E7:01:1F:03:04:05 02:0D:00 ✔ ✔ ✔ ✔ ✔ 0x0E Get Date/Time Get date/time 01:0E Complex ✔ ✔ ✔ ✔ ✔ 0x0F Set Local Date/Time Set local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on) 0C:0F:0A:07:E7:01:1F:03:04:05:FF:88:01 02:0F:00 ✔ ✔ ✔ ❌ ❌ 0x10 Get Local Date/Time Get local date/time 01:10 Complex ✔ ✔ ✔ ❌ ❌ 0x17 AP Control Ap mode: off 03:17:01:00 02:17:00 ✔ ✔ ✔ ✔ ✔ 0x17 AP Control Ap mode: on 03:17:01:01 02:17:00 ✔ ✔ ✔ ✔ ✔ 0x18 Media: HiLight Moment Hilight moment during encoding 01:18 02:18:00 ✔ ✔ ✔ ✔ ✔ 0x3C Get Hardware Info Get camera hardware info 01:3C Complex ✔ ✔ ✔ ✔ ✔ 0x3E Presets: Load Group Video 04:3E:02:03:E8 02:3E:00 ✔ ✔ ✔ ✔ ✔ 0x3E Presets: Load Group Photo 04:3E:02:03:E9 02:3E:00 ✔ ❌ ✔ ✔ ✔ 0x3E Presets: Load Group Timelapse 04:3E:02:03:EA 02:3E:00 ✔ ❌ ✔ ✔ ✔ 0x40 Presets: Load Example preset id: 0x1234ABCD 06:40:04:12:34:AB:CD 02:40:00 ✔ ✔ ✔ ✔ ✔ 0x50 Analytics Set third party client 01:50 02:50:00 ✔ ✔ ✔ ✔ ✔ 0x51 Open GoPro Get version 01:51 Complex ✔ ✔ ✔ ✔ ✔ Complex Command Inputs Set Local Date/Time The timezone is a two byte UTC offset in minutes and must be sent in Two's Complement form. Complex Command Responses Below are clarifications for complex camera responses Get Hardware Info Response Packet Response Byte(s) Description 1 20 Start packet 51 Response length 3C:00 Command 3C sent successfully 04 Length of model number 00:00:00:37 Model ID 0B Length of model id 48:45:52:4F:58:20:42:6C:61:63 \"HEROX Blac\" 2 80 Continuation packet 6B \"k\" 04 Length of board type 30:78:30:35 \"0x05\" 0F Length of firmware version 48:44:58:2E:58:58:2E:58:58:2E:58:58 \"HDX.XX.XX.XX\" 3 81 Continuation packet (1) 2E:58:58 \".XX\" 0E Length of serial number 58:58:58:58:58:58:58:58:58:58:58:58:58:58 \"XXXXXXXXXXXXXX\" 0A Length of AP SSID 4 82 Continuation packet (2) 47:50:32:34:35:30:58:58:58:58 \"GP2450XXXX\" 0C AP MAC Address length 58:58:58:58:58:58:58:58 \"XXXXXXXX\" 5 83 Continuation packet (3) 58:58:58:58 \"XXXX\" Open GoPro Version Given the response 06:51:00:01:01:01:00, the Open GoPro version would be vXX.YY. Response Byte(s) Description 06 Packet length 51 Command ID 00 Status (OK) 01 Length of major version 01 Major version: 1 01 Length of minor version 00 Minor version: 0 Get Date/Time Given the response 0B:0E:00:08:07:E5:01:02:03:04:05:06, the date/time would be 2022-01-02 03:04:05 (Saturday). Response Byte(s) Description 0B Packet length 0E Command ID 00 Status (OK) 08 Date length (bytes) 07:E6 Year 01 Month 02 Day 03 Hour 04 Minute 05 Second 06 Day of the week (Sun=0, Sat=6) Get Local Date/Time (with Timezone and DST) Given the response 0D:10:00:0A:07:E6:01:02:03:04:05:FE:20:01, the date/time would be 2022-01-02 03:04:05-0800 (DST: ON). Response Byte(s) Description 0D Packet length 10 Command ID 00 Status (OK) 0A Date length (bytes) 07:E6 Year 01 Month 02 Day 03 Hour 04 Minute 05 Second FE:20 UTC offset in minutes (Two's Complement) 01 DST: ON Settings GoPro settings can be configured using the GP-Settings (GP-0074) UUID. Setting status is returned on GP-Settings-Status (GP-0075) UUID. Settings Request Format This will configure a setting on the camera. Only one setting may be sent on a packet (GATT notify or write-no-response), although multiple packets may be sent back-to-back. Request Length Setting ID Setting Value Length Setting Value 1-2 bytes 1 byte 1 byte (variable length) Settings Response Format Response Length Setting ID Response Code 1 byte 1 byte 1 byte Settings Quick Reference All settings are sent to UUID GP-0074. All values are hexadecimal and length are in bytes. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Setting ID Setting Option Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 2 Resolution Set video resolution (id: 2) to 4k (id: 1) 03:02:01:01 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k (id: 4) 03:02:01:04 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 6) 03:02:01:06 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 1440 (id: 7) 03:02:01:07 02:02:00 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 1080 (id: 9) 03:02:01:09 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 18) 03:02:01:12 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 5k (id: 24) 03:02:01:18 02:02:00 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 5k 4:3 (id: 25) 03:02:01:19 02:02:00 ❌ ❌ ❌ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 8:7 (id: 26) 03:02:01:1A 02:02:00 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 4:3 (id: 27) 03:02:01:1B 02:02:00 ❌ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 8:7 (id: 28) 03:02:01:1C 02:02:00 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 9:16 (id: 29) 03:02:01:1D 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 9:16 (id: 30) 03:02:01:1E 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k (id: 100) 03:02:01:64 02:02:00 ❌ ✔ ✔ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 16:9 (id: 101) 03:02:01:65 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 16:9 (id: 102) 03:02:01:66 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 103) 03:02:01:67 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 16:9 (id: 104) 03:02:01:68 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 105) 03:02:01:69 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 16:9 (id: 106) 03:02:01:6A 02:02:00 ✔ ❌ ❌ ❌ ❌ 3 Frames Per Second Set video fps (id: 3) to 240 (id: 0) 03:03:01:00 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 120 (id: 1) 03:03:01:01 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 100 (id: 2) 03:03:01:02 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 60 (id: 5) 03:03:01:05 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 50 (id: 6) 03:03:01:06 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 30 (id: 8) 03:03:01:08 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 25 (id: 9) 03:03:01:09 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 24 (id: 10) 03:03:01:0A 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 200 (id: 13) 03:03:01:0D 02:03:00 ✔ ✔ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to never (id: 0) 03:3B:01:00 01:3B:00 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 1 min (id: 1) 03:3B:01:01 01:3B:00 ✔ \\>= v02.10.00 \\>= v02.01.00 ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 5 min (id: 4) 03:3B:01:04 01:3B:00 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 15 min (id: 6) 03:3B:01:06 01:3B:00 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 30 min (id: 7) 03:3B:01:07 01:3B:00 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 8 seconds (id: 11) 03:3B:01:0B 01:3B:00 ❌ \\>= v02.10.00 ❌ ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 30 seconds (id: 12) 03:3B:01:0C 01:3B:00 ❌ \\>= v02.10.00 ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 4:3 (id: 0) 03:6C:01:00 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 16:9 (id: 1) 03:6C:01:01 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 8:7 (id: 3) 03:6C:01:03 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 9:16 (id: 4) 03:6C:01:04 02:6C:00 ✔ ❌ ❌ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to wide (id: 0) 03:79:01:00 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to narrow (id: 2) 03:79:01:02 02:79:00 ❌ ❌ ❌ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to superview (id: 3) 03:79:01:03 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear (id: 4) 03:79:01:04 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to max superview (id: 7) 03:79:01:07 02:79:00 ✔ \\>= v02.00.00 ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon leveling (id: 8) 03:79:01:08 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to hyperview (id: 9) 03:79:01:09 02:79:00 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon lock (id: 10) 03:79:01:0A 02:79:00 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to max hyperview (id: 11) 03:79:01:0B 02:79:00 ✔ ❌ ❌ ❌ ❌ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to narrow (id: 19) 03:7A:01:13 02:7A:00 ❌ ❌ ❌ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to max superview (id: 100) 03:7A:01:64 02:7A:00 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to wide (id: 101) 03:7A:01:65 02:7A:00 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to linear (id: 102) 03:7A:01:66 02:7A:00 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to narrow (id: 19) 03:7B:01:13 02:7B:00 ❌ ❌ ❌ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to max superview (id: 100) 03:7B:01:64 02:7B:00 ❌ ❌ ✔ ✔ ❌ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to wide (id: 101) 03:7B:01:65 02:7B:00 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to linear (id: 102) 03:7B:01:66 02:7B:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse video (id: 13) 03:80:01:0D 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse photo (id: 20) 03:80:01:14 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse photo (id: 21) 03:80:01:15 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse video (id: 26) 03:80:01:1A 02:80:00 ✔ ❌ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 60hz (id: 2) 03:86:01:02 02:86:00 ✔ ✔ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 50hz (id: 3) 03:86:01:03 02:86:00 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to off (id: 0) 03:87:01:00 02:87:00 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to low (id: 1) 03:87:01:01 02:87:00 ✔ ✔ ✔ ❌ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to high (id: 2) 03:87:01:02 02:87:00 ❌ ❌ ❌ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to boost (id: 3) 03:87:01:03 02:87:00 ❌ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to auto boost (id: 4) 03:87:01:04 02:87:00 ✔ ✔ ✔ ❌ ❌ 135 Hypersmooth Set video hypersmooth (id: 135) to standard (id: 100) 03:87:01:64 02:87:00 ❌ ❌ ❌ ✔ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to off (id: 0) 03:96:01:00 02:96:00 ❌ \\>= v02.00.00 ✔ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to on (id: 1) 03:96:01:01 02:96:00 ❌ \\>= v02.00.00 ❌ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to locked (id: 2) 03:96:01:02 02:96:00 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to off (id: 0) 03:97:01:00 02:97:00 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to locked (id: 2) 03:97:01:02 02:97:00 ❌ ❌ ✔ ❌ ❌ 162 Max Lens Set max lens (id: 162) to off (id: 0) 03:A2:01:00 02:A2:00 ❌ ❌ ✔ \\>= v01.20.00 ✔ 162 Max Lens Set max lens (id: 162) to on (id: 1) 03:A2:01:01 02:A2:00 ❌ ❌ ✔ \\>= v01.20.00 ✔ 167 Hindsight* Set hindsight (id: 167) to 15 seconds (id: 2) 03:A7:01:02 02:A7:00 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to 30 seconds (id: 3) 03:A7:01:03 02:A7:00 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to off (id: 4) 03:A7:01:04 02:A7:00 ✔ ❌ ✔ ✔ ✔ 171 Interval Set photo single interval (id: 171) to off (id: 0) 03:AB:01:00 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 0.5s (id: 2) 03:AB:01:02 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 1s (id: 3) 03:AB:01:03 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 2s (id: 4) 03:AB:01:04 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 5s (id: 5) 03:AB:01:05 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 10s (id: 6) 03:AB:01:06 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 30s (id: 7) 03:AB:01:07 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 60s (id: 8) 03:AB:01:08 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 120s (id: 9) 03:AB:01:09 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 3s (id: 10) 03:AB:01:0A 02:AB:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to off (id: 0) 03:AC:01:00 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 seconds (id: 1) 03:AC:01:01 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 seconds (id: 2) 03:AC:01:02 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 minute (id: 3) 03:AC:01:03 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 5 minutes (id: 4) 03:AC:01:04 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 minutes (id: 5) 03:AC:01:05 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 minutes (id: 6) 03:AC:01:06 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 hour (id: 7) 03:AC:01:07 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 2 hours (id: 8) 03:AC:01:08 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 3 hours (id: 9) 03:AC:01:09 02:AC:00 ✔ ❌ ❌ ❌ ❌ 173 Video Performance Mode Set video performance mode (id: 173) to maximum video performance (id: 0) 03:AD:01:00 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to extended battery (id: 1) 03:AD:01:01 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to tripod / stationary video (id: 2) 03:AD:01:02 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 175 Controls Set controls (id: 175) to easy (id: 0) 03:AF:01:00 02:AF:00 ✔ ✔ ✔ ❌ ❌ 175 Controls Set controls (id: 175) to pro (id: 1) 03:AF:01:01 02:AF:00 ✔ ✔ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (id: 0) 03:B0:01:00 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (id: 1) 03:B0:01:01 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 2) 03:B0:01:02 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light) (id: 3) 03:B0:01:03 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4) 03:B0:01:04 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt) (id: 5) 03:B0:01:05 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light) (id: 6) 03:B0:01:06 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) 03:B0:01:07 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) 03:B0:01:08 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) 03:B0:01:09 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light, 50hz) (id: 10) 03:B0:01:0A 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11) 03:B0:01:0B 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12) 03:B0:01:0C 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13) 03:B0:01:0D 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14) 03:B0:01:0E 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15) 03:B0:01:0F 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16) 03:B0:01:10 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt) (id: 17) 03:B0:01:11 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt) (id: 18) 03:B0:01:12 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light) (id: 19) 03:B0:01:13 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20) 03:B0:01:14 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21) 03:B0:01:15 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22) 03:B0:01:16 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23) 03:B0:01:17 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (id: 24) 03:B0:01:18 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) 03:B0:01:19 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26) 03:B0:01:1A 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27) 03:B0:01:1B 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 28) 03:B0:01:1C 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 29) 03:B0:01:1D 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 30) 03:B0:01:1E 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 31) 03:B0:01:1F 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 32) 03:B0:01:20 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 33) 03:B0:01:21 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 34) 03:B0:01:22 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 35) 03:B0:01:23 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 36) 03:B0:01:24 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 37) 03:B0:01:25 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 38) 03:B0:01:26 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 39) 03:B0:01:27 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 40) 03:B0:01:28 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 41) 03:B0:01:29 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 42) 03:B0:01:2A 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 43) 03:B0:01:2B 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 44) 03:B0:01:2C 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 45) 03:B0:01:2D 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 46) 03:B0:01:2E 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 47) 03:B0:01:2F 02:B0:00 ✔ ❌ ❌ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to off (id: 0) 03:B1:01:00 02:B1:00 ❌ ❌ ✔ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to on (id: 1) 03:B1:01:01 02:B1:00 ❌ ❌ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 2.4ghz (id: 0) 03:B2:01:00 02:B2:00 ✔ ✔ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 5ghz (id: 1) 03:B2:01:01 02:B2:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to short (id: 1) 03:B3:01:01 02:B3:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to long (id: 2) 03:B3:01:02 02:B3:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to max (id: 3) 03:B3:01:03 02:B3:00 ✔ ✔ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to highest quality (id: 0) 03:B4:01:00 02:B4:00 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (id: 1) 03:B4:01:01 02:B4:00 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (green icon) (id: 101) 03:B4:01:65 02:B4:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 180 Video Mode Set video mode (id: 180) to longest battery (green icon) (id: 102) 03:B4:01:66 02:B4:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to standard (id: 0) 03:B6:01:00 02:B6:00 ✔ ❌ ❌ ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to high (id: 1) 03:B6:01:01 02:B6:00 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 8-bit (id: 0) 03:B7:01:00 02:B7:00 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 10-bit (id: 2) 03:B7:01:02 02:B7:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to standard (id: 0) 03:B8:01:00 02:B8:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to hdr (id: 1) 03:B8:01:01 02:B8:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to log (id: 2) 03:B8:01:02 02:B8:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to widescreen (id: 0) 03:B9:01:00 02:B9:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to mobile (id: 1) 03:B9:01:01 02:B9:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to universal (id: 2) 03:B9:01:02 02:B9:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to highest quality (id: 0) 03:BA:01:00 02:BA:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to standard quality (id: 1) 03:BA:01:01 02:BA:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to basic quality (id: 2) 03:BA:01:02 02:BA:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to timewarp (id: 0) 03:BB:01:00 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to star trails (id: 1) 03:BB:01:01 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to light painting (id: 2) 03:BB:01:02 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to vehicle lights (id: 3) 03:BB:01:03 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max timewarp (id: 4) 03:BB:01:04 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max star trails (id: 5) 03:BB:01:05 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max light painting (id: 6) 03:BB:01:06 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max vehicle lights (id: 7) 03:BB:01:07 02:BB:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to widescreen (id: 0) 03:BC:01:00 02:BC:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to mobile (id: 1) 03:BC:01:01 02:BC:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to universal (id: 2) 03:BC:01:02 02:BC:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to none (id: 0) 03:BD:01:00 02:BD:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 1.0 (id: 1) 03:BD:01:01 02:BD:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 2.0 (id: 2) 03:BD:01:02 02:BD:00 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to off (id: 0) 03:BE:01:00 02:BE:00 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to on (id: 1) 03:BE:01:01 02:BE:00 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to super photo (id: 0) 03:BF:01:00 02:BF:00 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to night photo (id: 1) 03:BF:01:01 02:BF:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0) 03:C0:01:00 02:C0:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1) 03:C0:01:01 02:C0:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3) 03:C0:01:03 02:C0:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to widescreen (id: 0) 03:C1:01:00 02:C1:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to vertical (id: 1) 03:C1:01:01 02:C1:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to full frame (id: 2) 03:C1:01:02 02:C1:00 ✔ ❌ ❌ ❌ ❌ 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. Note about Dependency Ordering and Blacklisting 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. Example Camera Command 1 Command 2 Command 3 Command 4 Command 5 Guaranteed Valid? HERO10 Black Res: 1080 Anti-Flicker: 60Hz (NTSC) FPS: 240 FOV: Wide Hypersmooth: OFF ✔ HERO10 Black FPS: 240 Anti-Flicker: 60Hz (NTSC) 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 Documents Product Release capabilities.xlsx capabilities.json HERO12 Black v01.30.00 v01.20.00 v01.10.00 HERO11 Black Mini v02.30.00 v02.20.00 v02.10.00 v02.00.00 v01.10.00 HERO11 Black v02.12.00 v02.10.00 v02.01.00 v01.20.00 v01.12.00 v01.10.00 HERO10 Black v01.50.00 v01.46.00 v01.42.00 v01.40.00 v01.30.00 v01.20.00 v01.16.00 v01.10.00 HERO9 Black v01.72.00 v01.70.00 Spreadsheet Format 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 Format 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. Below is a simplified example of the capabilities JSON file; a formal schema is also available here: capabilities_schema.json { \"(PRODUCT_NAME)\": { \"(RELEASE_VERSION)\": { \"states\": [ [ {\"setting_name\": \"(str)\", \"setting_id\": (int), \"option_name\": \"(str)\", \"option_id\": (int)}, ... ], ... ], }, ... }, ... } Query The camera provides two basic types of state information: Camera status and settings. Camera status info includes information such as the current preset/mode, whether the system is busy or encoding, remaining sdcard space, etc. Settings info gives the currently selected option for each setting; for example, this includes the current video resolution, frame rate, digital lens (FOV), etc. Queries are sent to to GP-0076 and responses are received on GP-0077. Query Command Format Header/Length Query ID Array of IDs 1-2 bytes 1 byte Variable Length Query Commands Note: omitting :xx:... from any (un)register command will result in being (un)registered for all associated values. Query ID Query Request Notes 0x12 Get setting value(s) nn:12:xx:... nn -> message length xx -> setting ID 0x12 Get all setting values 01:12 0x13 Get status value(s) nn:13:xx:... nn -> message length xx -> status ID 0x13 Get all status values 01:13 0x32 Get available option IDs for setting(s) nn:32:xx:... nn -> message length xx -> setting ID 0x32 Get available option IDs for all settings 01:32 0x52 Register for setting(s) value updates nn:52:xx:... nn -> message length xx -> setting ID 0x53 Register for status value updates nn:53:xx:... nn -> message length xx -> status ID 0x62 Register for available option updates for setting(s) nn:62:xx:... nn -> message length xx -> setting ID 0x72 Unregister for setting updates nn:72:xx:... nn -> message length xx -> setting ID 0x73 Unregister for status updates nn:73:xx:... nn -> message length xx -> status ID 0x82 Unregister for available option updates for setting(s) nn:82:xx:... nn -> message length xx -> setting ID 0x92 Async notification when setting changes 0x93 Async notification when status changes 0xA2 Async notification when available option(s) changed Query Response Format There are two types of response notifications: Type 1: Notfication sent in direct response to a get-value or register command Type 2: Notification sent in response to data changing (must be registered to receive) Message Length Query ID Command Status Status ID Status Value Length Status Value 1-2 bytes 1 byte 1 byte 1 byte 1 byte 1-255 bytes Multi-Value Responses When receiving a query response that contains information about more than one setting/status the Status ID, Status Value Length, and Status Value fields become collectively repeatable. Example: [MESSAGE LENGTH]:[QUERY ID]:[COMMAND STATUS]:[ID1]:[LENGTH1]:[VALUE1]:[ID2]:[LENGTH2]:[VALUE2]:... Query ID in Notifications In order to discern between a Type 1 and a Type 2 response, the camera changes the Query ID for Type 2: Query Query ID in Command Query ID in Notification Register for setting(s) value updates 0x52 0x92 Register for status value updates 0x53 0x93 Register for available option updates for setting(s) 0x62 0xA2 Status IDs Below is a table of supported status IDs. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Status ID Name Description Type Values HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 1 Internal battery present Is the system's internal battery present? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 2 Internal battery level Rough approximation of internal battery level in bars (or charging) integer 0: Zero 1: One 2: Two 3: Three 4: Charging ✔ ✔ ✔ ✔ ✔ 6 System hot Is the system currently overheating? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 8 System busy Is the camera busy? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 9 Quick capture active Is Quick Capture feature enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 10 Encoding active Is the system encoding right now? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 11 Lcd lock active Is LCD lock active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 13 Video progress counter When encoding video, this is the duration (seconds) of the video so far; 0 otherwise integer * ✔ ✔ ✔ ✔ ✔ 17 Enable Are Wireless Connections enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 19 State The pairing state of the camera integer 0: Never Started 1: Started 2: Aborted 3: Cancelled 4: Completed ✔ ✔ ✔ ✔ ✔ 20 Type The last type of pairing that the camera was engaged in integer 0: Not Pairing 1: Pairing App 2: Pairing Remote Control 3: Pairing Bluetooth Device ✔ ✔ ✔ ✔ ✔ 21 Pair time Time (milliseconds) since boot of last successful pairing complete action integer * ❌ ✔ ✔ ✔ ✔ 22 State State of current scan for WiFi Access Points. Appears to only change for CAH-related scans integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 23 Scan time msec The time, in milliseconds since boot that the WiFi Access Point scan completed integer * ✔ ✔ ✔ ✔ ✔ 24 Provision status WiFi AP provisioning state integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 26 Remote control version Wireless remote control version integer * ❌ ✔ ✔ ✔ ✔ 27 Remote control connected Is a wireless remote control connected? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 28 Pairing Wireless Pairing State integer * ❌ ✔ ✔ ✔ ✔ 29 Wlan ssid SSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 30 Ap ssid The camera's WiFi SSID. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 31 App count The number of wireless devices connected to the camera integer * ✔ ✔ ✔ ✔ ✔ 32 Enable Is Preview Stream enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 33 Sd status Primary Storage Status integer -1: Unknown 0: OK 1: SD Card Full 2: SD Card Removed 3: SD Card Format Error 4: SD Card Busy 8: SD Card Swapped ✔ ✔ ✔ ✔ ✔ 34 Remaining photos How many photos can be taken before sdcard is full integer * ✔ ❌ ✔ ✔ ✔ 35 Remaining video time How many minutes of video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 38 Num total photos Total number of photos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 39 Num total videos Total number of videos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 41 Ota status The current status of Over The Air (OTA) update integer 0: Idle 1: Downloading 2: Verifying 3: Download Failed 4: Verify Failed 5: Ready 6: GoPro App: Downloading 7: GoPro App: Verifying 8: GoPro App: Download Failed 9: GoPro App: Verify Failed 10: GoPro App: Ready ✔ ✔ ✔ ✔ ✔ 42 Download cancel request pending Is there a pending request to cancel a firmware update download? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 45 Camera locate active Is locate camera feature active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 49 Multi shot count down The current timelapse interval countdown value (e.g. 5...4...3...2...1...) integer * ✔ ✔ ✔ ✔ ✔ 54 Remaining space Remaining space on the sdcard in Kilobytes integer * ✔ ✔ ✔ ✔ ✔ 55 Supported Is preview stream supported in current recording/mode/secondary-stream? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 56 Wifi bars WiFi signal strength in bars integer * ✔ ✔ ✔ ✔ ✔ 58 Num hilights The number of hilights in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 59 Last hilight time msec Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 60 Next poll msec The min time between camera status updates (msec). Do not poll for status more often than this integer * ✔ ✔ ✔ ✔ ✔ 64 Remaining timelapse time How many min of Timelapse video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 65 Exposure select type Liveview Exposure Select Mode integer 0: Disabled 1: Auto 2: ISO Lock 3: Hemisphere ✔ ❌ ✔ ✔ ✔ 66 Exposure select x Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 67 Exposure select y Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 68 Gps status Does the camera currently have a GPS lock? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 69 Ap state Is the camera in AP Mode? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 70 Internal battery percentage Internal battery level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 74 Acc mic status Microphone Accesstory status integer 0: Microphone mod not connected 1: Microphone mod connected 2: Microphone mod connected and microphone plugged into Microphone mod ✔ ✔ ✔ ✔ ✔ 75 Digital zoom Digital Zoom level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 76 Wireless band Wireless Band integer 0: 2.4 GHz 1: 5 GHz 2: Max ✔ ✔ ✔ ✔ ✔ 77 Digital zoom active Is Digital Zoom feature available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 78 Mobile friendly video Are current video settings mobile friendly? (related to video compression and frame rate) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 79 First time use Is the camera currently in First Time Use (FTU) UI flow? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 81 Band 5ghz avail Is 5GHz wireless band available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 82 System ready Is the system ready to accept commands? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 83 Batt okay for ota Is the internal battery charged sufficiently to start Over The Air (OTA) update? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 85 Video low temp alert Is the camera getting too cold to continue recording? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 86 Actual orientation The rotational orientation of the camera integer 0: 0 degrees (upright) 1: 180 degrees (upside down) 2: 90 degrees (laying on right side) 3: 270 degrees (laying on left side) ✔ ✔ ✔ ✔ ✔ 88 Zoom while encoding Is this camera capable of zooming while encoding (static value based on model, not settings) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 89 Current mode Current flatmode ID integer * ✔ ✔ ✔ ✔ ✔ 93 Active video presets Current Video Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 94 Active photo presets Current Photo Preset (ID) integer * ✔ ❌ ✔ ✔ ✔ 95 Active timelapse presets Current Timelapse Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 96 Active presets group Current Preset Group (ID) integer * ✔ ✔ ✔ ✔ ✔ 97 Active preset Current Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 98 Preset modified Preset Modified Status, which contains an event ID and a preset (group) ID integer * ✔ ✔ ✔ ✔ ✔ 99 Remaining live bursts How many Live Bursts can be captured before sdcard is full integer * ❌ ❌ ✔ ✔ ✔ 100 Num total live bursts Total number of Live Bursts on sdcard integer * ❌ ❌ ✔ ✔ ✔ 101 Capture delay active Is Capture Delay currently active (i.e. counting down)? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 102 Media mod mic status Media mod State integer 0: Media mod microphone removed 2: Media mod microphone only 3: Media mod microphone with external microphone ✔ ✔ ✔ ✔ ✔ 103 Timewarp speed ramp active Time Warp Speed integer 0: 15x 1: 30x 2: 60x 3: 150x 4: 300x 5: 900x 6: 1800x 7: 2x 8: 5x 9: 10x 10: Auto 11: 1x (realtime) 12: 1/2x (slow-motion) ✔ ✔ ✔ ✔ ✔ 104 Linux core active Is the system's Linux core active? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 105 Camera lens type Camera lens type (reflects changes to setting 162 or setting 189) integer 0: Default 1: Max Lens 2: Max Lens 2.0 ✔ ✔ ✔ ✔ ✔ 106 Video hindsight capture active Is Video Hindsight Capture Active? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 107 Scheduled preset Scheduled Capture Preset ID integer * ✔ ❌ ✔ ✔ ✔ 108 Scheduled enabled Is Scheduled Capture set? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 110 Media mod status Media Mode Status (bitmasked) integer 0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False 1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True 2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False 3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True 4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False 5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True 6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False 7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True ✔ ❌ ✔ ✔ ✔ 111 Sd rating check error Does sdcard meet specified minimum write speed? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 112 Sd write speed error Number of sdcard write speed errors since device booted integer * ✔ ✔ ✔ ✔ ❌ 113 Turbo transfer Is Turbo Transfer active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 114 Camera control status Camera control status ID integer 0: Camera Idle: No one is attempting to change camera settings 1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control 2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings ✔ ✔ ✔ ✔ ❌ 115 Usb connected Is the camera connected to a PC via USB? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 116 Allow control over usb Camera control over USB state integer 0: Disabled 1: Enabled ✔ ✔ ✔ \\>= v01.30.00 ❌ 117 Total sd space kb Total SD card capacity in Kilobytes integer * ✔ ✔ ✔ ❌ ❌ Protobuf In order to maximize BLE bandwidth, some messages and their corresponding notifications utilize Google Protobuf (Protocol Buffers). Open GoPro currently uses Protocol Buffers Version 2. Note: All Protobuf messages (i.e. payloads, which are serialized protobuf objects) must be packetized and wrapped with Packet Headers as outlined in this document. Protobuf Message Format Protobuf communications with the camera differ from TLV-style communications. Rather than having a Type, Length, and Value, GoPro protobuf messages utilize the following: Feature ID: Indicates command type (e.g. command, setting, query) Action ID: Specific camera action; value indicates whether message was sent or an (aync) notification was received Value: Serialized protobuf object Requests Sent Message Length Feature ID Action ID Protobuf Bytestream 1-2 bytes 1 byte 1 byte Variable Length Notifications Received Message Length Feature ID Response Action ID Protobuf Bytestream 1-2 bytes 1 byte 1 byte Variable Length See Parsing Responses for details on how to detect and parse a protobuf response. Protobuf IDs Below is a table that links Protobuf Feature/Action IDs together with the UUIDs to write to and Response UUIDs to read notifications from. For additional details, see Services and Characteristics. Feature Feature ID Action IDs UUID Response UUID Network Management 0x02 0x02, 0x03, 0x04, 0x05, 0x0B, 0x0C, 0x82, 0x83, 0x84, 0x85 GP-0091 GP-0092 Command 0xF1 0x65, 0x66, 0x67, 0x69, 0x6B, 0x79, 0xE5, 0xE6, 0xE7, 0xE9, 0xEB, 0xF9 GP-0072 GP-0073 Query 0xF5 0x6E, 0x6F, 0x72, 0x74, 0xEE, 0xEF, 0xF2, 0xF3, 0xF4, 0xF5 GP-0076 GP-0077 Protobuf Commands Below is a table of protobuf commands that can be sent to the camera and their expected response. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Note: Some protobuf commands currently have no fields, which means they serialize into a 0-byte bytestream. For consistency, best practice is to always serialize the protobuf objects regardless of how many fields they define. Feature ID Action ID Response Action ID Description Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 0x02 0x02 0x82 Start scan RequestStartScan ResponseStartScanning ✔ ✔ ✔ ✔ ✔ 0x0B Async status update NotifStartScanning ✔ ✔ ✔ ✔ ✔ 0x03 0x83 Get ap entries RequestGetApEntries ResponseGetApEntries ✔ ✔ ✔ ✔ ✔ 0x04 0x84 Connect RequestConnect ResponseConnect ✔ ✔ ✔ ✔ ✔ 0x0C Async status update ResponseConnect ✔ ✔ ✔ ✔ ✔ 0x05 0x85 Connect new RequestConnectNew ResponseConnectNew ✔ ✔ ✔ ✔ ✔ 0x0C Async status update NotifProvisioningState ✔ ✔ ✔ ✔ ✔ 0xF1 0x65 0xE5 Request cohn setting RequestSetCOHNSetting ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x66 0xE6 Request clear cohn cert RequestClearCOHNCert ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x67 0xE7 Request create cohn cert RequestCreateCOHNCert ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x69 0xE9 Request set camera control status RequestSetCameraControlStatus ResponseGeneric ✔ ✔ ✔ \\>= v01.20.00 ❌ 0x6B 0xEB Request set turbo active RequestSetTurboActive ResponseGeneric ✔ ✔ ✔ ✔ ✔ 0x79 0xF9 Request set live stream RequestSetLiveStreamMode ResponseGeneric ✔ ✔ ✔ ✔ ✔ 0xF5 0x6E 0xEE Request get cohn cert RequestCOHNCert ResponseCOHNCert ✔ ❌ ❌ ❌ ❌ 0x6F 0xEF Request cohn status RequestGetCOHNStatus NotifyCOHNStatus ✔ ❌ ❌ ❌ ❌ 0xEF Async status update NotifyCOHNStatus ✔ ❌ ❌ ❌ ❌ 0x72 0xF2 Request get preset status RequestGetPresetStatus NotifyPresetStatus ✔ ✔ ✔ ✔ ✔ 0xF3 Async status update NotifyPresetStatus ✔ ✔ ✔ ✔ ✔ 0x74 0xF4 Request get live stream status RequestGetLiveStreamStatus NotifyLiveStreamStatus ✔ ✔ ✔ ✔ ✔ 0xF5 Async status update NotifyLiveStreamStatus ✔ ✔ ✔ ✔ ✔ Features Below are details about Open GoPro features. Presets The camera organizes modes of operation into presets. A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. Depending on the camera's state, different collections of presets will be available for immediate loading and use. Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: ID Setting 162 Max Lens 173 Video Performance Mode 175 Controls 177 Enable Night Photo 180 Video Mode 186 Video Mode 187 Lapse Mode 189 Max Lens Mod 190 Max Lens Mod Enable 191 Photo Mode To determine which presets are available for immediate use, get Preset Status. Preset Status All cameras support basic query and subscription mechanics that allow the user to: Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state (Un)register to be notified when a Preset is modified (e.g. resolution changes from 1080p to 4K) or a Preset Group is modified (e.g. presets are reordered/created/deleted) Preset Status should not be confused with camera status: Preset Status contains information about current preset groups and presets Camera status contains numerous statuses about current settings and camera system state Preset Groups Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. Presets Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of Settings associated with the Preset. Important Note: The Preset ID is required to load a Preset via the Presets: Load command. For details on which cameras are supported and how to get Preset Status, see Protobuf Commands. Global Behaviors In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a connected app is discouraged. Best practice for synchronizing user/app control is to use the Set Camera Control Status command and corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera Control Status ID IDLE 0 CONTROL 1 EXTERNAL_CONTROL 2 Set Camera Control Status This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. This causes the camera to immediately exit any contextual menus and return to the idle screen. Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. If the user returns the camera UI to the idle screen, the camera updates control status to Idle. Note: The entity currently claiming control of the camera is advertised in camera status 114 Information about whether the camera is in a contextual menu or not is advertised in camera status 63. For details on which cameras are supported and how to set Camera Control Status, see Protobuf Commands. Interface with Access Points The camera supports connecting to access points in Station Mode (STA). This is necessary for features such as Live Streaming, where the camera needs an Internet connection. While in this mode, HTTP command and control of the camera is not available on some cameras. Scanning for Access Points In order to scan for Access Points, use the flow below. See Protobuf Commands for command details. CentralCentralGP-0091GP-0091GP-0092GP-0092RequestStartScanResponseStartScanningscanning_state: EnumScanning.SCANNING_STARTEDloop[until scanning_state == EnumScanning.SCANNING_SUCCESS]Indicates scan is completeSave scan_id, total_entriesNotifStartScanningRequestGetApEntriesUse scan_id, total_entriesResponseGetApEntriesEach ScanEntry contains SSID, signal strength, freq Scan Results The ResponseGetApEntries message contains information about each discovered device. This information includes the success of the scan, the scan id used in the original request, and a ScanEntry message, whose definition is nested inside ResponseGetApEntries. A ScanEntry includes information about a discovered device including its SSID, relative signal strength, signal frequency, and a bitmasked scan_entry_flags value whose individual bits are defined by EnumScanEntryFlags. Note: When scan_entry_flags contains SCAN_FLAG_CONFIGURED, it is an indication that this network has already been provisioned. Connect to a New Access Point To provision and connect the camera to a new Access Point, use RequestConnectNew. Note: This should only be done once to provision the AP; subsequent connections should use RequestConnect. CentralCentralGP-0091GP-0091GP-0092GP-0092Scan for Access PointsRequestConnectNewResponseConnectNewprovisioning_state: EnumProvisioning.PROVISIONING_STARTEDloop[until provisioning_state == EnumProvisioning.PROVISIONING_SUCCESS_NEW_AP]NotifProvisionState Connect to a Provisioned Access Point To connect the camera to a provisioned Access Point, scan for Access Points and connect using RequestConnect: CentralCentralGP-0091GP-0091GP-0092GP-0092Scan for Access PointsRequestConnectResponseConnectprovisioning_state: EnumProvisioning.PROVISIONING_STARTEDloop[until provisioning_state == EnumProvisioning.PROVISIONING_SUCCESS_NEW_AP]NotifProvisionState Disconnect from an Access Point To disconnect from a connected Access Point and return the camera to AP mode, set AP Control: ON, which disables Station Mode. CentralCentralGP-0072GP-0072GP-0073GP-0073Scan for Access PointsCamera: STA ModeConnect to a New/Provisioned Access Point03:17:01:01AP Mode: ON02:17:00SuccessCamera: AP ModeDisconnected from Access Point Turbo Transfer Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. This is done by temporarily modifying low-level settings in the OS to prioritize WiFi offload speeds. When Turbo Transfer is active, theh camera displays an OSD indicating that media is being transferred in order to prevent the user from inadvertently changing settings or capturing media. Turbo Transfer should only be used during media offload. It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. Developers can query whether the camera is currently in Turbo Transfer Mode from camera status 113. Note: Pressing MODE/POWER or Shutter buttons on the camera will deactivate Turbo Transfer feature. Some cameras are already optimized for WiFi transfer and do not gain additional speed from this feature. For details on which cameras are supported and how to enable and disable Turbo Transfer, see Protobuf Commands. Live Streaming The camera supports the ability to stream to social media platforms such as Twitch, YouTube, Facebook or any other site that accepts RTMP(S) URLs. For additional details about getting started with RTMP, see How to Stream. Overview Live streaming with camera is accomplished as follows: Put the camera into Station Mode and connect it to an access point (see Interface With Access Points) Set the Live Stream Mode Poll for Live Stream Status until the camera indicates it is ready Set the shutter to begin live streaming Unset the shutter to stop live streaming Live Streaming Sequence CentralCentralGP-0091GP-0091GP-0092GP-0092GP-0072GP-0072GP-0073GP-0073GP-0074GP-0074GP-0075GP-0075GP-0076GP-0076GP-0077GP-0077Set live stream modeRequestSetLiveStreamModeResponseGenericPoll Live Stream Status until readyloop[until LIVE_STREAM_STATE_READY]RequestGetLiveStreamStatusNotifyLiveStreamStatusSet desired settingsloop[until Desired camera state attained]Set settingsuccess responseStart live streamingSet shuttersuccess responseStop live streamingUnset shuttersuccess response Set Live Stream Mode Set the live stream mode by sending a RequestSetLiveStreamMode command. Command and enum details are available in Protobuf Comands. Parameter Type Description url string RTMP(S) url used to stream. Set to empty string to invalidate/cancel stream encode bool Whether to encode video to sdcard while streaming or not window_size EnumWindowSize Streaming video resolution minimum_bitrate int32 Desired minimum streaming bitrate (min possible: 800) maximum_bitrate int32 Desired maximum streaming bitrate (max possible: 8000) starting_bitrate int32 Initial streaming bitrate (honored if 800 <= value <= 8000) lens EnumLens Streaming Field of View cert bytes SSL certificate(s) from a trusted Root CA for streaming services that use encryption (RTMPS) Note: For RTMPS, the cert parameter must be provided in PEM format. Get Live Stream Status Current status of the live stream is obtained by sending a RequestGetLiveStreamStatus command to the camera. This command serves two purposes: Get current state of the live stream (Un)register to be notified when live stream state changes Responses and notifications come as a NotifyLiveStreamStatus message with properties outlined in the table below. Command and enum details are available in Protobuf Comands. Parameter Type Description live_stream_status EnumLiveStreamStatus Basic streaming state (idle, ready, streaming, failed, etc) live_stream_error EnumLiveStreamError Error codes for specific streaming errors live_stream_encode bool Whether camera is encoding video to sdcard while encoding or not live_stream_bitrate int32 Current streaming bitrate (Kbps) live_stream_window_size_supported_array EnumWindowSize Defines supported streaming resolutions live_stream_encode_supported bool Does this camera support encoding while streaming? live_stream_max_lens_unsupported bool Does camera lack support for streaming with Max Lens feature? live_stream_minimum_stream_bitrate int32 Minimum possible bitrate (static) (Kbps) live_stream_maximum_stream_bitrate int32 Maximum possible bitrate (static) (Kbps) live_stream_lens_supported bool Does camera support multiple streaming FOVs? live_stream_lens_supported_array EnumLens Defines supported Field of View values Camera On the Home Network (COHN) Some cameras support Camera On the Home Network (COHN). This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. For security purposes, all communications are performed over HTTPS. Camera Supported HERO12 Black ✔ HERO11 Black Mini ❌ HERO11 Black ❌ HERO10 Black ❌ HERO9 Black ❌ In order to use the COHN capability, the camera must first be provisioned for COHN. At a high level, the provisioning process is as follows: Create the COHN certificate Get the COHN certificate Get Basic auth credentials Connect the camera to an access point HTTPS and SSL/TLS Certificates Secure communication with the camera over HTTPS requires two things: A trusted SSL/TLS certificate and Basic auth username/password used in the HTTPS header. SSL/TLS Certificate A provisioned camera has two certificates: A Root CA cert provided to the client, which has a 1 year lifespan A Camera cert, which contains the camera's current IP address on the local network and is signed by the Root CA cert This use of a certificate chain allows the camera's IP address to change (e.g. when DHCP lease expires or when access point is reset/replaced) without the client needing to download and install/trust a new certificate. Provision COHN In order to use COHN for the first time or deauthenticate existing users, the client should clear and then create the COHN cert, get COHN status for basic authorization (username/password) and then connect the camera to an access point. (Re-)Provision COHNclientclientGP-0072(Command)GP-0072(Command)GP-0073(Command Response)GP-0073(Command Response)GP-0076(Query)GP-0076(Query)GP-0077(Query Response)GP-0077(Query Response)Connect camera to access pointRequestGetCOHNStatusNotifyCOHNStatusContains:1. COHN statusalt[NotifyCOHNStatus.status == EnumCOHNState.COHN_PROVISIONED]RequestClearCOHNCert1. Camera disconnects from access point2. Root CA and Camera certs are deletedResponseGeneric[NotifyCOHNStatus.status == EnumCOHNState.COHN_UNPROVISIONED]no-opRequestCreateCOHNCertCamera creates Root CA cert&160;If connected to access point, camera will:1. Create Camera cert2. Sign Camera cert with Root CA certResponseGenericRequestCOHNCertResponseCOHNCertContains:1. Generic result2. Root CA certStore cert for future useRequestGetCOHNStatusNotifyCOHNStatusContains:1. Camera IP address on local network2. Basic auth username/password for HTTPS Verifying COHN Cert is Valid The camera acts as the Root Certificate Authority in creating the COHN certificate (Root CA cert). Clients can verify that the certificate is valid using utilities such as openssl: Example: $ openssl verify -CAfile '/path/to/GoProRootCA.crt' '/path/to/GoProRootCA.crt' GoProRootCA.crt: OK View COHN Cert Details Most operating systems have utilities to view details about a SSL/TLS certificate: MacOS: Right-mouse-click >> Quick Look Windows: Right-mouse-click >> Properties Ubuntu: Right-mouse-click >> Open with View File Commandline: openssl x509 -in /path/to/GoProRootCA.crt -noout -text Communicate via COHN Once the camera is provisioned, the client can communicate with the camera via HTTPS. The camera supports nearly all functionality over HTTPS that it does over HTTP. For more details about HTTP/HTTPS, see the Open GoPro HTTP spec.", + "excerpt": "About This Page This page describes the format, capabilities, and use of Bluetooth Low Energy (BLE) as it pertains to communicating with GoPro cameras. Messages are sent using either TLV or Protobuf format. General Communicating with a GoPro camera via Bluetooth Low Energy involves writing to Bluetooth characteristics and, typically, waiting for a response notification from a corresponding characteristic. The camera organizes its Generic Attribute Profile (GATT) table by broad features: AP control, control & query, etc. Note: All byte ordering is in Big Endian unless otherwise noted. Supported Cameras Below is a table of cameras that support GoPro's public BLE API: Model ID Model Code Marketing Name Minimal Firmware Version 62 H23.01 HERO12 Black v01.10.00 60 H22.03 HERO11 Black Mini v01.10.00 58 H22.01 HERO11 Black v01.10.00 57 H21.01 HERO10 Black v01.10.00 55 HD9.01 HERO9 Black v01.70.00 Services and Characteristics Note: GP-XXXX is shorthand for GoPro's 128-bit UUIDs: b5f9xxxx-aa8d-11e3-9046-0002a5d5c51b Service UUID Service Characteristic UUID Description Permissions GP-0001 GoPro WiFi Access Point GP-0002 WiFi AP SSID Read / Write GP-0003 WiFi AP Password Read / Write GP-0004 WiFi AP Power Write GP-0005 WiFi AP State Read / Indicate GP-0090 GoPro Camera Management GP-0091 Network Management Command Write GP-0092 Network Management Response Notify FEA6 Control & Query GP-0072 Command Write GP-0073 Command Response Notify GP-0074 Settings Write GP-0075 Settings Response Notify GP-0076 Query Write GP-0077 Query Response Notify Packet Headers The Bluetooth Low Energy protocol limits messages to 20 bytes per packet. To accommodate this limitation, GoPro cameras use start packets and continuation packets. If a message is 20 bytes or fewer, it can be sent with a single packet containing the start packet header. If a message is longer than 20 bytes, it must be chunked into multiple packets with the first packet containing a start packet header and subsequent packets containing continuation packet headers. All lengths are in bytes. Packet Header Format Message sending and receiving is accomplished by prepending General (5-bit), Extended (13-bit), Extended (16-bit), or Continuation headers onto each packet depending on the message size. General (5-bit) Messages (Send and Receive) Messages that are 31 bytes or fewer can be sent or received using the following format: Byte 1 7 6 5 4 3 2 1 0 0: Start 00: General Message Length: 5 bits Extended (13-bit) Messages (Send and Receive) Messages that are 8191 bytes or fewer can be sent or received using the following format: Quickstart Tip: Always use Extended (13-bit) packet headers when sending messages to avoid having to work with multiple packet header formats. Byte 1 Byte 2 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 0: Start 01: Extended (13-bit) Message Length: 13 bits Extended (16-bit) Messages (Receive only) If a message is 8192 bytes or longer, the camera will respond using the format below. Note: This format cannot be used for sending messages to the camera. Byte 1 Byte 2 Byte 3 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 0: Start 10: Extended (16-bit) Message Length: 16 bits Continuation Packets (Send and Receive) When sending or receiving a message that is longer than 20 bytes, the message must be split into N packets with packet 1 containing a start packet header and packets 2..N containing a continuation packet header. Note: Counters start at 0x0 and reset after 0xF. Byte 1 7 6 5 4 3 2 1 0 1: Continuation Counter (4-bit) Example: Packetizing a 5-bit General Message Message Length: 17 bytes Message: 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11 Packet Type Byte(s) Description 1 Header 11 (0) start packet (00) 5-bit General message (10001) message length: 17 Payload 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11 Message Example: Packetizing a 13-bit Extended Message Message Length: 50 bytes Message: 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12:13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25:26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32 Packet Type Byte(s) Description 1 Header 20:32 (0) start packet (01) 13-bit Extended message (0000000110010) message length: 50 Payload 01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12 Message (chunk 1 of 3) 2 Header 80 (1) continuation packet (000) ignored (0000) counter: 0 Payload 13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25 Message (chunk 2 of 3) 3 Header 81 (1) continuation packet (000) ignored (0001) counter: 1 Payload 26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32 Message (chunk 3 of 3) Example: Depacketizing a Multi-Packet Message Packets Received: 5 Once the packet headers are identified and removed from each packet, the complete response message can be assembled by concatenating the remaining packet data in the order it was received. Packet Byte(s) Header 1 20:57:01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12 20:57 (0) start packet (01) 13-bit Extended message (0000001010111) message length: 87 2 80:13:14:15:16:17:18:19:1A:1B:1C:1D:1E:1F:20:21:22:23:24:25 80 (1) continuation packet (000) ignored (0000) counter: 0 3 81:26:27:28:29:2A:2B:2C:2D:2E:2F:30:31:32:33:34:35:36:37:38 81 (1) continuation packet (000) ignored (0001) counter: 1 4 82:39:3A:3B:3C:3D:3E:3F:40:41:42:43:44:45:46:47:48:49:4A:4B 82 (1) continuation packet (000) ignored (0010) counter: 2 5 83:4C:4D:4E:4F:50:51:52:53:54:55:56:57 83 (1) continuation packet (000) ignored (0011) counter: 3 Discovery, Connection and Pairing Advertisements The camera will send BLE advertisements while it is ON and for the first 8 hours after the camera is put to sleep. During this time, the camera is discoverable and can be connected to. If the camera is in sleep mode, connecting to it will cause the camera to wake and boot up. Pairing In order to communicate with a GoPro camera via BLE, a client must first be paired with the camera. The pairing procedure must be done once for each new client. If the camera is factory reset, all clients will need to pair again. To pair with the camera, use the UI to put it into pairing mode, connect via BLE and then initiate pairing. The camera will whitelist the client so subsequent connections do not require pairing. Steps Discovery of and connection to the GoPro camera can be done as follows: Put the camera into pairing mode Scan to discover peripherals (which can be narrowed by limiting to peripherals that advertise service FEA6) Connect to the peripheral Finish pairing with the peripheral Discover all advertised services and characteristics Subscribe to notifications from all characteristics that have the notify flag set Sending and Receiving Messages In order to enable two-way communication with a GoPro camera, clients must connect to the camera and subscribe to characteristics that have the notify flag set. Messages are sent to the camera by writing to a write-enabled UUID and then waiting for a notification from the corresponding response UUID. Response notifications indicate whether the message was valid and will be (asynchronously) processed. For example, to send a camera control command, a client should write to GP-0072 and then wait for a response notification from GP-0073. Depending on the camera's state, it may not be ready to accept specific commands. This ready state is dependent on the System Busy and the Encoding Active status flags. For example: System Busy flag is set while loading presets, changing settings, formatting sdcard, ... Encoding Active flag is set while capturing photo/video media If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the System Busy and Encode Active flags to be unset before sending messages other than get status/setting queries. Parsing Responses In order to communicate fully with the camera, the user will need to be able to parse response and event notifications in TLV or Protobuf format as needed. TLV and Protobuf responses have very different formats. Parsing TLV data requires a parser to be written locally. Parsing Protobuf data can be done using code generated from Protobuf files linked in this document. Typically, the camera will send TLV responses/events for commands sent in TLV format and Protobuf responses/events for commands sent in Protobuf format. The pseudocode and flowcharts below refer to the following tables: Protobuf IDs Table Protobuf Commands Table Command Response Format Settings Response Format Query Response Format Pseudocode Below is pseudocode describing how to determine whether a respose is TLV or Protobuf and then parse it appropriately. Camera sends response R (array of bytes) from UUID U (string) with payload P (array of bytes) // Is it a Protobuf response? for each row in the Protobuf IDs table { F (int) = Feature ID A (array of int) = Action IDs if P[0] == F and P[1] in A { R is a protobuf message Match Feature ID P[0] and Action ID P[1] to a Response message in the Protobuf Commands Table Use matched Response message to parse payload into useful data structure Exit } } // Nope. It is a TLV response if U == GP-0072 (Command) { Parse using Command Response Format table } else if U == GP-0074 (Settings) { Parse using Settings Response Format table } else if U == GP-0076 (Query) { Parse using Query Response Format table } Exit Flowchart Below is a flowchart describing how to determine whether a respose is TLV or Protobuf and then parse it appropriately. Receive response RExtract payload P&160;P[0] == Feature ID from row N of Protobuf IDs TableANDP[1] in Action IDs list from row N of Protobuf IDs Table&160;yesnoR is a protobuf messageR is a TLV messageResponse RResponse UUIDR is a Command responseR is a Settings responseR is a Query responseParse accordinglyFeature ID = P[0]Action ID = P[1]Use: Protobuf Commands TableParse using appropriate protobuf messageKnowledge!GP-0072(Control)GP-0076(Query)GP-0074(Settings)TLV messageProtobuf message Keep Alive In order to maximize battery life, GoPro cameras automatically go to sleep after some time. This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support and a Keep Alive message that the user can regularly send to the camera. The camera will automatically go to sleep if both timers reach zero. The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or programmatically (un)sets the shutter, sets a setting, or loads a Preset. The Keep Alive timer is reset when the user sends a keep alive message. The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages every 3.0 seconds after a connection is established. Command UUID Write Response UUID Response GP-0074 03:5B:01:42 GP-0075 02:5B:00 Limitations HERO12 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO11 Black Mini The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO11 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO10 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HERO9 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings General Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds. In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode). Type Length Value GoPro's BLE protocol comes in two flavors: TLV (Type Length Value) and Protobuf. This section describes TLV style messaging. Note: All TLV messages (payloads) must be packetized and wrapped with Packet Headers as outlined in this document. Commands The table below contains command IDs supported by Open GoPro. Command messages are sent to GP-0072 and responses/notifications are received on GP-0073. Command ID Description 0x01 Set shutter 0x05 Sleep 0x0D Set Date/Time 0x0E Get Date/Time 0x0F Set Local Date/Time 0x10 Get Local Date/Time 0x17 AP Control 0x18 Media: HiLight Moment 0x3C Get Hardware Info 0x3E Presets: Load Group 0x40 Presets: Load 0x50 Analytics 0x51 Open GoPro Command Format Header/Length Command ID Parameter Length Parameter Value 1-2 bytes 1 byte 1 byte Variable length Command Response The GoPro camera sends responses to most commands received, indicating whether the command was valid and will be processed or not. Unless indicated otherwise in the Quick Reference table below, command responses use the format below. Command Response Format Header/Length Command ID Response Code Response 1-2 bytes 1 byte 1 byte Variable length Command Response Error Codes Error Code Description 0 Success 1 Error 2 Invalid Parameter 3..255 Reserved Commands Quick Reference Below is a table of commands that can be sent to the camera and how to send them. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ ID Command Description Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 0x01 Set shutter Shutter: off 03:01:01:00 02:01:00 ✔ ✔ ✔ ✔ ✔ 0x01 Set shutter Shutter: on 03:01:01:01 02:01:00 ✔ ✔ ✔ ✔ ✔ 0x05 Sleep Put camera to sleep 01:05 02:05:00 ✔ ✔ ✔ ✔ ✔ 0x0D Set Date/Time Set date/time to 2023-01-31 03:04:05 09:0D:07:07:E7:01:1F:03:04:05 02:0D:00 ✔ ✔ ✔ ✔ ✔ 0x0E Get Date/Time Get date/time 01:0E Complex ✔ ✔ ✔ ✔ ✔ 0x0F Set Local Date/Time Set local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on) 0C:0F:0A:07:E7:01:1F:03:04:05:FF:88:01 02:0F:00 ✔ ✔ ✔ ❌ ❌ 0x10 Get Local Date/Time Get local date/time 01:10 Complex ✔ ✔ ✔ ❌ ❌ 0x17 AP Control Ap mode: off 03:17:01:00 02:17:00 ✔ ✔ ✔ ✔ ✔ 0x17 AP Control Ap mode: on 03:17:01:01 02:17:00 ✔ ✔ ✔ ✔ ✔ 0x18 Media: HiLight Moment Hilight moment during encoding 01:18 02:18:00 ✔ ✔ ✔ ✔ ✔ 0x3C Get Hardware Info Get camera hardware info 01:3C Complex ✔ ✔ ✔ ✔ ✔ 0x3E Presets: Load Group Video 04:3E:02:03:E8 02:3E:00 ✔ ✔ ✔ ✔ ✔ 0x3E Presets: Load Group Photo 04:3E:02:03:E9 02:3E:00 ✔ ❌ ✔ ✔ ✔ 0x3E Presets: Load Group Timelapse 04:3E:02:03:EA 02:3E:00 ✔ ❌ ✔ ✔ ✔ 0x40 Presets: Load Example preset id: 0x1234ABCD 06:40:04:12:34:AB:CD 02:40:00 ✔ ✔ ✔ ✔ ✔ 0x50 Analytics Set third party client 01:50 02:50:00 ✔ ✔ ✔ ✔ ✔ 0x51 Open GoPro Get version 01:51 Complex ✔ ✔ ✔ ✔ ✔ Complex Command Inputs Set Local Date/Time The timezone is a two byte UTC offset in minutes and must be sent in Two's Complement form. Complex Command Responses Below are clarifications for complex camera responses Get Hardware Info Response Packet Response Byte(s) Description 1 20 Start packet 51 Response length 3C:00 Command 3C sent successfully 04 Length of model number 00:00:00:37 Model ID 0B Length of model id 48:45:52:4F:58:20:42:6C:61:63 \"HEROX Blac\" 2 80 Continuation packet 6B \"k\" 04 Length of board type 30:78:30:35 \"0x05\" 0F Length of firmware version 48:44:58:2E:58:58:2E:58:58:2E:58:58 \"HDX.XX.XX.XX\" 3 81 Continuation packet (1) 2E:58:58 \".XX\" 0E Length of serial number 58:58:58:58:58:58:58:58:58:58:58:58:58:58 \"XXXXXXXXXXXXXX\" 0A Length of AP SSID 4 82 Continuation packet (2) 47:50:32:34:35:30:58:58:58:58 \"GP2450XXXX\" 0C AP MAC Address length 58:58:58:58:58:58:58:58 \"XXXXXXXX\" 5 83 Continuation packet (3) 58:58:58:58 \"XXXX\" Open GoPro Version Given the response 06:51:00:01:01:01:00, the Open GoPro version would be vXX.YY. Response Byte(s) Description 06 Packet length 51 Command ID 00 Status (OK) 01 Length of major version 01 Major version: 1 01 Length of minor version 00 Minor version: 0 Get Date/Time Given the response 0B:0E:00:08:07:E5:01:02:03:04:05:06, the date/time would be 2022-01-02 03:04:05 (Saturday). Response Byte(s) Description 0B Packet length 0E Command ID 00 Status (OK) 08 Date length (bytes) 07:E6 Year 01 Month 02 Day 03 Hour 04 Minute 05 Second 06 Day of the week (Sun=0, Sat=6) Get Local Date/Time (with Timezone and DST) Given the response 0D:10:00:0A:07:E6:01:02:03:04:05:FE:20:01, the date/time would be 2022-01-02 03:04:05-0800 (DST: ON). Response Byte(s) Description 0D Packet length 10 Command ID 00 Status (OK) 0A Date length (bytes) 07:E6 Year 01 Month 02 Day 03 Hour 04 Minute 05 Second FE:20 UTC offset in minutes (Two's Complement) 01 DST: ON Settings GoPro settings can be configured using the GP-Settings (GP-0074) UUID. Setting status is returned on GP-Settings-Status (GP-0075) UUID. Settings Request Format This will configure a setting on the camera. Only one setting may be sent on a packet (GATT notify or write-no-response), although multiple packets may be sent back-to-back. Request Length Setting ID Setting Value Length Setting Value 1-2 bytes 1 byte 1 byte (variable length) Settings Response Format Response Length Setting ID Response Code 1 byte 1 byte 1 byte Settings Quick Reference All settings are sent to UUID GP-0074. All values are hexadecimal and length are in bytes. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Setting ID Setting Option Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 2 Resolution Set video resolution (id: 2) to 4k (id: 1) 03:02:01:01 02:02:00 \\>= v02.00.00 ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k (id: 4) 03:02:01:04 02:02:00 \\>= v02.00.00 ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 6) 03:02:01:06 02:02:00 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 1440 (id: 7) 03:02:01:07 02:02:00 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 1080 (id: 9) 03:02:01:09 02:02:00 \\>= v02.00.00 ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 18) 03:02:01:12 02:02:00 \\>= v02.00.00 ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 5k (id: 24) 03:02:01:18 02:02:00 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 5k 4:3 (id: 25) 03:02:01:19 02:02:00 ❌ ❌ ❌ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 8:7 (id: 26) 03:02:01:1A 02:02:00 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 4:3 (id: 27) 03:02:01:1B 02:02:00 ❌ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 8:7 (id: 28) 03:02:01:1C 02:02:00 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 9:16 (id: 29) 03:02:01:1D 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 9:16 (id: 30) 03:02:01:1E 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k (id: 100) 03:02:01:64 02:02:00 \\>= v02.00.00 ✔ ✔ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 16:9 (id: 101) 03:02:01:65 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 16:9 (id: 102) 03:02:01:66 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 103) 03:02:01:67 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 16:9 (id: 104) 03:02:01:68 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 105) 03:02:01:69 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 16:9 (id: 106) 03:02:01:6A 02:02:00 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k (id: 107) 03:02:01:6B 02:02:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k (id: 108) 03:02:01:6C 02:02:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k (id: 109) 03:02:01:6D 02:02:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 (id: 110) 03:02:01:6E 02:02:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k (id: 111) 03:02:01:6F 02:02:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 3 Frames Per Second Set video fps (id: 3) to 240 (id: 0) 03:03:01:00 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 120 (id: 1) 03:03:01:01 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 100 (id: 2) 03:03:01:02 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 60 (id: 5) 03:03:01:05 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 50 (id: 6) 03:03:01:06 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 30 (id: 8) 03:03:01:08 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 25 (id: 9) 03:03:01:09 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 24 (id: 10) 03:03:01:0A 02:03:00 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 200 (id: 13) 03:03:01:0D 02:03:00 ✔ ✔ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to never (id: 0) 03:3B:01:00 01:3B:00 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 1 min (id: 1) 03:3B:01:01 01:3B:00 ✔ \\>= v02.10.00 \\>= v02.01.00 ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 5 min (id: 4) 03:3B:01:04 01:3B:00 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 15 min (id: 6) 03:3B:01:06 01:3B:00 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 30 min (id: 7) 03:3B:01:07 01:3B:00 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 8 seconds (id: 11) 03:3B:01:0B 01:3B:00 ❌ \\>= v02.10.00 ❌ ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 30 seconds (id: 12) 03:3B:01:0C 01:3B:00 ❌ \\>= v02.10.00 ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 4:3 (id: 0) 03:6C:01:00 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 16:9 (id: 1) 03:6C:01:01 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 8:7 (id: 3) 03:6C:01:03 02:6C:00 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 9:16 (id: 4) 03:6C:01:04 02:6C:00 ✔ ❌ ❌ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to wide (id: 0) 03:79:01:00 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to narrow (id: 2) 03:79:01:02 02:79:00 ❌ ❌ ❌ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to superview (id: 3) 03:79:01:03 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear (id: 4) 03:79:01:04 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to max superview (id: 7) 03:79:01:07 02:79:00 ✔ \\>= v02.00.00 ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon leveling (id: 8) 03:79:01:08 02:79:00 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to hyperview (id: 9) 03:79:01:09 02:79:00 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon lock (id: 10) 03:79:01:0A 02:79:00 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to max hyperview (id: 11) 03:79:01:0B 02:79:00 ✔ ❌ ❌ ❌ ❌ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to narrow (id: 19) 03:7A:01:13 02:7A:00 ❌ ❌ ❌ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to max superview (id: 100) 03:7A:01:64 02:7A:00 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to wide (id: 101) 03:7A:01:65 02:7A:00 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to linear (id: 102) 03:7A:01:66 02:7A:00 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to narrow (id: 19) 03:7B:01:13 02:7B:00 ❌ ❌ ❌ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to max superview (id: 100) 03:7B:01:64 02:7B:00 ❌ ❌ ✔ ✔ ❌ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to wide (id: 101) 03:7B:01:65 02:7B:00 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to linear (id: 102) 03:7B:01:66 02:7B:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse video (id: 13) 03:80:01:0D 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse photo (id: 20) 03:80:01:14 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse photo (id: 21) 03:80:01:15 02:80:00 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse video (id: 26) 03:80:01:1A 02:80:00 ✔ ❌ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 60hz (id: 2) 03:86:01:02 02:86:00 ✔ ✔ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 50hz (id: 3) 03:86:01:03 02:86:00 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to off (id: 0) 03:87:01:00 02:87:00 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to low (id: 1) 03:87:01:01 02:87:00 ✔ ✔ ✔ ❌ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to high (id: 2) 03:87:01:02 02:87:00 ❌ ❌ ❌ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to boost (id: 3) 03:87:01:03 02:87:00 ❌ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to auto boost (id: 4) 03:87:01:04 02:87:00 ✔ ✔ ✔ ❌ ❌ 135 Hypersmooth Set video hypersmooth (id: 135) to standard (id: 100) 03:87:01:64 02:87:00 ❌ ❌ ❌ ✔ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to off (id: 0) 03:96:01:00 02:96:00 ❌ \\>= v02.00.00 ✔ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to on (id: 1) 03:96:01:01 02:96:00 ❌ \\>= v02.00.00 ❌ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to locked (id: 2) 03:96:01:02 02:96:00 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to off (id: 0) 03:97:01:00 02:97:00 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to locked (id: 2) 03:97:01:02 02:97:00 ❌ ❌ ✔ ❌ ❌ 162 Max Lens Set max lens (id: 162) to off (id: 0) 03:A2:01:00 02:A2:00 ❌ ❌ ✔ \\>= v01.20.00 ✔ 162 Max Lens Set max lens (id: 162) to on (id: 1) 03:A2:01:01 02:A2:00 ❌ ❌ ✔ \\>= v01.20.00 ✔ 167 Hindsight* Set hindsight (id: 167) to 15 seconds (id: 2) 03:A7:01:02 02:A7:00 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to 30 seconds (id: 3) 03:A7:01:03 02:A7:00 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to off (id: 4) 03:A7:01:04 02:A7:00 ✔ ❌ ✔ ✔ ✔ 171 Interval Set photo single interval (id: 171) to off (id: 0) 03:AB:01:00 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 0.5s (id: 2) 03:AB:01:02 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 1s (id: 3) 03:AB:01:03 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 2s (id: 4) 03:AB:01:04 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 5s (id: 5) 03:AB:01:05 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 10s (id: 6) 03:AB:01:06 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 30s (id: 7) 03:AB:01:07 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 60s (id: 8) 03:AB:01:08 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 120s (id: 9) 03:AB:01:09 02:AB:00 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 3s (id: 10) 03:AB:01:0A 02:AB:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to off (id: 0) 03:AC:01:00 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 seconds (id: 1) 03:AC:01:01 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 seconds (id: 2) 03:AC:01:02 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 minute (id: 3) 03:AC:01:03 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 5 minutes (id: 4) 03:AC:01:04 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 minutes (id: 5) 03:AC:01:05 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 minutes (id: 6) 03:AC:01:06 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 hour (id: 7) 03:AC:01:07 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 2 hours (id: 8) 03:AC:01:08 02:AC:00 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 3 hours (id: 9) 03:AC:01:09 02:AC:00 ✔ ❌ ❌ ❌ ❌ 173 Video Performance Mode Set video performance mode (id: 173) to maximum video performance (id: 0) 03:AD:01:00 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to extended battery (id: 1) 03:AD:01:01 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to tripod / stationary video (id: 2) 03:AD:01:02 02:AD:00 ❌ ❌ ❌ \\>= v01.16.00 ❌ 175 Controls Set controls (id: 175) to easy (id: 0) 03:AF:01:00 02:AF:00 ✔ ✔ ✔ ❌ ❌ 175 Controls Set controls (id: 175) to pro (id: 1) 03:AF:01:01 02:AF:00 ✔ ✔ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (id: 0) 03:B0:01:00 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (id: 1) 03:B0:01:01 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 2) 03:B0:01:02 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (low light) (id: 3) 03:B0:01:03 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt.) (id: 4) 03:B0:01:04 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt.) (id: 5) 03:B0:01:05 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (ext. batt.) (low light) (id: 6) 03:B0:01:06 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) 03:B0:01:07 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) 03:B0:01:08 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) 03:B0:01:09 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (low light) (id: 10) 03:B0:01:0A 02:B0:00 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (ext. batt.) (id: 11) 03:B0:01:0B 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (ext. batt.) (id: 12) 03:B0:01:0C 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (ext. batt.) (low light) (id: 13) 03:B0:01:0D 02:B0:00 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt.) (id: 14) 03:B0:01:0E 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (ext. batt.) (id: 15) 03:B0:01:0F 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt.) (id: 16) 03:B0:01:10 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt.) (id: 17) 03:B0:01:11 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt.) (id: 18) 03:B0:01:12 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (long. batt.) (low light) (id: 19) 03:B0:01:13 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (long. batt.) (id: 20) 03:B0:01:14 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (long. batt.) (id: 21) 03:B0:01:15 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (id: 22) 03:B0:01:16 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (id: 23) 03:B0:01:17 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (id: 24) 03:B0:01:18 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) 03:B0:01:19 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (50hz) (id: 26) 03:B0:01:1A 02:B0:00 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k) (50hz) (id: 27) 03:B0:01:1B 02:B0:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (low light) (vertical) (id: 28) 03:B0:01:1C 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (low light) (vertical) (id: 29) 03:B0:01:1D 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (vertical) (id: 30) 03:B0:01:1E 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (vertical) (id: 31) 03:B0:01:1F 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (full frame) (low light) (id: 32) 03:B0:01:20 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (full frame) (low light) (id: 33) 03:B0:01:21 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (full frame) (id: 34) 03:B0:01:22 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (full frame) (id: 35) 03:B0:01:23 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (low light) (id: 36) 03:B0:01:24 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (50hz) (low light) (id: 37) 03:B0:01:25 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (2.7k) (low light) (id: 38) 03:B0:01:26 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (2.7k) (50hz) (low light) (id: 39) 03:B0:01:27 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (2.7k) (id: 40) 03:B0:01:28 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (2.7k) (50hz) (id: 41) 03:B0:01:29 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt.) (vertical) (id: 42) 03:B0:01:2A 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (vertical) (id: 43) 03:B0:01:2B 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (long. batt.) (low light) (vertical) (id: 44) 03:B0:01:2C 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (vertical) (id: 45) 03:B0:01:2D 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (full frame) (low light) (id: 46) 03:B0:01:2E 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (50hz) (full frame) (low light) (id: 47) 03:B0:01:2F 02:B0:00 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (v2) (id: 100) 03:B0:01:64 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (v2) (id: 101) 03:B0:01:65 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (v2) (id: 102) 03:B0:01:66 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (low light) (v2) (id: 103) 03:B0:01:67 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (v2) (id: 104) 03:B0:01:68 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (v2) (id: 105) 03:B0:01:69 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (v2) (id: 106) 03:B0:01:6A 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (low light) (v2) (id: 107) 03:B0:01:6B 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt.) (v2) (id: 108) 03:B0:01:6C 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt.) (v2) (id: 109) 03:B0:01:6D 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt.) (v2) (id: 110) 03:B0:01:6E 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (long. batt.) (low light) (v2) (id: 111) 03:B0:01:6F 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (long. batt.) (v2) (id: 112) 03:B0:01:70 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (long. batt.) (v2) (id: 113) 03:B0:01:71 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (v2) (id: 114) 03:B0:01:72 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (v2) (id: 115) 03:B0:01:73 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (v2) (id: 116) 03:B0:01:74 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (50hz) (v2) (id: 117) 03:B0:01:75 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (low light) (v2) (vertical) (id: 118) 03:B0:01:76 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (low light) (v2) (vertical) (id: 119) 03:B0:01:77 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (v2) (vertical) (id: 120) 03:B0:01:78 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (v2) (vertical) (id: 121) 03:B0:01:79 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (full frame) (low light) (v2) (id: 122) 03:B0:01:7A 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (full frame) (low light) (v2) (id: 123) 03:B0:01:7B 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (full frame) (v2) (id: 124) 03:B0:01:7C 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (full frame) (v2) (id: 125) 03:B0:01:7D 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (low light) (v2) (id: 126) 03:B0:01:7E 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (50hz) (low light) (v2) (id: 127) 03:B0:01:7F 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (2.7k) (low light) (v2) (id: 128) 03:B0:01:80 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (2.7k) (50hz) (low light) (v2) (id: 129) 03:B0:01:81 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (2.7k) (v2) (id: 130) 03:B0:01:82 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (2.7k) (50hz) (v2) (id: 131) 03:B0:01:83 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt.) (v2) (vertical) (id: 132) 03:B0:01:84 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (v2) (vertical) (id: 133) 03:B0:01:85 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (long. batt.) (low light) (v2) (vertical) (id: 134) 03:B0:01:86 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (v2) (vertical) (id: 135) 03:B0:01:87 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (full frame) (low light) (v2) (id: 136) 03:B0:01:88 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed (4k) (50hz) (full frame) (low light) (v2) (id: 137) 03:B0:01:89 02:B0:00 \\>= v02.00.00 ❌ ❌ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to off (id: 0) 03:B1:01:00 02:B1:00 ❌ ❌ ✔ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to on (id: 1) 03:B1:01:01 02:B1:00 ❌ ❌ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 2.4ghz (id: 0) 03:B2:01:00 02:B2:00 ✔ ✔ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 5ghz (id: 1) 03:B2:01:01 02:B2:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to short (id: 1) 03:B3:01:01 02:B3:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to long (id: 2) 03:B3:01:02 02:B3:00 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to max (id: 3) 03:B3:01:03 02:B3:00 ✔ ✔ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to highest quality (id: 0) 03:B4:01:00 02:B4:00 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (id: 1) 03:B4:01:01 02:B4:00 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (green icon) (id: 101) 03:B4:01:65 02:B4:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 180 Video Mode Set video mode (id: 180) to longest battery (green icon) (id: 102) 03:B4:01:66 02:B4:00 ❌ ❌ \\>= v02.01.00 ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to standard (id: 0) 03:B6:01:00 02:B6:00 ✔ ❌ ❌ ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to high (id: 1) 03:B6:01:01 02:B6:00 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 8-bit (id: 0) 03:B7:01:00 02:B7:00 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 10-bit (id: 2) 03:B7:01:02 02:B7:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to standard (id: 0) 03:B8:01:00 02:B8:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to hdr (id: 1) 03:B8:01:01 02:B8:00 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to log (id: 2) 03:B8:01:02 02:B8:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to widescreen (id: 0) 03:B9:01:00 02:B9:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to mobile (id: 1) 03:B9:01:01 02:B9:00 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to universal (id: 2) 03:B9:01:02 02:B9:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to highest quality (id: 0) 03:BA:01:00 02:BA:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to standard quality (id: 1) 03:BA:01:01 02:BA:00 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to basic quality (id: 2) 03:BA:01:02 02:BA:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to timewarp (id: 0) 03:BB:01:00 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to star trails (id: 1) 03:BB:01:01 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to light painting (id: 2) 03:BB:01:02 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to vehicle lights (id: 3) 03:BB:01:03 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max timewarp (id: 4) 03:BB:01:04 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max star trails (id: 5) 03:BB:01:05 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max light painting (id: 6) 03:BB:01:06 02:BB:00 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max vehicle lights (id: 7) 03:BB:01:07 02:BB:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to widescreen (id: 0) 03:BC:01:00 02:BC:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to mobile (id: 1) 03:BC:01:01 02:BC:00 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to universal (id: 2) 03:BC:01:02 02:BC:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to none (id: 0) 03:BD:01:00 02:BD:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 1.0 (id: 1) 03:BD:01:01 02:BD:00 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 2.0 (id: 2) 03:BD:01:02 02:BD:00 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to off (id: 0) 03:BE:01:00 02:BE:00 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to on (id: 1) 03:BE:01:01 02:BE:00 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to super photo (id: 0) 03:BF:01:00 02:BF:00 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to night photo (id: 1) 03:BF:01:01 02:BF:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0) 03:C0:01:00 02:C0:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1) 03:C0:01:01 02:C0:00 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3) 03:C0:01:03 02:C0:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to widescreen (id: 0) 03:C1:01:00 02:C1:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to vertical (id: 1) 03:C1:01:01 02:C1:00 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to full frame (id: 2) 03:C1:01:02 02:C1:00 ✔ ❌ ❌ ❌ ❌ 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. Note about Dependency Ordering and Blacklisting 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. Example Camera Command 1 Command 2 Command 3 Command 4 Command 5 Guaranteed Valid? HERO10 Black Res: 1080 Anti-Flicker: 60Hz (NTSC) FPS: 240 FOV: Wide Hypersmooth: OFF ✔ HERO10 Black FPS: 240 Anti-Flicker: 60Hz (NTSC) 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 Documents Product Release capabilities.xlsx capabilities.json HERO12 Black v02.00.00 v01.30.00 v01.20.00 v01.10.00 HERO11 Black Mini v02.30.00 v02.20.00 v02.10.00 v02.00.00 v01.10.00 HERO11 Black v02.12.00 v02.10.00 v02.01.00 v01.20.00 v01.12.00 v01.10.00 HERO10 Black v01.50.00 v01.46.00 v01.42.00 v01.40.00 v01.30.00 v01.20.00 v01.16.00 v01.10.00 HERO9 Black v01.72.00 v01.70.00 Spreadsheet Format 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 Format 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. Below is a simplified example of the capabilities JSON file; a formal schema is also available here: capabilities_schema.json { \"(PRODUCT_NAME)\": { \"(RELEASE_VERSION)\": { \"states\": [ [ {\"setting_name\": \"(str)\", \"setting_id\": (int), \"option_name\": \"(str)\", \"option_id\": (int)}, ... ], ... ], }, ... }, ... } Query The camera provides two basic types of state information: Camera status and settings. Camera status info includes information such as the current preset/mode, whether the system is busy or encoding, remaining sdcard space, etc. Settings info gives the currently selected option for each setting; for example, this includes the current video resolution, frame rate, digital lens (FOV), etc. Queries are sent to to GP-0076 and responses are received on GP-0077. Query Command Format Header/Length Query ID Array of IDs 1-2 bytes 1 byte Variable Length Query Commands Note: omitting :xx:... from any (un)register command will result in being (un)registered for all associated values. Query ID Query Request Notes 0x12 Get setting value(s) nn:12:xx:... nn -> message length xx -> setting ID 0x12 Get all setting values 01:12 0x13 Get status value(s) nn:13:xx:... nn -> message length xx -> status ID 0x13 Get all status values 01:13 0x32 Get available option IDs for setting(s) nn:32:xx:... nn -> message length xx -> setting ID 0x32 Get available option IDs for all settings 01:32 0x52 Register for setting(s) value updates nn:52:xx:... nn -> message length xx -> setting ID 0x53 Register for status value updates nn:53:xx:... nn -> message length xx -> status ID 0x62 Register for available option updates for setting(s) nn:62:xx:... nn -> message length xx -> setting ID 0x72 Unregister for setting updates nn:72:xx:... nn -> message length xx -> setting ID 0x73 Unregister for status updates nn:73:xx:... nn -> message length xx -> status ID 0x82 Unregister for available option updates for setting(s) nn:82:xx:... nn -> message length xx -> setting ID 0x92 Async notification when setting changes 0x93 Async notification when status changes 0xA2 Async notification when available option(s) changed Query Response Format There are two types of response notifications: Type 1: Notfication sent in direct response to a get-value or register command Type 2: Notification sent in response to data changing (must be registered to receive) Message Length Query ID Command Status Status ID Status Value Length Status Value 1-2 bytes 1 byte 1 byte 1 byte 1 byte 1-255 bytes Multi-Value Responses When receiving a query response that contains information about more than one setting/status the Status ID, Status Value Length, and Status Value fields become collectively repeatable. Example: [MESSAGE LENGTH]:[QUERY ID]:[COMMAND STATUS]:[ID1]:[LENGTH1]:[VALUE1]:[ID2]:[LENGTH2]:[VALUE2]:... Query ID in Notifications In order to discern between a Type 1 and a Type 2 response, the camera changes the Query ID for Type 2: Query Query ID in Command Query ID in Notification Register for setting(s) value updates 0x52 0x92 Register for status value updates 0x53 0x93 Register for available option updates for setting(s) 0x62 0xA2 Status IDs Below is a table of supported status IDs. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Status ID Name Description Type Values HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 1 Internal battery present Is the system's internal battery present? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 2 Internal battery level Rough approximation of internal battery level in bars (or charging) integer 0: Zero 1: One 2: Two 3: Three 4: Charging ✔ ✔ ✔ ✔ ✔ 6 System hot Is the system currently overheating? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 8 System busy Is the camera busy? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 9 Quick capture active Is Quick Capture feature enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 10 Encoding active Is the system encoding right now? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 11 Lcd lock active Is LCD lock active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 13 Video progress counter When encoding video, this is the duration (seconds) of the video so far; 0 otherwise integer * ✔ ✔ ✔ ✔ ✔ 17 Enable Are Wireless Connections enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 19 State The pairing state of the camera integer 0: Never Started 1: Started 2: Aborted 3: Cancelled 4: Completed ✔ ✔ ✔ ✔ ✔ 20 Type The last type of pairing that the camera was engaged in integer 0: Not Pairing 1: Pairing App 2: Pairing Remote Control 3: Pairing Bluetooth Device ✔ ✔ ✔ ✔ ✔ 21 Pair time Time (milliseconds) since boot of last successful pairing complete action integer * ❌ ✔ ✔ ✔ ✔ 22 State State of current scan for WiFi Access Points. Appears to only change for CAH-related scans integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 23 Scan time msec The time, in milliseconds since boot that the WiFi Access Point scan completed integer * ✔ ✔ ✔ ✔ ✔ 24 Provision status WiFi AP provisioning state integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 26 Remote control version Wireless remote control version integer * ❌ ✔ ✔ ✔ ✔ 27 Remote control connected Is a wireless remote control connected? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 28 Pairing Wireless Pairing State integer * ❌ ✔ ✔ ✔ ✔ 29 Wlan ssid SSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 30 Ap ssid The camera's WiFi SSID. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 31 App count The number of wireless devices connected to the camera integer * ✔ ✔ ✔ ✔ ✔ 32 Enable Is Preview Stream enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 33 Sd status Primary Storage Status integer -1: Unknown 0: OK 1: SD Card Full 2: SD Card Removed 3: SD Card Format Error 4: SD Card Busy 8: SD Card Swapped ✔ ✔ ✔ ✔ ✔ 34 Remaining photos How many photos can be taken before sdcard is full integer * ✔ ❌ ✔ ✔ ✔ 35 Remaining video time How many minutes of video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 38 Num total photos Total number of photos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 39 Num total videos Total number of videos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 41 Ota status The current status of Over The Air (OTA) update integer 0: Idle 1: Downloading 2: Verifying 3: Download Failed 4: Verify Failed 5: Ready 6: GoPro App: Downloading 7: GoPro App: Verifying 8: GoPro App: Download Failed 9: GoPro App: Verify Failed 10: GoPro App: Ready ✔ ✔ ✔ ✔ ✔ 42 Download cancel request pending Is there a pending request to cancel a firmware update download? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 45 Camera locate active Is locate camera feature active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 49 Multi shot count down The current timelapse interval countdown value (e.g. 5...4...3...2...1...) integer * ✔ ✔ ✔ ✔ ✔ 54 Remaining space Remaining space on the sdcard in Kilobytes integer * ✔ ✔ ✔ ✔ ✔ 55 Supported Is preview stream supported in current recording/mode/secondary-stream? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 56 Wifi bars WiFi signal strength in bars integer * ✔ ✔ ✔ ✔ ✔ 58 Num hilights The number of hilights in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 59 Last hilight time msec Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 60 Next poll msec The min time between camera status updates (msec). Do not poll for status more often than this integer * ✔ ✔ ✔ ✔ ✔ 64 Remaining timelapse time How many min of Timelapse video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 65 Exposure select type Liveview Exposure Select Mode integer 0: Disabled 1: Auto 2: ISO Lock 3: Hemisphere ✔ ❌ ✔ ✔ ✔ 66 Exposure select x Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 67 Exposure select y Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 68 Gps status Does the camera currently have a GPS lock? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 69 Ap state Is the camera in AP Mode? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 70 Internal battery percentage Internal battery level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 74 Acc mic status Microphone Accesstory status integer 0: Microphone mod not connected 1: Microphone mod connected 2: Microphone mod connected and microphone plugged into Microphone mod ✔ ✔ ✔ ✔ ✔ 75 Digital zoom Digital Zoom level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 76 Wireless band Wireless Band integer 0: 2.4 GHz 1: 5 GHz 2: Max ✔ ✔ ✔ ✔ ✔ 77 Digital zoom active Is Digital Zoom feature available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 78 Mobile friendly video Are current video settings mobile friendly? (related to video compression and frame rate) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 79 First time use Is the camera currently in First Time Use (FTU) UI flow? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 81 Band 5ghz avail Is 5GHz wireless band available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 82 System ready Is the system ready to accept commands? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 83 Batt okay for ota Is the internal battery charged sufficiently to start Over The Air (OTA) update? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 85 Video low temp alert Is the camera getting too cold to continue recording? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 86 Actual orientation The rotational orientation of the camera integer 0: 0 degrees (upright) 1: 180 degrees (upside down) 2: 90 degrees (laying on right side) 3: 270 degrees (laying on left side) ✔ ✔ ✔ ✔ ✔ 88 Zoom while encoding Is this camera capable of zooming while encoding (static value based on model, not settings) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 89 Current mode Current flatmode ID integer * ✔ ✔ ✔ ✔ ✔ 93 Active video presets Current Video Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 94 Active photo presets Current Photo Preset (ID) integer * ✔ ❌ ✔ ✔ ✔ 95 Active timelapse presets Current Timelapse Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 96 Active presets group Current Preset Group (ID) integer * ✔ ✔ ✔ ✔ ✔ 97 Active preset Current Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 98 Preset modified Preset Modified Status, which contains an event ID and a preset (group) ID integer * ✔ ✔ ✔ ✔ ✔ 99 Remaining live bursts How many Live Bursts can be captured before sdcard is full integer * ❌ ❌ ✔ ✔ ✔ 100 Num total live bursts Total number of Live Bursts on sdcard integer * ❌ ❌ ✔ ✔ ✔ 101 Capture delay active Is Capture Delay currently active (i.e. counting down)? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 102 Media mod mic status Media mod State integer 0: Media mod microphone removed 2: Media mod microphone only 3: Media mod microphone with external microphone ✔ ✔ ✔ ✔ ✔ 103 Timewarp speed ramp active Time Warp Speed integer 0: 15x 1: 30x 2: 60x 3: 150x 4: 300x 5: 900x 6: 1800x 7: 2x 8: 5x 9: 10x 10: Auto 11: 1x (realtime) 12: 1/2x (slow-motion) ✔ ✔ ✔ ✔ ✔ 104 Linux core active Is the system's Linux core active? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 105 Camera lens type Camera lens type (reflects changes to setting 162 or setting 189) integer 0: Default 1: Max Lens 2: Max Lens 2.0 ✔ ✔ ✔ ✔ ✔ 106 Video hindsight capture active Is Video Hindsight Capture Active? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 107 Scheduled preset Scheduled Capture Preset ID integer * ✔ ❌ ✔ ✔ ✔ 108 Scheduled enabled Is Scheduled Capture set? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 110 Media mod status Media Mode Status (bitmasked) integer 0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False 1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True 2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False 3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True 4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False 5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True 6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False 7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True ✔ ❌ ✔ ✔ ✔ 111 Sd rating check error Does sdcard meet specified minimum write speed? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 112 Sd write speed error Number of sdcard write speed errors since device booted integer * ✔ ✔ ✔ ✔ ❌ 113 Turbo transfer Is Turbo Transfer active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 114 Camera control status Camera control status ID integer 0: Camera Idle: No one is attempting to change camera settings 1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control 2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings ✔ ✔ ✔ ✔ ❌ 115 Usb connected Is the camera connected to a PC via USB? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 116 Allow control over usb Camera control over USB state integer 0: Disabled 1: Enabled ✔ ✔ ✔ \\>= v01.30.00 ❌ 117 Total sd space kb Total SD card capacity in Kilobytes integer * ✔ ✔ ✔ ❌ ❌ Protobuf In order to maximize BLE bandwidth, some messages and their corresponding notifications utilize Google Protobuf (Protocol Buffers). Open GoPro currently uses Protocol Buffers Version 2. Note: All Protobuf messages (i.e. payloads, which are serialized protobuf objects) must be packetized and wrapped with Packet Headers as outlined in this document. Protobuf Message Format Protobuf communications with the camera differ from TLV-style communications. Rather than having a Type, Length, and Value, GoPro protobuf messages utilize the following: Feature ID: Indicates command type (e.g. command, setting, query) Action ID: Specific camera action; value indicates whether message was sent or an (aync) notification was received Value: Serialized protobuf object Requests Sent Message Length Feature ID Action ID Protobuf Bytestream 1-2 bytes 1 byte 1 byte Variable Length Notifications Received Message Length Feature ID Response Action ID Protobuf Bytestream 1-2 bytes 1 byte 1 byte Variable Length See Parsing Responses for details on how to detect and parse a protobuf response. Protobuf IDs Below is a table that links Protobuf Feature/Action IDs together with the UUIDs to write to and Response UUIDs to read notifications from. For additional details, see Services and Characteristics. Feature Feature ID Action IDs UUID Response UUID Network Management 0x02 0x02, 0x03, 0x04, 0x05, 0x0B, 0x0C, 0x82, 0x83, 0x84, 0x85 GP-0091 GP-0092 Command 0xF1 0x64, 0x65, 0x66, 0x67, 0x69, 0x6B, 0x79, 0xE4, 0xE5, 0xE6, 0xE7, 0xE9, 0xEB, 0xF9 GP-0072 GP-0073 Query 0xF5 0x6D, 0x6E, 0x6F, 0x72, 0x74, 0xED, 0xEE, 0xEF, 0xF2, 0xF3, 0xF4, 0xF5 GP-0076 GP-0077 Protobuf Commands Below is a table of protobuf commands that can be sent to the camera and their expected response. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Note: Some protobuf commands currently have no fields, which means they serialize into a 0-byte bytestream. For consistency, best practice is to always serialize the protobuf objects regardless of how many fields they define. Feature ID Action ID Response Action ID Description Request Response HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 0x02 0x02 0x82 Start scan RequestStartScan ResponseStartScanning ✔ ✔ ✔ ✔ ✔ 0x0B Async status update NotifStartScanning ✔ ✔ ✔ ✔ ✔ 0x03 0x83 Get ap entries RequestGetApEntries ResponseGetApEntries ✔ ✔ ✔ ✔ ✔ 0x04 0x84 Connect RequestConnect ResponseConnect ✔ ✔ ✔ ✔ ✔ 0x0C Async status update ResponseConnect ✔ ✔ ✔ ✔ ✔ 0x05 0x85 Connect new RequestConnectNew ResponseConnectNew ✔ ✔ ✔ ✔ ✔ 0x0C Async status update NotifProvisioningState ✔ ✔ ✔ ✔ ✔ 0xF1 0x64 0xE4 Request preset update custom RequestCustomPresetUpdate ResponseGeneric \\>= v02.00.00 ❌ ❌ ❌ ❌ 0x65 0xE5 Request cohn setting RequestSetCOHNSetting ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x66 0xE6 Request clear cohn cert RequestClearCOHNCert ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x67 0xE7 Request create cohn cert RequestCreateCOHNCert ResponseGeneric ✔ ❌ ❌ ❌ ❌ 0x69 0xE9 Request set camera control status RequestSetCameraControlStatus ResponseGeneric ✔ ✔ ✔ \\>= v01.20.00 ❌ 0x6B 0xEB Request set turbo active RequestSetTurboActive ResponseGeneric ✔ ✔ ✔ ✔ ✔ 0x79 0xF9 Request set live stream RequestSetLiveStreamMode ResponseGeneric ✔ ✔ ✔ ✔ ✔ 0xF5 0x6D 0xED Request get last media RequestGetLastCapturedMedia ResponseLastCapturedMedia \\>= v02.00.00 ❌ ❌ ❌ ❌ 0x6E 0xEE Request get cohn cert RequestCOHNCert ResponseCOHNCert ✔ ❌ ❌ ❌ ❌ 0x6F 0xEF Request cohn status RequestGetCOHNStatus NotifyCOHNStatus ✔ ❌ ❌ ❌ ❌ 0xEF Async status update NotifyCOHNStatus ✔ ❌ ❌ ❌ ❌ 0x72 0xF2 Request get preset status RequestGetPresetStatus NotifyPresetStatus ✔ ✔ ✔ ✔ ✔ 0xF3 Async status update NotifyPresetStatus ✔ ✔ ✔ ✔ ✔ 0x74 0xF4 Request get live stream status RequestGetLiveStreamStatus NotifyLiveStreamStatus ✔ ✔ ✔ ✔ ✔ 0xF5 Async status update NotifyLiveStreamStatus ✔ ✔ ✔ ✔ ✔ Features Below are details about Open GoPro features. Presets The camera organizes modes of operation into presets. A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. Depending on the camera's state, different collections of presets will be available for immediate loading and use. Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: ID Setting 162 Max Lens 173 Video Performance Mode 175 Controls 177 Enable Night Photo 180 Video Mode 186 Video Mode 187 Lapse Mode 189 Max Lens Mod 190 Max Lens Mod Enable 191 Photo Mode To determine which presets are available for immediate use, get Preset Status. Preset Status All cameras support basic query and subscription mechanics that allow the user to: Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state (Un)register to be notified when a Preset is modified (e.g. resolution changes from 1080p to 4K) or a Preset Group is modified (e.g. presets are reordered/created/deleted) Preset Status should not be confused with camera status: Preset Status contains information about current preset groups and presets Camera status contains numerous statuses about current settings and camera system state Preset Groups Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. Presets Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of Settings associated with the Preset. Important Note: The Preset ID is required to load a Preset via the Presets: Load command. Custom Preset Update The Custom Preset Update feature allows the user to update the title and icon of custom presets. The feature includes the following capabilities: Change icon to preexisting value defined in EnumPresetIcon Change title to preexisting value defined in EnumPresetTitle Use custom title (string) Expectations: Custom titles must be between 1 and 16 characters (inclusive) No special characters outside of the following languages: English, French, Italian, German, Spanish, Portuguese, Swedish, Russian When setting a custom name, the title_id field must be 94 (or \"PRESET_TITLE_USER_DEFINED_CUSTOM_NAME\") Fields with unchanged values may be omitted (e.g. if only updating icon_id, custom_name and title_id can be omitted) For details on which per-camera command support, see Protobuf Commands. Global Behaviors In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a connected app is discouraged. Best practice for synchronizing user/app control is to use the Set Camera Control Status command and corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera Control Status ID IDLE 0 CONTROL 1 EXTERNAL_CONTROL 2 Set Camera Control Status This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. This causes the camera to immediately exit any contextual menus and return to the idle screen. Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. If the user returns the camera UI to the idle screen, the camera updates control status to Idle. Note: The entity currently claiming control of the camera is advertised in camera status 114 Information about whether the camera is in a contextual menu or not is advertised in camera status 63. For details on which cameras are supported and how to set Camera Control Status, see Protobuf Commands. Interface with Access Points The camera supports connecting to access points in Station Mode (STA). This is necessary for features such as Live Streaming, where the camera needs an Internet connection. While in this mode, HTTP command and control of the camera is not available on some cameras. Scanning for Access Points In order to scan for Access Points, use the flow below. See Protobuf Commands for command details. CentralCentralGP-0091GP-0091GP-0092GP-0092RequestStartScanResponseStartScanningscanning_state: EnumScanning.SCANNING_STARTEDloop[until scanning_state == EnumScanning.SCANNING_SUCCESS]Indicates scan is completeSave scan_id, total_entriesNotifStartScanningRequestGetApEntriesUse scan_id, total_entriesResponseGetApEntriesEach ScanEntry contains SSID, signal strength, freq Scan Results The ResponseGetApEntries message contains information about each discovered device. This information includes the success of the scan, the scan id used in the original request, and a ScanEntry message, whose definition is nested inside ResponseGetApEntries. A ScanEntry includes information about a discovered device including its SSID, relative signal strength, signal frequency, and a bitmasked scan_entry_flags value whose individual bits are defined by EnumScanEntryFlags. Note: When scan_entry_flags contains SCAN_FLAG_CONFIGURED, it is an indication that this network has already been provisioned. Connect to a New Access Point To provision and connect the camera to a new Access Point, use RequestConnectNew. Note: This should only be done once to provision the AP; subsequent connections should use RequestConnect. CentralCentralGP-0091GP-0091GP-0092GP-0092Scan for Access PointsRequestConnectNewResponseConnectNewprovisioning_state: EnumProvisioning.PROVISIONING_STARTEDloop[until provisioning_state == EnumProvisioning.PROVISIONING_SUCCESS_NEW_AP]NotifProvisionState Connect to a Provisioned Access Point To connect the camera to a provisioned Access Point, scan for Access Points and connect using RequestConnect: CentralCentralGP-0091GP-0091GP-0092GP-0092Scan for Access PointsRequestConnectResponseConnectprovisioning_state: EnumProvisioning.PROVISIONING_STARTEDloop[until provisioning_state == EnumProvisioning.PROVISIONING_SUCCESS_NEW_AP]NotifProvisionState Disconnect from an Access Point To disconnect from a connected Access Point and return the camera to AP mode, set AP Control: ON, which disables Station Mode. CentralCentralGP-0072GP-0072GP-0073GP-0073Scan for Access PointsCamera: STA ModeConnect to a New/Provisioned Access Point03:17:01:01AP Mode: ON02:17:00SuccessCamera: AP ModeDisconnected from Access Point Turbo Transfer Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. This is done by temporarily modifying low-level settings in the OS to prioritize WiFi offload speeds. When Turbo Transfer is active, theh camera displays an OSD indicating that media is being transferred in order to prevent the user from inadvertently changing settings or capturing media. Turbo Transfer should only be used during media offload. It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. Developers can query whether the camera is currently in Turbo Transfer Mode from camera status 113. Note: Pressing MODE/POWER or Shutter buttons on the camera will deactivate Turbo Transfer feature. Some cameras are already optimized for WiFi transfer and do not gain additional speed from this feature. For details on which cameras are supported and how to enable and disable Turbo Transfer, see Protobuf Commands. Live Streaming The camera supports the ability to stream to social media platforms such as Twitch, YouTube, Facebook or any other site that accepts RTMP(S) URLs. For additional details about getting started with RTMP, see How to Stream. Overview Live streaming with camera is accomplished as follows: Put the camera into Station Mode and connect it to an access point (see Interface With Access Points) Set the Live Stream Mode Poll for Live Stream Status until the camera indicates it is ready Set the shutter to begin live streaming Unset the shutter to stop live streaming Live Streaming Sequence CentralCentralGP-0091GP-0091GP-0092GP-0092GP-0072GP-0072GP-0073GP-0073GP-0074GP-0074GP-0075GP-0075GP-0076GP-0076GP-0077GP-0077Set live stream modeRequestSetLiveStreamModeResponseGenericPoll Live Stream Status until readyloop[until LIVE_STREAM_STATE_READY]RequestGetLiveStreamStatusNotifyLiveStreamStatusSet desired settingsloop[until Desired camera state attained]Set settingsuccess responseStart live streamingSet shuttersuccess responseStop live streamingUnset shuttersuccess response Set Live Stream Mode Set the live stream mode by sending a RequestSetLiveStreamMode command. Command and enum details are available in Protobuf Comands. Parameter Type Description url string RTMP(S) url used to stream. Set to empty string to invalidate/cancel stream encode bool Whether to encode video to sdcard while streaming or not window_size EnumWindowSize Streaming video resolution minimum_bitrate int32 Desired minimum streaming bitrate (min possible: 800) maximum_bitrate int32 Desired maximum streaming bitrate (max possible: 8000) starting_bitrate int32 Initial streaming bitrate (honored if 800 <= value <= 8000) lens EnumLens Streaming Field of View cert bytes SSL certificate(s) from a trusted Root CA for streaming services that use encryption (RTMPS) Note: For RTMPS, the cert parameter must be provided in PEM format. Get Live Stream Status Current status of the live stream is obtained by sending a RequestGetLiveStreamStatus command to the camera. This command serves two purposes: Get current state of the live stream (Un)register to be notified when live stream state changes Responses and notifications come as a NotifyLiveStreamStatus message with properties outlined in the table below. Command and enum details are available in Protobuf Comands. Parameter Type Description live_stream_status EnumLiveStreamStatus Basic streaming state (idle, ready, streaming, failed, etc) live_stream_error EnumLiveStreamError Error codes for specific streaming errors live_stream_encode bool Whether camera is encoding video to sdcard while encoding or not live_stream_bitrate int32 Current streaming bitrate (Kbps) live_stream_window_size_supported_array EnumWindowSize Defines supported streaming resolutions live_stream_encode_supported bool Does this camera support encoding while streaming? live_stream_max_lens_unsupported bool Does camera lack support for streaming with Max Lens feature? live_stream_minimum_stream_bitrate int32 Minimum possible bitrate (static) (Kbps) live_stream_maximum_stream_bitrate int32 Maximum possible bitrate (static) (Kbps) live_stream_lens_supported bool Does camera support multiple streaming FOVs? live_stream_lens_supported_array EnumLens Defines supported Field of View values Camera On the Home Network (COHN) Some cameras support Camera On the Home Network (COHN). This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. For security purposes, all communications are performed over HTTPS. Camera Supported HERO12 Black ✔ HERO11 Black Mini ❌ HERO11 Black ❌ HERO10 Black ❌ HERO9 Black ❌ In order to use the COHN capability, the camera must first be provisioned for COHN. At a high level, the provisioning process is as follows: Create the COHN certificate Get the COHN certificate Get Basic auth credentials Connect the camera to an access point HTTPS and SSL/TLS Certificates Secure communication with the camera over HTTPS requires two things: A trusted SSL/TLS certificate and Basic auth username/password used in the HTTPS header. SSL/TLS Certificate A provisioned camera has two certificates: A Root CA cert provided to the client, which has a 1 year lifespan A Camera cert, which contains the camera's current IP address on the local network and is signed by the Root CA cert This use of a certificate chain allows the camera's IP address to change (e.g. when DHCP lease expires or when access point is reset/replaced) without the client needing to download and install/trust a new certificate. Provision COHN In order to use COHN for the first time or deauthenticate existing users, the client should clear and then create the COHN cert, get COHN status for basic authorization (username/password) and then connect the camera to an access point. (Re-)Provision COHNclientclientGP-0072(Command)GP-0072(Command)GP-0073(Command Response)GP-0073(Command Response)GP-0076(Query)GP-0076(Query)GP-0077(Query Response)GP-0077(Query Response)Connect camera to access pointRequestGetCOHNStatusNotifyCOHNStatusContains:1. COHN statusalt[NotifyCOHNStatus.status == EnumCOHNState.COHN_PROVISIONED]RequestClearCOHNCert1. Camera disconnects from access point2. Root CA and Camera certs are deletedResponseGeneric[NotifyCOHNStatus.status == EnumCOHNState.COHN_UNPROVISIONED]no-opRequestCreateCOHNCertCamera creates Root CA cert&160;If connected to access point, camera will:1. Create Camera cert2. Sign Camera cert with Root CA certResponseGenericRequestCOHNCertResponseCOHNCertContains:1. Generic result2. Root CA certStore cert for future useRequestGetCOHNStatusNotifyCOHNStatusContains:1. Camera IP address on local network2. Basic auth username/password for HTTPS Verifying COHN Cert is Valid The camera acts as the Root Certificate Authority in creating the COHN certificate (Root CA cert). Clients can verify that the certificate is valid using utilities such as openssl: Example: $ openssl verify -CAfile '/path/to/GoProRootCA.crt' '/path/to/GoProRootCA.crt' GoProRootCA.crt: OK View COHN Cert Details Most operating systems have utilities to view details about a SSL/TLS certificate: MacOS: Right-mouse-click >> Quick Look Windows: Right-mouse-click >> Properties Ubuntu: Right-mouse-click >> Open with View File Commandline: openssl x509 -in /path/to/GoProRootCA.crt -noout -text Communicate via COHN Once the camera is provisioned, the client can communicate with the camera via HTTPS. The camera supports nearly all functionality over HTTPS that it does over HTTP. For more details about HTTP/HTTPS, see the Open GoPro HTTP spec.", "categories": [], "tags": [], "url": "/OpenGoPro/ble_2_0#" }, - { - "title": "Demos: ", - "excerpt": "Bash Over the Air Firmware Update Demo A bash script to perform an over-the-air (OTA) firmware update C Cpp GoPro C/C++ Demos Two C / C++ demos to send media commands and start/stop the preview GoPro Low Latency Stream Demo Low latency webcam/preview stream Csharp GoProCSharpSample A C demo for discovering, pairing, connecting and controlling a camera CSharp Webcam Demo A C demo to demonstrate webcam functionality Python Multi Webcam A python demo for configuring and viewing multiple webcams from one computing device Open GoPro Python SDK A Python package to easily exercise the Open GoPro API’s + CLI’s for taking pictures, videos, etc Swift Swift Enable WiFi Demo A swift demo for discovering, connecting and enabling Wi-Fi on a GoPro camera", - "categories": [], - "tags": [], - "url": "/OpenGoPro/demos#" - }, { "title": "FAQ and Known Issues: ", "excerpt": "Frequently Asked Questions (FAQ) If you have somehow stumbled here first, note that there are specifications, demos, and tutorials which expand upon much of the information here. These can be found, among other places, from the home page. Connectivity What is the distance from the camera that BLE will still work? It is standard Bluetooth 4.0 range and it depends on external factors such as: Interference: anything interfering with the signal will shorten the range. The type of device that the camera is connected to: BT classification distinguishes 3 device classes based on their power levels. Depending on the class of the connected device, the range varies from less than 10 meters to 100 meters. Can I connect using WiFi only? Theoretically yes, if you already know the SSID, password, and the camera’s WiFi AP has been enabled. However, practically no because BLE is required in order to discover this information and configure the AP. Can I connect using BLE only? Yes, however there is some functionality that is not possible over BLE such as accessing the media list and downloading files. How to allow third-party devices to automatically discover close-by GoPro cameras? Devices can only be discovered via BLE by scanning for advertising GoPro cameras Multi Camera Setups How many devices can connect to the camera? Simultaneously, only one device can connect at a time. However, the camera stores BLE security keys and other connection information so it is possible to connect multiple devices sequentially. Is there currently a way to connect multiple cameras on the same Wifi network? No. Cameras can only be connected through Wi-Fi by becoming an access point itself (generating its own Wi-Fi network), not as a peripheral. What is the time offset between multiple cameras executing the same command? In cases when camera sync is important, we recommend using the USB connection, which minimizes the variance among devices. The time drift among cameras connected by USB cable to the same host will be up to ~35ms. Using BLE for that purpose will further increase it. Is there a way to precisely time sync cameras so the footage can be aligned during post-processing? The cameras set their time via GPS. By default, the camera seeks GPS at the beginning of every session, but this can be hindered by typical limitations of GPS signals. Additionally, there are two advanced options that require GoPro Labs firmware installed on the camera. The best bet is multi-cam GPS sync. Another option is precise time calibration via a dynamic QR scan from a smartphone or PC. Streaming What are the differences between the streaming options for GoPros? There are currently 3 different options on how to stream out of GoPro cameras. They are available either via Wi-Fi, USB, or both.   : Wifi :   : USB :       ViewFinder Preview LiveStream ViewFinder Preview Webcam Preview Webcam Orientation Floating or Fixed Landscape facing up Floating or Fixed Landscape: Floating or Fixed Landscape: Floating or Fixed Streaming Protocol UDP (MPEG-TS) RTMP UDP (MPEG-TS) UDP (MPEG-TS) UDP (MPEG-TS) Connection Protocol Wifi - AP Mode WiFi - STA Mode NCM NCM NCM Resolution 480p, 720p 480p, 720p, 1080p 480p, 720p 720p, 1080p 720p, 1080p Frame Rate 30 30 30 30 30 Bitrate 2.5 - 4 mbps 0.8 - 8 mbps 2.5 - 4 mbps 6 mbps 6 mbps \\   depending on model configurable depending on model     Stabilization Basic Stabilization HyperSmooth or none Basic Stabilization None None Image Quality Basic Same as recorded content Basic Basic Same as recorded content Minimum Latency 210 ms > 100ms (un-stabilized) 210 ms 210 ms 210 ms \\     > 1,100ms (stabilized)       Audio None Stereo None None None Max Stream Time 150 minutes (720p on fully 85 minutes (720p on fully Unlimited (with external Unlimited(with external Unlimited (with external\\   charged Enduro battery) charged Enduro battery) power via USB) power via USB) power via USB How to achieve low latency feed streaming onto displays? The stream has a minimum latency of about 210ms. If you are seeing latency higher than that, we often find that as a result of using off-the-shelf libraries like ffmpeg which adds its own buffering. For preview and framing use cases, we don’t recommend using the live streaming RTMP protocol because it adds unnecessary steps in the pipeline, and puts the camera in the streaming preset, which offers little other control. A low latency streaming demo is available in the demos. How do I minimize latency of video preview with FFPLAY? FFPLAY by default will buffer remote streams. You can minimize the buffer using: --no-cache (receiving side) `-fflags nobuffer” (sender). However, the best latency can be achieved by building your own pipeline or ffmpegs library for decoding the bytes. Users should be able to achieve about 200-300 ms latency on the desktop and possibly optimize lower than that. How to view the video stream in VLC? To view the stream in VLC, you need to open network stream udp://@0.0.0.0:8554. You will still see latency because VLC uses its own caching. Power What are the power requirements for GoPro if connected over USB? All cameras have minimum power requirements, as specified here. As long as the power is supplied, cameras will be fully functional with or without an internal battery. Removing the battery and running on USB power alone will improve thermal performance and runtime. If you are seeing issues with insufficient power and have a charger with correct specs, the problems likely stem from low quality cables or low-quality adapters that are not able to consistently provide advertised amperage. We have encountered USB-C cables manufactured with poor quality control that transfer enough power only when their connectors face one side up, but not the other. We recommend using only high-quality components that deliver the correct power output How to enable automatic power on and off in wired setups? Cameras cannot be switched on remotely over USB, or “woken up” remotely after they “go to sleep”. The best workaround for this is via the GoPro Labs firmware that forces the camera to automatically switch on as soon as it detects USB power and switch off when the powering stops. Refer to the WAKE command here. Metadata Can I use the GPS track from the camera in real time? No. The GPS track on the camera as well as other metadata is not available until the file is written and saved. If the objective is to add metadata to the stream, currently the only option is to pull GPS data from another device (phone, wearable,… ) and sync it to the video feed. What can be accessed in the metadata file? Metadata exists as a proprietary GPMF (GoPro Metadata Format) and can be extracted from the file via API commands separately for GPS, Telemetry data, or the entire metadata container. The following data points can be extracted: Camera settings (Exposure time, ISO, Sensor Gain, White balance) Date and Time IMU: GPS, gyroscope, and accelerometer Smile detection Audio levels Face detection in bounding boxes Scene Classifiers (water, urban, vegetation, snow, beach, indoor) Is there a way to change the file names or otherwise classify my video file? Currently there are two options to do that, and both require GoPro Labs firmware. The stock firmware doesn’t provide that option. With GoPro Labs installed, you can either inject metadata into the file (and extract it later with the GPMF parser) or use custom naming for the file. Is there a way to add time stamps to the video files and mark specific moments? Open GoPro users can add time stamped markers, called “Hilights”, to flag specific moments in the video. Hilights can be injected into the video in the real time and then extracted for analytics or other post-processing purposes. The same Hilights are used in GoPro’s auto-editing engine Quik to determine the most interesting moments in the video. General Which cameras are supported by Open GoPro? The answer at a high level is >= Hero 9. However, there are also certain firmware requirements. For a complete answer, see the Specification. Camera Logic Do commands operate as priority-wise or time-related? The cameras use first-in, first-out logic. Is there an option to send the commands in cyclic format instead of sending requests for each command? If you want to receive information asynchronously, it is possible via registering for BLE notifications. See an example (tracking battery) in the Python SDK. Troubleshooting If you are able to consistently reproduce a problem, please file a bug on Github Issues Why is the camera not advertising? If you have not yet paired to the camera with the desired device, then you need to first set the camera into pairing mode (Connections->Connect Device->Quick App). If you have already paired, then the camera should be advertising and ready to connect. If it is not advertising, it is possible you are already connected to it from a previous session. To be sure, power cycle both the camera and the peer device. Workaround for intermittent Wifi AP Connection failure On >= Hero 11, try disabling and then re-enabling the camera’s Wifi AP using the AP Control BLE Command Known Issues Relevant to All Supported Cameras Webcam does not enter idle mode once plugged in The webcam status will be wrongly reported as IDLE instead of OFF after a new USB connection. The best workaround for this is to call Webcam Start followed by Webcam Stop after connecting USB in order to make the webcam truly IDLE and thus willing to accept setting changes. Intermittent failure to connect to the cameras Wifi Access Point On rare occasions, connections to the camera’s Wifi AP will continuously fail until the camera is reset. It is possible to workaround this as described in Troubleshooting Spurious Protobuf Notifications sent once camera is connected in Station mode Once the camera has been connected in station mode (STA), it will start sending protobuf notifications with action ID 0xFF. These should be ignored. Hero 11 (v01.10.00) Specific Wired Communication is broken after update mode This is fixed by Resetting Connections and then re-pairing.", @@ -22,10 +15,10 @@ var store = [ }, { "title": "HTTP Specification v2.0: ", - "excerpt": "Overview The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera. What can you do with the GoPro API? The GoPro API allows you to control and query the camera: Capture photo/video media Get media list Change settings Get and set the date/time Get camera status Get media metadata (file size, width, height, duration, tags, etc) and more! Supported Cameras Below is a table of cameras that support GoPro's public HTTP API: Model ID Model Code Marketing Name Minimal Firmware Version 62 H23.01 HERO12 Black v01.10.00 60 H22.03 HERO11 Black Mini v01.10.00 58 H22.01 HERO11 Black v01.10.00 57 H21.01 HERO10 Black v01.10.00 55 HD9.01 HERO9 Black v01.70.00 The Basics Connection WiFi Connection to the camera via WiFi requires that the camera's WiFi Access Point be enabled. This can be done by connecting to the camera via Bluetooth Low Energy (BLE) and sending a command to enable AP Mode. USB OpenGoPro systems that utilize USB must support the Network Control Model (NCM) protocol. Connecting via USB requires the following steps: Physically connect the camera's USB-C port to your system Send HTTP command to enable wired USB control Authentication WiFi Once the WiFi Access Point has been turned on, authentication with the camera simply requires connecting with the correct SSID and password. This information can be obtained in two ways: Put the camera into pairing mode and tap the info button in the top-right corner of the screen. Read the SSID/password directly via Bluetooth Low Energy. See Services and Characteristics section in BLE Specification for details. USB No authentication is necessary. Socket Address WiFi The socket address for WiFi connections is 10.5.5.9:8080. USB The socket address for USB connections is 172.2X.1YZ.51:8080 where: X is the 100's digit from the camera serial number Y is the 10's digit from the camera serial number Z is the 1's digit from the camera serial number The camera's serial number can be obtained in any of the following ways: Reading the sticker inside the camera's battery enclosure Camera UI: Preferences >> About >> Camera Info Bluetooth Low Energy: By reading directly from Hardware Info For example, if the camera's serial number is C0000123456789, the IP address for USB connections would be 172.27.189.51. Alternatively, the IP address can be discovered via mDNS as the camera registers the _gopro-web service. Request and Response Formats Most commands are sent via HTTP/GET and require no special headers. Responses come in two parts: The standard HTTP return codes and JSON containing any additional information. The typical use case is that the camera accepts a valid command, returns HTTP/200 (OK) and empty JSON (i.e. { }) and begins asynchronously working on the command. If an error occurs, the camera will return a standard HTTP error code and JSON with helpful error/debug information. Depending on the command sent, the camera can return JSON, binary, or Protobuf data. Some examples are listed below: Command Return Type Get Camera State JSON Get Media Info JSON Get Media GPMF Binary Get Media List JSON Get Media Screennail (JPEG) Binary Get Media Thumbnail (JPEG) Binary Get Presets JSON Sending Commands Depending on the camera's state, it may not be ready to accept specific commands. This ready state is dependent on the System Busy and the Encoding Active status flags. For example: System Busy flag is set while loading presets, changing settings, formatting sdcard, ... Encoding Active flag is set while capturing photo/video media If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the System Busy and Encode Active flags to be unset before sending messages other than camera status queries. For details regarding camera state, see Status Codes. Keep Alive In order to maximize battery life, GoPro cameras automatically go to sleep after some time. This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support and a Keep Alive message that the user can regularly send to the camera. The camera will automatically go to sleep if both timers reach zero. The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or programmatically (un)sets the shutter, sets a setting, or loads a Preset. The Keep Alive timer is reset when the user sends a keep alive message. The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages every 3.0 seconds after a connection is established. Command HTTP/GET Description /gopro/camera/keep_alive Send keep-alive Commands Using the Open GoPro API, a client can perform various command, control, and query operations! Commands Quick Reference Below is a table of commands that can be sent to the camera and how to send them. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Command Description HTTP Method Endpoint HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black Analytics Set third party client GET /gopro/camera/analytics/set_client_info ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 COHN: Get cert Get cohn cert GET /GoProRootCA.crt ✔ ❌ ❌ ❌ ❌ COHN: Get status Get cohn status POST /gopro/cohn/status ✔ ❌ ❌ ❌ ❌ COHN: Get status Get cohn status POST /gopro/cohn/status ✔ ❌ ❌ ❌ ❌ Camera: Get State Get camera state (status + settings) GET /gopro/camera/state ✔ ✔ ✔ ✔ ✔ Digital Zoom Digital zoom 50% GET /gopro/camera/digital_zoom?percent=50 ✔ ✔ ✔ ✔ ✔ Get Date/Time Get date/time GET /gopro/camera/get_date_time ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Get Hardware Info Get camera hardware info GET /gopro/camera/info ✔ ❌ ❌ ❌ ❌ Keep-alive Send keep-alive GET /gopro/camera/keep_alive ✔ ✔ ✔ ✔ ✔ Media: GPMF Get GPMF data (JPG) GET /gopro/media/gpmf?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: GPMF Get GPMF data (MP4) GET /gopro/media/gpmf?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: HiLight (Add) Add hilight to 100GOPRO/xxx.JPG GET /gopro/media/hilight/file?path=100GOPRO/XXX.JPG ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Add) Add hilight to 100GOPRO/xxx.MP4 at offset 2500 ms GET /gopro/media/hilight/file?path=100GOPRO/XXX.MP4&ms=2500 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Remove) Remove hilight from 100GOPRO/xxx.JPG GET /gopro/media/hilight/remove?path=100GOPRO/XXX.JPG ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Remove) Remove hilight from 100GOPRO/xxx.MP4 at offset 2500ms GET /gopro/media/hilight/remove?path=100GOPRO/XXX.MP4&ms=2500 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight Moment Hilight moment during encoding GET /gopro/media/hilight/moment ✔ ✔ ✔ \\>= v01.30.00 ❌ Media: Info Get media info (JPG) GET /gopro/media/info?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Info Get media info (MP4) GET /gopro/media/info?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: List Get media list GET /gopro/media/list ✔ ✔ ✔ ✔ ✔ Media: Screennail Get screennail for \"100GOPRO/xxx.JPG\" GET /gopro/media/screennail?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Screennail Get screennail for \"100GOPRO/xxx.MP4\" GET /gopro/media/screennail?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Telemetry Get telemetry track data (JPG) GET /gopro/media/telemetry?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Telemetry Get telemetry track data (MP4) GET /gopro/media/telemetry?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Thumbnail Get thumbnail for \"100GOPRO/xxx.JPG\" GET /gopro/media/thumbnail?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Thumbnail Get thumbnail for \"100GOPRO/xxx.MP4\" GET /gopro/media/thumbnail?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Turbo Transfer Turbo transfer: off GET /gopro/media/turbo_transfer?p=0 ✔ ✔ ✔ ✔ ✔ Media: Turbo Transfer Turbo transfer: on GET /gopro/media/turbo_transfer?p=1 ✔ ✔ ✔ ✔ ✔ OTA Update Soft update: upload 12345 bytes starting at offset 67890 POST /gp/gpSoftUpdate (plus data) ✔ ✔ ✔ ✔ ✔ OTA Update Soft update: mark upload complete POST /gp/gpSoftUpdate (plus data) ✔ ✔ ✔ ✔ ✔ Open GoPro Get version GET /gopro/version ✔ ✔ ✔ ✔ ✔ Presets: Get Status Get preset status GET /gopro/camera/presets/get ✔ ✔ ✔ ✔ ✔ Presets: Load Example preset id: 0x1234ABCD GET /gopro/camera/presets/load?id=305441741 ✔ ✔ ✔ ✔ ✔ Presets: Load Group Video GET /gopro/camera/presets/set_group?id=1000 ✔ ✔ ✔ ✔ ✔ Presets: Load Group Photo GET /gopro/camera/presets/set_group?id=1001 ✔ ❌ ✔ ✔ ✔ Presets: Load Group Timelapse GET /gopro/camera/presets/set_group?id=1002 ✔ ❌ ✔ ✔ ✔ Set Camera Control Status Set camera control status to idle GET /gopro/camera/control/set_ui_controller?p=0 ✔ ✔ ✔ \\>= v01.20.00 ❌ Set Camera Control Status Set camera control status to external_control GET /gopro/camera/control/set_ui_controller?p=2 ✔ ✔ ✔ \\>= v01.20.00 ❌ Set Date/Time Set date/time to 2023-01-31 03:04:05 GET /gopro/camera/set_date_time?date=2023_1_31&time=3_4_5 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Set Local Date/Time Set local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on) GET /gopro/camera/set_date_time?date=2023_1_31&time=3_4_5&tzone=-120&dst=1 ✔ ✔ ✔ ❌ ❌ Set shutter Shutter: on GET /gopro/camera/shutter/start ✔ ✔ ✔ ✔ ❌ Set shutter Shutter: off GET /gopro/camera/shutter/stop ✔ ✔ ✔ ✔ ❌ Simple OTA Update Simple ota update with file: update.zip POST /gp/gpUpdate (plus data) ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: show canceled/failed ui on the camera GET /gp/gpSoftUpdate?request=canceled ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: delete cached update files GET /gp/gpSoftUpdate?request=delete ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: get current update state GET /gp/gpSoftUpdate?request=progress ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: display update ui on camera GET /gp/gpSoftUpdate?request=showui ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: initiate firmware update GET /gp/gpSoftUpdate?request=start ✔ ✔ ✔ ✔ ✔ Stream: Start Start preview stream GET /gopro/camera/stream/start ✔ ✔ ✔ ✔ ✔ Stream: Stop Stop preview stream GET /gopro/camera/stream/stop ✔ ✔ ✔ ✔ ✔ Webcam: Exit Exit webcam mode GET /gopro/webcam/exit ✔ ❌ ✔ ✔ ❌ Webcam: Preview Start preview stream GET /gopro/webcam/preview ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam GET /gopro/webcam/start ✔ ❌ ✔ \\>= v01.40.00 ❌ Webcam: Start Start webcam (port: 12345) GET /gopro/webcam/start?port=12345 ✔ ❌ \\>= v02.01.00 ❌ ❌ Webcam: Start Start webcam (port: 12345, protocol: rtsp) GET /gopro/webcam/start?port=12345&protocol=RTSP ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam (port: 12345, protocol: ts) GET /gopro/webcam/start?port=12345&protocol=TS ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam (res: resolution_1080, fov: wide) GET /gopro/webcam/start?res=12&fov=0 ✔ ❌ ✔ ✔ ❌ Webcam: Status Get webcam status GET /gopro/webcam/status ✔ ❌ ✔ ✔ ❌ Webcam: Stop Stop webcam GET /gopro/webcam/stop ✔ ❌ ✔ ✔ ❌ Webcam: Version Get webcam api version GET /gopro/webcam/version ✔ ❌ ✔ ✔ ❌ Wired USB Control Disable wired usb control GET /gopro/camera/control/wired_usb?p=0 ✔ ✔ ✔ \\>= v01.30.00 ❌ Wired USB Control Enable wired usb control GET /gopro/camera/control/wired_usb?p=1 ✔ ✔ ✔ \\>= v01.30.00 ❌ Settings GoPro cameras have hundreds of setting options to choose from, all of which can be set using a single endpoint. The endpoint is configured with a setting id and an option value. Note that setting option values are not globally unique. While most option values are enumerated values, some are complex bitmasked values. Settings Quick Reference Below is a table of setting options detailing how to set every option supported by Open GoPro cameras. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Setting ID Setting Option HTTP Method Endpoint HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 2 Resolution Set video resolution (id: 2) to 4k (id: 1) GET /gopro/camera/setting?setting=2&option=1 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k (id: 4) GET /gopro/camera/setting?setting=2&option=4 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 6) GET /gopro/camera/setting?setting=2&option=6 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 1440 (id: 7) GET /gopro/camera/setting?setting=2&option=7 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 1080 (id: 9) GET /gopro/camera/setting?setting=2&option=9 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 18) GET /gopro/camera/setting?setting=2&option=18 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 5k (id: 24) GET /gopro/camera/setting?setting=2&option=24 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 5k 4:3 (id: 25) GET /gopro/camera/setting?setting=2&option=25 ❌ ❌ ❌ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 8:7 (id: 26) GET /gopro/camera/setting?setting=2&option=26 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 4:3 (id: 27) GET /gopro/camera/setting?setting=2&option=27 ❌ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 8:7 (id: 28) GET /gopro/camera/setting?setting=2&option=28 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 9:16 (id: 29) GET /gopro/camera/setting?setting=2&option=29 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 9:16 (id: 30) GET /gopro/camera/setting?setting=2&option=30 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k (id: 100) GET /gopro/camera/setting?setting=2&option=100 ❌ ✔ ✔ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 16:9 (id: 101) GET /gopro/camera/setting?setting=2&option=101 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 16:9 (id: 102) GET /gopro/camera/setting?setting=2&option=102 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 103) GET /gopro/camera/setting?setting=2&option=103 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 16:9 (id: 104) GET /gopro/camera/setting?setting=2&option=104 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 105) GET /gopro/camera/setting?setting=2&option=105 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 16:9 (id: 106) GET /gopro/camera/setting?setting=2&option=106 ✔ ❌ ❌ ❌ ❌ 3 Frames Per Second Set video fps (id: 3) to 240 (id: 0) GET /gopro/camera/setting?setting=3&option=0 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 120 (id: 1) GET /gopro/camera/setting?setting=3&option=1 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 100 (id: 2) GET /gopro/camera/setting?setting=3&option=2 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 60 (id: 5) GET /gopro/camera/setting?setting=3&option=5 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 50 (id: 6) GET /gopro/camera/setting?setting=3&option=6 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 30 (id: 8) GET /gopro/camera/setting?setting=3&option=8 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 25 (id: 9) GET /gopro/camera/setting?setting=3&option=9 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 24 (id: 10) GET /gopro/camera/setting?setting=3&option=10 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 200 (id: 13) GET /gopro/camera/setting?setting=3&option=13 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to wide (id: 0) GET /gopro/camera/setting?setting=43&option=0 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to narrow (id: 2) GET /gopro/camera/setting?setting=43&option=2 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to superview (id: 3) GET /gopro/camera/setting?setting=43&option=3 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to linear (id: 4) GET /gopro/camera/setting?setting=43&option=4 ✔ ✔ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to never (id: 0) GET /gopro/camera/setting?setting=59&option=0 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 1 min (id: 1) GET /gopro/camera/setting?setting=59&option=1 ✔ \\>= v02.10.00 \\>= v02.01.00 ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 5 min (id: 4) GET /gopro/camera/setting?setting=59&option=4 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 15 min (id: 6) GET /gopro/camera/setting?setting=59&option=6 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 30 min (id: 7) GET /gopro/camera/setting?setting=59&option=7 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 8 seconds (id: 11) GET /gopro/camera/setting?setting=59&option=11 ❌ \\>= v02.10.00 ❌ ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 30 seconds (id: 12) GET /gopro/camera/setting?setting=59&option=12 ❌ \\>= v02.10.00 ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 4:3 (id: 0) GET /gopro/camera/setting?setting=108&option=0 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 16:9 (id: 1) GET /gopro/camera/setting?setting=108&option=1 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 8:7 (id: 3) GET /gopro/camera/setting?setting=108&option=3 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 9:16 (id: 4) GET /gopro/camera/setting?setting=108&option=4 ✔ ❌ ❌ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to wide (id: 0) GET /gopro/camera/setting?setting=121&option=0 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to narrow (id: 2) GET /gopro/camera/setting?setting=121&option=2 ❌ ❌ ❌ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to superview (id: 3) GET /gopro/camera/setting?setting=121&option=3 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear (id: 4) GET /gopro/camera/setting?setting=121&option=4 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to max superview (id: 7) GET /gopro/camera/setting?setting=121&option=7 ✔ \\>= v02.00.00 ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon leveling (id: 8) GET /gopro/camera/setting?setting=121&option=8 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to hyperview (id: 9) GET /gopro/camera/setting?setting=121&option=9 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon lock (id: 10) GET /gopro/camera/setting?setting=121&option=10 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to max hyperview (id: 11) GET /gopro/camera/setting?setting=121&option=11 ✔ ❌ ❌ ❌ ❌ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to narrow (id: 19) GET /gopro/camera/setting?setting=122&option=19 ❌ ❌ ❌ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to max superview (id: 100) GET /gopro/camera/setting?setting=122&option=100 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to wide (id: 101) GET /gopro/camera/setting?setting=122&option=101 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to linear (id: 102) GET /gopro/camera/setting?setting=122&option=102 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to narrow (id: 19) GET /gopro/camera/setting?setting=123&option=19 ❌ ❌ ❌ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to max superview (id: 100) GET /gopro/camera/setting?setting=123&option=100 ❌ ❌ ✔ ✔ ❌ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to wide (id: 101) GET /gopro/camera/setting?setting=123&option=101 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to linear (id: 102) GET /gopro/camera/setting?setting=123&option=102 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse video (id: 13) GET /gopro/camera/setting?setting=128&option=13 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse photo (id: 20) GET /gopro/camera/setting?setting=128&option=20 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse photo (id: 21) GET /gopro/camera/setting?setting=128&option=21 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse video (id: 26) GET /gopro/camera/setting?setting=128&option=26 ✔ ❌ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 60hz (id: 2) GET /gopro/camera/setting?setting=134&option=2 ✔ ✔ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 50hz (id: 3) GET /gopro/camera/setting?setting=134&option=3 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to off (id: 0) GET /gopro/camera/setting?setting=135&option=0 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to low (id: 1) GET /gopro/camera/setting?setting=135&option=1 ✔ ✔ ✔ ❌ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to high (id: 2) GET /gopro/camera/setting?setting=135&option=2 ❌ ❌ ❌ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to boost (id: 3) GET /gopro/camera/setting?setting=135&option=3 ❌ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to auto boost (id: 4) GET /gopro/camera/setting?setting=135&option=4 ✔ ✔ ✔ ❌ ❌ 135 Hypersmooth Set video hypersmooth (id: 135) to standard (id: 100) GET /gopro/camera/setting?setting=135&option=100 ❌ ❌ ❌ ✔ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to off (id: 0) GET /gopro/camera/setting?setting=150&option=0 ❌ \\>= v02.00.00 ✔ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to on (id: 1) GET /gopro/camera/setting?setting=150&option=1 ❌ \\>= v02.00.00 ❌ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to locked (id: 2) GET /gopro/camera/setting?setting=150&option=2 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to off (id: 0) GET /gopro/camera/setting?setting=151&option=0 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to locked (id: 2) GET /gopro/camera/setting?setting=151&option=2 ❌ ❌ ✔ ❌ ❌ 162 Max Lens Set max lens (id: 162) to off (id: 0) GET /gopro/camera/setting?setting=162&option=0 ❌ ❌ ✔ \\>= v01.20.00 ✔ 162 Max Lens Set max lens (id: 162) to on (id: 1) GET /gopro/camera/setting?setting=162&option=1 ❌ ❌ ✔ \\>= v01.20.00 ✔ 167 Hindsight* Set hindsight (id: 167) to 15 seconds (id: 2) GET /gopro/camera/setting?setting=167&option=2 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to 30 seconds (id: 3) GET /gopro/camera/setting?setting=167&option=3 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to off (id: 4) GET /gopro/camera/setting?setting=167&option=4 ✔ ❌ ✔ ✔ ✔ 171 Interval Set photo single interval (id: 171) to off (id: 0) GET /gopro/camera/setting?setting=171&option=0 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 0.5s (id: 2) GET /gopro/camera/setting?setting=171&option=2 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 1s (id: 3) GET /gopro/camera/setting?setting=171&option=3 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 2s (id: 4) GET /gopro/camera/setting?setting=171&option=4 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 5s (id: 5) GET /gopro/camera/setting?setting=171&option=5 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 10s (id: 6) GET /gopro/camera/setting?setting=171&option=6 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 30s (id: 7) GET /gopro/camera/setting?setting=171&option=7 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 60s (id: 8) GET /gopro/camera/setting?setting=171&option=8 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 120s (id: 9) GET /gopro/camera/setting?setting=171&option=9 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 3s (id: 10) GET /gopro/camera/setting?setting=171&option=10 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to off (id: 0) GET /gopro/camera/setting?setting=172&option=0 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 seconds (id: 1) GET /gopro/camera/setting?setting=172&option=1 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 seconds (id: 2) GET /gopro/camera/setting?setting=172&option=2 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 minute (id: 3) GET /gopro/camera/setting?setting=172&option=3 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 5 minutes (id: 4) GET /gopro/camera/setting?setting=172&option=4 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 minutes (id: 5) GET /gopro/camera/setting?setting=172&option=5 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 minutes (id: 6) GET /gopro/camera/setting?setting=172&option=6 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 hour (id: 7) GET /gopro/camera/setting?setting=172&option=7 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 2 hours (id: 8) GET /gopro/camera/setting?setting=172&option=8 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 3 hours (id: 9) GET /gopro/camera/setting?setting=172&option=9 ✔ ❌ ❌ ❌ ❌ 173 Video Performance Mode Set video performance mode (id: 173) to maximum video performance (id: 0) GET /gopro/camera/setting?setting=173&option=0 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to extended battery (id: 1) GET /gopro/camera/setting?setting=173&option=1 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to tripod / stationary video (id: 2) GET /gopro/camera/setting?setting=173&option=2 ❌ ❌ ❌ \\>= v01.16.00 ❌ 175 Controls Set controls (id: 175) to easy (id: 0) GET /gopro/camera/setting?setting=175&option=0 ✔ ✔ ✔ ❌ ❌ 175 Controls Set controls (id: 175) to pro (id: 1) GET /gopro/camera/setting?setting=175&option=1 ✔ ✔ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (id: 0) GET /gopro/camera/setting?setting=176&option=0 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (id: 1) GET /gopro/camera/setting?setting=176&option=1 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 2) GET /gopro/camera/setting?setting=176&option=2 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light) (id: 3) GET /gopro/camera/setting?setting=176&option=3 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4) GET /gopro/camera/setting?setting=176&option=4 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt) (id: 5) GET /gopro/camera/setting?setting=176&option=5 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light) (id: 6) GET /gopro/camera/setting?setting=176&option=6 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) GET /gopro/camera/setting?setting=176&option=7 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) GET /gopro/camera/setting?setting=176&option=8 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) GET /gopro/camera/setting?setting=176&option=9 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light, 50hz) (id: 10) GET /gopro/camera/setting?setting=176&option=10 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11) GET /gopro/camera/setting?setting=176&option=11 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12) GET /gopro/camera/setting?setting=176&option=12 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13) GET /gopro/camera/setting?setting=176&option=13 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14) GET /gopro/camera/setting?setting=176&option=14 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15) GET /gopro/camera/setting?setting=176&option=15 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16) GET /gopro/camera/setting?setting=176&option=16 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt) (id: 17) GET /gopro/camera/setting?setting=176&option=17 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt) (id: 18) GET /gopro/camera/setting?setting=176&option=18 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light) (id: 19) GET /gopro/camera/setting?setting=176&option=19 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20) GET /gopro/camera/setting?setting=176&option=20 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21) GET /gopro/camera/setting?setting=176&option=21 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22) GET /gopro/camera/setting?setting=176&option=22 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23) GET /gopro/camera/setting?setting=176&option=23 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (id: 24) GET /gopro/camera/setting?setting=176&option=24 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) GET /gopro/camera/setting?setting=176&option=25 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26) GET /gopro/camera/setting?setting=176&option=26 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27) GET /gopro/camera/setting?setting=176&option=27 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 28) GET /gopro/camera/setting?setting=176&option=28 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 29) GET /gopro/camera/setting?setting=176&option=29 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 30) GET /gopro/camera/setting?setting=176&option=30 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 31) GET /gopro/camera/setting?setting=176&option=31 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 32) GET /gopro/camera/setting?setting=176&option=32 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 33) GET /gopro/camera/setting?setting=176&option=33 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 34) GET /gopro/camera/setting?setting=176&option=34 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 35) GET /gopro/camera/setting?setting=176&option=35 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 36) GET /gopro/camera/setting?setting=176&option=36 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 37) GET /gopro/camera/setting?setting=176&option=37 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 38) GET /gopro/camera/setting?setting=176&option=38 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 39) GET /gopro/camera/setting?setting=176&option=39 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 40) GET /gopro/camera/setting?setting=176&option=40 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 41) GET /gopro/camera/setting?setting=176&option=41 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 42) GET /gopro/camera/setting?setting=176&option=42 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 43) GET /gopro/camera/setting?setting=176&option=43 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 44) GET /gopro/camera/setting?setting=176&option=44 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 45) GET /gopro/camera/setting?setting=176&option=45 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 46) GET /gopro/camera/setting?setting=176&option=46 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 47) GET /gopro/camera/setting?setting=176&option=47 ✔ ❌ ❌ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to off (id: 0) GET /gopro/camera/setting?setting=177&option=0 ❌ ❌ ✔ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to on (id: 1) GET /gopro/camera/setting?setting=177&option=1 ❌ ❌ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 2.4ghz (id: 0) GET /gopro/camera/setting?setting=178&option=0 ✔ ✔ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 5ghz (id: 1) GET /gopro/camera/setting?setting=178&option=1 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to short (id: 1) GET /gopro/camera/setting?setting=179&option=1 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to long (id: 2) GET /gopro/camera/setting?setting=179&option=2 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to max (id: 3) GET /gopro/camera/setting?setting=179&option=3 ✔ ✔ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to highest quality (id: 0) GET /gopro/camera/setting?setting=180&option=0 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (id: 1) GET /gopro/camera/setting?setting=180&option=1 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (green icon) (id: 101) GET /gopro/camera/setting?setting=180&option=101 ❌ ❌ \\>= v02.01.00 ❌ ❌ 180 Video Mode Set video mode (id: 180) to longest battery (green icon) (id: 102) GET /gopro/camera/setting?setting=180&option=102 ❌ ❌ \\>= v02.01.00 ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to standard (id: 0) GET /gopro/camera/setting?setting=182&option=0 ✔ ❌ ❌ ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to high (id: 1) GET /gopro/camera/setting?setting=182&option=1 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 8-bit (id: 0) GET /gopro/camera/setting?setting=183&option=0 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 10-bit (id: 2) GET /gopro/camera/setting?setting=183&option=2 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to standard (id: 0) GET /gopro/camera/setting?setting=184&option=0 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to hdr (id: 1) GET /gopro/camera/setting?setting=184&option=1 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to log (id: 2) GET /gopro/camera/setting?setting=184&option=2 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to widescreen (id: 0) GET /gopro/camera/setting?setting=185&option=0 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to mobile (id: 1) GET /gopro/camera/setting?setting=185&option=1 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to universal (id: 2) GET /gopro/camera/setting?setting=185&option=2 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to highest quality (id: 0) GET /gopro/camera/setting?setting=186&option=0 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to standard quality (id: 1) GET /gopro/camera/setting?setting=186&option=1 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to basic quality (id: 2) GET /gopro/camera/setting?setting=186&option=2 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to timewarp (id: 0) GET /gopro/camera/setting?setting=187&option=0 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to star trails (id: 1) GET /gopro/camera/setting?setting=187&option=1 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to light painting (id: 2) GET /gopro/camera/setting?setting=187&option=2 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to vehicle lights (id: 3) GET /gopro/camera/setting?setting=187&option=3 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max timewarp (id: 4) GET /gopro/camera/setting?setting=187&option=4 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max star trails (id: 5) GET /gopro/camera/setting?setting=187&option=5 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max light painting (id: 6) GET /gopro/camera/setting?setting=187&option=6 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max vehicle lights (id: 7) GET /gopro/camera/setting?setting=187&option=7 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to widescreen (id: 0) GET /gopro/camera/setting?setting=188&option=0 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to mobile (id: 1) GET /gopro/camera/setting?setting=188&option=1 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to universal (id: 2) GET /gopro/camera/setting?setting=188&option=2 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to none (id: 0) GET /gopro/camera/setting?setting=189&option=0 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 1.0 (id: 1) GET /gopro/camera/setting?setting=189&option=1 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 2.0 (id: 2) GET /gopro/camera/setting?setting=189&option=2 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to off (id: 0) GET /gopro/camera/setting?setting=190&option=0 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to on (id: 1) GET /gopro/camera/setting?setting=190&option=1 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to super photo (id: 0) GET /gopro/camera/setting?setting=191&option=0 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to night photo (id: 1) GET /gopro/camera/setting?setting=191&option=1 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0) GET /gopro/camera/setting?setting=192&option=0 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1) GET /gopro/camera/setting?setting=192&option=1 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3) GET /gopro/camera/setting?setting=192&option=3 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to widescreen (id: 0) GET /gopro/camera/setting?setting=193&option=0 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to vertical (id: 1) GET /gopro/camera/setting?setting=193&option=1 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to full frame (id: 2) GET /gopro/camera/setting?setting=193&option=2 ✔ ❌ ❌ ❌ ❌ 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. Note about Dependency Ordering and Blacklisting 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. Example Camera Command 1 Command 2 Command 3 Command 4 Command 5 Guaranteed Valid? HERO10 Black Res: 1080 Anti-Flicker: 60Hz (NTSC) FPS: 240 FOV: Wide Hypersmooth: OFF ✔ HERO10 Black FPS: 240 Anti-Flicker: 60Hz (NTSC) 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 Documents Product Release capabilities.xlsx capabilities.json HERO12 Black v01.30.00 v01.20.00 v01.10.00 HERO11 Black Mini v02.30.00 v02.20.00 v02.10.00 v02.00.00 v01.10.00 HERO11 Black v02.12.00 v02.10.00 v02.01.00 v01.20.00 v01.12.00 v01.10.00 HERO10 Black v01.50.00 v01.46.00 v01.42.00 v01.40.00 v01.30.00 v01.20.00 v01.16.00 v01.10.00 HERO9 Black v01.72.00 v01.70.00 Spreadsheet Format 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 Format 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. Below is a simplified example of the capabilities JSON file; a formal schema is also available here: capabilities_schema.json { \"(PRODUCT_NAME)\": { \"(RELEASE_VERSION)\": { \"states\": [ [ {\"setting_name\": \"(str)\", \"setting_id\": (int), \"option_name\": \"(str)\", \"option_id\": (int)}, ... ], ... ], }, ... }, ... } Media The camera provides an endpoint to query basic details about media captured on the sdcard. Chapters All GoPro cameras break longer videos into chapters. GoPro cameras currently limit file sizes on sdcards to 4GB for both FAT32 and exFAT file systems. This limitation is most commonly seen when recording longer (10+ minute) videos. In practice, the camera will split video media into chapters named Gqccmmmm.MP4 (and ones for THM/LRV) such that: q: Quality Level (X: Extreme, H: High, M: Medium, L: Low) cc: Chapter Number (01-99) mmmm: Media ID (0001-9999) When media becomes chaptered, the camera increments subsequent Chapter Numbers while leaving the Media ID unchanged. For example, if the user records a long High-quality video that results in 4 chapters, the files on the sdcard may look like the following: -rwxrwxrwx@ 1 gopro 123456789 4006413091 Jan 1 00:00 GH010078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17663 Jan 1 00:00 GH010078.THM -rwxrwxrwx@ 1 gopro 123456789 4006001541 Jan 1 00:00 GH020078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17357 Jan 1 00:00 GH020078.THM -rwxrwxrwx@ 1 gopro 123456789 4006041985 Jan 1 00:00 GH030078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17204 Jan 1 00:00 GH030078.THM -rwxrwxrwx@ 1 gopro 123456789 756706872 Jan 1 00:00 GH040078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17420 Jan 1 00:00 GH040078.THM -rwxrwxrwx@ 1 gopro 123456789 184526939 Jan 1 00:00 GL010078.LRV -rwxrwxrwx@ 1 gopro 123456789 184519787 Jan 1 00:00 GL020078.LRV -rwxrwxrwx@ 1 gopro 123456789 184517614 Jan 1 00:00 GL030078.LRV -rwxrwxrwx@ 1 gopro 123456789 34877660 Jan 1 00:00 GL040078.LRV Media Info Format The Media: Info command provides additional details about a media above and beyond its counterpart, the Media: List command. Such information includes resolution, frame rate, duration, hilight info, etc. Example Video Info: { \"cre\": \"1613676644\", \"s\": \"11305367\", \"mahs\": \"1\", \"us\": \"0\", \"mos\": [], \"eis\": \"0\", \"pta\": \"1\", \"ao\": \"stereo\", \"tr\": \"0\", \"mp\": \"0\", \"ct\": \"0\", \"rot\": \"0\", \"fov\": \"4\", \"lc\": \"0\", \"prjn\": \"6\", \"gumi\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\", \"ls\": \"1072714\", \"cl\": \"0\", \"avc_profile\": \"4\", \"profile\": \"42\", \"hc\": \"0\", \"hi\": [], \"dur\": \"2\", \"w\": \"1920\", \"h\": \"1080\", \"fps\": \"60000\", \"fps_denom\": \"1001\", \"prog\": \"1\", \"subsample\": \"0\" } Common Keys (Video / Photo) Key Type Description Examples ao string Audio Option off, stereo, wind, auto avc_profile uint8 Advanced Video Codec Profile 0..255 cl bool File clipped from another source? 0:false, 1:true cre uint32 File creation timestamp (sec since epoch) 1692992748 ct uint32 Content type 0..12 dur uint32 Duration of video in seconds 42 eis bool File made with Electronic Image Stabilization 0:false, 1:true fps uint32 Frame rate (numerator) 1001 fps_denom uint32 Frme rate (denominator) 30000 gumi string Globally Unique Media ID \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\" h uint32 Video height in pixels 1080 hc uint32 Hilight count video:0..99, photo:0..1 hdr bool Photo taken with High Dynamic Range? 0:false, 1:true hi Array of uint32 Offset to hilights in media in milliseconds [1500, 4700] lc uint32 Spherical Lens Config 0:front, 1:rear ls int32 Low Resolution Video file size in bytes (or -1 if no LRV file) -1, 1234567890 mos Array of string Mobile Offload State \"app\", \"pc\", \"other\" mp bool Metadata Present? 0:no metadata, 1:metadata exists profile uint8 Advanced Video Codec Level 0..255 prog bool Is video progressive? 0:interlaced, 1:progressive pta bool Media has Protune audio file? 0:false, 1:true raw bool Photo has raw version? 0:false, 1:true s uint64 File size in bytes 1234567890 subsample bool Is video subsampled? 0:false, 1:true tr bool Is file transcoded? 0:false, 1:true w uint32 Width of media in pixels 1920 wdr bool Photo taken with Wide Dynamic Range? 0:false, 1:true Video Keys Key Type Description Examples ao string Audio Option off, stereo, wind, auto avc_profile uint8 Advanced Video Codec Profile 0..255 cl bool File clipped from another source? 0:false, 1:true dur uint32 Duration of video in seconds 42 fps uint32 Frame rate (numerator) 1001 fps_denom uint32 Frme rate (denominator) 30000 hi Array of uint32 Offset to hilights in media in milliseconds [1500, 4700] ls int32 Low Resolution Video file size in bytes (or -1 if no LRV file) -1, 1234567890 profile uint8 Advanced Video Codec Level 0..255 prog bool Is video progressive? 0:interlaced, 1:progressive pta bool Media has Protune audio file? 0:false, 1:true subsample bool Is video subsampled? 0:false, 1:true Photo Keys Key Type Description Examples hdr bool Photo taken with High Dynamic Range? 0:false, 1:true raw bool Photo has raw version? 0:false, 1:true wdr bool Photo taken with Wide Dynamic Range? 0:false, 1:true Media Info: Content Type The \"ct\" (Content Type) metadata indicates what mode (or group) the media was captured in. Note: All Time Lapse modes that result in MPEG media use the same content type ID. ID Mode Video 0 Looping 1 Chaptered Video 2 Time Lapse 3 Single Photo 4 Burst Photo 5 Time Lapse Photo 6 Night Lapse Photo 8 Night Photo 9 Continuous Photo 10 Raw Photo 11 Live Burst 12 Media List Format The format of the media list is given below. { \"id\": \"<MEDIA SESSION ID>\", \"media\": [ { \"d\": \"<DIRECTORY NAME>\", \"fs\": [ {<MEDIA ITEM INFO>}, ... ] }, ... ] } Media List Keys The outer structure of the media list and the inner structure of individual media items use the keys in the table below. Key Description b ID of first member of a group (for grouped media items) cre Creation timestamp (seconds since epoch) d Directory name fs File system. Contains listing of media items in directory g Group ID (if grouped media item) glrv Low resolution video file size id Media list session identifier l ID of last member of a group (for grouped media items) m List of missing/deleted group member IDs (for grouped media items) media Contains media info for for each directory (e.g. 100GOPRO/, 101GOPRO/, ...) mod Last modified time (seconds since epoch) n Media filename s Size of (group) media in bytes t Group type (for grouped media items) (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse) Grouped Media Items To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos, Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys that allow the user to extrapolate individual filenames for each member of the group. Filenames for group media items have the form \"GXXXYYYY.ZZZ\" where XXX is the group ID, YYY is the group member ID and ZZZ is the file extension. For example, take the media list below, which contains a Time Lapse Photo group media item: { \"id\": \"2530266050123724003\", \"media\": [ { \"d\": \"100GOPRO\", \"fs\": [ { \"b\": \"8\", \"cre\": \"1613669353\", \"g\": \"1\", \"l\": \"396\", \"m\": ['75', '139'], \"mod\": \"1613669353\", \"n\": \"G0010008.JPG\", \"s\": \"773977407\", \"t\": \"t\" } ] } ] } The first filename in the group is \"G0010008.JPG\" (key: \"n\"). The ID of the first group member in this case is \"008\" (key: \"b\"). The ID of the last group member in this case is \"396\" (key: \"l\"). The IDs of deleted members in this case are \"75\" and \"139\" (key: \"m\") Given this information, the user can extrapolate that the group currently contains G0010008.JPG, G0010009.JPG, G0010010.JPG, ..., G0010074.JPG, G0010076.JPG, ..., G0010138.JPG, G0010140.JPG, ..., G0010394.JPG, G0010395.JPG. G0010396.JPG Media HiLights The HiLight Tags feature allows the user to tag moments of interest either during video capture or on existing media. Add/Remove HiLights Below is a table of all HiLight commands. For details on how to send HiLight commands, see Commands Quick Reference. Command Description Media: HiLight (Add) Video: Add a tag at a specific time offset (ms) Photo: Add a tag Media: HiLight (Remove) Video: Remove a tag at a specific time offset (ms) Photo: Remove tag Media: HiLight Moment Add a tag to the current time offset (ms) while encoding video Note: Attempting to add a HiLight tag at a time offset that exceeds the duration of the video or removing a non-existent HiLight tag will result in an HTTP/500 error. Get HiLights Once HiLight tags have been added, they can be queried by calling the Media: Info command; the response content will be JSON that contains HiLight information: Media Type Key Value Photo hc HiLight Count Video hc HiLight Count Video hi HiLights (list of time offsets in ms) Example The JSON sample below shows media that contains three HiLights at time offsets 2502ms, 5839ms, and 11478ms. Note: Photo info will not have an \"hi\":[...] key-value pair. { ..., \"hc\":\"3\", \"hi\":[2502,5839,11478], ..., } Downloading Media The URL to download/stream media from the DCIM/ directory on the sdcard is the Base URL plus /videos/DCIM/XXX/YYY where XXX is the directory name within DCIM/ given by the media list and YYY is the target media filename. For example: Given the following media list: { \"id\": \"3586667939918700960\", \"media\": [ { \"d\": \"100GOPRO\", \"fs\": [ { \"n\": \"GH010397.MP4\", \"cre\": \"1613672729\", \"mod\": \"1613672729\", \"glrv\": \"1895626\", \"ls\": \"-1\", \"s\": \"19917136\" }, { \"cre\": \"1614340213\", \"mod\": \"1614340213\", \"n\": \"GOPR0001.JPG\", \"s\": \"6961371\" } ] } ] } The URL to download GH010397.MP4 over WiFi would be http://10.5.5.9:8080/videos/DCIM/100GOPRO/GH010397.MP4 The URL to download GOPR0001.JPG over WiFi would be http://10.5.5.9:8080/videos/DCIM/100GOPRO/GOPR0001.JPG Turbo Transfer Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. This special mode should only be used during media offload. It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. For details on which cameras are supported and how to enable and disable Turbo Transfer, see Commands Quick Reference. Downloading Preview Stream When the preview stream is started, the camera starts up a UDP client and begins writing MPEG Transport Stream data to the client on port 8554. In order to stream this data, the client must implement a UDP connection that binds to the same port and decode the data. Camera State The camera provides multiple types of state, all of which can be queried: Camera state: Contains information about camera status (photos taken, date, is-camera-encoding, etc) and settings (current video resolution, current frame rate, etc) Preset State: How presets are arranged into preset groups, their titles, icons, settings closely associated with each preset, etc Camera State Format Camera state is given in the following form: { \"status\": { \"1\": <status 1 value>, \"2\": <status 2 value>, ... }, \"settings: { \"2\": <setting 2 value>, \"3\": <setting 3 value>, ... } } Where status X value and setting X value are almost always integer values. See Status Codes table in this document for exceptions. For status, keys are status codes and values are status values. For settings, keys are setting IDs, and values are option values Status IDs Below is a table of supported status IDs. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Status ID Name Description Type Values HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 1 Internal battery present Is the system's internal battery present? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 2 Internal battery level Rough approximation of internal battery level in bars (or charging) integer 0: Zero 1: One 2: Two 3: Three 4: Charging ✔ ✔ ✔ ✔ ✔ 6 System hot Is the system currently overheating? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 8 System busy Is the camera busy? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 9 Quick capture active Is Quick Capture feature enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 10 Encoding active Is the system encoding right now? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 11 Lcd lock active Is LCD lock active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 13 Video progress counter When encoding video, this is the duration (seconds) of the video so far; 0 otherwise integer * ✔ ✔ ✔ ✔ ✔ 17 Enable Are Wireless Connections enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 19 State The pairing state of the camera integer 0: Never Started 1: Started 2: Aborted 3: Cancelled 4: Completed ✔ ✔ ✔ ✔ ✔ 20 Type The last type of pairing that the camera was engaged in integer 0: Not Pairing 1: Pairing App 2: Pairing Remote Control 3: Pairing Bluetooth Device ✔ ✔ ✔ ✔ ✔ 21 Pair time Time (milliseconds) since boot of last successful pairing complete action integer * ❌ ✔ ✔ ✔ ✔ 22 State State of current scan for WiFi Access Points. Appears to only change for CAH-related scans integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 23 Scan time msec The time, in milliseconds since boot that the WiFi Access Point scan completed integer * ✔ ✔ ✔ ✔ ✔ 24 Provision status WiFi AP provisioning state integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 26 Remote control version Wireless remote control version integer * ❌ ✔ ✔ ✔ ✔ 27 Remote control connected Is a wireless remote control connected? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 28 Pairing Wireless Pairing State integer * ❌ ✔ ✔ ✔ ✔ 29 Wlan ssid SSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 30 Ap ssid The camera's WiFi SSID. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 31 App count The number of wireless devices connected to the camera integer * ✔ ✔ ✔ ✔ ✔ 32 Enable Is Preview Stream enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 33 Sd status Primary Storage Status integer -1: Unknown 0: OK 1: SD Card Full 2: SD Card Removed 3: SD Card Format Error 4: SD Card Busy 8: SD Card Swapped ✔ ✔ ✔ ✔ ✔ 34 Remaining photos How many photos can be taken before sdcard is full integer * ✔ ❌ ✔ ✔ ✔ 35 Remaining video time How many minutes of video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 38 Num total photos Total number of photos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 39 Num total videos Total number of videos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 41 Ota status The current status of Over The Air (OTA) update integer 0: Idle 1: Downloading 2: Verifying 3: Download Failed 4: Verify Failed 5: Ready 6: GoPro App: Downloading 7: GoPro App: Verifying 8: GoPro App: Download Failed 9: GoPro App: Verify Failed 10: GoPro App: Ready ✔ ✔ ✔ ✔ ✔ 42 Download cancel request pending Is there a pending request to cancel a firmware update download? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 45 Camera locate active Is locate camera feature active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 49 Multi shot count down The current timelapse interval countdown value (e.g. 5...4...3...2...1...) integer * ✔ ✔ ✔ ✔ ✔ 54 Remaining space Remaining space on the sdcard in Kilobytes integer * ✔ ✔ ✔ ✔ ✔ 55 Supported Is preview stream supported in current recording/mode/secondary-stream? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 56 Wifi bars WiFi signal strength in bars integer * ✔ ✔ ✔ ✔ ✔ 58 Num hilights The number of hilights in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 59 Last hilight time msec Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 60 Next poll msec The min time between camera status updates (msec). Do not poll for status more often than this integer * ✔ ✔ ✔ ✔ ✔ 64 Remaining timelapse time How many min of Timelapse video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 65 Exposure select type Liveview Exposure Select Mode integer 0: Disabled 1: Auto 2: ISO Lock 3: Hemisphere ✔ ❌ ✔ ✔ ✔ 66 Exposure select x Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 67 Exposure select y Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 68 Gps status Does the camera currently have a GPS lock? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 69 Ap state Is the camera in AP Mode? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 70 Internal battery percentage Internal battery level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 74 Acc mic status Microphone Accesstory status integer 0: Microphone mod not connected 1: Microphone mod connected 2: Microphone mod connected and microphone plugged into Microphone mod ✔ ✔ ✔ ✔ ✔ 75 Digital zoom Digital Zoom level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 76 Wireless band Wireless Band integer 0: 2.4 GHz 1: 5 GHz 2: Max ✔ ✔ ✔ ✔ ✔ 77 Digital zoom active Is Digital Zoom feature available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 78 Mobile friendly video Are current video settings mobile friendly? (related to video compression and frame rate) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 79 First time use Is the camera currently in First Time Use (FTU) UI flow? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 81 Band 5ghz avail Is 5GHz wireless band available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 82 System ready Is the system ready to accept commands? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 83 Batt okay for ota Is the internal battery charged sufficiently to start Over The Air (OTA) update? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 85 Video low temp alert Is the camera getting too cold to continue recording? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 86 Actual orientation The rotational orientation of the camera integer 0: 0 degrees (upright) 1: 180 degrees (upside down) 2: 90 degrees (laying on right side) 3: 270 degrees (laying on left side) ✔ ✔ ✔ ✔ ✔ 88 Zoom while encoding Is this camera capable of zooming while encoding (static value based on model, not settings) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 89 Current mode Current flatmode ID integer * ✔ ✔ ✔ ✔ ✔ 93 Active video presets Current Video Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 94 Active photo presets Current Photo Preset (ID) integer * ✔ ❌ ✔ ✔ ✔ 95 Active timelapse presets Current Timelapse Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 96 Active presets group Current Preset Group (ID) integer * ✔ ✔ ✔ ✔ ✔ 97 Active preset Current Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 98 Preset modified Preset Modified Status, which contains an event ID and a preset (group) ID integer * ✔ ✔ ✔ ✔ ✔ 99 Remaining live bursts How many Live Bursts can be captured before sdcard is full integer * ❌ ❌ ✔ ✔ ✔ 100 Num total live bursts Total number of Live Bursts on sdcard integer * ❌ ❌ ✔ ✔ ✔ 101 Capture delay active Is Capture Delay currently active (i.e. counting down)? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 102 Media mod mic status Media mod State integer 0: Media mod microphone removed 2: Media mod microphone only 3: Media mod microphone with external microphone ✔ ✔ ✔ ✔ ✔ 103 Timewarp speed ramp active Time Warp Speed integer 0: 15x 1: 30x 2: 60x 3: 150x 4: 300x 5: 900x 6: 1800x 7: 2x 8: 5x 9: 10x 10: Auto 11: 1x (realtime) 12: 1/2x (slow-motion) ✔ ✔ ✔ ✔ ✔ 104 Linux core active Is the system's Linux core active? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 105 Camera lens type Camera lens type (reflects changes to setting 162 or setting 189) integer 0: Default 1: Max Lens 2: Max Lens 2.0 ✔ ✔ ✔ ✔ ✔ 106 Video hindsight capture active Is Video Hindsight Capture Active? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 107 Scheduled preset Scheduled Capture Preset ID integer * ✔ ❌ ✔ ✔ ✔ 108 Scheduled enabled Is Scheduled Capture set? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 110 Media mod status Media Mode Status (bitmasked) integer 0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False 1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True 2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False 3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True 4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False 5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True 6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False 7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True ✔ ❌ ✔ ✔ ✔ 111 Sd rating check error Does sdcard meet specified minimum write speed? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 112 Sd write speed error Number of sdcard write speed errors since device booted integer * ✔ ✔ ✔ ✔ ❌ 113 Turbo transfer Is Turbo Transfer active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 114 Camera control status Camera control status ID integer 0: Camera Idle: No one is attempting to change camera settings 1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control 2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings ✔ ✔ ✔ ✔ ❌ 115 Usb connected Is the camera connected to a PC via USB? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 116 Allow control over usb Camera control over USB state integer 0: Disabled 1: Enabled ✔ ✔ ✔ \\>= v01.30.00 ❌ 117 Total sd space kb Total SD card capacity in Kilobytes integer * ✔ ✔ ✔ ❌ ❌ Preset Status Format Preset Status is returned as JSON, whose content is the serialization of the protobuf message: NotifyPresetStatus. Using Google protobuf APIs, the JSON can be converted back into a programmatic object in the user's language of choice. Features Presets The camera organizes modes of operation into presets. A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. Depending on the camera's state, different collections of presets will be available for immediate loading and use. Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: ID Setting 162 Max Lens 173 Video Performance Mode 175 Controls 177 Enable Night Photo 180 Video Mode 186 Video Mode 187 Lapse Mode 189 Max Lens Mod 190 Max Lens Mod Enable 191 Photo Mode To determine which presets are available for immediate use, get Preset Status. Preset Status All cameras support basic query and subscription mechanics that allow the user to: Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state Preset Status should not be confused with camera status: Preset Status contains information about current preset groups and presets Camera status contains numerous statuses about current settings and camera system state Preset Groups Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. Presets Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of Settings associated with the Preset. Important Note: The Preset ID is required to load a Preset via the Presets: Load command. Global Behaviors In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a connected app is discouraged. Best practice for synchronizing user/app control is to use the Set Camera Control Status command and corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera Control Status ID IDLE 0 CONTROL 1 EXTERNAL_CONTROL 2 Set Camera Control Status This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. This causes the camera to immediately exit any contextual menus and return to the idle screen. Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. If the user returns the camera UI to the idle screen, the camera updates control status to Idle. Note: The entity currently claiming control of the camera is advertised in camera status 114 Information about whether the camera is in a contextual menu or not is advertised in camera status 63. OTA Update The Over The Air (OTA) update feature allows the user to update the camera's firmware via HTTP connection. There are two ways to perform OTA updates: Simple OTA Update and Resumable OTA Update. Firmware update files can be obtained from GoPro's update page or programmatically using the firmware catalog. Note: In order to complete the firmware update process, the camera will reboot one or more times. This will cause any existing HTTP connections to be lost. Simple OTA Update The simple OTA update process is done by sending an entire update file to the camera in a single HTTP/POST. Details can be found in the diagram below. Simple OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/POST: /gp/gpUpdateContent-Type: multipart/form-dataData:DirectToSD=1update=1sha1=<SHA1_HASH>file=<UPDATE.zip>HTTP/200 (OK)JSON: { \"status\":\"0\" }WiFi connection terminatesCamera displays \"Update Complete\" OSD, reboots 1-2 times Resumable OTA Update The resumable OTA update process involves uploading chunks (or all) of a file, marking the file complete and then telling the camera to begin the update process. Chunks are stored until they are explicitly deleted, allowing the client to stop and resume as needed. Details can be found in the diagram below. Resumable OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/GET: /gp/gpSoftUpdate?request=deleteDelete any old/cached dataHTTP/200 (OK)JSON {\"status\":0,\"message\":\"OK\",\"sha1\":\"\",\"bytes_complete\":0,\"complete\":false}HTTP/GET: /gp/gpSoftUpdate?request=showuiDisplay update OSD on camera UI (optional)HTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"\",\"bytes_complete\":0,\"complete\":false}loop[read CHUNK_BYTES of UPDATE.zip, starting at OFFSET]HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>offset=<OFFSET>file=<CHUNK_BYTES>HTTP/200 (OK)JSON: {\"status\": 0,\"message\": \"OK\",\"sha1\": \"SHA1_HASH\",\"bytes_complete\": (total uploaded bytes),\"complete\": false}HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>complete=trueHTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"SHA1_HASH\",\"bytes_complete\":(size of UPDATE.zip),\"complete\":true}HTTP/GET: /gp/gpSoftUpdate?request=startStart updating firmwareHTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"SHA1_HASH\",\"bytes_complete\":(size of UPDATE.zip),\"complete\":true}loop[while camera updates firmware]HTTP/GET: /gp/gpSoftUpdate?request=progressJSON: {\"status\":11,\"message\":\"Firmware update in progress\"}WiFi connection lostCamera displays OSD \"Update Complete\", reboots 1-2 times OTA Update Status Codes ID Status Description 0 Ok No errors occurred 1 Unknown Request Server did not recognize the request 2 Bad Params Parameter values not recognized 3 SHA1 Send Mismatch SHA1 for chunk did not match SHA1 of previous chunk(s) 4 SHA1 Calculates Mismatch Calculated SHA1 did not match user-specified SHA1 5 HTTP Boundary Error HTTP Post malformed 6 HTTP Post Error Unexpected HTTP/POST Content Type 7 Server Busy HTTP server is busy 8 Offset Mismatch Tried to upload chunk with offset that did not align with previous chunk 9 Bad Post Data Server failed to parse POST data 10 File Incomplete Tried to start update before server finished validating .zip file 11 Update in Progress Firmware update in progress 12 Insufficient Space Insufficient space on the sdcard to hold (decompressed) update file Webcam The webcam feature enables developers who are interested in writing custom drivers to broadcast the camera's video preview with a limited set of resolution, field of view, port, and protocol options. While active, the webcam feature sends raw data to the connected client using a supported protocol. To enable multi-cam support, some cameras support running on a user-specified port. Protocol and port details are provided in a table below. To test basic functionality, start the webcam, and use an application such as VLC to open a network stream: Protocol VLC Network URL TS udp://@:{PORT} RTSP rtsp://{CAMERA_IP}:554/live For readers interested in using a GoPro camera as a webcam with preexisting tools, please see How to use GoPro as a Webcam. Webcam Finite State Machine PREREQUISITEWired USB Control disabledREADYWebcam ready to startStatus is either OFF (0) or IDLE (1)High Power PreviewStatus: 2Low Power PreviewStatus: 3Connect USB to cameraStopExitStartStopExitPreviewStopExitStartPreviewStartPreview Webcam Commands Note: For USB connections, prior to issuing webcam commands, Wired USB Control should be disabled. For details about how to send this and webcam commands, see Commands Quick Reference. Command Connections Description Webcam: Start USB, WIFI* Enters webcam mode, uses default resolution and last-used fov, starts high-res stream to the IP address of caller Webcam: Start (with args) USB, WIFI* Enters webcam mode, uses specified res/fov/protocol/port, starts streaming to the IP address of caller Webcam: Preview USB, WIFI* Enters webcam mode, sets stream resolution and bitrate, starts low-res stream to the IP address of caller. Can set Webcam Digital Lenses and Digital Zoom levels while streaming Webcam: Stop USB, WIFI* Stops the webcam stream Webcam: Exit USB, WIFI* Stops the webcam stream and exits webcam mode Webcam: Status USB, WIFI Returns the current state of the webcam endpoint, including status and error codes (see tables below) Webcam: Version USB, WIFI Provides version information about webcam implementation in JSON format * Indicates that connection is supported in HERO12 Black v01.10.00 and newer versions/models Status Codes Status Code OFF 0 IDLE 1 HIGH_POWER_PREVIEW 2 LOW_POWER_PREVIEW 3 Error Codes Status Code NONE 0 SET_PRESET 1 SET_WINDOW_SIZE 2 EXEC_STREAM 3 SHUTTER 4 COM_TIMEOUT 5 INVALID_PARAM 6 UNAVAILABLE 7 EXIT 8 Webcam Capabilities Webcam supports setting resolution and field of view. Changing other settings while in IDLE state such as Hypersmooth may succeed but are not officially supported. There is a known issue on some cameras in which the webcam status will be wrongly reported as IDLE instead of OFF after a new USB connection. The best workaround for this is to call Webcam: Start followed by the Webcam: Stop after connecting USB in order to attain the true IDLE state. Default Parameter Values Parameter Default Value res 12 (1080p) fov Last-used or 0 (Wide) if FOV not previously set protocol \"TS\" Webcam Capabilities Camera Resolution FOV HERO12 Black 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO11 Black 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO10 Black 480p (id: 4) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO9 Black 480p (id: 4) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) Supported Protocols Camera Protocol Default Port Supports User-Defined Port? HERO12 Black TS 8554 ✔ RTSP 554 ❌ HERO11 Black TS 8554 ✔ HERO10 Black TS 8554 ❌ HERO9 Black TS 8554 ❌ Webcam Stabilization Should the client require stabilization, the Hypersmooth setting can be used while in the state: READY (Status: OFF). This setting can only be set while webcam is disabled, which requires either sending the Webcam: Exit command or reseating the USB-C connection to the camera. Note: The Low Hypersmooth option provides lower/lighter stabilization when used in Webcam mode vs other camera modes. Camera Version Supported Hypersmooth Options HERO12 Black v01.10.00+ Off (id: 0), Low (id: 1), Auto Boost (id: 4) HERO11 Black Mini v01.10.00+ Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4) HERO11 Black v01.10.00+ Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4) HERO10 Black v01.10.00+ Off (id: 0), High (id: 2), Boost (id: 3), Standard (id: 100) HERO9 Black v01.70.00+ Off (id: 0), Low (id: 1), High (id: 2), Boost (id: 3) Camera On the Home Network (COHN) Some cameras support Camera On the Home Network (COHN). This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. For security purposes, all communications are performed over HTTPS. Camera Supported HERO12 Black ✔ HERO11 Black Mini ❌ HERO11 Black ❌ HERO10 Black ❌ HERO9 Black ❌ Provisioning COHN In order to use the COHN capability, the camera must first be provisioned for COHN. For instructions on how to do this, see Open GoPro BLE spec. Send Messages via HTTPS Once the camera is provisioned, the client can issue commands and set settings via HTTPS using the COHN certificate and Basic authorization (username/password) credentials obtained during provisioning or subsequently by querying for COHN status. HTTPS Headers All HTTPS messages must contain Basic access authentication headers, using the username and password from the COHN status obtained during or after provisioning. COHN Commands Command Command Response Format Description /GoProRootCA.crt Text Get COHN cert /gopro/cohn/status JSON Get current COHN status Get COHN Cert The /GoProRootCA.crt endpoint provides a way to obtain the COHN cert via HTTP(S). The response content is in plain text. For example: -----BEGIN CERTIFICATE----- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -----END CERTIFICATE----- Get COHN Status The /gopro/cohn/status endpoint provides a way to get the current status of COHN. The status's format is NotifyCOHNStatus (a Google Procol Buffer v2 message) converted into JSON. Example: { \"status\": \"COHN_PROVISIONED\", \"state\": \"COHN_STATE_NetworkConnected\", \"username\": \"gopro\", \"password\": \"xxxxxxxxxxxx\", \"ipaddress\": \"xxx.xxx.xxx.xxx\", \"enabled\": true } Limitations HERO12 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO11 Black Mini The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO11 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO10 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO9 Black The HTTP server is not available while the camera is encoding, which means shutter controls are not supported over WiFi. This limitation can be overcome by using Bluetooth Low Energy for command and control and HTTP/REST for querying media content such as media list, media info, preview stream, etc. USB command and control is not supported on HERO9 Black. HTTP command arguments must be given in the order outlined in Commands Quick Reference General Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds. In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode).", + "excerpt": "Overview The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera. What can you do with the GoPro API? The GoPro API allows you to control and query the camera: Capture photo/video media Get media list Change settings Get and set the date/time Get camera status Get media metadata (file size, width, height, duration, tags, etc) and more! Supported Cameras Below is a table of cameras that support GoPro's public HTTP API: Model ID Model Code Marketing Name Minimal Firmware Version 62 H23.01 HERO12 Black v01.10.00 60 H22.03 HERO11 Black Mini v01.10.00 58 H22.01 HERO11 Black v01.10.00 57 H21.01 HERO10 Black v01.10.00 55 HD9.01 HERO9 Black v01.70.00 The Basics Connection WiFi Connection to the camera via WiFi requires that the camera's WiFi Access Point be enabled. This can be done by connecting to the camera via Bluetooth Low Energy (BLE) and sending a command to enable AP Mode. USB OpenGoPro systems that utilize USB must support the Network Control Model (NCM) protocol. Connecting via USB requires the following steps: Physically connect the camera's USB-C port to your system Send HTTP command to enable wired USB control Authentication WiFi Once the WiFi Access Point has been turned on, authentication with the camera simply requires connecting with the correct SSID and password. This information can be obtained in two ways: Put the camera into pairing mode and tap the info button in the top-right corner of the screen. Read the SSID/password directly via Bluetooth Low Energy. See Services and Characteristics section in BLE Specification for details. USB No authentication is necessary. Socket Address WiFi The socket address for WiFi connections is 10.5.5.9:8080. USB The socket address for USB connections is 172.2X.1YZ.51:8080 where: X is the 100's digit from the camera serial number Y is the 10's digit from the camera serial number Z is the 1's digit from the camera serial number The camera's serial number can be obtained in any of the following ways: Reading the sticker inside the camera's battery enclosure Camera UI: Preferences >> About >> Camera Info Bluetooth Low Energy: By reading directly from Hardware Info For example, if the camera's serial number is C0000123456789, the IP address for USB connections would be 172.27.189.51. Alternatively, the IP address can be discovered via mDNS as the camera registers the _gopro-web service. Request and Response Formats Most commands are sent via HTTP/GET and require no special headers. Responses come in two parts: The standard HTTP return codes and JSON containing any additional information. The typical use case is that the camera accepts a valid command, returns HTTP/200 (OK) and empty JSON (i.e. { }) and begins asynchronously working on the command. If an error occurs, the camera will return a standard HTTP error code and JSON with helpful error/debug information. Depending on the command sent, the camera can return JSON, binary, or Protobuf data. Some examples are listed below: Command Return Type Get Camera State JSON Get Media Info JSON Get Media GPMF Binary Get Media List JSON Get Media Screennail (JPEG) Binary Get Media Thumbnail (JPEG) Binary Get Presets JSON Sending Commands Depending on the camera's state, it may not be ready to accept specific commands. This ready state is dependent on the System Busy and the Encoding Active status flags. For example: System Busy flag is set while loading presets, changing settings, formatting sdcard, ... Encoding Active flag is set while capturing photo/video media If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the System Busy and Encode Active flags to be unset before sending messages other than camera status queries. For details regarding camera state, see Status Codes. Keep Alive In order to maximize battery life, GoPro cameras automatically go to sleep after some time. This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support and a Keep Alive message that the user can regularly send to the camera. The camera will automatically go to sleep if both timers reach zero. The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or programmatically (un)sets the shutter, sets a setting, or loads a Preset. The Keep Alive timer is reset when the user sends a keep alive message. The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages every 3.0 seconds after a connection is established. Command HTTP/GET Description /gopro/camera/keep_alive Send keep-alive Commands Using the Open GoPro API, a client can perform various command, control, and query operations! Commands Quick Reference Below is a table of commands that can be sent to the camera and how to send them. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Command Description HTTP Method Endpoint HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black Analytics Set third party client GET /gopro/camera/analytics/set_client_info ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 COHN: Get cert Get cohn cert GET /GoProRootCA.crt ✔ ❌ ❌ ❌ ❌ COHN: Get status Get cohn status POST /gopro/cohn/status ✔ ❌ ❌ ❌ ❌ COHN: Get status Get cohn status POST /gopro/cohn/status ✔ ❌ ❌ ❌ ❌ Camera: Get State Get camera state (status + settings) GET /gopro/camera/state ✔ ✔ ✔ ✔ ✔ Digital Zoom Digital zoom 50% GET /gopro/camera/digital_zoom?percent=50 ✔ ✔ ✔ ✔ ✔ Get Date/Time Get date/time GET /gopro/camera/get_date_time ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Get Hardware Info Get camera hardware info GET /gopro/camera/info ✔ ❌ ❌ ❌ ❌ Keep-alive Send keep-alive GET /gopro/camera/keep_alive ✔ ✔ ✔ ✔ ✔ Media: GPMF Get GPMF data (JPG) GET /gopro/media/gpmf?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: GPMF Get GPMF data (MP4) GET /gopro/media/gpmf?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: HiLight (Add) Add hilight to 100GOPRO/xxx.JPG GET /gopro/media/hilight/file?path=100GOPRO/XXX.JPG ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Add) Add hilight to 100GOPRO/xxx.MP4 at offset 2500 ms GET /gopro/media/hilight/file?path=100GOPRO/XXX.MP4&ms=2500 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Remove) Remove hilight from 100GOPRO/xxx.JPG GET /gopro/media/hilight/remove?path=100GOPRO/XXX.JPG ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight (Remove) Remove hilight from 100GOPRO/xxx.MP4 at offset 2500ms GET /gopro/media/hilight/remove?path=100GOPRO/XXX.MP4&ms=2500 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Media: HiLight Moment Hilight moment during encoding GET /gopro/media/hilight/moment ✔ ✔ ✔ \\>= v01.30.00 ❌ Media: Info Get media info (JPG) GET /gopro/media/info?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Info Get media info (MP4) GET /gopro/media/info?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: List Get media list GET /gopro/media/list ✔ ✔ ✔ ✔ ✔ Media: Screennail Get screennail for \"100GOPRO/xxx.JPG\" GET /gopro/media/screennail?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Screennail Get screennail for \"100GOPRO/xxx.MP4\" GET /gopro/media/screennail?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Telemetry Get telemetry track data (JPG) GET /gopro/media/telemetry?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Telemetry Get telemetry track data (MP4) GET /gopro/media/telemetry?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Thumbnail Get thumbnail for \"100GOPRO/xxx.JPG\" GET /gopro/media/thumbnail?path=100GOPRO/XXX.JPG ✔ ✔ ✔ ✔ ✔ Media: Thumbnail Get thumbnail for \"100GOPRO/xxx.MP4\" GET /gopro/media/thumbnail?path=100GOPRO/XXX.MP4 ✔ ✔ ✔ ✔ ✔ Media: Turbo Transfer Turbo transfer: off GET /gopro/media/turbo_transfer?p=0 ✔ ✔ ✔ ✔ ✔ Media: Turbo Transfer Turbo transfer: on GET /gopro/media/turbo_transfer?p=1 ✔ ✔ ✔ ✔ ✔ OTA Update Soft update: upload 12345 bytes starting at offset 67890 POST /gp/gpSoftUpdate (plus data) ✔ ✔ ✔ ✔ ✔ OTA Update Soft update: mark upload complete POST /gp/gpSoftUpdate (plus data) ✔ ✔ ✔ ✔ ✔ Open GoPro Get version GET /gopro/version ✔ ✔ ✔ ✔ ✔ Presets: Get Status Get preset status GET /gopro/camera/presets/get ✔ ✔ ✔ ✔ ✔ Presets: Load Example preset id: 0x1234ABCD GET /gopro/camera/presets/load?id=305441741 ✔ ✔ ✔ ✔ ✔ Presets: Load Group Video GET /gopro/camera/presets/set_group?id=1000 ✔ ✔ ✔ ✔ ✔ Presets: Load Group Photo GET /gopro/camera/presets/set_group?id=1001 ✔ ❌ ✔ ✔ ✔ Presets: Load Group Timelapse GET /gopro/camera/presets/set_group?id=1002 ✔ ❌ ✔ ✔ ✔ Set Camera Control Status Set camera control status to idle GET /gopro/camera/control/set_ui_controller?p=0 ✔ ✔ ✔ \\>= v01.20.00 ❌ Set Camera Control Status Set camera control status to external_control GET /gopro/camera/control/set_ui_controller?p=2 ✔ ✔ ✔ \\>= v01.20.00 ❌ Set Date/Time Set date/time to 2023-01-31 03:04:05 GET /gopro/camera/set_date_time?date=2023_1_31&time=3_4_5 ✔ ✔ ✔ \\>= v01.30.00 \\>= v01.70.00 Set Local Date/Time Set local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on) GET /gopro/camera/set_date_time?date=2023_1_31&time=3_4_5&tzone=-120&dst=1 ✔ ✔ ✔ ❌ ❌ Set shutter Shutter: on GET /gopro/camera/shutter/start ✔ ✔ ✔ ✔ ❌ Set shutter Shutter: off GET /gopro/camera/shutter/stop ✔ ✔ ✔ ✔ ❌ Simple OTA Update Simple ota update with file: update.zip POST /gp/gpUpdate (plus data) ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: show canceled/failed ui on the camera GET /gp/gpSoftUpdate?request=canceled ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: delete cached update files GET /gp/gpSoftUpdate?request=delete ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: get current update state GET /gp/gpSoftUpdate?request=progress ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: display update ui on camera GET /gp/gpSoftUpdate?request=showui ✔ ✔ ✔ ✔ ✔ Soft Update Soft update: initiate firmware update GET /gp/gpSoftUpdate?request=start ✔ ✔ ✔ ✔ ✔ Stream: Start Start preview stream GET /gopro/camera/stream/start ✔ ✔ ✔ ✔ ✔ Stream: Stop Stop preview stream GET /gopro/camera/stream/stop ✔ ✔ ✔ ✔ ✔ Webcam: Exit Exit webcam mode GET /gopro/webcam/exit ✔ ❌ ✔ ✔ ❌ Webcam: Preview Start preview stream GET /gopro/webcam/preview ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam GET /gopro/webcam/start ✔ ❌ ✔ \\>= v01.40.00 ❌ Webcam: Start Start webcam (port: 12345) GET /gopro/webcam/start?port=12345 ✔ ❌ \\>= v02.01.00 ❌ ❌ Webcam: Start Start webcam (port: 12345, protocol: rtsp) GET /gopro/webcam/start?port=12345&protocol=RTSP ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam (port: 12345, protocol: ts) GET /gopro/webcam/start?port=12345&protocol=TS ✔ ❌ ✔ ✔ ❌ Webcam: Start Start webcam (res: resolution_1080, fov: wide) GET /gopro/webcam/start?res=12&fov=0 ✔ ❌ ✔ ✔ ❌ Webcam: Status Get webcam status GET /gopro/webcam/status ✔ ❌ ✔ ✔ ❌ Webcam: Stop Stop webcam GET /gopro/webcam/stop ✔ ❌ ✔ ✔ ❌ Webcam: Version Get webcam api version GET /gopro/webcam/version ✔ ❌ ✔ ✔ ❌ Wired USB Control Disable wired usb control GET /gopro/camera/control/wired_usb?p=0 ✔ ✔ ✔ \\>= v01.30.00 ❌ Wired USB Control Enable wired usb control GET /gopro/camera/control/wired_usb?p=1 ✔ ✔ ✔ \\>= v01.30.00 ❌ Settings GoPro cameras have hundreds of setting options to choose from, all of which can be set using a single endpoint. The endpoint is configured with a setting id and an option value. Note that setting option values are not globally unique. While most option values are enumerated values, some are complex bitmasked values. Settings Quick Reference Below is a table of setting options detailing how to set every option supported by Open GoPro cameras. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Setting ID Setting Option HTTP Method Endpoint HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 2 Resolution Set video resolution (id: 2) to 4k (id: 1) GET /gopro/camera/setting?setting=2&option=1 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k (id: 4) GET /gopro/camera/setting?setting=2&option=4 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 6) GET /gopro/camera/setting?setting=2&option=6 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 1440 (id: 7) GET /gopro/camera/setting?setting=2&option=7 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 1080 (id: 9) GET /gopro/camera/setting?setting=2&option=9 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 18) GET /gopro/camera/setting?setting=2&option=18 ❌ ✔ ✔ ✔ ✔ 2 Resolution Set video resolution (id: 2) to 5k (id: 24) GET /gopro/camera/setting?setting=2&option=24 ❌ ❌ ❌ ❌ ✔ 2 Resolution Set video resolution (id: 2) to 5k 4:3 (id: 25) GET /gopro/camera/setting?setting=2&option=25 ❌ ❌ ❌ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 8:7 (id: 26) GET /gopro/camera/setting?setting=2&option=26 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 4:3 (id: 27) GET /gopro/camera/setting?setting=2&option=27 ❌ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 8:7 (id: 28) GET /gopro/camera/setting?setting=2&option=28 ✔ ✔ ✔ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 9:16 (id: 29) GET /gopro/camera/setting?setting=2&option=29 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 9:16 (id: 30) GET /gopro/camera/setting?setting=2&option=30 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k (id: 100) GET /gopro/camera/setting?setting=2&option=100 ❌ ✔ ✔ ✔ ❌ 2 Resolution Set video resolution (id: 2) to 5.3k 16:9 (id: 101) GET /gopro/camera/setting?setting=2&option=101 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 16:9 (id: 102) GET /gopro/camera/setting?setting=2&option=102 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 4k 4:3 (id: 103) GET /gopro/camera/setting?setting=2&option=103 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 16:9 (id: 104) GET /gopro/camera/setting?setting=2&option=104 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 2.7k 4:3 (id: 105) GET /gopro/camera/setting?setting=2&option=105 ✔ ❌ ❌ ❌ ❌ 2 Resolution Set video resolution (id: 2) to 1080 16:9 (id: 106) GET /gopro/camera/setting?setting=2&option=106 ✔ ❌ ❌ ❌ ❌ 3 Frames Per Second Set video fps (id: 3) to 240 (id: 0) GET /gopro/camera/setting?setting=3&option=0 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 120 (id: 1) GET /gopro/camera/setting?setting=3&option=1 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 100 (id: 2) GET /gopro/camera/setting?setting=3&option=2 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 60 (id: 5) GET /gopro/camera/setting?setting=3&option=5 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 50 (id: 6) GET /gopro/camera/setting?setting=3&option=6 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 30 (id: 8) GET /gopro/camera/setting?setting=3&option=8 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 25 (id: 9) GET /gopro/camera/setting?setting=3&option=9 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 24 (id: 10) GET /gopro/camera/setting?setting=3&option=10 ✔ ✔ ✔ ✔ ✔ 3 Frames Per Second Set video fps (id: 3) to 200 (id: 13) GET /gopro/camera/setting?setting=3&option=13 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to wide (id: 0) GET /gopro/camera/setting?setting=43&option=0 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to narrow (id: 2) GET /gopro/camera/setting?setting=43&option=2 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to superview (id: 3) GET /gopro/camera/setting?setting=43&option=3 ✔ ✔ ✔ ✔ ✔ 43 Webcam Digital Lenses Set webcam digital lenses (id: 43) to linear (id: 4) GET /gopro/camera/setting?setting=43&option=4 ✔ ✔ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to never (id: 0) GET /gopro/camera/setting?setting=59&option=0 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 1 min (id: 1) GET /gopro/camera/setting?setting=59&option=1 ✔ \\>= v02.10.00 \\>= v02.01.00 ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 5 min (id: 4) GET /gopro/camera/setting?setting=59&option=4 ✔ \\>= v02.10.00 ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 15 min (id: 6) GET /gopro/camera/setting?setting=59&option=6 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 30 min (id: 7) GET /gopro/camera/setting?setting=59&option=7 ✔ ❌ ✔ ✔ ✔ 59 Auto Power Down Set auto power down (id: 59) to 8 seconds (id: 11) GET /gopro/camera/setting?setting=59&option=11 ❌ \\>= v02.10.00 ❌ ❌ ❌ 59 Auto Power Down Set auto power down (id: 59) to 30 seconds (id: 12) GET /gopro/camera/setting?setting=59&option=12 ❌ \\>= v02.10.00 ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 4:3 (id: 0) GET /gopro/camera/setting?setting=108&option=0 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 16:9 (id: 1) GET /gopro/camera/setting?setting=108&option=1 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 8:7 (id: 3) GET /gopro/camera/setting?setting=108&option=3 ✔ ❌ ❌ ❌ ❌ 108 Aspect Ratio Set video aspect ratio (id: 108) to 9:16 (id: 4) GET /gopro/camera/setting?setting=108&option=4 ✔ ❌ ❌ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to wide (id: 0) GET /gopro/camera/setting?setting=121&option=0 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to narrow (id: 2) GET /gopro/camera/setting?setting=121&option=2 ❌ ❌ ❌ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to superview (id: 3) GET /gopro/camera/setting?setting=121&option=3 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear (id: 4) GET /gopro/camera/setting?setting=121&option=4 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to max superview (id: 7) GET /gopro/camera/setting?setting=121&option=7 ✔ \\>= v02.00.00 ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon leveling (id: 8) GET /gopro/camera/setting?setting=121&option=8 ✔ ✔ ✔ ✔ ✔ 121 Video Digital Lenses Set video digital lenses (id: 121) to hyperview (id: 9) GET /gopro/camera/setting?setting=121&option=9 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to linear + horizon lock (id: 10) GET /gopro/camera/setting?setting=121&option=10 ✔ ✔ ✔ ❌ ❌ 121 Video Digital Lenses Set video digital lenses (id: 121) to max hyperview (id: 11) GET /gopro/camera/setting?setting=121&option=11 ✔ ❌ ❌ ❌ ❌ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to narrow (id: 19) GET /gopro/camera/setting?setting=122&option=19 ❌ ❌ ❌ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to max superview (id: 100) GET /gopro/camera/setting?setting=122&option=100 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to wide (id: 101) GET /gopro/camera/setting?setting=122&option=101 ✔ ❌ ✔ ✔ ✔ 122 Photo Digital Lenses Set photo digital lenses (id: 122) to linear (id: 102) GET /gopro/camera/setting?setting=122&option=102 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to narrow (id: 19) GET /gopro/camera/setting?setting=123&option=19 ❌ ❌ ❌ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to max superview (id: 100) GET /gopro/camera/setting?setting=123&option=100 ❌ ❌ ✔ ✔ ❌ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to wide (id: 101) GET /gopro/camera/setting?setting=123&option=101 ✔ ❌ ✔ ✔ ✔ 123 Time Lapse Digital Lenses Set time lapse digital lenses (id: 123) to linear (id: 102) GET /gopro/camera/setting?setting=123&option=102 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse video (id: 13) GET /gopro/camera/setting?setting=128&option=13 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to time lapse photo (id: 20) GET /gopro/camera/setting?setting=128&option=20 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse photo (id: 21) GET /gopro/camera/setting?setting=128&option=21 ✔ ❌ ✔ ✔ ✔ 128 Media Format Set media format (id: 128) to night lapse video (id: 26) GET /gopro/camera/setting?setting=128&option=26 ✔ ❌ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 60hz (id: 2) GET /gopro/camera/setting?setting=134&option=2 ✔ ✔ ✔ ✔ ✔ 134 Anti-Flicker Set setup anti flicker (id: 134) to 50hz (id: 3) GET /gopro/camera/setting?setting=134&option=3 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to off (id: 0) GET /gopro/camera/setting?setting=135&option=0 ✔ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to low (id: 1) GET /gopro/camera/setting?setting=135&option=1 ✔ ✔ ✔ ❌ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to high (id: 2) GET /gopro/camera/setting?setting=135&option=2 ❌ ❌ ❌ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to boost (id: 3) GET /gopro/camera/setting?setting=135&option=3 ❌ ✔ ✔ ✔ ✔ 135 Hypersmooth Set video hypersmooth (id: 135) to auto boost (id: 4) GET /gopro/camera/setting?setting=135&option=4 ✔ ✔ ✔ ❌ ❌ 135 Hypersmooth Set video hypersmooth (id: 135) to standard (id: 100) GET /gopro/camera/setting?setting=135&option=100 ❌ ❌ ❌ ✔ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to off (id: 0) GET /gopro/camera/setting?setting=150&option=0 ❌ \\>= v02.00.00 ✔ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to on (id: 1) GET /gopro/camera/setting?setting=150&option=1 ❌ \\>= v02.00.00 ❌ ❌ ❌ 150 Horizon Leveling Set video horizon levelling (id: 150) to locked (id: 2) GET /gopro/camera/setting?setting=150&option=2 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to off (id: 0) GET /gopro/camera/setting?setting=151&option=0 ❌ ❌ ✔ ❌ ❌ 151 Horizon Leveling Set photo horizon levelling (id: 151) to locked (id: 2) GET /gopro/camera/setting?setting=151&option=2 ❌ ❌ ✔ ❌ ❌ 162 Max Lens Set max lens (id: 162) to off (id: 0) GET /gopro/camera/setting?setting=162&option=0 ❌ ❌ ✔ \\>= v01.20.00 ✔ 162 Max Lens Set max lens (id: 162) to on (id: 1) GET /gopro/camera/setting?setting=162&option=1 ❌ ❌ ✔ \\>= v01.20.00 ✔ 167 Hindsight* Set hindsight (id: 167) to 15 seconds (id: 2) GET /gopro/camera/setting?setting=167&option=2 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to 30 seconds (id: 3) GET /gopro/camera/setting?setting=167&option=3 ✔ ❌ ✔ ✔ ✔ 167 Hindsight* Set hindsight (id: 167) to off (id: 4) GET /gopro/camera/setting?setting=167&option=4 ✔ ❌ ✔ ✔ ✔ 171 Interval Set photo single interval (id: 171) to off (id: 0) GET /gopro/camera/setting?setting=171&option=0 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 0.5s (id: 2) GET /gopro/camera/setting?setting=171&option=2 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 1s (id: 3) GET /gopro/camera/setting?setting=171&option=3 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 2s (id: 4) GET /gopro/camera/setting?setting=171&option=4 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 5s (id: 5) GET /gopro/camera/setting?setting=171&option=5 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 10s (id: 6) GET /gopro/camera/setting?setting=171&option=6 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 30s (id: 7) GET /gopro/camera/setting?setting=171&option=7 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 60s (id: 8) GET /gopro/camera/setting?setting=171&option=8 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 120s (id: 9) GET /gopro/camera/setting?setting=171&option=9 ✔ ❌ ❌ ❌ ❌ 171 Interval Set photo single interval (id: 171) to 3s (id: 10) GET /gopro/camera/setting?setting=171&option=10 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to off (id: 0) GET /gopro/camera/setting?setting=172&option=0 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 seconds (id: 1) GET /gopro/camera/setting?setting=172&option=1 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 seconds (id: 2) GET /gopro/camera/setting?setting=172&option=2 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 minute (id: 3) GET /gopro/camera/setting?setting=172&option=3 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 5 minutes (id: 4) GET /gopro/camera/setting?setting=172&option=4 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 15 minutes (id: 5) GET /gopro/camera/setting?setting=172&option=5 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 30 minutes (id: 6) GET /gopro/camera/setting?setting=172&option=6 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 1 hour (id: 7) GET /gopro/camera/setting?setting=172&option=7 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 2 hours (id: 8) GET /gopro/camera/setting?setting=172&option=8 ✔ ❌ ❌ ❌ ❌ 172 Duration Set photo interval duration (id: 172) to 3 hours (id: 9) GET /gopro/camera/setting?setting=172&option=9 ✔ ❌ ❌ ❌ ❌ 173 Video Performance Mode Set video performance mode (id: 173) to maximum video performance (id: 0) GET /gopro/camera/setting?setting=173&option=0 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to extended battery (id: 1) GET /gopro/camera/setting?setting=173&option=1 ❌ ❌ ❌ \\>= v01.16.00 ❌ 173 Video Performance Mode Set video performance mode (id: 173) to tripod / stationary video (id: 2) GET /gopro/camera/setting?setting=173&option=2 ❌ ❌ ❌ \\>= v01.16.00 ❌ 175 Controls Set controls (id: 175) to easy (id: 0) GET /gopro/camera/setting?setting=175&option=0 ✔ ✔ ✔ ❌ ❌ 175 Controls Set controls (id: 175) to pro (id: 1) GET /gopro/camera/setting?setting=175&option=1 ✔ ✔ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (id: 0) GET /gopro/camera/setting?setting=176&option=0 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (id: 1) GET /gopro/camera/setting?setting=176&option=1 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 2) GET /gopro/camera/setting?setting=176&option=2 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light) (id: 3) GET /gopro/camera/setting?setting=176&option=3 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4) GET /gopro/camera/setting?setting=176&option=4 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt) (id: 5) GET /gopro/camera/setting?setting=176&option=5 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light) (id: 6) GET /gopro/camera/setting?setting=176&option=6 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) GET /gopro/camera/setting?setting=176&option=7 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) GET /gopro/camera/setting?setting=176&option=8 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) GET /gopro/camera/setting?setting=176&option=9 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (low light, 50hz) (id: 10) GET /gopro/camera/setting?setting=176&option=10 ✔ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11) GET /gopro/camera/setting?setting=176&option=11 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12) GET /gopro/camera/setting?setting=176&option=12 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13) GET /gopro/camera/setting?setting=176&option=13 ❌ ❌ ✔ ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14) GET /gopro/camera/setting?setting=176&option=14 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15) GET /gopro/camera/setting?setting=176&option=15 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16) GET /gopro/camera/setting?setting=176&option=16 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt) (id: 17) GET /gopro/camera/setting?setting=176&option=17 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt) (id: 18) GET /gopro/camera/setting?setting=176&option=18 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light) (id: 19) GET /gopro/camera/setting?setting=176&option=19 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20) GET /gopro/camera/setting?setting=176&option=20 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21) GET /gopro/camera/setting?setting=176&option=21 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22) GET /gopro/camera/setting?setting=176&option=22 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23) GET /gopro/camera/setting?setting=176&option=23 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k) (id: 24) GET /gopro/camera/setting?setting=176&option=24 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) GET /gopro/camera/setting?setting=176&option=25 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26) GET /gopro/camera/setting?setting=176&option=26 ✔ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27) GET /gopro/camera/setting?setting=176&option=27 ❌ ❌ \\>= v02.01.00 ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 28) GET /gopro/camera/setting?setting=176&option=28 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 29) GET /gopro/camera/setting?setting=176&option=29 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 30) GET /gopro/camera/setting?setting=176&option=30 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 31) GET /gopro/camera/setting?setting=176&option=31 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 32) GET /gopro/camera/setting?setting=176&option=32 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 33) GET /gopro/camera/setting?setting=176&option=33 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 34) GET /gopro/camera/setting?setting=176&option=34 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 35) GET /gopro/camera/setting?setting=176&option=35 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 36) GET /gopro/camera/setting?setting=176&option=36 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 37) GET /gopro/camera/setting?setting=176&option=37 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 38) GET /gopro/camera/setting?setting=176&option=38 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 39) GET /gopro/camera/setting?setting=176&option=39 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 40) GET /gopro/camera/setting?setting=176&option=40 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 41) GET /gopro/camera/setting?setting=176&option=41 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 42) GET /gopro/camera/setting?setting=176&option=42 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 2x slo-mo (id: 43) GET /gopro/camera/setting?setting=176&option=43 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 44) GET /gopro/camera/setting?setting=176&option=44 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 45) GET /gopro/camera/setting?setting=176&option=45 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 46) GET /gopro/camera/setting?setting=176&option=46 ✔ ❌ ❌ ❌ ❌ 176 Speed Set speed (id: 176) to 1x speed / low light (id: 47) GET /gopro/camera/setting?setting=176&option=47 ✔ ❌ ❌ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to off (id: 0) GET /gopro/camera/setting?setting=177&option=0 ❌ ❌ ✔ ❌ ❌ 177 Enable Night Photo Set enable night photo (id: 177) to on (id: 1) GET /gopro/camera/setting?setting=177&option=1 ❌ ❌ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 2.4ghz (id: 0) GET /gopro/camera/setting?setting=178&option=0 ✔ ✔ ✔ ❌ ❌ 178 Wireless Band Set wireless band (id: 178) to 5ghz (id: 1) GET /gopro/camera/setting?setting=178&option=1 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to short (id: 1) GET /gopro/camera/setting?setting=179&option=1 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to long (id: 2) GET /gopro/camera/setting?setting=179&option=2 ✔ ✔ ✔ ❌ ❌ 179 Trail Length Set trail length (id: 179) to max (id: 3) GET /gopro/camera/setting?setting=179&option=3 ✔ ✔ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to highest quality (id: 0) GET /gopro/camera/setting?setting=180&option=0 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (id: 1) GET /gopro/camera/setting?setting=180&option=1 ❌ ❌ ✔ ❌ ❌ 180 Video Mode Set video mode (id: 180) to extended battery (green icon) (id: 101) GET /gopro/camera/setting?setting=180&option=101 ❌ ❌ \\>= v02.01.00 ❌ ❌ 180 Video Mode Set video mode (id: 180) to longest battery (green icon) (id: 102) GET /gopro/camera/setting?setting=180&option=102 ❌ ❌ \\>= v02.01.00 ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to standard (id: 0) GET /gopro/camera/setting?setting=182&option=0 ✔ ❌ ❌ ❌ ❌ 182 Bit Rate Set system video bit rate (id: 182) to high (id: 1) GET /gopro/camera/setting?setting=182&option=1 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 8-bit (id: 0) GET /gopro/camera/setting?setting=183&option=0 ✔ ❌ ❌ ❌ ❌ 183 Bit Depth Set system video bit depth (id: 183) to 10-bit (id: 2) GET /gopro/camera/setting?setting=183&option=2 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to standard (id: 0) GET /gopro/camera/setting?setting=184&option=0 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to hdr (id: 1) GET /gopro/camera/setting?setting=184&option=1 ✔ ❌ ❌ ❌ ❌ 184 Profiles Set video profile (id: 184) to log (id: 2) GET /gopro/camera/setting?setting=184&option=2 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to widescreen (id: 0) GET /gopro/camera/setting?setting=185&option=0 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to mobile (id: 1) GET /gopro/camera/setting?setting=185&option=1 ✔ ❌ ❌ ❌ ❌ 185 Aspect Ratio Set video easy aspect ratio (id: 185) to universal (id: 2) GET /gopro/camera/setting?setting=185&option=2 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to highest quality (id: 0) GET /gopro/camera/setting?setting=186&option=0 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to standard quality (id: 1) GET /gopro/camera/setting?setting=186&option=1 ✔ ❌ ❌ ❌ ❌ 186 Video Mode Set video easy presets (id: 186) to basic quality (id: 2) GET /gopro/camera/setting?setting=186&option=2 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to timewarp (id: 0) GET /gopro/camera/setting?setting=187&option=0 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to star trails (id: 1) GET /gopro/camera/setting?setting=187&option=1 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to light painting (id: 2) GET /gopro/camera/setting?setting=187&option=2 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to vehicle lights (id: 3) GET /gopro/camera/setting?setting=187&option=3 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max timewarp (id: 4) GET /gopro/camera/setting?setting=187&option=4 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max star trails (id: 5) GET /gopro/camera/setting?setting=187&option=5 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max light painting (id: 6) GET /gopro/camera/setting?setting=187&option=6 ✔ ❌ ❌ ❌ ❌ 187 Lapse Mode Set multi shot easy presets (id: 187) to max vehicle lights (id: 7) GET /gopro/camera/setting?setting=187&option=7 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to widescreen (id: 0) GET /gopro/camera/setting?setting=188&option=0 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to mobile (id: 1) GET /gopro/camera/setting?setting=188&option=1 ✔ ❌ ❌ ❌ ❌ 188 Aspect Ratio Set multi shot easy aspect ratio (id: 188) to universal (id: 2) GET /gopro/camera/setting?setting=188&option=2 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to none (id: 0) GET /gopro/camera/setting?setting=189&option=0 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 1.0 (id: 1) GET /gopro/camera/setting?setting=189&option=1 ✔ ❌ ❌ ❌ ❌ 189 Max Lens Mod Set system addon lens active (id: 189) to max lens 2.0 (id: 2) GET /gopro/camera/setting?setting=189&option=2 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to off (id: 0) GET /gopro/camera/setting?setting=190&option=0 ✔ ❌ ❌ ❌ ❌ 190 Max Lens Mod Enable Set system addon lens status (id: 190) to on (id: 1) GET /gopro/camera/setting?setting=190&option=1 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to super photo (id: 0) GET /gopro/camera/setting?setting=191&option=0 ✔ ❌ ❌ ❌ ❌ 191 Photo Mode Set photo easy presets (id: 191) to night photo (id: 1) GET /gopro/camera/setting?setting=191&option=1 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0) GET /gopro/camera/setting?setting=192&option=0 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1) GET /gopro/camera/setting?setting=192&option=1 ✔ ❌ ❌ ❌ ❌ 192 Aspect Ratio Set multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3) GET /gopro/camera/setting?setting=192&option=3 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to widescreen (id: 0) GET /gopro/camera/setting?setting=193&option=0 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to vertical (id: 1) GET /gopro/camera/setting?setting=193&option=1 ✔ ❌ ❌ ❌ ❌ 193 Framing Set video easy framing (id: 193) to full frame (id: 2) GET /gopro/camera/setting?setting=193&option=2 ✔ ❌ ❌ ❌ ❌ 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. Note about Dependency Ordering and Blacklisting 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. Example Camera Command 1 Command 2 Command 3 Command 4 Command 5 Guaranteed Valid? HERO10 Black Res: 1080 Anti-Flicker: 60Hz (NTSC) FPS: 240 FOV: Wide Hypersmooth: OFF ✔ HERO10 Black FPS: 240 Anti-Flicker: 60Hz (NTSC) 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 Documents Product Release capabilities.xlsx capabilities.json HERO12 Black v01.30.00 v01.20.00 v01.10.00 HERO11 Black Mini v02.30.00 v02.20.00 v02.10.00 v02.00.00 v01.10.00 HERO11 Black v02.12.00 v02.10.00 v02.01.00 v01.20.00 v01.12.00 v01.10.00 HERO10 Black v01.50.00 v01.46.00 v01.42.00 v01.40.00 v01.30.00 v01.20.00 v01.16.00 v01.10.00 HERO9 Black v01.72.00 v01.70.00 Spreadsheet Format 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 Format 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. Below is a simplified example of the capabilities JSON file; a formal schema is also available here: capabilities_schema.json { \"(PRODUCT_NAME)\": { \"(RELEASE_VERSION)\": { \"states\": [ [ {\"setting_name\": \"(str)\", \"setting_id\": (int), \"option_name\": \"(str)\", \"option_id\": (int)}, ... ], ... ], }, ... }, ... } Media The camera provides an endpoint to query basic details about media captured on the sdcard. Chapters All GoPro cameras break longer videos into chapters. GoPro cameras currently limit file sizes on sdcards to 4GB for both FAT32 and exFAT file systems. This limitation is most commonly seen when recording longer (10+ minute) videos. In practice, the camera will split video media into chapters named Gqccmmmm.MP4 (and ones for THM/LRV) such that: q: Quality Level (X: Extreme, H: High, M: Medium, L: Low) cc: Chapter Number (01-99) mmmm: Media ID (0001-9999) When media becomes chaptered, the camera increments subsequent Chapter Numbers while leaving the Media ID unchanged. For example, if the user records a long High-quality video that results in 4 chapters, the files on the sdcard may look like the following: -rwxrwxrwx@ 1 gopro 123456789 4006413091 Jan 1 00:00 GH010078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17663 Jan 1 00:00 GH010078.THM -rwxrwxrwx@ 1 gopro 123456789 4006001541 Jan 1 00:00 GH020078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17357 Jan 1 00:00 GH020078.THM -rwxrwxrwx@ 1 gopro 123456789 4006041985 Jan 1 00:00 GH030078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17204 Jan 1 00:00 GH030078.THM -rwxrwxrwx@ 1 gopro 123456789 756706872 Jan 1 00:00 GH040078.MP4 -rwxrwxrwx@ 1 gopro 123456789 17420 Jan 1 00:00 GH040078.THM -rwxrwxrwx@ 1 gopro 123456789 184526939 Jan 1 00:00 GL010078.LRV -rwxrwxrwx@ 1 gopro 123456789 184519787 Jan 1 00:00 GL020078.LRV -rwxrwxrwx@ 1 gopro 123456789 184517614 Jan 1 00:00 GL030078.LRV -rwxrwxrwx@ 1 gopro 123456789 34877660 Jan 1 00:00 GL040078.LRV Media Info Format The Media: Info command provides additional details about a media above and beyond its counterpart, the Media: List command. Such information includes resolution, frame rate, duration, hilight info, etc. Example Video Info: { \"cre\": \"1613676644\", \"s\": \"11305367\", \"mahs\": \"1\", \"us\": \"0\", \"mos\": [], \"eis\": \"0\", \"pta\": \"1\", \"ao\": \"stereo\", \"tr\": \"0\", \"mp\": \"0\", \"ct\": \"0\", \"rot\": \"0\", \"fov\": \"4\", \"lc\": \"0\", \"prjn\": \"6\", \"gumi\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\", \"ls\": \"1072714\", \"cl\": \"0\", \"avc_profile\": \"4\", \"profile\": \"42\", \"hc\": \"0\", \"hi\": [], \"dur\": \"2\", \"w\": \"1920\", \"h\": \"1080\", \"fps\": \"60000\", \"fps_denom\": \"1001\", \"prog\": \"1\", \"subsample\": \"0\" } Common Keys (Video / Photo) Key Type Description Examples ao string Audio Option off, stereo, wind, auto avc_profile uint8 Advanced Video Codec Profile 0..255 cl bool File clipped from another source? 0:false, 1:true cre uint32 File creation timestamp (sec since epoch) 1692992748 ct uint32 Content type 0..12 dur uint32 Duration of video in seconds 42 eis bool File made with Electronic Image Stabilization 0:false, 1:true fps uint32 Frame rate (numerator) 1001 fps_denom uint32 Frme rate (denominator) 30000 gumi string Globally Unique Media ID \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\" h uint32 Video height in pixels 1080 hc uint32 Hilight count video:0..99, photo:0..1 hdr bool Photo taken with High Dynamic Range? 0:false, 1:true hi Array of uint32 Offset to hilights in media in milliseconds [1500, 4700] lc uint32 Spherical Lens Config 0:front, 1:rear ls int32 Low Resolution Video file size in bytes (or -1 if no LRV file) -1, 1234567890 mos Array of string Mobile Offload State \"app\", \"pc\", \"other\" mp bool Metadata Present? 0:no metadata, 1:metadata exists profile uint8 Advanced Video Codec Level 0..255 prog bool Is video progressive? 0:interlaced, 1:progressive pta bool Media has Protune audio file? 0:false, 1:true raw bool Photo has raw version? 0:false, 1:true s uint64 File size in bytes 1234567890 subsample bool Is video subsampled? 0:false, 1:true tr bool Is file transcoded? 0:false, 1:true w uint32 Width of media in pixels 1920 wdr bool Photo taken with Wide Dynamic Range? 0:false, 1:true Video Keys Key Type Description Examples ao string Audio Option off, stereo, wind, auto avc_profile uint8 Advanced Video Codec Profile 0..255 cl bool File clipped from another source? 0:false, 1:true dur uint32 Duration of video in seconds 42 fps uint32 Frame rate (numerator) 1001 fps_denom uint32 Frme rate (denominator) 30000 hi Array of uint32 Offset to hilights in media in milliseconds [1500, 4700] ls int32 Low Resolution Video file size in bytes (or -1 if no LRV file) -1, 1234567890 profile uint8 Advanced Video Codec Level 0..255 prog bool Is video progressive? 0:interlaced, 1:progressive pta bool Media has Protune audio file? 0:false, 1:true subsample bool Is video subsampled? 0:false, 1:true Photo Keys Key Type Description Examples hdr bool Photo taken with High Dynamic Range? 0:false, 1:true raw bool Photo has raw version? 0:false, 1:true wdr bool Photo taken with Wide Dynamic Range? 0:false, 1:true Media Info: Content Type The \"ct\" (Content Type) metadata indicates what mode (or group) the media was captured in. Note: All Time Lapse modes that result in MPEG media use the same content type ID. ID Mode Video 0 Looping 1 Chaptered Video 2 Time Lapse 3 Single Photo 4 Burst Photo 5 Time Lapse Photo 6 Night Lapse Photo 8 Night Photo 9 Continuous Photo 10 Raw Photo 11 Live Burst 12 Media List Format The format of the media list is given below. { \"id\": \"<MEDIA SESSION ID>\", \"media\": [ { \"d\": \"<DIRECTORY NAME>\", \"fs\": [ {<MEDIA ITEM INFO>}, ... ] }, ... ] } Media List Keys The outer structure of the media list and the inner structure of individual media items use the keys in the table below. Key Description b ID of first member of a group (for grouped media items) cre Creation timestamp (seconds since epoch) d Directory name fs File system. Contains listing of media items in directory g Group ID (if grouped media item) glrv Low resolution video file size id Media list session identifier l ID of last member of a group (for grouped media items) m List of missing/deleted group member IDs (for grouped media items) media Contains media info for for each directory (e.g. 100GOPRO/, 101GOPRO/, ...) mod Last modified time (seconds since epoch) n Media filename s Size of (group) media in bytes t Group type (for grouped media items) (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse) Grouped Media Items To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos, Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys that allow the user to extrapolate individual filenames for each member of the group. Filenames for group media items have the form \"GXXXYYYY.ZZZ\" where XXX is the group ID, YYY is the group member ID and ZZZ is the file extension. For example, take the media list below, which contains a Time Lapse Photo group media item: { \"id\": \"2530266050123724003\", \"media\": [ { \"d\": \"100GOPRO\", \"fs\": [ { \"b\": \"8\", \"cre\": \"1613669353\", \"g\": \"1\", \"l\": \"396\", \"m\": ['75', '139'], \"mod\": \"1613669353\", \"n\": \"G0010008.JPG\", \"s\": \"773977407\", \"t\": \"t\" } ] } ] } The first filename in the group is \"G0010008.JPG\" (key: \"n\"). The ID of the first group member in this case is \"008\" (key: \"b\"). The ID of the last group member in this case is \"396\" (key: \"l\"). The IDs of deleted members in this case are \"75\" and \"139\" (key: \"m\") Given this information, the user can extrapolate that the group currently contains G0010008.JPG, G0010009.JPG, G0010010.JPG, ..., G0010074.JPG, G0010076.JPG, ..., G0010138.JPG, G0010140.JPG, ..., G0010394.JPG, G0010395.JPG. G0010396.JPG Media HiLights The HiLight Tags feature allows the user to tag moments of interest either during video capture or on existing media. Add/Remove HiLights Below is a table of all HiLight commands. For details on how to send HiLight commands, see Commands Quick Reference. Command Description Media: HiLight (Add) Video: Add a tag at a specific time offset (ms) Photo: Add a tag Media: HiLight (Remove) Video: Remove a tag at a specific time offset (ms) Photo: Remove tag Media: HiLight Moment Add a tag to the current time offset (ms) while encoding video Note: Attempting to add a HiLight tag at a time offset that exceeds the duration of the video or removing a non-existent HiLight tag will result in an HTTP/500 error. Get HiLights Once HiLight tags have been added, they can be queried by calling the Media: Info command; the response content will be JSON that contains HiLight information: Media Type Key Value Photo hc HiLight Count Video hc HiLight Count Video hi HiLights (list of time offsets in ms) Example The JSON sample below shows media that contains three HiLights at time offsets 2502ms, 5839ms, and 11478ms. Note: Photo info will not have an \"hi\":[...] key-value pair. { ..., \"hc\":\"3\", \"hi\":[2502,5839,11478], ..., } Downloading Media The URL to download/stream media from the DCIM/ directory on the sdcard is the Base URL plus /videos/DCIM/XXX/YYY where XXX is the directory name within DCIM/ given by the media list and YYY is the target media filename. For example: Given the following media list: { \"id\": \"3586667939918700960\", \"media\": [ { \"d\": \"100GOPRO\", \"fs\": [ { \"n\": \"GH010397.MP4\", \"cre\": \"1613672729\", \"mod\": \"1613672729\", \"glrv\": \"1895626\", \"ls\": \"-1\", \"s\": \"19917136\" }, { \"cre\": \"1614340213\", \"mod\": \"1614340213\", \"n\": \"GOPR0001.JPG\", \"s\": \"6961371\" } ] } ] } The URL to download GH010397.MP4 over WiFi would be http://10.5.5.9:8080/videos/DCIM/100GOPRO/GH010397.MP4 The URL to download GOPR0001.JPG over WiFi would be http://10.5.5.9:8080/videos/DCIM/100GOPRO/GOPR0001.JPG Turbo Transfer Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. This special mode should only be used during media offload. It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. For details on which cameras are supported and how to enable and disable Turbo Transfer, see Commands Quick Reference. Downloading Preview Stream When the preview stream is started, the camera starts up a UDP client and begins writing MPEG Transport Stream data to the client on port 8554. In order to stream this data, the client must implement a UDP connection that binds to the same port and decode the data. Camera State The camera provides multiple types of state, all of which can be queried: Camera state: Contains information about camera status (photos taken, date, is-camera-encoding, etc) and settings (current video resolution, current frame rate, etc) Preset State: How presets are arranged into preset groups, their titles, icons, settings closely associated with each preset, etc Camera State Format Camera state is given in the following form: { \"status\": { \"1\": <status 1 value>, \"2\": <status 2 value>, ... }, \"settings: { \"2\": <setting 2 value>, \"3\": <setting 3 value>, ... } } Where status X value and setting X value are almost always integer values. See Status Codes table in this document for exceptions. For status, keys are status codes and values are status values. For settings, keys are setting IDs, and values are option values Status IDs Below is a table of supported status IDs. * Indicates that item is experimental ✔ Indicates support for all Open GoPro firmware versions. ❌ Indicates a lack of support for all Open GoPro firmware versions. >= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ Status ID Name Description Type Values HERO12 Black HERO11 Black Mini HERO11 Black HERO10 Black HERO9 Black 1 Internal battery present Is the system's internal battery present? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 2 Internal battery level Rough approximation of internal battery level in bars (or charging) integer 0: Zero 1: One 2: Two 3: Three 4: Charging ✔ ✔ ✔ ✔ ✔ 6 System hot Is the system currently overheating? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 8 System busy Is the camera busy? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 9 Quick capture active Is Quick Capture feature enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 10 Encoding active Is the system encoding right now? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 11 Lcd lock active Is LCD lock active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 13 Video progress counter When encoding video, this is the duration (seconds) of the video so far; 0 otherwise integer * ✔ ✔ ✔ ✔ ✔ 17 Enable Are Wireless Connections enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 19 State The pairing state of the camera integer 0: Never Started 1: Started 2: Aborted 3: Cancelled 4: Completed ✔ ✔ ✔ ✔ ✔ 20 Type The last type of pairing that the camera was engaged in integer 0: Not Pairing 1: Pairing App 2: Pairing Remote Control 3: Pairing Bluetooth Device ✔ ✔ ✔ ✔ ✔ 21 Pair time Time (milliseconds) since boot of last successful pairing complete action integer * ❌ ✔ ✔ ✔ ✔ 22 State State of current scan for WiFi Access Points. Appears to only change for CAH-related scans integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 23 Scan time msec The time, in milliseconds since boot that the WiFi Access Point scan completed integer * ✔ ✔ ✔ ✔ ✔ 24 Provision status WiFi AP provisioning state integer 0: Never started 1: Started 2: Aborted 3: Canceled 4: Completed ✔ ✔ ✔ ✔ ✔ 26 Remote control version Wireless remote control version integer * ❌ ✔ ✔ ✔ ✔ 27 Remote control connected Is a wireless remote control connected? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 28 Pairing Wireless Pairing State integer * ❌ ✔ ✔ ✔ ✔ 29 Wlan ssid SSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 30 Ap ssid The camera's WiFi SSID. On BLE connection, value is big-endian byte-encoded int string * ✔ ✔ ✔ ✔ ✔ 31 App count The number of wireless devices connected to the camera integer * ✔ ✔ ✔ ✔ ✔ 32 Enable Is Preview Stream enabled? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 33 Sd status Primary Storage Status integer -1: Unknown 0: OK 1: SD Card Full 2: SD Card Removed 3: SD Card Format Error 4: SD Card Busy 8: SD Card Swapped ✔ ✔ ✔ ✔ ✔ 34 Remaining photos How many photos can be taken before sdcard is full integer * ✔ ❌ ✔ ✔ ✔ 35 Remaining video time How many minutes of video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ How many group photos can be taken with current settings before sdcard is full 38 Num total photos Total number of photos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 39 Num total videos Total number of videos on sdcard integer * ✔ ✔ ✔ ✔ ✔ 41 Ota status The current status of Over The Air (OTA) update integer 0: Idle 1: Downloading 2: Verifying 3: Download Failed 4: Verify Failed 5: Ready 6: GoPro App: Downloading 7: GoPro App: Verifying 8: GoPro App: Download Failed 9: GoPro App: Verify Failed 10: GoPro App: Ready ✔ ✔ ✔ ✔ ✔ 42 Download cancel request pending Is there a pending request to cancel a firmware update download? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 45 Camera locate active Is locate camera feature active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 49 Multi shot count down The current timelapse interval countdown value (e.g. 5...4...3...2...1...) integer * ✔ ✔ ✔ ✔ ✔ 54 Remaining space Remaining space on the sdcard in Kilobytes integer * ✔ ✔ ✔ ✔ ✔ 55 Supported Is preview stream supported in current recording/mode/secondary-stream? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 56 Wifi bars WiFi signal strength in bars integer * ✔ ✔ ✔ ✔ ✔ 58 Num hilights The number of hilights in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 59 Last hilight time msec Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops) integer * ✔ ✔ ✔ ✔ ✔ 60 Next poll msec The min time between camera status updates (msec). Do not poll for status more often than this integer * ✔ ✔ ✔ ✔ ✔ 64 Remaining timelapse time How many min of Timelapse video can be captured with current settings before sdcard is full integer * ✔ ✔ ✔ ✔ ✔ 65 Exposure select type Liveview Exposure Select Mode integer 0: Disabled 1: Auto 2: ISO Lock 3: Hemisphere ✔ ❌ ✔ ✔ ✔ 66 Exposure select x Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 67 Exposure select y Liveview Exposure Select: y-coordinate (percent) percent 0-100 ✔ ❌ ✔ ✔ ✔ 68 Gps status Does the camera currently have a GPS lock? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 69 Ap state Is the camera in AP Mode? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 70 Internal battery percentage Internal battery level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 74 Acc mic status Microphone Accesstory status integer 0: Microphone mod not connected 1: Microphone mod connected 2: Microphone mod connected and microphone plugged into Microphone mod ✔ ✔ ✔ ✔ ✔ 75 Digital zoom Digital Zoom level (percent) percent 0-100 ✔ ✔ ✔ ✔ ✔ 76 Wireless band Wireless Band integer 0: 2.4 GHz 1: 5 GHz 2: Max ✔ ✔ ✔ ✔ ✔ 77 Digital zoom active Is Digital Zoom feature available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 78 Mobile friendly video Are current video settings mobile friendly? (related to video compression and frame rate) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 79 First time use Is the camera currently in First Time Use (FTU) UI flow? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 81 Band 5ghz avail Is 5GHz wireless band available? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 82 System ready Is the system ready to accept commands? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 83 Batt okay for ota Is the internal battery charged sufficiently to start Over The Air (OTA) update? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 85 Video low temp alert Is the camera getting too cold to continue recording? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 86 Actual orientation The rotational orientation of the camera integer 0: 0 degrees (upright) 1: 180 degrees (upside down) 2: 90 degrees (laying on right side) 3: 270 degrees (laying on left side) ✔ ✔ ✔ ✔ ✔ 88 Zoom while encoding Is this camera capable of zooming while encoding (static value based on model, not settings) boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 89 Current mode Current flatmode ID integer * ✔ ✔ ✔ ✔ ✔ 93 Active video presets Current Video Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 94 Active photo presets Current Photo Preset (ID) integer * ✔ ❌ ✔ ✔ ✔ 95 Active timelapse presets Current Timelapse Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 96 Active presets group Current Preset Group (ID) integer * ✔ ✔ ✔ ✔ ✔ 97 Active preset Current Preset (ID) integer * ✔ ✔ ✔ ✔ ✔ 98 Preset modified Preset Modified Status, which contains an event ID and a preset (group) ID integer * ✔ ✔ ✔ ✔ ✔ 99 Remaining live bursts How many Live Bursts can be captured before sdcard is full integer * ❌ ❌ ✔ ✔ ✔ 100 Num total live bursts Total number of Live Bursts on sdcard integer * ❌ ❌ ✔ ✔ ✔ 101 Capture delay active Is Capture Delay currently active (i.e. counting down)? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 102 Media mod mic status Media mod State integer 0: Media mod microphone removed 2: Media mod microphone only 3: Media mod microphone with external microphone ✔ ✔ ✔ ✔ ✔ 103 Timewarp speed ramp active Time Warp Speed integer 0: 15x 1: 30x 2: 60x 3: 150x 4: 300x 5: 900x 6: 1800x 7: 2x 8: 5x 9: 10x 10: Auto 11: 1x (realtime) 12: 1/2x (slow-motion) ✔ ✔ ✔ ✔ ✔ 104 Linux core active Is the system's Linux core active? boolean 0: False 1: True ❌ ❌ ❌ ✔ ✔ 105 Camera lens type Camera lens type (reflects changes to setting 162 or setting 189) integer 0: Default 1: Max Lens 2: Max Lens 2.0 ✔ ✔ ✔ ✔ ✔ 106 Video hindsight capture active Is Video Hindsight Capture Active? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 107 Scheduled preset Scheduled Capture Preset ID integer * ✔ ❌ ✔ ✔ ✔ 108 Scheduled enabled Is Scheduled Capture set? boolean 0: False 1: True ✔ ❌ ✔ ✔ ✔ 110 Media mod status Media Mode Status (bitmasked) integer 0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False 1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True 2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False 3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True 4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False 5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True 6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False 7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True ✔ ❌ ✔ ✔ ✔ 111 Sd rating check error Does sdcard meet specified minimum write speed? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 112 Sd write speed error Number of sdcard write speed errors since device booted integer * ✔ ✔ ✔ ✔ ❌ 113 Turbo transfer Is Turbo Transfer active? boolean 0: False 1: True ✔ ✔ ✔ ✔ ✔ 114 Camera control status Camera control status ID integer 0: Camera Idle: No one is attempting to change camera settings 1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control 2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings ✔ ✔ ✔ ✔ ❌ 115 Usb connected Is the camera connected to a PC via USB? boolean 0: False 1: True ✔ ✔ ✔ ✔ ❌ 116 Allow control over usb Camera control over USB state integer 0: Disabled 1: Enabled ✔ ✔ ✔ \\>= v01.30.00 ❌ 117 Total sd space kb Total SD card capacity in Kilobytes integer * ✔ ✔ ✔ ❌ ❌ Preset Status Format Preset Status is returned as JSON, whose content is the serialization of the protobuf message: NotifyPresetStatus. Using Google protobuf APIs, the JSON can be converted back into a programmatic object in the user's language of choice. Features Presets The camera organizes modes of operation into presets. A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. Depending on the camera's state, different collections of presets will be available for immediate loading and use. Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: ID Setting 162 Max Lens 173 Video Performance Mode 175 Controls 177 Enable Night Photo 180 Video Mode 186 Video Mode 187 Lapse Mode 189 Max Lens Mod 190 Max Lens Mod Enable 191 Photo Mode To determine which presets are available for immediate use, get Preset Status. Preset Status All cameras support basic query and subscription mechanics that allow the user to: Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state Preset Status should not be confused with camera status: Preset Status contains information about current preset groups and presets Camera status contains numerous statuses about current settings and camera system state Preset Groups Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. Presets Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of Settings associated with the Preset. Important Note: The Preset ID is required to load a Preset via the Presets: Load command. Global Behaviors In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a connected app is discouraged. Best practice for synchronizing user/app control is to use the Set Camera Control Status command and corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera Control Status ID IDLE 0 CONTROL 1 EXTERNAL_CONTROL 2 Set Camera Control Status This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. This causes the camera to immediately exit any contextual menus and return to the idle screen. Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. If the user returns the camera UI to the idle screen, the camera updates control status to Idle. Note: The entity currently claiming control of the camera is advertised in camera status 114 Information about whether the camera is in a contextual menu or not is advertised in camera status 63. OTA Update The Over The Air (OTA) update feature allows the user to update the camera's firmware via HTTP connection. There are two ways to perform OTA updates: Simple OTA Update and Resumable OTA Update. Firmware update files can be obtained from GoPro's update page or programmatically using the firmware catalog. Note: In order to complete the firmware update process, the camera will reboot one or more times. This will cause any existing HTTP connections to be lost. Simple OTA Update The simple OTA update process is done by sending an entire update file to the camera in a single HTTP/POST. Details can be found in the diagram below. Simple OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/POST: /gp/gpUpdateContent-Type: multipart/form-dataData:DirectToSD=1update=1sha1=<SHA1_HASH>file=<UPDATE.zip>HTTP/200 (OK)JSON: { \"status\":\"0\" }WiFi connection terminatesCamera displays \"Update Complete\" OSD, reboots 1-2 times Resumable OTA Update The resumable OTA update process involves uploading chunks (or all) of a file, marking the file complete and then telling the camera to begin the update process. Chunks are stored until they are explicitly deleted, allowing the client to stop and resume as needed. Details can be found in the diagram below. Resumable OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/GET: /gp/gpSoftUpdate?request=deleteDelete any old/cached dataHTTP/200 (OK)JSON {\"status\":0,\"message\":\"OK\",\"sha1\":\"\",\"bytes_complete\":0,\"complete\":false}HTTP/GET: /gp/gpSoftUpdate?request=showuiDisplay update OSD on camera UI (optional)HTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"\",\"bytes_complete\":0,\"complete\":false}loop[read CHUNK_BYTES of UPDATE.zip, starting at OFFSET]HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>offset=<OFFSET>file=<CHUNK_BYTES>HTTP/200 (OK)JSON: {\"status\": 0,\"message\": \"OK\",\"sha1\": \"SHA1_HASH\",\"bytes_complete\": (total uploaded bytes),\"complete\": false}HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>complete=trueHTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"SHA1_HASH\",\"bytes_complete\":(size of UPDATE.zip),\"complete\":true}HTTP/GET: /gp/gpSoftUpdate?request=startStart updating firmwareHTTP/200 (OK)JSON: {\"status\":0,\"message\":\"OK\",\"sha1\":\"SHA1_HASH\",\"bytes_complete\":(size of UPDATE.zip),\"complete\":true}loop[while camera updates firmware]HTTP/GET: /gp/gpSoftUpdate?request=progressJSON: {\"status\":11,\"message\":\"Firmware update in progress\"}WiFi connection lostCamera displays OSD \"Update Complete\", reboots 1-2 times OTA Update Status Codes ID Status Description 0 Ok No errors occurred 1 Unknown Request Server did not recognize the request 2 Bad Params Parameter values not recognized 3 SHA1 Send Mismatch SHA1 for chunk did not match SHA1 of previous chunk(s) 4 SHA1 Calculates Mismatch Calculated SHA1 did not match user-specified SHA1 5 HTTP Boundary Error HTTP Post malformed 6 HTTP Post Error Unexpected HTTP/POST Content Type 7 Server Busy HTTP server is busy 8 Offset Mismatch Tried to upload chunk with offset that did not align with previous chunk 9 Bad Post Data Server failed to parse POST data 10 File Incomplete Tried to start update before server finished validating .zip file 11 Update in Progress Firmware update in progress 12 Insufficient Space Insufficient space on the sdcard to hold (decompressed) update file Webcam The webcam feature enables developers who are interested in writing custom drivers to broadcast the camera's video preview with a limited set of resolution, field of view, port, and protocol options. While active, the webcam feature sends raw data to the connected client using a supported protocol. To enable multi-cam support, some cameras support running on a user-specified port. Protocol and port details are provided in a table below. To test basic functionality, start the webcam, and use an application such as VLC to open a network stream: Protocol VLC Network URL TS udp://@:{PORT} RTSP rtsp://{CAMERA_IP}:554/live For readers interested in using a GoPro camera as a webcam with preexisting tools, please see How to use GoPro as a Webcam. Webcam Finite State Machine PREREQUISITEWired USB Control disabledREADYWebcam ready to startStatus is either OFF (0) or IDLE (1)High Power PreviewStatus: 2Low Power PreviewStatus: 3Connect USB to cameraStopExitStartStopExitPreviewStopExitStartPreviewStartPreview Webcam Commands Note: For USB connections, prior to issuing webcam commands, Wired USB Control should be disabled. For details about how to send this and webcam commands, see Commands Quick Reference. Command Connections Description Webcam: Start USB, WIFI* Enters webcam mode, uses default resolution and last-used fov, starts high-res stream to the IP address of caller Webcam: Start (with args) USB, WIFI* Enters webcam mode, uses specified res/fov/protocol/port, starts streaming to the IP address of caller Webcam: Preview USB, WIFI* Enters webcam mode, sets stream resolution and bitrate, starts low-res stream to the IP address of caller. Can set Webcam Digital Lenses and Digital Zoom levels while streaming Webcam: Stop USB, WIFI* Stops the webcam stream Webcam: Exit USB, WIFI* Stops the webcam stream and exits webcam mode Webcam: Status USB, WIFI Returns the current state of the webcam endpoint, including status and error codes (see tables below) Webcam: Version USB, WIFI Provides version information about webcam implementation in JSON format * Indicates that connection is supported in HERO12 Black v01.10.00 and newer versions/models Status Codes Status Code OFF 0 IDLE 1 HIGH_POWER_PREVIEW 2 LOW_POWER_PREVIEW 3 Error Codes Status Code NONE 0 SET_PRESET 1 SET_WINDOW_SIZE 2 EXEC_STREAM 3 SHUTTER 4 COM_TIMEOUT 5 INVALID_PARAM 6 UNAVAILABLE 7 EXIT 8 Webcam Capabilities Webcam supports setting resolution and field of view. Changing other settings while in IDLE state such as Hypersmooth may succeed but are not officially supported. There is a known issue on some cameras in which the webcam status will be wrongly reported as IDLE instead of OFF after a new USB connection. The best workaround for this is to call Webcam: Start followed by the Webcam: Stop after connecting USB in order to attain the true IDLE state. Default Parameter Values Parameter Default Value res 12 (1080p) fov Last-used or 0 (Wide) if FOV not previously set protocol \"TS\" Webcam Capabilities Camera Resolution FOV HERO12 Black 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO11 Black 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO10 Black 480p (id: 4) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) HERO9 Black 480p (id: 4) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 720p (id: 7) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) 1080p (id: 12) Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4) Supported Protocols Camera Protocol Default Port Supports User-Defined Port? HERO12 Black TS 8554 ✔ RTSP 554 ❌ HERO11 Black TS 8554 ✔ HERO10 Black TS 8554 ❌ HERO9 Black TS 8554 ❌ Webcam Stabilization Should the client require stabilization, the Hypersmooth setting can be used while in the state: READY (Status: OFF). This setting can only be set while webcam is disabled, which requires either sending the Webcam: Exit command or reseating the USB-C connection to the camera. Note: The Low Hypersmooth option provides lower/lighter stabilization when used in Webcam mode vs other camera modes. Camera Version Supported Hypersmooth Options HERO12 Black v01.10.00+ Off (id: 0), Low (id: 1), Auto Boost (id: 4) HERO11 Black Mini v01.10.00+ Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4) HERO11 Black v01.10.00+ Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4) HERO10 Black v01.10.00+ Off (id: 0), High (id: 2), Boost (id: 3), Standard (id: 100) HERO9 Black v01.70.00+ Off (id: 0), Low (id: 1), High (id: 2), Boost (id: 3) Camera On the Home Network (COHN) Some cameras support Camera On the Home Network (COHN). This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. For security purposes, all communications are performed over HTTPS. Camera Supported HERO12 Black ✔ HERO11 Black Mini ❌ HERO11 Black ❌ HERO10 Black ❌ HERO9 Black ❌ Provisioning COHN In order to use the COHN capability, the camera must first be provisioned for COHN. Send Messages via HTTPS Once the camera is provisioned, the client can issue commands and set settings via HTTPS using the COHN certificate and Basic authorization (username/password) credentials obtained during provisioning or subsequently by querying for COHN status. HTTPS Headers All HTTPS messages must contain Basic access authentication headers, using the username and password from the COHN status obtained during or after provisioning. COHN Commands Command Command Response Format Description /GoProRootCA.crt Text Get COHN cert /gopro/cohn/status JSON Get current COHN status Get COHN Cert The /GoProRootCA.crt endpoint provides a way to obtain the COHN cert via HTTP(S). The response content is in plain text. For example: -----BEGIN CERTIFICATE----- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -----END CERTIFICATE----- Get COHN Status The /gopro/cohn/status endpoint provides a way to get the current status of COHN. The status's format is NotifyCOHNStatus (a Google Procol Buffer v2 message) converted into JSON. Example: { \"status\": \"COHN_PROVISIONED\", \"state\": \"COHN_STATE_NetworkConnected\", \"username\": \"gopro\", \"password\": \"xxxxxxxxxxxx\", \"ipaddress\": \"xxx.xxx.xxx.xxx\", \"enabled\": true } Limitations HERO12 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO11 Black Mini The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO11 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO10 Black The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings HTTP command arguments must be given in the order outlined in Commands Quick Reference HERO9 Black The HTTP server is not available while the camera is encoding, which means shutter controls are not supported over WiFi. This limitation can be overcome by using Bluetooth Low Energy for command and control and HTTP/REST for querying media content such as media list, media info, preview stream, etc. USB command and control is not supported on HERO9 Black. HTTP command arguments must be given in the order outlined in Commands Quick Reference General Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds. In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode).", "categories": [], "tags": [], - "url": "/OpenGoPro/http_2_0#" + "url": "/OpenGoPro/http-legacy#" }, { "title": "Open GoPro: ", @@ -35,480 +28,375 @@ var store = [ "url": "/OpenGoPro/#" }, { - "title": "Protocol Documentation: ", - "excerpt": "This page provides documentation for all of the protobuf message fields.", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#" - }, - { - "title": "Protocol Documentation: Protobuf Files", - "excerpt": "- [cohn.proto](cohn-proto) - [live_streaming.proto](live_streaming-proto) - [network_management.proto](network_management-proto) - [preset_status.proto](preset_status-proto) - [request_get_preset_status.proto](request_get_preset_status-proto) - [response_generic.proto](response_generic-proto) - [set_camera_control_status.proto](set_camera_control_status-proto) - [turbo_transfer.proto](turbo_transfer-proto)", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#protobuf-files" - }, - { - "title": "Protocol Documentation: cohn.proto", - "excerpt": "", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#cohn-proto" - }, - { - "title": "Protocol Documentation: NotifyCOHNStatus", - "excerpt": "Current COHN status triggered by a RequestGetCOHNStatus | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | status | [EnumCOHNStatus](open_gopro-EnumCOHNStatus) | optional | Current COHN status | | state | [EnumCOHNNetworkState](open_gopro-EnumCOHNNetworkState) | optional | Current COHN network state | | username | [string](string) | optional | Username used for http basic auth header | | password | [string](string) | optional | Password used for http basic auth header | | ipaddress | [string](string) | optional | Camera’s IP address on the local network | | enabled | [bool](bool) | optional | Is COHN currently enabled | | ssid | [string](string) | optional | Currently connected SSID | | macaddress | [string](string) | optional | MAC address of the wifi adapter |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#notifycohnstatus" - }, - { - "title": "Protocol Documentation: RequestCOHNCert", - "excerpt": "Get the COHN certificate. Returns a @ref ResponseCOHNCert", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestcohncert" - }, - { - "title": "Protocol Documentation: RequestClearCOHNCert", - "excerpt": "Clear the COHN certificate. Returns a @ref ResponseGeneric with the status of the clear", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestclearcohncert" - }, - { - "title": "Protocol Documentation: RequestCreateCOHNCert", - "excerpt": "Create the COHN certificate. Returns a @ref ResponseGeneric with the status of the creation | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | override | [bool](bool) | optional | Override current provisioning and create new cert |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestcreatecohncert" - }, - { - "title": "Protocol Documentation: RequestGetCOHNStatus", - "excerpt": "Get the current COHN status. This always returns a @ref NotifyCOHNStatus Additionally, asynchronous updates can also be registerd to return more @ref NotifyCOHNStatus when a value changes. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | register_cohn_status | [bool](bool) | optional | 1 to register, 0 to unregister |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestgetcohnstatus" - }, - { - "title": "Protocol Documentation: RequestSetCOHNSetting", - "excerpt": "Enable and disable COHN if provisioned Returns a @ref ResponseGeneric | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | cohn_active | [bool](bool) | optional | 1 to enable, 0 to disable |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestsetcohnsetting" - }, - { - "title": "Protocol Documentation: ResponseCOHNCert", - "excerpt": "COHN Certificate response triggered by RequestCOHNCert | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | optional | Was request successful? | | cert | [string](string) | optional | Root CA cert (ASCII text) |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#responsecohncert" - }, - { - "title": "Protocol Documentation: EnumCOHNNetworkState", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | COHN_STATE_Init | 0 | | | COHN_STATE_Error | 1 | | | COHN_STATE_Exit | 2 | | | COHN_STATE_Idle | 5 | | | COHN_STATE_NetworkConnected | 27 | | | COHN_STATE_NetworkDisconnected | 28 | | | COHN_STATE_ConnectingToNetwork | 29 | | | COHN_STATE_Invalid | 30 | |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#enumcohnnetworkstate" - }, - { - "title": "Protocol Documentation: EnumCOHNStatus", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | COHN_UNPROVISIONED | 0 | | | COHN_PROVISIONED | 1 | |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#enumcohnstatus" - }, - { - "title": "Protocol Documentation: live_streaming.proto", - "excerpt": "", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#live-streaming-proto" - }, - { - "title": "Protocol Documentation: NotifyLiveStreamStatus", - "excerpt": "Live Stream status Sent either: - as a syncrhonous response to initial @ref RequestGetLiveStreamStatus - as asynchronous notifications registered for via @ref RequestGetLiveStreamStatus | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | live_stream_status | [EnumLiveStreamStatus](open_gopro-EnumLiveStreamStatus) | optional | Live stream status | | live_stream_error | [EnumLiveStreamError](open_gopro-EnumLiveStreamError) | optional | Live stream error | | live_stream_encode | [bool](bool) | optional | Is live stream encoding? | | live_stream_bitrate | [int32](int32) | optional | Live stream bitrate (Kbps) | | live_stream_window_size_supported_array | [EnumWindowSize](open_gopro-EnumWindowSize) | repeated | List of supported resolutions returned when live stream is registered or requested 1. register --> camera 2. register response (with capabilities) --> mobile 3. async notifications (without capabilities) --> mobile | | live_stream_encode_supported | [bool](bool) | optional | Does the camera support encoding while live streaming? | | live_stream_max_lens_unsupported | [bool](bool) | optional | Is the Max Lens feature NOT supported? | | live_stream_minimum_stream_bitrate | [int32](int32) | optional | Camera-defined minimum bitrate (static) (Kbps) | | live_stream_maximum_stream_bitrate | [int32](int32) | optional | Camera-defined maximum bitrate (static) (Kbps) | | live_stream_lens_supported | [bool](bool) | optional | Does camera support setting lens for live streaming? | | live_stream_lens_supported_array | [EnumLens](open_gopro-EnumLens) | repeated | Array of supported lenses for live streaming |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#notifylivestreamstatus" - }, - { - "title": "Protocol Documentation: RequestGetLiveStreamStatus", - "excerpt": "Get the current livestream status (and optionally register for future status changes) Both current status and future status changes are sent via @ref NotifyLiveStreamStatus | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | register_live_stream_status | [EnumRegisterLiveStreamStatus](open_gopro-EnumRegisterLiveStreamStatus) | repeated | Array of live stream statuses to be notified about | | unregister_live_stream_status | [EnumRegisterLiveStreamStatus](open_gopro-EnumRegisterLiveStreamStatus) | repeated | Array of live stream statuses to stop being notified about |", - "categories": [], - "tags": [], - "url": "/OpenGoPro/protos#requestgetlivestreamstatus" - }, - { - "title": "Protocol Documentation: RequestSetLiveStreamMode", - "excerpt": "Configure lives streaming The current livestream status can be queried via @ref RequestGetLiveStreamStatus TODO What is the response? | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | url | [string](string) | optional | RTMP(S) URL used for live stream | | encode | [bool](bool) | optional | Save media to sdcard while streaming? | | window_size | [EnumWindowSize](open_gopro-EnumWindowSize) | optional | Live stream resolution | | cert | [bytes](bytes) | optional | Certificate for servers that require it | | minimum_bitrate | [int32](int32) | optional | Minimum desired bitrate (may or may not be honored) | | maximum_bitrate | [int32](int32) | optional | Maximum desired bitrate (may or may not be honored) | | starting_bitrate | [int32](int32) | optional | Starting bitrate | | lens | [EnumLens](open_gopro-EnumLens) | optional | Lens to use for live stream (see NotifyLiveStreamStatus.live_stream_lens_supported) |", + "title": "Tutorials: ", + "excerpt": "This set of tutorials is a series of sample scripts / files and accompanying .html walk-throughs to implement basic functionality to interact with a GoPro device using the following languages: - Python - Kotlin - More to come! The tutorials only support Open GoPro Version 2.0 and must be run on a [supported camera]({% link specs/ble_versions/ble_2_0.md %}supported-cameras). They will provide walk-throughs and sample code to use the relevant language / framework to exercise the Open GoPro Interface using Bluetooth Low Energy (BLE) and HTTP over WiFi. The tutorials are meant as an introduction to the Open GoPro specification. They are not a substitute for the complete [BLE]({% link specs/ble_versions/ble_2_0.md %}) and [HTTP](/http) specifications which will be your main source of reference after completing the tutorials. {% for tutorial in site.tutorials %} - [{{ tutorial.title }}]({{ tutorial.permalink | prepend: site.baseurl }}) {% endfor %}", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestsetlivestreammode" + "url": "/OpenGoPro/tutorials/#" }, { - "title": "Protocol Documentation: EnumLens", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | LENS_WIDE | 0 | | | LENS_LINEAR | 4 | | | LENS_SUPERVIEW | 3 | |", + "title": "open_gopro Protobuf Documentation: ", + "excerpt": "EnumCOHNNetworkState | Name | Value | Summary | | ---- | ----- | ------- | | COHN_STATE_Init | 0 | | | COHN_STATE_Error | 1 | | | COHN_STATE_Exit | 2 | | | COHN_STATE_Idle | 5 | | | COHN_STATE_NetworkConnected | 27 | | | COHN_STATE_NetworkDisconnected | 28 | | | COHN_STATE_ConnectingToNetwork | 29 | | | COHN_STATE_Invalid | 30 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumlens" + "url": "/OpenGoPro/protos/open_gopro.html#" }, { - "title": "Protocol Documentation: EnumLiveStreamError", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | LIVE_STREAM_ERROR_NONE | 0 | No error (success) | | LIVE_STREAM_ERROR_NETWORK | 1 | General network error during the stream | | LIVE_STREAM_ERROR_CREATESTREAM | 2 | Startup error: bad URL or valid with live stream server | | LIVE_STREAM_ERROR_OUTOFMEMORY | 3 | Not enough memory on camera to complete task | | LIVE_STREAM_ERROR_INPUTSTREAM | 4 | Failed to get stream from low level camera system | | LIVE_STREAM_ERROR_INTERNET | 5 | No internet access detected on startup of streamer | | LIVE_STREAM_ERROR_OSNETWORK | 6 | Error occured in linux networking stack. usually means the server closed the connection | | LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT | 7 | Timed out attemping to connect to the wifi network when attemping live stream | | LIVE_STREAM_ERROR_SSL_HANDSHAKE | 8 | SSL handshake failed (commonly caused due to incorrect time / time zone) | | LIVE_STREAM_ERROR_CAMERA_BLOCKED | 9 | Low level camera system rejected attempt to start live stream | | LIVE_STREAM_ERROR_UNKNOWN | 10 | Unknown | | LIVE_STREAM_ERROR_SD_CARD_FULL | 40 | Can not perform livestream because sd card is full | | LIVE_STREAM_ERROR_SD_CARD_REMOVED | 41 | Livestream stopped because sd card was removed |", + "title": "open_gopro Protobuf Documentation: EnumCOHNStatus", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | COHN_UNPROVISIONED | 0 | | | COHN_PROVISIONED | 1 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumlivestreamerror" + "url": "/OpenGoPro/protos/open_gopro.html#enumcohnstatus" }, { - "title": "Protocol Documentation: EnumLiveStreamStatus", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | LIVE_STREAM_STATE_IDLE | 0 | Initial status. Livestream has not yet been configured | | LIVE_STREAM_STATE_CONFIG | 1 | Livestream is being configured | | LIVE_STREAM_STATE_READY | 2 | Livestream has finished configuration and is ready to start streaming | | LIVE_STREAM_STATE_STREAMING | 3 | Livestream is actively streaming | | LIVE_STREAM_STATE_COMPLETE_STAY_ON | 4 | Live stream is exiting. No errors occured. | | LIVE_STREAM_STATE_FAILED_STAY_ON | 5 | Live stream is exiting. An error occurred. | | LIVE_STREAM_STATE_RECONNECTING | 6 | An error occurred during livestream and stream is attempting to reconnect. |", + "title": "open_gopro Protobuf Documentation: EnumCameraControlStatus", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | CAMERA_IDLE | 0 | | | CAMERA_CONTROL | 1 | Can only be set by camera, not by app or third party | | CAMERA_EXTERNAL_CONTROL | 2 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumlivestreamstatus" + "url": "/OpenGoPro/protos/open_gopro.html#enumcameracontrolstatus" }, { - "title": "Protocol Documentation: EnumRegisterLiveStreamStatus", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | REGISTER_LIVE_STREAM_STATUS_STATUS | 1 | | | REGISTER_LIVE_STREAM_STATUS_ERROR | 2 | | | REGISTER_LIVE_STREAM_STATUS_MODE | 3 | | | REGISTER_LIVE_STREAM_STATUS_BITRATE | 4 | |", + "title": "open_gopro Protobuf Documentation: EnumFlatMode", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | FLAT_MODE_UNKNOWN | -1 | | | FLAT_MODE_PLAYBACK | 4 | | | FLAT_MODE_SETUP | 5 | | | FLAT_MODE_VIDEO | 12 | | | FLAT_MODE_TIME_LAPSE_VIDEO | 13 | | | FLAT_MODE_LOOPING | 15 | | | FLAT_MODE_PHOTO_SINGLE | 16 | | | FLAT_MODE_PHOTO | 17 | | | FLAT_MODE_PHOTO_NIGHT | 18 | | | FLAT_MODE_PHOTO_BURST | 19 | | | FLAT_MODE_TIME_LAPSE_PHOTO | 20 | | | FLAT_MODE_NIGHT_LAPSE_PHOTO | 21 | | | FLAT_MODE_BROADCAST_RECORD | 22 | | | FLAT_MODE_BROADCAST_BROADCAST | 23 | | | FLAT_MODE_TIME_WARP_VIDEO | 24 | | | FLAT_MODE_LIVE_BURST | 25 | | | FLAT_MODE_NIGHT_LAPSE_VIDEO | 26 | | | FLAT_MODE_SLOMO | 27 | | | FLAT_MODE_IDLE | 28 | | | FLAT_MODE_VIDEO_STAR_TRAIL | 29 | | | FLAT_MODE_VIDEO_LIGHT_PAINTING | 30 | | | FLAT_MODE_VIDEO_LIGHT_TRAIL | 31 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumregisterlivestreamstatus" + "url": "/OpenGoPro/protos/open_gopro.html#enumflatmode" }, { - "title": "Protocol Documentation: EnumWindowSize", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | WINDOW_SIZE_480 | 4 | | | WINDOW_SIZE_720 | 7 | | | WINDOW_SIZE_1080 | 12 | |", + "title": "open_gopro Protobuf Documentation: EnumLens", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | LENS_WIDE | 0 | | | LENS_LINEAR | 4 | | | LENS_SUPERVIEW | 3 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumwindowsize" + "url": "/OpenGoPro/protos/open_gopro.html#enumlens" }, { - "title": "Protocol Documentation: network_management.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: EnumLiveStreamError", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | LIVE_STREAM_ERROR_NONE | 0 | No error (success) | | LIVE_STREAM_ERROR_NETWORK | 1 | General network error during the stream | | LIVE_STREAM_ERROR_CREATESTREAM | 2 | Startup error: bad URL or valid with live stream server | | LIVE_STREAM_ERROR_OUTOFMEMORY | 3 | Not enough memory on camera to complete task | | LIVE_STREAM_ERROR_INPUTSTREAM | 4 | Failed to get stream from low level camera system | | LIVE_STREAM_ERROR_INTERNET | 5 | No internet access detected on startup of streamer | | LIVE_STREAM_ERROR_OSNETWORK | 6 | Error occured in linux networking stack. usually means the server closed the connection | | LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT | 7 | Timed out attemping to connect to the wifi network when attemping live stream | | LIVE_STREAM_ERROR_SSL_HANDSHAKE | 8 | SSL handshake failed (commonly caused due to incorrect time / time zone) | | LIVE_STREAM_ERROR_CAMERA_BLOCKED | 9 | Low level camera system rejected attempt to start live stream | | LIVE_STREAM_ERROR_UNKNOWN | 10 | Unknown | | LIVE_STREAM_ERROR_SD_CARD_FULL | 40 | Can not perform livestream because sd card is full | | LIVE_STREAM_ERROR_SD_CARD_REMOVED | 41 | Livestream stopped because sd card was removed |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#network-management-proto" + "url": "/OpenGoPro/protos/open_gopro.html#enumlivestreamerror" }, { - "title": "Protocol Documentation: NotifProvisioningState", - "excerpt": "Provision state notification TODO refernce where this is triggered | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | provisioning_state | [EnumProvisioning](open_gopro-EnumProvisioning) | required | Provisioning / connection state |", + "title": "open_gopro Protobuf Documentation: EnumLiveStreamStatus", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | LIVE_STREAM_STATE_IDLE | 0 | Initial status. Livestream has not yet been configured | | LIVE_STREAM_STATE_CONFIG | 1 | Livestream is being configured | | LIVE_STREAM_STATE_READY | 2 | Livestream has finished configuration and is ready to start streaming | | LIVE_STREAM_STATE_STREAMING | 3 | Livestream is actively streaming | | LIVE_STREAM_STATE_COMPLETE_STAY_ON | 4 | Live stream is exiting. No errors occured. | | LIVE_STREAM_STATE_FAILED_STAY_ON | 5 | Live stream is exiting. An error occurred. | | LIVE_STREAM_STATE_RECONNECTING | 6 | An error occurred during livestream and stream is attempting to reconnect. |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#notifprovisioningstate" + "url": "/OpenGoPro/protos/open_gopro.html#enumlivestreamstatus" }, { - "title": "Protocol Documentation: NotifStartScanning", - "excerpt": "Scanning state notification Triggered via @ref RequestStartScan | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | scanning_state | [EnumScanning](open_gopro-EnumScanning) | required | Scanning state | | scan_id | [int32](int32) | optional | ID associated with scan results (included if scan was successful) | | total_entries | [int32](int32) | optional | Number of APs found during scan (included if scan was successful) | | total_configured_ssid | [int32](int32) | required | Total count of camera's provisioned SSIDs |", + "title": "open_gopro Protobuf Documentation: EnumPresetGroup", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | PRESET_GROUP_ID_VIDEO | 1000 | | | PRESET_GROUP_ID_PHOTO | 1001 | | | PRESET_GROUP_ID_TIMELAPSE | 1002 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#notifstartscanning" + "url": "/OpenGoPro/protos/open_gopro.html#enumpresetgroup" }, { - "title": "Protocol Documentation: RequestConnect", - "excerpt": "Connect to (but do not authenticate with) an Access Point This is intended to be used to connect to a previously-connected Access Point Response: @ref ResponseConnect | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | ssid | [string](string) | required | AP SSID |", + "title": "open_gopro Protobuf Documentation: EnumPresetGroupIcon", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | PRESET_GROUP_VIDEO_ICON_ID | 0 | | | PRESET_GROUP_PHOTO_ICON_ID | 1 | | | PRESET_GROUP_TIMELAPSE_ICON_ID | 2 | | | PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID | 3 | | | PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID | 4 | | | PRESET_GROUP_MAX_VIDEO_ICON_ID | 5 | | | PRESET_GROUP_MAX_PHOTO_ICON_ID | 6 | | | PRESET_GROUP_MAX_TIMELAPSE_ICON_ID | 7 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestconnect" + "url": "/OpenGoPro/protos/open_gopro.html#enumpresetgroupicon" }, { - "title": "Protocol Documentation: RequestConnectNew", - "excerpt": "Connect to and authenticate with an Access Point This is only intended to be used if the AP is not previously provisioned. Response: @ref ResponseConnectNew sent immediately Notification: @ref NotifProvisioningState sent periodically as provisioning state changes | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | ssid | [string](string) | required | AP SSID | | password | [string](string) | required | AP password | | static_ip | [bytes](bytes) | optional | Static IP address | | gateway | [bytes](bytes) | optional | Gateway IP address | | subnet | [bytes](bytes) | optional | Subnet mask | | dns_primary | [bytes](bytes) | optional | Primary DNS | | dns_secondary | [bytes](bytes) | optional | Secondary DNS |", + "title": "open_gopro Protobuf Documentation: EnumPresetIcon", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | PRESET_ICON_VIDEO | 0 | | | PRESET_ICON_ACTIVITY | 1 | | | PRESET_ICON_CINEMATIC | 2 | | | PRESET_ICON_PHOTO | 3 | | | PRESET_ICON_LIVE_BURST | 4 | | | PRESET_ICON_BURST | 5 | | | PRESET_ICON_PHOTO_NIGHT | 6 | | | PRESET_ICON_TIMEWARP | 7 | | | PRESET_ICON_TIMELAPSE | 8 | | | PRESET_ICON_NIGHTLAPSE | 9 | | | PRESET_ICON_SNAIL | 10 | | | PRESET_ICON_VIDEO_2 | 11 | | | PRESET_ICON_PHOTO_2 | 13 | | | PRESET_ICON_PANORAMA | 14 | | | PRESET_ICON_BURST_2 | 15 | | | PRESET_ICON_TIMEWARP_2 | 16 | | | PRESET_ICON_TIMELAPSE_2 | 17 | | | PRESET_ICON_CUSTOM | 18 | | | PRESET_ICON_AIR | 19 | | | PRESET_ICON_BIKE | 20 | | | PRESET_ICON_EPIC | 21 | | | PRESET_ICON_INDOOR | 22 | | | PRESET_ICON_MOTOR | 23 | | | PRESET_ICON_MOUNTED | 24 | | | PRESET_ICON_OUTDOOR | 25 | | | PRESET_ICON_POV | 26 | | | PRESET_ICON_SELFIE | 27 | | | PRESET_ICON_SKATE | 28 | | | PRESET_ICON_SNOW | 29 | | | PRESET_ICON_TRAIL | 30 | | | PRESET_ICON_TRAVEL | 31 | | | PRESET_ICON_WATER | 32 | | | PRESET_ICON_LOOPING | 33 | | | PRESET_ICON_BASIC | 58 | | | PRESET_ICON_ULTRA_SLO_MO | 59 | | | PRESET_ICON_STANDARD_ENDURANCE | 60 | | | PRESET_ICON_ACTIVITY_ENDURANCE | 61 | | | PRESET_ICON_CINEMATIC_ENDURANCE | 62 | | | PRESET_ICON_SLOMO_ENDURANCE | 63 | | | PRESET_ICON_STATIONARY_1 | 64 | | | PRESET_ICON_STATIONARY_2 | 65 | | | PRESET_ICON_STATIONARY_3 | 66 | | | PRESET_ICON_STATIONARY_4 | 67 | | | PRESET_ICON_SIMPLE_SUPER_PHOTO | 70 | | | PRESET_ICON_SIMPLE_NIGHT_PHOTO | 71 | | | PRESET_ICON_HIGHEST_QUALITY_VIDEO | 73 | | | PRESET_ICON_STANDARD_QUALITY_VIDEO | 74 | | | PRESET_ICON_BASIC_QUALITY_VIDEO | 75 | | | PRESET_ICON_STAR_TRAIL | 76 | | | PRESET_ICON_LIGHT_PAINTING | 77 | | | PRESET_ICON_LIGHT_TRAIL | 78 | | | PRESET_ICON_FULL_FRAME | 79 | | | PRESET_ICON_TIMELAPSE_PHOTO | 1000 | | | PRESET_ICON_NIGHTLAPSE_PHOTO | 1001 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestconnectnew" + "url": "/OpenGoPro/protos/open_gopro.html#enumpreseticon" }, { - "title": "Protocol Documentation: RequestGetApEntries", - "excerpt": "Get a list of Access Points found during a @ref RequestStartScan Response: @ref ResponseGetApEntries | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | start_index | [int32](int32) | required | Used for paging. 0", + "title": "open_gopro Protobuf Documentation: EnumPresetTitle", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | PRESET_TITLE_ACTIVITY | 0 | | | PRESET_TITLE_STANDARD | 1 | | | PRESET_TITLE_CINEMATIC | 2 | | | PRESET_TITLE_PHOTO | 3 | | | PRESET_TITLE_LIVE_BURST | 4 | | | PRESET_TITLE_BURST | 5 | | | PRESET_TITLE_NIGHT | 6 | | | PRESET_TITLE_TIME_WARP | 7 | | | PRESET_TITLE_TIME_LAPSE | 8 | | | PRESET_TITLE_NIGHT_LAPSE | 9 | | | PRESET_TITLE_VIDEO | 10 | | | PRESET_TITLE_SLOMO | 11 | | | PRESET_TITLE_PHOTO_2 | 13 | | | PRESET_TITLE_PANORAMA | 14 | | | PRESET_TITLE_TIME_WARP_2 | 16 | | | PRESET_TITLE_CUSTOM | 18 | | | PRESET_TITLE_AIR | 19 | | | PRESET_TITLE_BIKE | 20 | | | PRESET_TITLE_EPIC | 21 | | | PRESET_TITLE_INDOOR | 22 | | | PRESET_TITLE_MOTOR | 23 | | | PRESET_TITLE_MOUNTED | 24 | | | PRESET_TITLE_OUTDOOR | 25 | | | PRESET_TITLE_POV | 26 | | | PRESET_TITLE_SELFIE | 27 | | | PRESET_TITLE_SKATE | 28 | | | PRESET_TITLE_SNOW | 29 | | | PRESET_TITLE_TRAIL | 30 | | | PRESET_TITLE_TRAVEL | 31 | | | PRESET_TITLE_WATER | 32 | | | PRESET_TITLE_LOOPING | 33 | | | PRESET_TITLE_BASIC | 58 | | | PRESET_TITLE_ULTRA_SLO_MO | 59 | | | PRESET_TITLE_STANDARD_ENDURANCE | 60 | | | PRESET_TITLE_ACTIVITY_ENDURANCE | 61 | | | PRESET_TITLE_CINEMATIC_ENDURANCE | 62 | | | PRESET_TITLE_SLOMO_ENDURANCE | 63 | | | PRESET_TITLE_STATIONARY_1 | 64 | | | PRESET_TITLE_STATIONARY_2 | 65 | | | PRESET_TITLE_STATIONARY_3 | 66 | | | PRESET_TITLE_STATIONARY_4 | 67 | | | PRESET_TITLE_SIMPLE_VIDEO | 68 | | | PRESET_TITLE_SIMPLE_TIME_WARP | 69 | | | PRESET_TITLE_SIMPLE_SUPER_PHOTO | 70 | | | PRESET_TITLE_SIMPLE_NIGHT_PHOTO | 71 | | | PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE | 72 | | | PRESET_TITLE_HIGHEST_QUALITY | 73 | | | PRESET_TITLE_EXTENDED_BATTERY | 74 | | | PRESET_TITLE_LONGEST_BATTERY | 75 | | | PRESET_TITLE_STAR_TRAIL | 76 | | | PRESET_TITLE_LIGHT_PAINTING | 77 | | | PRESET_TITLE_LIGHT_TRAIL | 78 | | | PRESET_TITLE_FULL_FRAME | 79 | | | PRESET_TITLE_STANDARD_QUALITY_VIDEO | 82 | | | PRESET_TITLE_BASIC_QUALITY_VIDEO | 83 | | | PRESET_TITLE_HIGHEST_QUALITY_VIDEO | 93 | | | PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | 94 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestgetapentries" + "url": "/OpenGoPro/protos/open_gopro.html#enumpresettitle" }, { - "title": "Protocol Documentation: RequestReleaseNetwork", - "excerpt": "Request to disconnect from current AP network Response: @ref ResponseGeneric", + "title": "open_gopro Protobuf Documentation: EnumProvisioning", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | PROVISIONING_UNKNOWN | 0 | | | PROVISIONING_NEVER_STARTED | 1 | | | PROVISIONING_STARTED | 2 | | | PROVISIONING_ABORTED_BY_SYSTEM | 3 | | | PROVISIONING_CANCELLED_BY_USER | 4 | | | PROVISIONING_SUCCESS_NEW_AP | 5 | | | PROVISIONING_SUCCESS_OLD_AP | 6 | | | PROVISIONING_ERROR_FAILED_TO_ASSOCIATE | 7 | | | PROVISIONING_ERROR_PASSWORD_AUTH | 8 | | | PROVISIONING_ERROR_EULA_BLOCKING | 9 | | | PROVISIONING_ERROR_NO_INTERNET | 10 | | | PROVISIONING_ERROR_UNSUPPORTED_TYPE | 11 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestreleasenetwork" + "url": "/OpenGoPro/protos/open_gopro.html#enumprovisioning" }, { - "title": "Protocol Documentation: RequestStartScan", - "excerpt": "Start scanning for Access Points @note Serialization of this object is zero bytes. Response: @ref ResponseStartScanning are sent immediately after the camera receives this command Notifications: @ref NotifStartScanning are sent periodically as scanning state changes. Use to detect scan complete.", + "title": "open_gopro Protobuf Documentation: EnumRegisterLiveStreamStatus", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | REGISTER_LIVE_STREAM_STATUS_STATUS | 1 | | | REGISTER_LIVE_STREAM_STATUS_ERROR | 2 | | | REGISTER_LIVE_STREAM_STATUS_MODE | 3 | | | REGISTER_LIVE_STREAM_STATUS_BITRATE | 4 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requeststartscan" + "url": "/OpenGoPro/protos/open_gopro.html#enumregisterlivestreamstatus" }, { - "title": "Protocol Documentation: ResponseConnect", - "excerpt": "The status of an attempt to connect to an Access Point Sent as the initial response to @ref RequestConnect | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | required | Generic pass/fail/error info | | provisioning_state | [EnumProvisioning](open_gopro-EnumProvisioning) | required | Provisioning/connection state | | timeout_seconds | [int32](int32) | required | Network connection timeout (seconds) |", + "title": "open_gopro Protobuf Documentation: EnumRegisterPresetStatus", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | REGISTER_PRESET_STATUS_PRESET | 1 | Send notification when properties of a preset change | | REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY | 2 | Send notification when properties of a preset group change |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responseconnect" + "url": "/OpenGoPro/protos/open_gopro.html#enumregisterpresetstatus" }, { - "title": "Protocol Documentation: ResponseConnectNew", - "excerpt": "The status of an attempt to connect to an Access Point Sent as the initial response to @ref RequestConnectNew | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | required | Status of Connect New request | | provisioning_state | [EnumProvisioning](open_gopro-EnumProvisioning) | required | Current provisioning state of the network | | timeout_seconds | [int32](int32) | required | number of seconds camera will wait before declaring a network connection attempt failed. |", + "title": "open_gopro Protobuf Documentation: EnumResultGeneric", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | RESULT_UNKNOWN | 0 | | | RESULT_SUCCESS | 1 | | | RESULT_ILL_FORMED | 2 | | | RESULT_NOT_SUPPORTED | 3 | | | RESULT_ARGUMENT_OUT_OF_BOUNDS | 4 | | | RESULT_ARGUMENT_INVALID | 5 | | | RESULT_RESOURCE_NOT_AVAILABLE | 6 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responseconnectnew" + "url": "/OpenGoPro/protos/open_gopro.html#enumresultgeneric" }, { - "title": "Protocol Documentation: ResponseGetApEntries", - "excerpt": "A list of scan entries describing a scanned Access Point This is sent in response to a @ref RequestGetApEntries | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | required | Generic pass/fail/error info | | scan_id | [int32](int32) | required | ID associated with this batch of results | | entries | [ResponseGetApEntries.ScanEntry](open_gopro-ResponseGetApEntries-ScanEntry) | repeated | Array containing details about discovered APs |", + "title": "open_gopro Protobuf Documentation: EnumScanEntryFlags", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | SCAN_FLAG_OPEN | 0x00 | This network does not require authentication | | SCAN_FLAG_AUTHENTICATED | 0x01 | This network requires authentication | | SCAN_FLAG_CONFIGURED | 0x02 | This network has been previously provisioned | | SCAN_FLAG_BEST_SSID | 0x04 | | | SCAN_FLAG_ASSOCIATED | 0x08 | camera is connected to this AP | | SCAN_FLAG_UNSUPPORTED_TYPE | 0x10 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responsegetapentries" + "url": "/OpenGoPro/protos/open_gopro.html#enumscanentryflags" }, { - "title": "Protocol Documentation: ResponseGetApEntries.ScanEntry", - "excerpt": "The individual Scan Entry model | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | ssid | [string](string) | required | AP SSID | | signal_strength_bars | [int32](int32) | required | Signal strength (3 bars: >-70 dBm; 2 bars: >-85 dBm; 1 bar:", + "title": "open_gopro Protobuf Documentation: EnumScanning", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | SCANNING_UNKNOWN | 0 | | | SCANNING_NEVER_STARTED | 1 | | | SCANNING_STARTED | 2 | | | SCANNING_ABORTED_BY_SYSTEM | 3 | | | SCANNING_CANCELLED_BY_USER | 4 | | | SCANNING_SUCCESS | 5 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responsegetapentries-scanentry" + "url": "/OpenGoPro/protos/open_gopro.html#enumscanning" }, { - "title": "Protocol Documentation: ResponseStartScanning", - "excerpt": "The current scanning state. This is the initial response to a @ref RequestStartScan | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | required | Generic pass/fail/error info | | scanning_state | [EnumScanning](open_gopro-EnumScanning) | required | Scanning state |", + "title": "open_gopro Protobuf Documentation: EnumWindowSize", + "excerpt": "| Name | Value | Summary | | ---- | ----- | ------- | | WINDOW_SIZE_480 | 4 | | | WINDOW_SIZE_720 | 7 | | | WINDOW_SIZE_1080 | 12 | |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responsestartscanning" + "url": "/OpenGoPro/protos/open_gopro.html#enumwindowsize" }, { - "title": "Protocol Documentation: EnumProvisioning", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | PROVISIONING_UNKNOWN | 0 | | | PROVISIONING_NEVER_STARTED | 1 | | | PROVISIONING_STARTED | 2 | | | PROVISIONING_ABORTED_BY_SYSTEM | 3 | | | PROVISIONING_CANCELLED_BY_USER | 4 | | | PROVISIONING_SUCCESS_NEW_AP | 5 | | | PROVISIONING_SUCCESS_OLD_AP | 6 | | | PROVISIONING_ERROR_FAILED_TO_ASSOCIATE | 7 | | | PROVISIONING_ERROR_PASSWORD_AUTH | 8 | | | PROVISIONING_ERROR_EULA_BLOCKING | 9 | | | PROVISIONING_ERROR_NO_INTERNET | 10 | | | PROVISIONING_ERROR_UNSUPPORTED_TYPE | 11 | |", + "title": "open_gopro Protobuf Documentation: Media", + "excerpt": "A reusable model to represent a media file | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | folder | optional | string | 1 | Directory that the media is contained in | | file | optional | string | 2 | Filename of media |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumprovisioning" + "url": "/OpenGoPro/protos/open_gopro.html#media" }, { - "title": "Protocol Documentation: EnumScanEntryFlags", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | SCAN_FLAG_OPEN | 0 | This network does not require authentication | | SCAN_FLAG_AUTHENTICATED | 1 | This network requires authentication | | SCAN_FLAG_CONFIGURED | 2 | This network has been previously provisioned | | SCAN_FLAG_BEST_SSID | 4 | | | SCAN_FLAG_ASSOCIATED | 8 | camera is connected to this AP | | SCAN_FLAG_UNSUPPORTED_TYPE | 16 | |", + "title": "open_gopro Protobuf Documentation: NotifProvisioningState", + "excerpt": "Provision state notification TODO refernce where this is triggered | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}enumprovisioning) | 1 | Provisioning / connection state |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumscanentryflags" + "url": "/OpenGoPro/protos/open_gopro.html#notifprovisioningstate" }, { - "title": "Protocol Documentation: EnumScanning", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | SCANNING_UNKNOWN | 0 | | | SCANNING_NEVER_STARTED | 1 | | | SCANNING_STARTED | 2 | | | SCANNING_ABORTED_BY_SYSTEM | 3 | | | SCANNING_CANCELLED_BY_USER | 4 | | | SCANNING_SUCCESS | 5 | |", + "title": "open_gopro Protobuf Documentation: NotifStartScanning", + "excerpt": "Scanning state notification Triggered via [RequestStartScan]( {% link protos/open_gopro.md %}requeststartscan ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | scanning_state | required | [EnumScanning]({% link protos/open_gopro.md %}enumscanning) | 1 | Scanning state | | scan_id | optional | int32 | 2 | ID associated with scan results (included if scan was successful) | | total_entries | optional | int32 | 3 | Number of APs found during scan (included if scan was successful) | | total_configured_ssid | required | int32 | 4 | Total count of camera's provisioned SSIDs |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumscanning" + "url": "/OpenGoPro/protos/open_gopro.html#notifstartscanning" }, { - "title": "Protocol Documentation: preset_status.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: NotifyCOHNStatus", + "excerpt": "Current COHN status triggered by a RequestGetCOHNStatus | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | status | optional | [EnumCOHNStatus]({% link protos/open_gopro.md %}enumcohnstatus) | 1 | Current COHN status | | state | optional | [EnumCOHNNetworkState]({% link protos/open_gopro.md %}enumcohnnetworkstate) | 2 | Current COHN network state | | username | optional | string | 3 | Username used for http basic auth header | | password | optional | string | 4 | Password used for http basic auth header | | ipaddress | optional | string | 5 | Camera's IP address on the local network | | enabled | optional | bool | 6 | Is COHN currently enabled | | ssid | optional | string | 7 | Currently connected SSID | | macaddress | optional | string | 8 | MAC address of the wifi adapter |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#preset-status-proto" + "url": "/OpenGoPro/protos/open_gopro.html#notifycohnstatus" }, { - "title": "Protocol Documentation: NotifyPresetStatus", - "excerpt": "Current Preset status Sent either: - synchronously via initial response to @ref RequestGetPresetStatus - asynchronously when Preset change if registered in @rev RequestGetPresetStatus | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | preset_group_array | [PresetGroup](open_gopro-PresetGroup) | repeated | Array of currently available Preset Groups |", + "title": "open_gopro Protobuf Documentation: NotifyLiveStreamStatus", + "excerpt": "Live Stream status Sent either: - as a syncrhonous response to initial [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}requestgetlivestreamstatus ) - as asynchronous notifications registered for via [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}requestgetlivestreamstatus ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | live_stream_status | optional | [EnumLiveStreamStatus]({% link protos/open_gopro.md %}enumlivestreamstatus) | 1 | Live stream status | | live_stream_error | optional | [EnumLiveStreamError]({% link protos/open_gopro.md %}enumlivestreamerror) | 2 | Live stream error | | live_stream_encode | optional | bool | 3 | Is live stream encoding? | | live_stream_bitrate | optional | int32 | 4 | Live stream bitrate (Kbps) | | live_stream_window_size_supported_array | repeated | [EnumWindowSize]({% link protos/open_gopro.md %}enumwindowsize) | 5 | Set of currently supported resolutions | | live_stream_encode_supported | optional | bool | 6 | Does the camera support encoding while live streaming? | | live_stream_max_lens_unsupported | optional | bool | 7 | Is the Max Lens feature NOT supported? | | live_stream_minimum_stream_bitrate | optional | int32 | 8 | Camera-defined minimum bitrate (static) (Kbps) | | live_stream_maximum_stream_bitrate | optional | int32 | 9 | Camera-defined maximum bitrate (static) (Kbps) | | live_stream_lens_supported | optional | bool | 10 | Does camera support setting lens for live streaming? | | live_stream_lens_supported_array | repeated | [EnumLens]({% link protos/open_gopro.md %}enumlens) | 11 | Set of currently supported FOV options |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#notifypresetstatus" + "url": "/OpenGoPro/protos/open_gopro.html#notifylivestreamstatus" }, { - "title": "Protocol Documentation: Preset", - "excerpt": "An individual preset. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | id | [int32](int32) | optional | Preset ID | | mode | [EnumFlatMode](open_gopro-EnumFlatMode) | optional | Preset flatmode ID | | title_id | [EnumPresetTitle](open_gopro-EnumPresetTitle) | optional | Preset Title ID | | title_number | [int32](int32) | optional | Preset Title Number (e.g. 1/2/3 in Custom1, Custom2, Custom3) | | user_defined | [bool](bool) | optional | Is the Preset custom/user-defined? | | icon | [EnumPresetIcon](open_gopro-EnumPresetIcon) | optional | Preset Icon ID | | setting_array | [PresetSetting](open_gopro-PresetSetting) | repeated | Array of settings associated with this Preset | | is_modified | [bool](bool) | optional | Has Preset been modified from factory defaults? (False for user-defined Presets) | | is_fixed | [bool](bool) | optional | Is this Preset mutable? | | custom_name | [string](string) | optional | Custom string name given to this preset via @ref RequestCustomPresetUpdate |", + "title": "open_gopro Protobuf Documentation: NotifyPresetStatus", + "excerpt": "Current Preset status Sent either: - synchronously via initial response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}requestgetpresetstatus ) - asynchronously when Preset change if registered in @rev RequestGetPresetStatus | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | preset_group_array | repeated | [PresetGroup]({% link protos/open_gopro.md %}presetgroup) | 1 | Array of currently available Preset Groups |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#preset" + "url": "/OpenGoPro/protos/open_gopro.html#notifypresetstatus" }, { - "title": "Protocol Documentation: PresetGroup", - "excerpt": "Preset Group meta information and contained Presets | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | id | [EnumPresetGroup](open_gopro-EnumPresetGroup) | optional | Preset Group ID | | preset_array | [Preset](open_gopro-Preset) | repeated | Array of Presets contained in this Preset Group | | can_add_preset | [bool](bool) | optional | Is there room in the group to add additional Presets? | | icon | [EnumPresetGroupIcon](open_gopro-EnumPresetGroupIcon) | optional | The icon to display for this preset group |", + "title": "open_gopro Protobuf Documentation: Preset", + "excerpt": "An individual preset. | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | id | optional | int32 | 1 | Preset ID | | mode | optional | [EnumFlatMode]({% link protos/open_gopro.md %}enumflatmode) | 2 | Preset flatmode ID | | title_id | optional | [EnumPresetTitle]({% link protos/open_gopro.md %}enumpresettitle) | 3 | Preset Title ID | | title_number | optional | int32 | 4 | Preset Title Number (e.g. 1/2/3 in Custom1, Custom2, Custom3) | | user_defined | optional | bool | 5 | Is the Preset custom/user-defined? | | icon | optional | [EnumPresetIcon]({% link protos/open_gopro.md %}enumpreseticon) | 6 | Preset Icon ID | | setting_array | repeated | [PresetSetting]({% link protos/open_gopro.md %}presetsetting) | 7 | Array of settings associated with this Preset | | is_modified | optional | bool | 8 | Has Preset been modified from factory defaults? (False for user-defined Presets) | | is_fixed | optional | bool | 9 | Is this Preset mutable? | | custom_name | optional | string | 10 | Custom string name given to this preset via [RequestCustomPresetUpdate]( {% link protos/open_gopro.md %}requestcustompresetupdate ) |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#presetgroup" + "url": "/OpenGoPro/protos/open_gopro.html#preset" }, { - "title": "Protocol Documentation: PresetSetting", - "excerpt": "Setting representation that comprises a @ref Preset | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | id | [int32](int32) | optional | Setting ID | | value | [int32](int32) | optional | Setting value | | is_caption | [bool](bool) | optional | Does this setting appear on the Preset \"pill\" in the camera UI? |", + "title": "open_gopro Protobuf Documentation: PresetGroup", + "excerpt": "Preset Group meta information and contained Presets | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | id | optional | [EnumPresetGroup]({% link protos/open_gopro.md %}enumpresetgroup) | 1 | Preset Group ID | | preset_array | repeated | [Preset]({% link protos/open_gopro.md %}preset) | 2 | Array of Presets contained in this Preset Group | | can_add_preset | optional | bool | 3 | Is there room in the group to add additional Presets? | | icon | optional | [EnumPresetGroupIcon]({% link protos/open_gopro.md %}enumpresetgroupicon) | 4 | The icon to display for this preset group |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#presetsetting" + "url": "/OpenGoPro/protos/open_gopro.html#presetgroup" }, { - "title": "Protocol Documentation: EnumFlatMode", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | FLAT_MODE_UNKNOWN | -1 | | | FLAT_MODE_PLAYBACK | 4 | | | FLAT_MODE_SETUP | 5 | | | FLAT_MODE_VIDEO | 12 | | | FLAT_MODE_TIME_LAPSE_VIDEO | 13 | | | FLAT_MODE_LOOPING | 15 | | | FLAT_MODE_PHOTO_SINGLE | 16 | | | FLAT_MODE_PHOTO | 17 | | | FLAT_MODE_PHOTO_NIGHT | 18 | | | FLAT_MODE_PHOTO_BURST | 19 | | | FLAT_MODE_TIME_LAPSE_PHOTO | 20 | | | FLAT_MODE_NIGHT_LAPSE_PHOTO | 21 | | | FLAT_MODE_BROADCAST_RECORD | 22 | | | FLAT_MODE_BROADCAST_BROADCAST | 23 | | | FLAT_MODE_TIME_WARP_VIDEO | 24 | | | FLAT_MODE_LIVE_BURST | 25 | | | FLAT_MODE_NIGHT_LAPSE_VIDEO | 26 | | | FLAT_MODE_SLOMO | 27 | | | FLAT_MODE_IDLE | 28 | | | FLAT_MODE_VIDEO_STAR_TRAIL | 29 | | | FLAT_MODE_VIDEO_LIGHT_PAINTING | 30 | | | FLAT_MODE_VIDEO_LIGHT_TRAIL | 31 | |", + "title": "open_gopro Protobuf Documentation: PresetSetting", + "excerpt": "Setting representation that comprises a [Preset]( {% link protos/open_gopro.md %}preset ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | id | optional | int32 | 1 | Setting ID | | value | optional | int32 | 2 | Setting value | | is_caption | optional | bool | 3 | Does this setting appear on the Preset \"pill\" in the camera UI? |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumflatmode" + "url": "/OpenGoPro/protos/open_gopro.html#presetsetting" }, { - "title": "Protocol Documentation: EnumPresetGroup", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | PRESET_GROUP_ID_VIDEO | 1000 | | | PRESET_GROUP_ID_PHOTO | 1001 | | | PRESET_GROUP_ID_TIMELAPSE | 1002 | | | PRESET_GROUP_ID_VIDEO_DUAL_LENS | 1003 | | | PRESET_GROUP_ID_PHOTO_DUAL_LENS | 1004 | | | PRESET_GROUP_ID_TIMELAPSE_DUAL_LENS | 1005 | | | PRESET_GROUP_ID_SPECIAL | 1006 | |", + "title": "open_gopro Protobuf Documentation: RequestCOHNCert", + "excerpt": "Get the COHN certificate. Returns a [ResponseCOHNCert]( {% link protos/open_gopro.md %}responsecohncert )", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumpresetgroup" + "url": "/OpenGoPro/protos/open_gopro.html#requestcohncert" }, { - "title": "Protocol Documentation: EnumPresetGroupIcon", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | PRESET_GROUP_VIDEO_ICON_ID | 0 | | | PRESET_GROUP_PHOTO_ICON_ID | 1 | | | PRESET_GROUP_TIMELAPSE_ICON_ID | 2 | | | PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID | 3 | | | PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID | 4 | | | PRESET_GROUP_MAX_VIDEO_ICON_ID | 5 | | | PRESET_GROUP_MAX_PHOTO_ICON_ID | 6 | | | PRESET_GROUP_MAX_TIMELAPSE_ICON_ID | 7 | |", + "title": "open_gopro Protobuf Documentation: RequestClearCOHNCert", + "excerpt": "Clear the COHN certificate. Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) with the status of the clear", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumpresetgroupicon" + "url": "/OpenGoPro/protos/open_gopro.html#requestclearcohncert" }, { - "title": "Protocol Documentation: EnumPresetIcon", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | PRESET_ICON_VIDEO | 0 | | | PRESET_ICON_ACTIVITY | 1 | | | PRESET_ICON_CINEMATIC | 2 | | | PRESET_ICON_PHOTO | 3 | | | PRESET_ICON_LIVE_BURST | 4 | | | PRESET_ICON_BURST | 5 | | | PRESET_ICON_PHOTO_NIGHT | 6 | | | PRESET_ICON_TIMEWARP | 7 | | | PRESET_ICON_TIMELAPSE | 8 | | | PRESET_ICON_NIGHTLAPSE | 9 | | | PRESET_ICON_SNAIL | 10 | | | PRESET_ICON_VIDEO_2 | 11 | | | PRESET_ICON_360_VIDEO | 12 | | | PRESET_ICON_PHOTO_2 | 13 | | | PRESET_ICON_PANORAMA | 14 | | | PRESET_ICON_BURST_2 | 15 | | | PRESET_ICON_TIMEWARP_2 | 16 | | | PRESET_ICON_TIMELAPSE_2 | 17 | | | PRESET_ICON_CUSTOM | 18 | | | PRESET_ICON_AIR | 19 | | | PRESET_ICON_BIKE | 20 | | | PRESET_ICON_EPIC | 21 | | | PRESET_ICON_INDOOR | 22 | | | PRESET_ICON_MOTOR | 23 | | | PRESET_ICON_MOUNTED | 24 | | | PRESET_ICON_OUTDOOR | 25 | | | PRESET_ICON_POV | 26 | | | PRESET_ICON_SELFIE | 27 | | | PRESET_ICON_SKATE | 28 | | | PRESET_ICON_SNOW | 29 | | | PRESET_ICON_TRAIL | 30 | | | PRESET_ICON_TRAVEL | 31 | | | PRESET_ICON_WATER | 32 | | | PRESET_ICON_LOOPING | 33 | | | PRESET_ICON_STARS | 34 | New custom icon (34 - 43)added for HERO 12 | | PRESET_ICON_ACTION | 35 | | | PRESET_ICON_FOLLOW_CAM | 36 | | | PRESET_ICON_SURF | 37 | | | PRESET_ICON_CITY | 38 | | | PRESET_ICON_SHAKY | 39 | | | PRESET_ICON_CHESTY | 40 | | | PRESET_ICON_HELMET | 41 | | | PRESET_ICON_BITE | 42 | | | PRESET_ICON_MTB | 43 | | | PRESET_ICON_MAX_VIDEO | 55 | Reserved 44 - 50 for Custom presets. Add icons below for new presets starting from 51 | | PRESET_ICON_MAX_PHOTO | 56 | | | PRESET_ICON_MAX_TIMEWARP | 57 | | | PRESET_ICON_BASIC | 58 | | | PRESET_ICON_ULTRA_SLO_MO | 59 | | | PRESET_ICON_STANDARD_ENDURANCE | 60 | | | PRESET_ICON_ACTIVITY_ENDURANCE | 61 | | | PRESET_ICON_CINEMATIC_ENDURANCE | 62 | | | PRESET_ICON_SLOMO_ENDURANCE | 63 | | | PRESET_ICON_STATIONARY_1 | 64 | | | PRESET_ICON_STATIONARY_2 | 65 | | | PRESET_ICON_STATIONARY_3 | 66 | | | PRESET_ICON_STATIONARY_4 | 67 | | | PRESET_ICON_SIMPLE_SUPER_PHOTO | 70 | | | PRESET_ICON_SIMPLE_NIGHT_PHOTO | 71 | | | PRESET_ICON_HIGHEST_QUALITY_VIDEO | 73 | | | PRESET_ICON_STANDARD_QUALITY_VIDEO | 74 | | | PRESET_ICON_BASIC_QUALITY_VIDEO | 75 | | | PRESET_ICON_STAR_TRAIL | 76 | | | PRESET_ICON_LIGHT_PAINTING | 77 | | | PRESET_ICON_LIGHT_TRAIL | 78 | | | PRESET_ICON_FULL_FRAME | 79 | | | PRESET_ICON_EASY_MAX_VIDEO | 80 | | | PRESET_ICON_EASY_MAX_PHOTO | 81 | | | PRESET_ICON_EASY_MAX_TIMEWARP | 82 | | | PRESET_ICON_EASY_MAX_STAR_TRAIL | 83 | | | PRESET_ICON_EASY_MAX_LIGHT_PAINTING | 84 | | | PRESET_ICON_EASY_MAX_LIGHT_TRAIL | 85 | | | PRESET_ICON_MAX_STAR_TRAIL | 89 | | | PRESET_ICON_MAX_LIGHT_PAINTING | 90 | | | PRESET_ICON_MAX_LIGHT_TRAIL | 91 | | | PRESET_ICON_TIMELAPSE_PHOTO | 1000 | | | PRESET_ICON_NIGHTLAPSE_PHOTO | 1001 | |", + "title": "open_gopro Protobuf Documentation: RequestConnect", + "excerpt": "Connect to (but do not authenticate with) an Access Point This is intended to be used to connect to a previously-connected Access Point Response: [ResponseConnect]( {% link protos/open_gopro.md %}responseconnect ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | ssid | required | string | 1 | AP SSID |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumpreseticon" + "url": "/OpenGoPro/protos/open_gopro.html#requestconnect" }, { - "title": "Protocol Documentation: EnumPresetTitle", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | PRESET_TITLE_ACTIVITY | 0 | | | PRESET_TITLE_STANDARD | 1 | | | PRESET_TITLE_CINEMATIC | 2 | | | PRESET_TITLE_PHOTO | 3 | | | PRESET_TITLE_LIVE_BURST | 4 | | | PRESET_TITLE_BURST | 5 | | | PRESET_TITLE_NIGHT | 6 | | | PRESET_TITLE_TIME_WARP | 7 | | | PRESET_TITLE_TIME_LAPSE | 8 | | | PRESET_TITLE_NIGHT_LAPSE | 9 | | | PRESET_TITLE_VIDEO | 10 | | | PRESET_TITLE_SLOMO | 11 | | | PRESET_TITLE_360_VIDEO | 12 | | | PRESET_TITLE_PHOTO_2 | 13 | | | PRESET_TITLE_PANORAMA | 14 | | | PRESET_TITLE_360_PHOTO | 15 | | | PRESET_TITLE_TIME_WARP_2 | 16 | | | PRESET_TITLE_360_TIME_WARP | 17 | | | PRESET_TITLE_CUSTOM | 18 | | | PRESET_TITLE_AIR | 19 | | | PRESET_TITLE_BIKE | 20 | | | PRESET_TITLE_EPIC | 21 | | | PRESET_TITLE_INDOOR | 22 | | | PRESET_TITLE_MOTOR | 23 | | | PRESET_TITLE_MOUNTED | 24 | | | PRESET_TITLE_OUTDOOR | 25 | | | PRESET_TITLE_POV | 26 | | | PRESET_TITLE_SELFIE | 27 | | | PRESET_TITLE_SKATE | 28 | | | PRESET_TITLE_SNOW | 29 | | | PRESET_TITLE_TRAIL | 30 | | | PRESET_TITLE_TRAVEL | 31 | | | PRESET_TITLE_WATER | 32 | | | PRESET_TITLE_LOOPING | 33 | | | PRESET_TITLE_STARS | 34 | New custom names (34 - 43)added for HERO 12 | | PRESET_TITLE_ACTION | 35 | | | PRESET_TITLE_FOLLOW_CAM | 36 | | | PRESET_TITLE_SURF | 37 | | | PRESET_TITLE_CITY | 38 | | | PRESET_TITLE_SHAKY | 39 | | | PRESET_TITLE_CHESTY | 40 | | | PRESET_TITLE_HELMET | 41 | | | PRESET_TITLE_BITE | 42 | | | PRESET_TITLE_MTB | 43 | | | PRESET_TITLE_360_TIMELAPSE | 51 | Reserved 44 - 50 for custom presets. | | PRESET_TITLE_360_NIGHT_LAPSE | 52 | | | PRESET_TITLE_360_NIGHT_PHOTO | 53 | | | PRESET_TITLE_PANO_TIME_LAPSE | 54 | | | PRESET_TITLE_MAX_VIDEO | 55 | | | PRESET_TITLE_MAX_PHOTO | 56 | | | PRESET_TITLE_MAX_TIMEWARP | 57 | | | PRESET_TITLE_BASIC | 58 | | | PRESET_TITLE_ULTRA_SLO_MO | 59 | | | PRESET_TITLE_STANDARD_ENDURANCE | 60 | | | PRESET_TITLE_ACTIVITY_ENDURANCE | 61 | | | PRESET_TITLE_CINEMATIC_ENDURANCE | 62 | | | PRESET_TITLE_SLOMO_ENDURANCE | 63 | | | PRESET_TITLE_STATIONARY_1 | 64 | | | PRESET_TITLE_STATIONARY_2 | 65 | | | PRESET_TITLE_STATIONARY_3 | 66 | | | PRESET_TITLE_STATIONARY_4 | 67 | | | PRESET_TITLE_SIMPLE_VIDEO | 68 | | | PRESET_TITLE_SIMPLE_TIME_WARP | 69 | | | PRESET_TITLE_SIMPLE_SUPER_PHOTO | 70 | | | PRESET_TITLE_SIMPLE_NIGHT_PHOTO | 71 | | | PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE | 72 | | | PRESET_TITLE_HIGHEST_QUALITY | 73 | | | PRESET_TITLE_EXTENDED_BATTERY | 74 | | | PRESET_TITLE_LONGEST_BATTERY | 75 | | | PRESET_TITLE_STAR_TRAIL | 76 | | | PRESET_TITLE_LIGHT_PAINTING | 77 | | | PRESET_TITLE_LIGHT_TRAIL | 78 | | | PRESET_TITLE_FULL_FRAME | 79 | | | PRESET_TITLE_MAX_LENS_VIDEO | 80 | | | PRESET_TITLE_MAX_LENS_TIMEWARP | 81 | | | PRESET_TITLE_STANDARD_QUALITY_VIDEO | 82 | | | PRESET_TITLE_BASIC_QUALITY_VIDEO | 83 | | | PRESET_TITLE_EASY_MAX_VIDEO | 84 | | | PRESET_TITLE_EASY_MAX_PHOTO | 85 | | | PRESET_TITLE_EASY_MAX_TIMEWARP | 86 | | | PRESET_TITLE_EASY_MAX_STAR_TRAIL | 87 | | | PRESET_TITLE_EASY_MAX_LIGHT_PAINTING | 88 | | | PRESET_TITLE_EASY_MAX_LIGHT_TRAIL | 89 | | | PRESET_TITLE_MAX_STAR_TRAIL | 90 | | | PRESET_TITLE_MAX_LIGHT_PAINTING | 91 | | | PRESET_TITLE_MAX_LIGHT_TRAIL | 92 | | | PRESET_TITLE_HIGHEST_QUALITY_VIDEO | 93 | | | PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | 94 | |", + "title": "open_gopro Protobuf Documentation: RequestConnectNew", + "excerpt": "Connect to and authenticate with an Access Point This is only intended to be used if the AP is not previously provisioned. Response: [ResponseConnectNew]( {% link protos/open_gopro.md %}responseconnectnew ) sent immediately Notification: [NotifProvisioningState]( {% link protos/open_gopro.md %}notifprovisioningstate ) sent periodically as provisioning state changes | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | ssid | required | string | 1 | AP SSID | | password | required | string | 2 | AP password | | static_ip | optional | bytes | 3 | Static IP address | | gateway | optional | bytes | 4 | Gateway IP address | | subnet | optional | bytes | 5 | Subnet mask | | dns_primary | optional | bytes | 6 | Primary DNS | | dns_secondary | optional | bytes | 7 | Secondary DNS |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumpresettitle" + "url": "/OpenGoPro/protos/open_gopro.html#requestconnectnew" }, { - "title": "Protocol Documentation: request_get_preset_status.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: RequestCreateCOHNCert", + "excerpt": "Create the COHN certificate. Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) with the status of the creation | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | override | optional | bool | 1 | Override current provisioning and create new cert |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#request-get-preset-status-proto" + "url": "/OpenGoPro/protos/open_gopro.html#requestcreatecohncert" }, { - "title": "Protocol Documentation: RequestGetPresetStatus", - "excerpt": "Get preset status (and optionally register to be notified when it changes) Response: @ref NotifyPresetStatus sent immediately Notification: @ref NotifyPresetStatus sent periodically as preset status changes, if registered. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | register_preset_status | [EnumRegisterPresetStatus](open_gopro-EnumRegisterPresetStatus) | repeated | Array of Preset statuses to be notified about | | unregister_preset_status | [EnumRegisterPresetStatus](open_gopro-EnumRegisterPresetStatus) | repeated | Array of Preset statuses to stop being notified about |", + "title": "open_gopro Protobuf Documentation: RequestCustomPresetUpdate", + "excerpt": "Request to update the active custom preset This only operates on the currently active Preset and will fail if the current Preset is not custom. The use cases are: 1. Update the Custom Preset Icon - `icon_id` is always optional and can always be passed and / or 2. Update the Custom Preset Title to a... - **Factory Preset Title**: Set `title_id` to a non-94 value - **Custom Preset Name**: Set `title_id` to 94 and specify a `custom_name` Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) with the status of the preset update request. | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | title_id | optional | [EnumPresetTitle]({% link protos/open_gopro.md %}enumpresettitle) | 1 | Preset Title ID The range of acceptable custom title ID's can be found in the initial [NotifyPresetStatus]( {% link protos/open_gopro.md %}notifypresetstatus ) response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}requestgetpresetstatus ) | | custom_name | optional | string | 2 | utf-8 encoded target custom preset name | | icon_id | optional | [EnumPresetIcon]({% link protos/open_gopro.md %}enumpreseticon) | 3 | Preset Icon ID The range of acceptable custom icon ID's can be found in the initial [NotifyPresetStatus]( {% link protos/open_gopro.md %}notifypresetstatus ) response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}requestgetpresetstatus ) |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestgetpresetstatus" + "url": "/OpenGoPro/protos/open_gopro.html#requestcustompresetupdate" }, { - "title": "Protocol Documentation: EnumRegisterPresetStatus", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | REGISTER_PRESET_STATUS_PRESET | 1 | Send notification when properties of a preset change | | REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY | 2 | Send notification when properties of a preset group change |", + "title": "open_gopro Protobuf Documentation: RequestGetApEntries", + "excerpt": "Get a list of Access Points found during a [RequestStartScan]( {% link protos/open_gopro.md %}requeststartscan ) Response: [ResponseGetApEntries]( {% link protos/open_gopro.md %}responsegetapentries ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | start_index | required | int32 | 1 | Used for paging. 0 <= start_index < [ResponseGetApEntries]( {% link protos/open_gopro.md %}responsegetapentries ) .total_entries | | max_entries | required | int32 | 2 | Used for paging. Value must be < [ResponseGetApEntries]( {% link protos/open_gopro.md %}responsegetapentries ) .total_entries | | scan_id | required | int32 | 3 | ID corresponding to a set of scan results (i.e. [ResponseGetApEntries]( {% link protos/open_gopro.md %}responsegetapentries ) .scan_id) |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumregisterpresetstatus" + "url": "/OpenGoPro/protos/open_gopro.html#requestgetapentries" }, { - "title": "Protocol Documentation: response_generic.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: RequestGetCOHNStatus", + "excerpt": "Get the current COHN status. This always returns a [NotifyCOHNStatus]( {% link protos/open_gopro.md %}notifycohnstatus ) Additionally, asynchronous updates can also be registerd to return more [NotifyCOHNStatus]( {% link protos/open_gopro.md %}notifycohnstatus ) when a value changes. | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | register_cohn_status | optional | bool | 1 | 1 to register, 0 to unregister |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#response-generic-proto" + "url": "/OpenGoPro/protos/open_gopro.html#requestgetcohnstatus" }, { - "title": "Protocol Documentation: ResponseGeneric", - "excerpt": "Generic Response used across most response / notification messages @ref EnumResultGeneric | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | result | [EnumResultGeneric](open_gopro-EnumResultGeneric) | required | Generic pass/fail/error info |", + "title": "open_gopro Protobuf Documentation: RequestGetLastCapturedMedia", + "excerpt": "Get the last captured media filename Returns a [ResponseLastCapturedMedia]( {% link protos/open_gopro.md %}responselastcapturedmedia )", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#responsegeneric" + "url": "/OpenGoPro/protos/open_gopro.html#requestgetlastcapturedmedia" }, { - "title": "Protocol Documentation: EnumResultGeneric", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | RESULT_UNKNOWN | 0 | | | RESULT_SUCCESS | 1 | | | RESULT_ILL_FORMED | 2 | | | RESULT_NOT_SUPPORTED | 3 | | | RESULT_ARGUMENT_OUT_OF_BOUNDS | 4 | | | RESULT_ARGUMENT_INVALID | 5 | |", + "title": "open_gopro Protobuf Documentation: RequestGetLiveStreamStatus", + "excerpt": "Get the current livestream status (and optionally register for future status changes) Both current status and future status changes are sent via [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}notifylivestreamstatus ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | register_live_stream_status | repeated | [EnumRegisterLiveStreamStatus]({% link protos/open_gopro.md %}enumregisterlivestreamstatus) | 1 | Array of live stream statuses to be notified about | | unregister_live_stream_status | repeated | [EnumRegisterLiveStreamStatus]({% link protos/open_gopro.md %}enumregisterlivestreamstatus) | 2 | Array of live stream statuses to stop being notified about |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumresultgeneric" + "url": "/OpenGoPro/protos/open_gopro.html#requestgetlivestreamstatus" }, { - "title": "Protocol Documentation: set_camera_control_status.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: RequestGetPresetStatus", + "excerpt": "Get preset status (and optionally register to be notified when it changes) Response: [NotifyPresetStatus]( {% link protos/open_gopro.md %}notifypresetstatus ) sent immediately Notification: [NotifyPresetStatus]( {% link protos/open_gopro.md %}notifypresetstatus ) sent periodically as preset status changes, if registered. | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | register_preset_status | repeated | [EnumRegisterPresetStatus]({% link protos/open_gopro.md %}enumregisterpresetstatus) | 1 | Array of Preset statuses to be notified about | | unregister_preset_status | repeated | [EnumRegisterPresetStatus]({% link protos/open_gopro.md %}enumregisterpresetstatus) | 2 | Array of Preset statuses to stop being notified about |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#set-camera-control-status-proto" + "url": "/OpenGoPro/protos/open_gopro.html#requestgetpresetstatus" }, { - "title": "Protocol Documentation: RequestSetCameraControlStatus", - "excerpt": "Set Camera Control Status (as part of Global Behaviors feature) Response: @ref ResponseGeneric | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | camera_control_status | [EnumCameraControlStatus](open_gopro-EnumCameraControlStatus) | required | Declare who is taking control of the camera |", + "title": "open_gopro Protobuf Documentation: RequestReleaseNetwork", + "excerpt": "Request to disconnect from current AP network Response: [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric )", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestsetcameracontrolstatus" + "url": "/OpenGoPro/protos/open_gopro.html#requestreleasenetwork" }, { - "title": "Protocol Documentation: EnumCameraControlStatus", - "excerpt": "| Name | Number | Description | | ---- | ------ | ----------- | | CAMERA_IDLE | 0 | | | CAMERA_CONTROL | 1 | Can only be set by camera, not by app or third party | | CAMERA_EXTERNAL_CONTROL | 2 | |", + "title": "open_gopro Protobuf Documentation: RequestSetCOHNSetting", + "excerpt": "Enable and disable COHN if provisioned Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | cohn_active | optional | bool | 1 | 1 to enable, 0 to disable |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#enumcameracontrolstatus" + "url": "/OpenGoPro/protos/open_gopro.html#requestsetcohnsetting" }, { - "title": "Protocol Documentation: turbo_transfer.proto", - "excerpt": "", + "title": "open_gopro Protobuf Documentation: RequestSetCameraControlStatus", + "excerpt": "Set Camera Control Status (as part of Global Behaviors feature) Response: [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | camera_control_status | required | [EnumCameraControlStatus]({% link protos/open_gopro.md %}enumcameracontrolstatus) | 1 | Declare who is taking control of the camera |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#turbo-transfer-proto" + "url": "/OpenGoPro/protos/open_gopro.html#requestsetcameracontrolstatus" }, { - "title": "Protocol Documentation: RequestSetTurboActive", - "excerpt": "Enable/disable display of \"Transferring Media\" UI Response: @ref ResponseGeneric | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | active | [bool](bool) | required | Enable or disable Turbo Transfer feature |", + "title": "open_gopro Protobuf Documentation: RequestSetLiveStreamMode", + "excerpt": "Configure lives streaming The current livestream status can be queried via [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}requestgetlivestreamstatus ) Response: [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | url | optional | string | 1 | RTMP(S) URL used for live stream | | encode | optional | bool | 2 | Save media to sdcard while streaming? | | window_size | optional | [EnumWindowSize]({% link protos/open_gopro.md %}enumwindowsize) | 3 | Resolution to use for live stream The set of supported lenses is only available from the `live_stream_window_size_supported_array` in [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}notifylivestreamstatus )) | | cert | optional | bytes | 6 | Certificate for servers that require it | | minimum_bitrate | optional | int32 | 7 | Minimum desired bitrate (may or may not be honored) | | maximum_bitrate | optional | int32 | 8 | Maximum desired bitrate (may or may not be honored) | | starting_bitrate | optional | int32 | 9 | Starting bitrate | | lens | optional | [EnumLens]({% link protos/open_gopro.md %}enumlens) | 10 | Lens to use for live stream The set of supported lenses is only available from the `live_stream_lens_supported_array` in [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}notifylivestreamstatus )) |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#requestsetturboactive" + "url": "/OpenGoPro/protos/open_gopro.html#requestsetlivestreammode" }, { - "title": "Protocol Documentation: Scalar Value Types", - "excerpt": "| .proto Type | Notes | C++ | Java | Python | Go | C | PHP | Ruby | | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | | double | | double | double | float | float64 | double | float | Float | | float | | float | float | float | float32 | float | float | Float | | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |", + "title": "open_gopro Protobuf Documentation: RequestSetTurboActive", + "excerpt": "Enable/disable display of \"Transferring Media\" UI Response: [ResponseGeneric]( {% link protos/open_gopro.md %}responsegeneric ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | active | required | bool | 1 | Enable or disable Turbo Transfer feature |", "categories": [], "tags": [], - "url": "/OpenGoPro/protos#scalar-value-types" + "url": "/OpenGoPro/protos/open_gopro.html#requestsetturboactive" }, { - "title": "Tutorials: ", - "excerpt": "This set of tutorials is a series of sample scripts / files and accompanying .html walk-throughs to implement basic functionality to interact with a GoPro device using the following languages: - Python - Kotlin - More to come! The tutorials only support Open GoPro Version 2.0 and must be run on a [supported camera]({% link specs/ble_versions/ble_2_0.md %}supported-cameras). They will provide walk-throughs and sample code to use the relevant language / framework to exercise the Open GoPro Interface using Bluetooth Low Energy (BLE) and HTTP over WiFi. The tutorials are meant as an introduction to the Open GoPro specification. They are not a substitute for the complete [BLE]({% link specs/ble_versions/ble_2_0.md %}) and [HTTP]({% link specs/http_versions/http_2_0.md %}) specifications which will be your main source of reference after completing the tutorials. {% for tutorial in site.tutorials %} - [{{ tutorial.title }}]({{ tutorial.permalink | prepend: site.baseurl }}) {% endfor %}", + "title": "open_gopro Protobuf Documentation: RequestStartScan", + "excerpt": "Start scanning for Access Points > Serialization of this object is zero bytes. Response: [ResponseStartScanning]( {% link protos/open_gopro.md %}responsestartscanning ) are sent immediately after the camera receives this command Notifications: [NotifStartScanning]( {% link protos/open_gopro.md %}notifstartscanning ) are sent periodically as scanning state changes. Use to detect scan complete.", "categories": [], "tags": [], - "url": "/OpenGoPro/tutorials/#" + "url": "/OpenGoPro/protos/open_gopro.html#requeststartscan" }, { - "title": "Over the Air Firmware Update Demo: ", - "excerpt": "Over the Air Firmware Update Demo Assumptions Prerequisites OTA Procedure Usage Testing This directory contains a bash script to perform an over-the-air (OTA) firmware (FW) update to the camera. Assumptions The host PC is already connected via WiFi to the target camera The target FW images are already provided from GoPro as a .zip file. These can be found on the Update Page or programmatically from the Firmware Catalog JSON information. Prerequisites Alternatively to satisfying these prerequisites, the script can be run with the Docker option (see usage) The script uses open ssl to calculate the hash so openssl must be installed and available on the system path. The script uses curl to send HTTP commands so curl must be installed and available on the system path. OTA Procedure The OTA procedure requires the following steps: Calculate the SHA1 hash of the target .zip file. Delete any partially stored data. Show the update UI Upload the target firmware to the camera Notify the camera that the upload is complete Instruct the camera to load the new firmware Usage Call the send_ota.sh script here with the -h option for a detailed usage: Usage: ./send_ota.sh [-d] OTA_UPDATE_FILE Given a target FW .zip file, calculate its SHA1 hash, then send it over-the-air to an already connected camera. Required positional arguments: OTA_UPDATE_FILE target .zip file to send over-the-air. If using docker, must be passed as relative path from the directory of this script Optional arguments: -d Use docker for openssl and curl commands. -h Print this Help. Testing There is a test script that will use a Python script (contained in a Docker container) to: get the FW catalog JSON get the UPDATE.zip from the link in the JSON exercise the send_ota.sh script to send this firmware to the camera (outside of the container) The test script is located ./test/test.sh and should be passed the camera that is connected, i.e.: ./test.sh \"HERO_11\" Note! The test script needs to be run from the test folder You can also run with the --help parameter to get a list of cameras.", + "title": "open_gopro Protobuf Documentation: ResponseCOHNCert", + "excerpt": "COHN Certificate response triggered by RequestCOHNCert | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | optional | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Was request successful? | | cert | optional | string | 2 | Root CA cert (ASCII text) |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/bash/ota_update#" + "url": "/OpenGoPro/protos/open_gopro.html#responsecohncert" }, { - "title": "GoPro C/C++ Demos: ", - "excerpt": "GoPro C/C++ Demos Build Requirements Steps Run Requirements Steps Media Commands Stream Commands This folder contains C and C++ examples to perform some Open GoPro functionality. There are two examples, each of which are detailed in a section below. Media Commands Stream Commands Build Requirements This demo depends on the following external libraries: libCurl: a client-side URL transfer library used to make command requests to the camera over WiFi and get the JSON response cJSON: an ultra-light JSON parser that can be used to parse the JSON responses from the WiFi commands To use the build system contained here, the following programs are required to be installed: Conan: a python-based C / C++ package manager If a local python 3 is found, this will be automatically installed CMake: a project configuration and build tool Steps Run the build.sh file. This will: verify existence of requirements (and install Conan if applicable) use Conan to download and install libCurl and cJson use CMake to configure build system and build executables The output binaries will then be available in build/bin Run Requirements Before running the executables built here, you must first be connected to the camera’s WiFi Access Point. This can be done via: Connect BLE to turn on AP and get WiFi SSID/PASSPHRASE Use retrieved WiFi SSID/PASSPHRASE to connect system to GoPro WiFi A programmatic example of this process can be found in the Open GoPro Python SDK’s Connect Wifi Demo. This can be run (assuming a local Python 3.8.x installation exists) via: pip install open-gopro gopro-wifi Steps Media Commands This demo shows one way to get the media list and download the first media file. It also supports requests to get the media list, media info and downloading specific media files. For a list of possible commands, do: $ ./build/bin/media_commands --help Media List: $ ./build/bin/media_commands <-l, --list_files> Media List(Pretty Print): $ ./build/bin/media_commands <-f, --list_files_pretty> Media Info: $ ./build/bin/media_commands <-i, --info> <camera_file_path> Media Info(Pretty Print): $ ./build/bin/media_commands <-p, --info_pretty> <camera_file_path> Media Download: $ ./build/bin/media_commands <-g, --download> <camera_file_path> <output_path/output_file_name> Media Hilight Moment: $ ./build/bin/media_commands --tag Media Hilight File: $ ./build/bin/media_commands --tag-video <video_file_path> <offset_ms> $ ./build/bin/media_commands --tag-photo <photo_file_path> Media Hilight Remove: $ ./build/bin/media_commands --tag-video-remove <video_file_path> <offset_ms> $ ./build/bin/media_commands --tag-photo-remove <photo_file_path> Media Demo: $ ./build/bin/media_commands <-d, --demo> <output_path> Stream Commands This demo demonstrates one way to start and stop the preview stream. Note: To run the Preview Stream demo. A media player (i.e: VLC) that supports UDP is needed to view the preview stream. The UDP address is udp://0.0.0.0:8554 Start Stream: $ ./build/bin/stream_commands <-s, --start> Stop Stream: $ ./build/bin/stream_commands <-e, --end> Preview Stream Demo: $ ./build/bin/stream_commands <-d, --demo>", + "title": "open_gopro Protobuf Documentation: ResponseConnect", + "excerpt": "The status of an attempt to connect to an Access Point Sent as the initial response to [RequestConnect]( {% link protos/open_gopro.md %}requestconnect ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Generic pass/fail/error info | | provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}enumprovisioning) | 2 | Provisioning/connection state | | timeout_seconds | required | int32 | 3 | Network connection timeout (seconds) |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/c_c++/GoProC_C++Demo#" + "url": "/OpenGoPro/protos/open_gopro.html#responseconnect" }, { - "title": "GoPro Low Latency Stream Demo: ", - "excerpt": "This demostrates how to decode the GoPro webcam or 16x9 video preview stream using the ffmpeg library. To use this demo, plug in a hero 9 or hero 10 camera while in a standard video mode and run the app. The webcam stream at 1080p should be displayed in the window. The display output is not optimized. To switch to preview stream (720p non processed stream), uncomment the define in GoProStreamDemo.h //define USE_PREVIEW_STREAM", + "title": "open_gopro Protobuf Documentation: ResponseConnectNew", + "excerpt": "The status of an attempt to connect to an Access Point Sent as the initial response to [RequestConnectNew]( {% link protos/open_gopro.md %}requestconnectnew ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Status of Connect New request | | provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}enumprovisioning) | 2 | Current provisioning state of the network | | timeout_seconds | required | int32 | 3 | number of seconds camera will wait before declaring a network connection attempt failed. |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/c_c++/GoProStreamDemo#" + "url": "/OpenGoPro/protos/open_gopro.html#responseconnectnew" }, { - "title": "GoProCSharpSample: ", - "excerpt": "This sample demonstrates how to discover, pair, and connect to a GoPro camera via Bluetooth LE (BLE). Once a connection is established, the code shows how to: Enable Wi-Fi on the GoPro camera Read the camera wifi name and password Get status and notification of camera’s battery level, encoding flag, and wifi ap on flag. Start and stop camera shutter Requirements Visual Studio is required to run the solution. Visit https://visualstudio.microsoft.com/downloads/ to download. The target .NET framework is v4.7.2 GoPro camera must be paired before any other operations will succeed. Put the camera in pairing mode before attempting pairing with the app. Usage Open and run the demo in Visual Studio to show the GUI Scan for GoPro devices Pair to the discovered device that is not GoPro Cam. In the .gif below, this is GoPro 0456 (Only needs to be done once, or if camera is factory reset) After pairing is successful, connect to the same GoPro device Now use any of the GUI buttons to read WiFi info, enable WiFi AP, set shutter, etc.", + "title": "open_gopro Protobuf Documentation: ResponseGeneric", + "excerpt": "Generic Response used across most response / notification messages [EnumResultGeneric]( {% link protos/open_gopro.md %}enumresultgeneric ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Generic pass/fail/error info |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/csharp/GoProCSharpSample#" + "url": "/OpenGoPro/protos/open_gopro.html#responsegeneric" }, { - "title": "CSharp Webcam Demo: ", - "excerpt": "This demo implements a simple GUI to interact with a GoPro camera that supports Open GoPro 2.0. Requirements This demo will only run on Windows. Visual Studio is required to run the solution. Visit VisualStudio to download. The target .NET framework is v4.7.2 GoPro camera must be paired before any other operations will succeed. Put the camera in pairing mode before attempting pairing with the app. Prerequisites The correct GoPro Webcam drivers must be installed. To verify this, ensure that you can first use your desired GoPro as a webcam following the steps here. Usage Connect the GoPro to your computer using the USB cable Open the solution (GoProWebCamViewer.sln) in Visual Studio, build and run io to show the Webcam GUI Select Start Player to start the VLC backend. Note that the log and status bar have updated. This will be true for all functionality. Select Show Preview to start a low quality preview stream While in preview, feel free to update the FOV or change the zoom Once you are ready, select Start Webcam to start full resolution streaming", + "title": "open_gopro Protobuf Documentation: ResponseGetApEntries", + "excerpt": "A list of scan entries describing a scanned Access Point This is sent in response to a [RequestGetApEntries]( {% link protos/open_gopro.md %}requestgetapentries ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Generic pass/fail/error info | | scan_id | required | int32 | 2 | ID associated with this batch of results | | entries | repeated | [ScanEntry]({% link protos/open_gopro.md %}scanentry) | 3 | Array containing details about discovered APs |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/csharp/webcam#" + "url": "/OpenGoPro/protos/open_gopro.html#responsegetapentries" }, { - "title": "Multi Webcam: ", - "excerpt": "Multi Webcam Assumptions Installation Quick Start Start Webcam Example Single Webcam Multiple Webcams Module Usage This is a small Python module to demonstrate GoPro Webcam usage, including how to use multiple webcams simultaneously from the same PC. Assumptions It is assumed that the GoPro’s are using firmware versions that support the port parameter to the Start Webcam endpoint. See the Open GoPro Commands Quick Reference for more information. Installation This module requires Python >= 3.9 and < 3.11. It should be installed locally, either with pip via: pip install . or poetry via: poetry install --only main Quick Start Once installed, the following CLI programs are available: Each CLI has useful help available by calling it with the --help argument Start Webcam Configure and start a single webcam. Its stream can then be viewed using, for example VLC. usage: start-webcam [-h] [-p PORT] [-r RESOLUTION] [-f FOV] serial Enable and start the webcam. positional arguments: serial Last 3 digits of camera serial number. options: -h, --help show this help message and exit -p PORT, --port PORT Port to use. If not set, port will not be specified to camera. -r RESOLUTION, --resolution RESOLUTION Resolution to use. If set, fov must also be set. -f FOV, --fov FOV FOV to use. If set, resolution must also be set Example start-webcam 992 -p 9000 The stream can than be viewed at udp://@0.0.0.0:9001 Single Webcam Configure and start a single webcam. Then display its stream. This is different than the previous program in that it also handles displaying the stream (using OpenCV). usage: single-webcam [-h] [-p PORT] [-r RESOLUTION] [-f FOV] serial Enable and start the webcam and a player to view it. positional arguments: serial Last 3 digits of camera serial number. options: -h, --help show this help message and exit -p PORT, --port PORT Port to use. If not set, port will not be specified to camera. -r RESOLUTION, --resolution RESOLUTION Resolution to use. If set, fov must also be set. -f FOV, --fov FOV FOV to use. If set, resolution must also be set Multiple Webcams Using a .json configuraton file, configure, start, and view multiple webcams. usage: multi-webcam [-h] config Configure, enable and start webcams with players to view them. positional arguments: config Location of config json file. options: -h, --help show this help message and exit where an example config file could look like this: { \"992\": { \"port\": 9000, \"resolution\": 12, \"fov\": 0 }, \"149\": { \"resolution\": 12, \"fov\": 0 } } If port is not set, an available port will be discovered automatically starting at 8554. If resolution or fov are not set, they will be set to defaults by the GoPro. Cameras Module Usage For detailed module usage, see the docstrings in ./multi_webcam/webcam.py.", + "title": "open_gopro Protobuf Documentation: ResponseLastCapturedMedia", + "excerpt": "Message sent in response to a [RequestGetLastCapturedMedia]( {% link protos/open_gopro.md %}requestgetlastcapturedmedia ) This contains the complete path of the last captured media. Depending on the type of media captured, it will return: - Single photo / video: The single media path - Any grouped media: The path to the first captured media in the group | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | optional | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Was the request successful? | | media | optional | [Media]({% link protos/open_gopro.md %}media) | 2 | Last captured media if result is RESULT_SUCCESS. Invalid if result is RESULT_RESOURCE_NOT_AVAILBLE. |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/python/multi_webcam#" + "url": "/OpenGoPro/protos/open_gopro.html#responselastcapturedmedia" }, { - "title": "Open GoPro Python SDK: ", - "excerpt": "This is a Python package that provides an interface for the user to exercise the Open GoPro Bluetooth Low Energy (BLE) and Wi-Fi / USB HTTP API’s as well as install command line interfaces to take photos, videos, and view video streams. Free software: MIT license Documentation: View on Open GoPro View on Github Documentation Note! This README is only an overview of the package. Complete documentation can be found on Open GoPro Features Top-level GoPro class interface to use BLE, WiFi, and / or USB Cross-platform (tested on MacOS Big Sur, Windows 10, and Ubuntu 20.04) BLE implemented using bleak Wi-Fi controller provided in the Open GoPro package (loosely based on the Wireless Library Supports all commands, settings, and statuses from the Open GoPro API Asyncio based Automatically handles connection maintenance: manage camera ready / encoding periodically sends keep alive signals Includes detailed logging for each module Includes demo scripts installed as command-line applications to show BLE, WiFi, and USB functionality such as: Take a photo Take a video Configure and view a GoPro webcam stream GUI to send all commands and view the live / preview stream Log the battery Installation Note! This package requires Python >= 3.8 and < 3.12 The minimal install to use the Open GoPro library and the CLI demos is: $ pip install open-gopro To also install the extra dependencies to run the GUI demos, do: $ pip install open-gopro[gui] Usage To automatically connect to GoPro device via BLE and WiFI, set the preset, set video parameters, take a video, and download all files: import asyncio from open_gopro import WirelessGoPro, Params async def main(): async with WirelessGoPro() as gopro: await gopro.ble_setting.resolution.set(Params.Resolution.RES_4K) await gopro.ble_setting.fps.set(Params.FPS.FPS_30) await gopro.ble_command.set_shutter(shutter=Params.Toggle.ENABLE) await asyncio.sleep(2) Record for 2 seconds await gopro.ble_command.set_shutter(shutter=Params.Toggle.DISABLE) Download all of the files from the camera media_list = (await gopro.http_command.get_media_list()).data.files for item in media_list: await gopro.http_command.download_file(camera_file=item.filename) asyncio.run(main()) And much more! Demos Note! These demos can be found on Github Demos can be found in the installed package in the “demos” folder. They are installed as a CLI entrypoint and can be run as shown below. Command Line Interface (CLI) Demos All of these demos are CLI only and can thus be run with the minimal (non-GUI) install. Capture a photo and download it to your computer: $ gopro-photo Capture a video and download it to your computer: $ gopro-video Connect to the GoPro and log battery consumption in to a .csv: $ gopro-log-battery Connect to the GoPro’s Wi-Fi AP and maintain the connection: $ gopro-wifi For more information on each, try running with help as such: $ gopro-photo --help usage: gopro-photo [-h] [-i IDENTIFIER] [-l LOG] [-o OUTPUT] [-w WIFI_INTERFACE] Connect to a GoPro camera, take a photo, then download it. optional arguments: -h, --help show this help message and exit -i IDENTIFIER, --identifier IDENTIFIER Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first discovered GoPro will be connected to -l LOG, --log LOG Location to store detailed log -o OUTPUT, --output OUTPUT Where to write the photo to. If not set, write to 'photo.jpg' -w WIFI_INTERFACE, --wifi_interface WIFI_INTERFACE System Wifi Interface. If not set, first discovered interface will be used. GUI Demos These demos require the additional GUI installation. Start the preview stream and view it: $ gopro-preview-stream Start the live stream and view it: $ gopro-live-stream", + "title": "open_gopro Protobuf Documentation: ResponseStartScanning", + "excerpt": "The current scanning state. This is the initial response to a [RequestStartScan]( {% link protos/open_gopro.md %}requeststartscan ) | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}enumresultgeneric) | 1 | Generic pass/fail/error info | | scanning_state | required | [EnumScanning]({% link protos/open_gopro.md %}enumscanning) | 2 | Scanning state |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/python/sdk_wireless_camera_control#" + "url": "/OpenGoPro/protos/open_gopro.html#responsestartscanning" }, { - "title": "Swift Enable WiFi Demo: ", - "excerpt": "This demo demonstrates how to discover and connect to a GoPro camera via Bluetooth LE (BLE). Once a connection is established, the demo demonstrates how to enable Wi-Fi on the GoPro camera and join the camera’s Wi-Fi. The steps required to join camera’s Wi-Fi are: Enable Wi-Fi Request camera’s Wi-Fi settings (SSID and password) Use iOS NetworkExtension API to join camera’s WiFi Requirements GoPro camera must be paired with the mobile device. If the camera is not paired, put the camera in pairing mode File Structure BLE CentralManager.swift - A simple wrapper around CBCentralManager to handle CoreBluetooth Central related tasks Peripheral.swift - A simple wrapper around CBPeripheral to handle CoreBluetooth Peripheral related tasks Peripheral+Camera.swift - An extension of Peripheral class for sending commands to a GoPro camera Views CameraSelectionView.swift - A SwiftUI list view for showing the nearby GoPro cameras CameraView.swift - A simple view with a button for initiate the request to enable Wi-Fi on the connected GoPro camera", + "title": "open_gopro Protobuf Documentation: ScanEntry", + "excerpt": "The individual Scan Entry model | Field | Typespec | Value Type | Value | Summary | | ----- | -------- | ---------- | ----- | ------- | | ssid | required | string | 1 | AP SSID | | signal_strength_bars | required | int32 | 2 | Signal strength (3 bars: >-70 dBm; 2 bars: >-85 dBm; 1 bar: <=-85 dBm) | | signal_frequency_mhz | required | int32 | 4 | Signal frequency (MHz) | | scan_entry_flags | required | int32 | 5 | Bitmasked value from [EnumScanEntryFlags]( {% link protos/open_gopro.md %}enumscanentryflags ) |", "categories": [], "tags": [], - "url": "/OpenGoPro/demos/swift/EnableWiFiDemo#" + "url": "/OpenGoPro/protos/open_gopro.html#scanentry" }, { "title": "Tutorial 1: Connect BLE: ", diff --git a/ble_2_0.html b/ble_2_0.html index df7e4477..cee92bf2 100644 --- a/ble_2_0.html +++ b/ble_2_0.html @@ -138,7 +138,7 @@ Tutorials
  • - Demos + Demos
  • FAQ @@ -346,7 +346,7 @@

    GoPro

  • - Protobuf + Protobuf @@ -386,7 +386,7 @@

    Bluetooth Low Energy - 61 minute read + 67 minute read @@ -527,6 +527,7 @@

    Bluetooth Low Energy Preset Status

  • @@ -1942,7 +1943,7 @@

    Settings Quick Reference

    Set video resolution (id: 2) to 4k (id: 1) 03:02:01:01 02:02:00 - + >= v02.00.00 @@ -1954,7 +1955,7 @@

    Settings Quick Reference

    Set video resolution (id: 2) to 2.7k (id: 4) 03:02:01:04 02:02:00 - + >= v02.00.00 @@ -1990,7 +1991,7 @@

    Settings Quick Reference

    Set video resolution (id: 2) to 1080 (id: 9) 03:02:01:09 02:02:00 - + >= v02.00.00 @@ -2002,7 +2003,7 @@

    Settings Quick Reference

    Set video resolution (id: 2) to 4k 4:3 (id: 18) 03:02:01:12 02:02:00 - + >= v02.00.00 @@ -2098,7 +2099,7 @@

    Settings Quick Reference

    Set video resolution (id: 2) to 5.3k (id: 100) 03:02:01:64 02:02:00 - + >= v02.00.00 @@ -2176,6 +2177,66 @@

    Settings Quick Reference

    + + 2 + Resolution + Set video resolution (id: 2) to 5.3k (id: 107) + 03:02:01:6B + 02:02:00 + >= v02.00.00 + + + + + + + 2 + Resolution + Set video resolution (id: 2) to 4k (id: 108) + 03:02:01:6C + 02:02:00 + >= v02.00.00 + + + + + + + 2 + Resolution + Set video resolution (id: 2) to 4k (id: 109) + 03:02:01:6D + 02:02:00 + >= v02.00.00 + + + + + + + 2 + Resolution + Set video resolution (id: 2) to 1080 (id: 110) + 03:02:01:6E + 02:02:00 + >= v02.00.00 + + + + + + + 2 + Resolution + Set video resolution (id: 2) to 2.7k (id: 111) + 03:02:01:6F + 02:02:00 + >= v02.00.00 + + + + + 3 Frames Per Second @@ -3187,7 +3248,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (id: 0) + Set speed (id: 176) to 8x ultra slo-mo (id: 0) 03:B0:01:00 02:B0:00 @@ -3199,7 +3260,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (id: 1) + Set speed (id: 176) to 4x super slo-mo (id: 1) 03:B0:01:01 02:B0:00 @@ -3211,7 +3272,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 2) + Set speed (id: 176) to 2x slo-mo (id: 2) 03:B0:01:02 02:B0:00 @@ -3223,7 +3284,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (low light) (id: 3) + Set speed (id: 176) to 1x speed (low light) (id: 3) 03:B0:01:03 02:B0:00 @@ -3235,7 +3296,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4) + Set speed (id: 176) to 4x super slo-mo (ext. batt.) (id: 4) 03:B0:01:04 02:B0:00 @@ -3247,7 +3308,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (ext. batt) (id: 5) + Set speed (id: 176) to 2x slo-mo (ext. batt.) (id: 5) 03:B0:01:05 02:B0:00 @@ -3259,7 +3320,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (ext. batt, low light) (id: 6) + Set speed (id: 176) to 1x speed (ext. batt.) (low light) (id: 6) 03:B0:01:06 02:B0:00 @@ -3271,7 +3332,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) + Set speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7) 03:B0:01:07 02:B0:00 @@ -3283,7 +3344,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) + Set speed (id: 176) to 4x super slo-mo (50hz) (id: 8) 03:B0:01:08 02:B0:00 @@ -3295,7 +3356,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) + Set speed (id: 176) to 2x slo-mo (50hz) (id: 9) 03:B0:01:09 02:B0:00 @@ -3307,7 +3368,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (low light, 50hz) (id: 10) + Set speed (id: 176) to 1x speed (50hz) (low light) (id: 10) 03:B0:01:0A 02:B0:00 @@ -3319,7 +3380,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11) + Set speed (id: 176) to 4x super slo-mo (50hz) (ext. batt.) (id: 11) 03:B0:01:0B 02:B0:00 @@ -3331,7 +3392,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12) + Set speed (id: 176) to 2x slo-mo (50hz) (ext. batt.) (id: 12) 03:B0:01:0C 02:B0:00 @@ -3343,7 +3404,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13) + Set speed (id: 176) to 1x speed (50hz) (ext. batt.) (low light) (id: 13) 03:B0:01:0D 02:B0:00 @@ -3355,7 +3416,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14) + Set speed (id: 176) to 8x ultra slo-mo (ext. batt.) (id: 14) 03:B0:01:0E 02:B0:00 @@ -3367,7 +3428,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15) + Set speed (id: 176) to 8x ultra slo-mo (50hz) (ext. batt.) (id: 15) 03:B0:01:0F 02:B0:00 @@ -3379,7 +3440,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16) + Set speed (id: 176) to 8x ultra slo-mo (long. batt.) (id: 16) 03:B0:01:10 02:B0:00 @@ -3391,7 +3452,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (long. batt) (id: 17) + Set speed (id: 176) to 4x super slo-mo (long. batt.) (id: 17) 03:B0:01:11 02:B0:00 @@ -3403,7 +3464,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (long. batt) (id: 18) + Set speed (id: 176) to 2x slo-mo (long. batt.) (id: 18) 03:B0:01:12 02:B0:00 @@ -3415,7 +3476,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (long. batt, low light) (id: 19) + Set speed (id: 176) to 1x speed (long. batt.) (low light) (id: 19) 03:B0:01:13 02:B0:00 @@ -3427,7 +3488,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20) + Set speed (id: 176) to 8x ultra slo-mo (50hz) (long. batt.) (id: 20) 03:B0:01:14 02:B0:00 @@ -3439,7 +3500,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21) + Set speed (id: 176) to 4x super slo-mo (50hz) (long. batt.) (id: 21) 03:B0:01:15 02:B0:00 @@ -3451,7 +3512,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22) + Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (id: 22) 03:B0:01:16 02:B0:00 @@ -3463,7 +3524,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23) + Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (id: 23) 03:B0:01:17 02:B0:00 @@ -3475,7 +3536,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (4k) (id: 24) + Set speed (id: 176) to 2x slo-mo (4k) (id: 24) 03:B0:01:18 02:B0:00 @@ -3487,7 +3548,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) + Set speed (id: 176) to 4x super slo-mo (2.7k) (id: 25) 03:B0:01:19 02:B0:00 @@ -3499,7 +3560,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26) + Set speed (id: 176) to 2x slo-mo (4k) (50hz) (id: 26) 03:B0:01:1A 02:B0:00 @@ -3511,7 +3572,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27) + Set speed (id: 176) to 4x super slo-mo (2.7k) (50hz) (id: 27) 03:B0:01:1B 02:B0:00 @@ -3523,7 +3584,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 28) + Set speed (id: 176) to 1x speed (low light) (vertical) (id: 28) 03:B0:01:1C 02:B0:00 @@ -3535,7 +3596,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 29) + Set speed (id: 176) to 1x speed (50hz) (low light) (vertical) (id: 29) 03:B0:01:1D 02:B0:00 @@ -3547,7 +3608,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 30) + Set speed (id: 176) to 2x slo-mo (vertical) (id: 30) 03:B0:01:1E 02:B0:00 @@ -3559,7 +3620,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 31) + Set speed (id: 176) to 2x slo-mo (50hz) (vertical) (id: 31) 03:B0:01:1F 02:B0:00 @@ -3571,7 +3632,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 32) + Set speed (id: 176) to 1x speed (full frame) (low light) (id: 32) 03:B0:01:20 02:B0:00 @@ -3583,7 +3644,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 33) + Set speed (id: 176) to 1x speed (50hz) (full frame) (low light) (id: 33) 03:B0:01:21 02:B0:00 @@ -3595,7 +3656,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 34) + Set speed (id: 176) to 2x slo-mo (full frame) (id: 34) 03:B0:01:22 02:B0:00 @@ -3607,7 +3668,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 35) + Set speed (id: 176) to 2x slo-mo (50hz) (full frame) (id: 35) 03:B0:01:23 02:B0:00 @@ -3619,7 +3680,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 36) + Set speed (id: 176) to 1x speed (4k) (low light) (id: 36) 03:B0:01:24 02:B0:00 @@ -3631,7 +3692,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 37) + Set speed (id: 176) to 1x speed (4k) (50hz) (low light) (id: 37) 03:B0:01:25 02:B0:00 @@ -3643,7 +3704,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 38) + Set speed (id: 176) to 1x speed (2.7k) (low light) (id: 38) 03:B0:01:26 02:B0:00 @@ -3655,7 +3716,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 39) + Set speed (id: 176) to 1x speed (2.7k) (50hz) (low light) (id: 39) 03:B0:01:27 02:B0:00 @@ -3667,7 +3728,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 40) + Set speed (id: 176) to 2x slo-mo (2.7k) (id: 40) 03:B0:01:28 02:B0:00 @@ -3679,7 +3740,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 41) + Set speed (id: 176) to 2x slo-mo (2.7k) (50hz) (id: 41) 03:B0:01:29 02:B0:00 @@ -3691,7 +3752,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 42) + Set speed (id: 176) to 2x slo-mo (long. batt.) (vertical) (id: 42) 03:B0:01:2A 02:B0:00 @@ -3703,7 +3764,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 2x slo-mo (id: 43) + Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (vertical) (id: 43) 03:B0:01:2B 02:B0:00 @@ -3715,7 +3776,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 44) + Set speed (id: 176) to 1x speed (long. batt.) (low light) (vertical) (id: 44) 03:B0:01:2C 02:B0:00 @@ -3727,7 +3788,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 45) + Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (vertical) (id: 45) 03:B0:01:2D 02:B0:00 @@ -3739,7 +3800,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 46) + Set speed (id: 176) to 1x speed (4k) (full frame) (low light) (id: 46) 03:B0:01:2E 02:B0:00 @@ -3751,7 +3812,7 @@

    Settings Quick Reference

    176 Speed - Set speed (id: 176) to 1x speed / low light (id: 47) + Set speed (id: 176) to 1x speed (4k) (50hz) (full frame) (low light) (id: 47) 03:B0:01:2F 02:B0:00 @@ -3760,6 +3821,462 @@

    Settings Quick Reference

    + + 176 + Speed + Set speed (id: 176) to 8x ultra slo-mo (v2) (id: 100) + 03:B0:01:64 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 4x super slo-mo (v2) (id: 101) + 03:B0:01:65 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (v2) (id: 102) + 03:B0:01:66 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (low light) (v2) (id: 103) + 03:B0:01:67 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 8x ultra slo-mo (50hz) (v2) (id: 104) + 03:B0:01:68 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 4x super slo-mo (50hz) (v2) (id: 105) + 03:B0:01:69 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (50hz) (v2) (id: 106) + 03:B0:01:6A + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (50hz) (low light) (v2) (id: 107) + 03:B0:01:6B + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 8x ultra slo-mo (long. batt.) (v2) (id: 108) + 03:B0:01:6C + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 4x super slo-mo (long. batt.) (v2) (id: 109) + 03:B0:01:6D + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (long. batt.) (v2) (id: 110) + 03:B0:01:6E + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (long. batt.) (low light) (v2) (id: 111) + 03:B0:01:6F + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 8x ultra slo-mo (50hz) (long. batt.) (v2) (id: 112) + 03:B0:01:70 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 4x super slo-mo (50hz) (long. batt.) (v2) (id: 113) + 03:B0:01:71 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (v2) (id: 114) + 03:B0:01:72 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (v2) (id: 115) + 03:B0:01:73 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (4k) (v2) (id: 116) + 03:B0:01:74 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (4k) (50hz) (v2) (id: 117) + 03:B0:01:75 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (low light) (v2) (vertical) (id: 118) + 03:B0:01:76 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (50hz) (low light) (v2) (vertical) (id: 119) + 03:B0:01:77 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (v2) (vertical) (id: 120) + 03:B0:01:78 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (50hz) (v2) (vertical) (id: 121) + 03:B0:01:79 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (full frame) (low light) (v2) (id: 122) + 03:B0:01:7A + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (50hz) (full frame) (low light) (v2) (id: 123) + 03:B0:01:7B + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (full frame) (v2) (id: 124) + 03:B0:01:7C + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (50hz) (full frame) (v2) (id: 125) + 03:B0:01:7D + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (4k) (low light) (v2) (id: 126) + 03:B0:01:7E + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (4k) (50hz) (low light) (v2) (id: 127) + 03:B0:01:7F + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (2.7k) (low light) (v2) (id: 128) + 03:B0:01:80 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (2.7k) (50hz) (low light) (v2) (id: 129) + 03:B0:01:81 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (2.7k) (v2) (id: 130) + 03:B0:01:82 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (2.7k) (50hz) (v2) (id: 131) + 03:B0:01:83 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (long. batt.) (v2) (vertical) (id: 132) + 03:B0:01:84 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 2x slo-mo (50hz) (long. batt.) (v2) (vertical) (id: 133) + 03:B0:01:85 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (long. batt.) (low light) (v2) (vertical) (id: 134) + 03:B0:01:86 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (50hz) (long. batt.) (low light) (v2) (vertical) (id: 135) + 03:B0:01:87 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (4k) (full frame) (low light) (v2) (id: 136) + 03:B0:01:88 + 02:B0:00 + >= v02.00.00 + + + + + + + 176 + Speed + Set speed (id: 176) to 1x speed (4k) (50hz) (full frame) (low light) (v2) (id: 137) + 03:B0:01:89 + 02:B0:00 + >= v02.00.00 + + + + + 177 Enable Night Photo @@ -4403,10 +4920,13 @@

    Capability Documents

    Release - + capabilities.xlsx
    capabilities.json - HERO12 Black + HERO12 Black + v02.00.00 + + v01.30.00 @@ -5875,14 +6395,14 @@

    Protobuf IDs

    Command 0xF1 - 0x65, 0x66, 0x67, 0x69, 0x6B, 0x79, 0xE5, 0xE6, 0xE7, 0xE9, 0xEB, 0xF9 + 0x64, 0x65, 0x66, 0x67, 0x69, 0x6B, 0x79, 0xE4, 0xE5, 0xE6, 0xE7, 0xE9, 0xEB, 0xF9 GP-0072 GP-0073 Query 0xF5 - 0x6E, 0x6F, 0x72, 0x74, 0xEE, 0xEF, 0xF2, 0xF3, 0xF4, 0xF5 + 0x6D, 0x6E, 0x6F, 0x72, 0x74, 0xED, 0xEE, 0xEF, 0xF2, 0xF3, 0xF4, 0xF5 GP-0076 GP-0077 @@ -6012,7 +6532,19 @@

    Protobuf Commands

    - 0xF1 + 0xF1 + 0x64 + 0xE4 + Request preset update custom + RequestCustomPresetUpdate + ResponseGeneric + >= v02.00.00 + + + + + + 0x65 0xE5 Request cohn setting @@ -6085,7 +6617,19 @@

    Protobuf Commands

    - 0xF5 + 0xF5 + 0x6D + 0xED + Request get last media + RequestGetLastCapturedMedia + ResponseLastCapturedMedia + >= v02.00.00 + + + + + + 0x6E 0xEE Request get cohn cert @@ -6283,8 +6827,33 @@

    Presets

    Important Note: The Preset ID is required to load a Preset via the Presets: Load command.

    +

    Custom Preset Update

    +

    +The Custom Preset Update feature allows the user to update the title and icon of custom presets. +The feature includes the following capabilities: +

    + + + +

    +Expectations: +

    + + +

    -For details on which cameras are supported and how to get Preset Status, see Protobuf Commands. +For details on which per-camera command support, see Protobuf Commands.

    Global Behaviors

    diff --git a/contribution.html b/contribution.html index af6bb03d..cb72e0ef 100644 --- a/contribution.html +++ b/contribution.html @@ -138,7 +138,7 @@ Tutorials
  • - Demos + Demos
  • FAQ @@ -520,10 +520,10 @@

    Quiz

    %} -
    +
    -
    What is the question?
    -
    +
    What is the question?
    +

    @@ -536,10 +536,10 @@

    Quiz

    - - @@ -555,10 +555,10 @@

    Quiz

    %}
    -
    +
    -
    True or False?
    -
    +
    True or False?
    +

    @@ -568,10 +568,10 @@

    Quiz

    - - @@ -594,7 +594,7 @@

    Tabs

    -
      +
      • tab1 @@ -609,7 +609,7 @@

        Tabs

      -
        +
        • This is the content of the first tab.

          diff --git a/faq.html b/faq.html index e6757c0c..60df680a 100644 --- a/faq.html +++ b/faq.html @@ -138,7 +138,7 @@ Tutorials
        • - Demos + Demos
        • FAQ @@ -612,7 +612,7 @@

          Streaming

          that as a result of using off-the-shelf libraries like ffmpeg which adds its own buffering. For preview and framing use cases, we don’t recommend using the live streaming RTMP protocol because it adds unnecessary steps in the pipeline, and puts the camera in the streaming preset, which offers little other control. -A low latency streaming demo is available in the demos.

          +A low latency streaming demo is available in the demos.

    diff --git a/feed.xml b/feed.xml index aabac13d..41cc93b1 100644 --- a/feed.xml +++ b/feed.xml @@ -1 +1 @@ -Jekyll2023-12-11T15:38:12-08:00https://gopro.github.io/OpenGoPro/feed.xmlOpen GoProOpen Source GoPro InterfaceGoPro \ No newline at end of file +Jekyll2023-12-21T16:22:03-08:00https://gopro.github.io/OpenGoPro/feed.xmlOpen GoProOpen Source GoPro InterfaceGoPro \ No newline at end of file diff --git a/http-legacy.html b/http-legacy.html new file mode 100644 index 00000000..2fb98061 --- /dev/null +++ b/http-legacy.html @@ -0,0 +1,6856 @@ + + + + + + +HTTP Specification v2.0 : Open GoPro + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + + +
    + + + + + + + + + + + + + +
    + + + + + +
    + + + + + +
    + +
    +

    HTTP Specification v2.0 +

    + + +

    + + + + + + + + + + + + 62 minute read + + + +

    + + +
    + + +
    + + + +

    Overview

    + +

    +The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera. +

    + +

    What can you do with the GoPro API?

    + +

    +The GoPro API allows you to control and query the camera: +

    +
      +
    • Capture photo/video media
    • +
    • Get media list
    • +
    • Change settings
    • +
    • Get and set the date/time
    • +
    • Get camera status
    • +
    • Get media metadata (file size, width, height, duration, tags, etc)
    • +
    • and more!
    • +
    + + +

    Supported Cameras

    + +

    +Below is a table of cameras that support GoPro's public HTTP API: +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Model IDModel CodeMarketing NameMinimal Firmware Version
    62H23.01HERO12 Blackv01.10.00
    60H22.03HERO11 Black Miniv01.10.00
    58H22.01HERO11 Blackv01.10.00
    57H21.01HERO10 Blackv01.10.00
    55HD9.01HERO9 Blackv01.70.00
    + +

    The Basics

    + +

    Connection

    +

    WiFi

    +

    +Connection to the camera via WiFi requires that the camera's WiFi Access Point be enabled. +This can be done by connecting to the camera via +Bluetooth Low Energy (BLE) +and sending a command to enable AP Mode. +

    + +

    USB

    +

    +OpenGoPro systems that utilize USB must support the Network Control Model (NCM) protocol. +Connecting via USB requires the following steps: +

    +
      +
    1. Physically connect the camera's USB-C port to your system
    2. +
    3. Send HTTP command to enable wired USB control
    4. +
    + + +

    Authentication

    + +

    WiFi

    + +

    +Once the WiFi Access Point has been turned on, authentication with the camera simply requires connecting with the +correct SSID and password. This information can be obtained in two ways: + +

    +
      +
    • Put the camera into pairing mode and tap the info button in the top-right corner of the screen.
    • +
    • Read the SSID/password directly via Bluetooth Low Energy. See Services and Characteristics section in BLE Specification for details.
    • +
    + + +

    USB

    +

    +No authentication is necessary. +

    + +

    Socket Address

    + +

    WiFi

    +

    +The socket address for WiFi connections is 10.5.5.9:8080. +

    + +

    USB

    +

    +The socket address for USB connections is 172.2X.1YZ.51:8080 where: + +

    +
      +
    • X is the 100's digit from the camera serial number
    • +
    • Y is the 10's digit from the camera serial number
    • +
    • Z is the 1's digit from the camera serial number
    • +
    + + +

    +The camera's serial number can be obtained in any of the following ways: +

    +
      +
    • Reading the sticker inside the camera's battery enclosure
    • +
    • Camera UI: Preferences >> About >> Camera Info
    • +
    • Bluetooth Low Energy: By reading directly from Hardware Info +
    • +
    + + +

    +For example, if the camera's serial number is C0000123456789, the IP address for USB connections would be 172.27.189.51. +

    + +

    +Alternatively, the IP address can be discovered via mDNS as the camera registers the _gopro-web service. +

    + +

    Request and Response Formats

    +

    +Most commands are sent via HTTP/GET and require no special headers. +Responses come in two parts: The standard HTTP return codes and JSON containing any additional information. +

    + +

    +The typical use case is that the camera accepts a valid command, returns HTTP/200 (OK) and empty JSON +(i.e. { }) and begins asynchronously working on the command. +If an error occurs, the camera will return a standard HTTP error code and JSON with helpful error/debug information. +

    + +

    +Depending on the command sent, the camera can return JSON, binary, or Protobuf data. Some examples are listed below: +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CommandReturn Type
    Get Camera StateJSON
    Get Media InfoJSON
    Get Media GPMF +Binary
    Get Media ListJSON
    Get Media Screennail (JPEG)Binary
    Get Media Thumbnail (JPEG)Binary
    Get PresetsJSON
    + +

    Sending Commands

    + +

    +Depending on the camera's state, it may not be ready to accept specific commands. +This ready state is dependent on the System Busy and the Encoding Active status flags. For example: + +

    +
      +
    • System Busy flag is set while loading presets, changing settings, formatting sdcard, ...
    • +
    • Encoding Active flag is set while capturing photo/video media
    • +
    + + +

    +If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the +System Busy and Encode Active flags to be unset before sending messages other than camera status queries. +For details regarding camera state, see Status Codes. +

    + +

    Keep Alive

    +

    +In order to maximize battery life, GoPro cameras automatically go to sleep after some time. +This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support +and a Keep Alive message that the user can regularly send to the camera. +The camera will automatically go to sleep if both timers reach zero. +

    + +

    +The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or +programmatically (un)sets the shutter, sets a setting, or loads a Preset. +

    + +

    +The Keep Alive timer is reset when the user sends a keep alive message. +

    + +

    +The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages +every 3.0 seconds after a connection is established. +

    + +

    Command

    + + + + + + + + + + + +
    HTTP/GETDescription
    /gopro/camera/keep_aliveSend keep-alive
    + +

    Commands

    +

    Using the Open GoPro API, a client can perform various command, control, and query operations!

    + +

    Commands Quick Reference

    +

    +Below is a table of commands that can be sent to the camera and how to send them.
    +* Indicates that item is experimental
    + Indicates support for all Open GoPro firmware versions.
    + Indicates a lack of support for all Open GoPro firmware versions.
    +>= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CommandDescriptionHTTP MethodEndpointHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    AnalyticsSet third party clientGET/gopro/camera/analytics/set_client_info>= v01.30.00>= v01.70.00
    COHN: Get certGet cohn certGET/GoProRootCA.crt
    COHN: Get statusGet cohn statusPOST/gopro/cohn/status
    COHN: Get statusGet cohn statusPOST/gopro/cohn/status
    Camera: Get StateGet camera state (status + settings)GET/gopro/camera/state
    Digital ZoomDigital zoom 50%GET/gopro/camera/digital_zoom?percent=50
    Get Date/TimeGet date/timeGET/gopro/camera/get_date_time>= v01.30.00>= v01.70.00
    Get Hardware InfoGet camera hardware infoGET/gopro/camera/info
    Keep-aliveSend keep-aliveGET/gopro/camera/keep_alive
    Media: GPMFGet GPMF data (JPG)GET/gopro/media/gpmf?path=100GOPRO/XXX.JPG
    Media: GPMFGet GPMF data (MP4)GET/gopro/media/gpmf?path=100GOPRO/XXX.MP4
    Media: HiLight (Add)Add hilight to 100GOPRO/xxx.JPGGET/gopro/media/hilight/file?path=100GOPRO/XXX.JPG>= v01.30.00>= v01.70.00
    Media: HiLight (Add)Add hilight to 100GOPRO/xxx.MP4 at offset 2500 msGET/gopro/media/hilight/file?path=100GOPRO/XXX.MP4&ms=2500>= v01.30.00>= v01.70.00
    Media: HiLight (Remove)Remove hilight from 100GOPRO/xxx.JPGGET/gopro/media/hilight/remove?path=100GOPRO/XXX.JPG>= v01.30.00>= v01.70.00
    Media: HiLight (Remove)Remove hilight from 100GOPRO/xxx.MP4 at offset 2500msGET/gopro/media/hilight/remove?path=100GOPRO/XXX.MP4&ms=2500>= v01.30.00>= v01.70.00
    Media: HiLight MomentHilight moment during encodingGET/gopro/media/hilight/moment>= v01.30.00
    Media: InfoGet media info (JPG)GET/gopro/media/info?path=100GOPRO/XXX.JPG
    Media: InfoGet media info (MP4)GET/gopro/media/info?path=100GOPRO/XXX.MP4
    Media: ListGet media listGET/gopro/media/list
    Media: ScreennailGet screennail for “100GOPRO/xxx.JPG”GET/gopro/media/screennail?path=100GOPRO/XXX.JPG
    Media: ScreennailGet screennail for “100GOPRO/xxx.MP4”GET/gopro/media/screennail?path=100GOPRO/XXX.MP4
    Media: TelemetryGet telemetry track data (JPG)GET/gopro/media/telemetry?path=100GOPRO/XXX.JPG
    Media: TelemetryGet telemetry track data (MP4)GET/gopro/media/telemetry?path=100GOPRO/XXX.MP4
    Media: ThumbnailGet thumbnail for “100GOPRO/xxx.JPG”GET/gopro/media/thumbnail?path=100GOPRO/XXX.JPG
    Media: ThumbnailGet thumbnail for “100GOPRO/xxx.MP4”GET/gopro/media/thumbnail?path=100GOPRO/XXX.MP4
    Media: Turbo TransferTurbo transfer: offGET/gopro/media/turbo_transfer?p=0
    Media: Turbo TransferTurbo transfer: onGET/gopro/media/turbo_transfer?p=1
    OTA UpdateSoft update: upload 12345 bytes starting at offset 67890POST/gp/gpSoftUpdate (plus data)
    OTA UpdateSoft update: mark upload completePOST/gp/gpSoftUpdate (plus data)
    Open GoProGet versionGET/gopro/version
    Presets: Get StatusGet preset statusGET/gopro/camera/presets/get
    Presets: LoadExample preset id: 0x1234ABCDGET/gopro/camera/presets/load?id=305441741
    Presets: Load GroupVideoGET/gopro/camera/presets/set_group?id=1000
    Presets: Load GroupPhotoGET/gopro/camera/presets/set_group?id=1001
    Presets: Load GroupTimelapseGET/gopro/camera/presets/set_group?id=1002
    Set Camera Control StatusSet camera control status to idleGET/gopro/camera/control/set_ui_controller?p=0>= v01.20.00
    Set Camera Control StatusSet camera control status to external_controlGET/gopro/camera/control/set_ui_controller?p=2>= v01.20.00
    Set Date/TimeSet date/time to 2023-01-31 03:04:05GET/gopro/camera/set_date_time?date=2023_1_31&time=3_4_5>= v01.30.00>= v01.70.00
    Set Local Date/TimeSet local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on)GET/gopro/camera/set_date_time?date=2023_1_31&time=3_4_5&tzone=-120&dst=1
    Set shutterShutter: onGET/gopro/camera/shutter/start
    Set shutterShutter: offGET/gopro/camera/shutter/stop
    Simple OTA UpdateSimple ota update with file: update.zipPOST/gp/gpUpdate (plus data)
    Soft UpdateSoft update: show canceled/failed ui on the cameraGET/gp/gpSoftUpdate?request=canceled
    Soft UpdateSoft update: delete cached update filesGET/gp/gpSoftUpdate?request=delete
    Soft UpdateSoft update: get current update stateGET/gp/gpSoftUpdate?request=progress
    Soft UpdateSoft update: display update ui on cameraGET/gp/gpSoftUpdate?request=showui
    Soft UpdateSoft update: initiate firmware updateGET/gp/gpSoftUpdate?request=start
    Stream: StartStart preview streamGET/gopro/camera/stream/start
    Stream: StopStop preview streamGET/gopro/camera/stream/stop
    Webcam: ExitExit webcam modeGET/gopro/webcam/exit
    Webcam: PreviewStart preview streamGET/gopro/webcam/preview
    Webcam: StartStart webcamGET/gopro/webcam/start>= v01.40.00
    Webcam: StartStart webcam (port: 12345)GET/gopro/webcam/start?port=12345>= v02.01.00
    Webcam: StartStart webcam (port: 12345, protocol: rtsp)GET/gopro/webcam/start?port=12345&protocol=RTSP
    Webcam: StartStart webcam (port: 12345, protocol: ts)GET/gopro/webcam/start?port=12345&protocol=TS
    Webcam: StartStart webcam (res: resolution_1080, fov: wide)GET/gopro/webcam/start?res=12&fov=0
    Webcam: StatusGet webcam statusGET/gopro/webcam/status
    Webcam: StopStop webcamGET/gopro/webcam/stop
    Webcam: VersionGet webcam api versionGET/gopro/webcam/version
    Wired USB ControlDisable wired usb controlGET/gopro/camera/control/wired_usb?p=0>= v01.30.00
    Wired USB ControlEnable wired usb controlGET/gopro/camera/control/wired_usb?p=1>= v01.30.00
    + +

    Settings

    +

    +GoPro cameras have hundreds of setting options to choose from, all of which can be set using a single endpoint. +The endpoint is configured with a setting id and an option value. +Note that setting option values are not globally unique. +While most option values are enumerated values, some are complex bitmasked values. +

    + +

    Settings Quick Reference

    +

    +Below is a table of setting options detailing how to set every option supported by Open GoPro cameras.
    +* Indicates that item is experimental
    + Indicates support for all Open GoPro firmware versions.
    + Indicates a lack of support for all Open GoPro firmware versions.
    +>= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Setting IDSettingOptionHTTP MethodEndpointHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    2ResolutionSet video resolution (id: 2) to 4k (id: 1)GET/gopro/camera/setting?setting=2&option=1
    2ResolutionSet video resolution (id: 2) to 2.7k (id: 4)GET/gopro/camera/setting?setting=2&option=4
    2ResolutionSet video resolution (id: 2) to 2.7k 4:3 (id: 6)GET/gopro/camera/setting?setting=2&option=6
    2ResolutionSet video resolution (id: 2) to 1440 (id: 7)GET/gopro/camera/setting?setting=2&option=7
    2ResolutionSet video resolution (id: 2) to 1080 (id: 9)GET/gopro/camera/setting?setting=2&option=9
    2ResolutionSet video resolution (id: 2) to 4k 4:3 (id: 18)GET/gopro/camera/setting?setting=2&option=18
    2ResolutionSet video resolution (id: 2) to 5k (id: 24)GET/gopro/camera/setting?setting=2&option=24
    2ResolutionSet video resolution (id: 2) to 5k 4:3 (id: 25)GET/gopro/camera/setting?setting=2&option=25
    2ResolutionSet video resolution (id: 2) to 5.3k 8:7 (id: 26)GET/gopro/camera/setting?setting=2&option=26
    2ResolutionSet video resolution (id: 2) to 5.3k 4:3 (id: 27)GET/gopro/camera/setting?setting=2&option=27
    2ResolutionSet video resolution (id: 2) to 4k 8:7 (id: 28)GET/gopro/camera/setting?setting=2&option=28
    2ResolutionSet video resolution (id: 2) to 4k 9:16 (id: 29)GET/gopro/camera/setting?setting=2&option=29
    2ResolutionSet video resolution (id: 2) to 1080 9:16 (id: 30)GET/gopro/camera/setting?setting=2&option=30
    2ResolutionSet video resolution (id: 2) to 5.3k (id: 100)GET/gopro/camera/setting?setting=2&option=100
    2ResolutionSet video resolution (id: 2) to 5.3k 16:9 (id: 101)GET/gopro/camera/setting?setting=2&option=101
    2ResolutionSet video resolution (id: 2) to 4k 16:9 (id: 102)GET/gopro/camera/setting?setting=2&option=102
    2ResolutionSet video resolution (id: 2) to 4k 4:3 (id: 103)GET/gopro/camera/setting?setting=2&option=103
    2ResolutionSet video resolution (id: 2) to 2.7k 16:9 (id: 104)GET/gopro/camera/setting?setting=2&option=104
    2ResolutionSet video resolution (id: 2) to 2.7k 4:3 (id: 105)GET/gopro/camera/setting?setting=2&option=105
    2ResolutionSet video resolution (id: 2) to 1080 16:9 (id: 106)GET/gopro/camera/setting?setting=2&option=106
    3Frames Per SecondSet video fps (id: 3) to 240 (id: 0)GET/gopro/camera/setting?setting=3&option=0
    3Frames Per SecondSet video fps (id: 3) to 120 (id: 1)GET/gopro/camera/setting?setting=3&option=1
    3Frames Per SecondSet video fps (id: 3) to 100 (id: 2)GET/gopro/camera/setting?setting=3&option=2
    3Frames Per SecondSet video fps (id: 3) to 60 (id: 5)GET/gopro/camera/setting?setting=3&option=5
    3Frames Per SecondSet video fps (id: 3) to 50 (id: 6)GET/gopro/camera/setting?setting=3&option=6
    3Frames Per SecondSet video fps (id: 3) to 30 (id: 8)GET/gopro/camera/setting?setting=3&option=8
    3Frames Per SecondSet video fps (id: 3) to 25 (id: 9)GET/gopro/camera/setting?setting=3&option=9
    3Frames Per SecondSet video fps (id: 3) to 24 (id: 10)GET/gopro/camera/setting?setting=3&option=10
    3Frames Per SecondSet video fps (id: 3) to 200 (id: 13)GET/gopro/camera/setting?setting=3&option=13
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to wide (id: 0)GET/gopro/camera/setting?setting=43&option=0
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to narrow (id: 2)GET/gopro/camera/setting?setting=43&option=2
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to superview (id: 3)GET/gopro/camera/setting?setting=43&option=3
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to linear (id: 4)GET/gopro/camera/setting?setting=43&option=4
    59Auto Power DownSet auto power down (id: 59) to never (id: 0)GET/gopro/camera/setting?setting=59&option=0>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 1 min (id: 1)GET/gopro/camera/setting?setting=59&option=1>= v02.10.00>= v02.01.00
    59Auto Power DownSet auto power down (id: 59) to 5 min (id: 4)GET/gopro/camera/setting?setting=59&option=4>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 15 min (id: 6)GET/gopro/camera/setting?setting=59&option=6
    59Auto Power DownSet auto power down (id: 59) to 30 min (id: 7)GET/gopro/camera/setting?setting=59&option=7
    59Auto Power DownSet auto power down (id: 59) to 8 seconds (id: 11)GET/gopro/camera/setting?setting=59&option=11>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 30 seconds (id: 12)GET/gopro/camera/setting?setting=59&option=12>= v02.10.00
    108Aspect RatioSet video aspect ratio (id: 108) to 4:3 (id: 0)GET/gopro/camera/setting?setting=108&option=0
    108Aspect RatioSet video aspect ratio (id: 108) to 16:9 (id: 1)GET/gopro/camera/setting?setting=108&option=1
    108Aspect RatioSet video aspect ratio (id: 108) to 8:7 (id: 3)GET/gopro/camera/setting?setting=108&option=3
    108Aspect RatioSet video aspect ratio (id: 108) to 9:16 (id: 4)GET/gopro/camera/setting?setting=108&option=4
    121Video Digital LensesSet video digital lenses (id: 121) to wide (id: 0)GET/gopro/camera/setting?setting=121&option=0
    121Video Digital LensesSet video digital lenses (id: 121) to narrow (id: 2)GET/gopro/camera/setting?setting=121&option=2
    121Video Digital LensesSet video digital lenses (id: 121) to superview (id: 3)GET/gopro/camera/setting?setting=121&option=3
    121Video Digital LensesSet video digital lenses (id: 121) to linear (id: 4)GET/gopro/camera/setting?setting=121&option=4
    121Video Digital LensesSet video digital lenses (id: 121) to max superview (id: 7)GET/gopro/camera/setting?setting=121&option=7>= v02.00.00
    121Video Digital LensesSet video digital lenses (id: 121) to linear + horizon leveling (id: 8)GET/gopro/camera/setting?setting=121&option=8
    121Video Digital LensesSet video digital lenses (id: 121) to hyperview (id: 9)GET/gopro/camera/setting?setting=121&option=9
    121Video Digital LensesSet video digital lenses (id: 121) to linear + horizon lock (id: 10)GET/gopro/camera/setting?setting=121&option=10
    121Video Digital LensesSet video digital lenses (id: 121) to max hyperview (id: 11)GET/gopro/camera/setting?setting=121&option=11
    122Photo Digital LensesSet photo digital lenses (id: 122) to narrow (id: 19)GET/gopro/camera/setting?setting=122&option=19
    122Photo Digital LensesSet photo digital lenses (id: 122) to max superview (id: 100)GET/gopro/camera/setting?setting=122&option=100
    122Photo Digital LensesSet photo digital lenses (id: 122) to wide (id: 101)GET/gopro/camera/setting?setting=122&option=101
    122Photo Digital LensesSet photo digital lenses (id: 122) to linear (id: 102)GET/gopro/camera/setting?setting=122&option=102
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to narrow (id: 19)GET/gopro/camera/setting?setting=123&option=19
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to max superview (id: 100)GET/gopro/camera/setting?setting=123&option=100
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to wide (id: 101)GET/gopro/camera/setting?setting=123&option=101
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to linear (id: 102)GET/gopro/camera/setting?setting=123&option=102
    128Media FormatSet media format (id: 128) to time lapse video (id: 13)GET/gopro/camera/setting?setting=128&option=13
    128Media FormatSet media format (id: 128) to time lapse photo (id: 20)GET/gopro/camera/setting?setting=128&option=20
    128Media FormatSet media format (id: 128) to night lapse photo (id: 21)GET/gopro/camera/setting?setting=128&option=21
    128Media FormatSet media format (id: 128) to night lapse video (id: 26)GET/gopro/camera/setting?setting=128&option=26
    134Anti-FlickerSet setup anti flicker (id: 134) to 60hz (id: 2)GET/gopro/camera/setting?setting=134&option=2
    134Anti-FlickerSet setup anti flicker (id: 134) to 50hz (id: 3)GET/gopro/camera/setting?setting=134&option=3
    135HypersmoothSet video hypersmooth (id: 135) to off (id: 0)GET/gopro/camera/setting?setting=135&option=0
    135HypersmoothSet video hypersmooth (id: 135) to low (id: 1)GET/gopro/camera/setting?setting=135&option=1
    135HypersmoothSet video hypersmooth (id: 135) to high (id: 2)GET/gopro/camera/setting?setting=135&option=2
    135HypersmoothSet video hypersmooth (id: 135) to boost (id: 3)GET/gopro/camera/setting?setting=135&option=3
    135HypersmoothSet video hypersmooth (id: 135) to auto boost (id: 4)GET/gopro/camera/setting?setting=135&option=4
    135HypersmoothSet video hypersmooth (id: 135) to standard (id: 100)GET/gopro/camera/setting?setting=135&option=100
    150Horizon LevelingSet video horizon levelling (id: 150) to off (id: 0)GET/gopro/camera/setting?setting=150&option=0>= v02.00.00
    150Horizon LevelingSet video horizon levelling (id: 150) to on (id: 1)GET/gopro/camera/setting?setting=150&option=1>= v02.00.00
    150Horizon LevelingSet video horizon levelling (id: 150) to locked (id: 2)GET/gopro/camera/setting?setting=150&option=2
    151Horizon LevelingSet photo horizon levelling (id: 151) to off (id: 0)GET/gopro/camera/setting?setting=151&option=0
    151Horizon LevelingSet photo horizon levelling (id: 151) to locked (id: 2)GET/gopro/camera/setting?setting=151&option=2
    162Max LensSet max lens (id: 162) to off (id: 0)GET/gopro/camera/setting?setting=162&option=0>= v01.20.00
    162Max LensSet max lens (id: 162) to on (id: 1)GET/gopro/camera/setting?setting=162&option=1>= v01.20.00
    167Hindsight*Set hindsight (id: 167) to 15 seconds (id: 2)GET/gopro/camera/setting?setting=167&option=2
    167Hindsight*Set hindsight (id: 167) to 30 seconds (id: 3)GET/gopro/camera/setting?setting=167&option=3
    167Hindsight*Set hindsight (id: 167) to off (id: 4)GET/gopro/camera/setting?setting=167&option=4
    171IntervalSet photo single interval (id: 171) to off (id: 0)GET/gopro/camera/setting?setting=171&option=0
    171IntervalSet photo single interval (id: 171) to 0.5s (id: 2)GET/gopro/camera/setting?setting=171&option=2
    171IntervalSet photo single interval (id: 171) to 1s (id: 3)GET/gopro/camera/setting?setting=171&option=3
    171IntervalSet photo single interval (id: 171) to 2s (id: 4)GET/gopro/camera/setting?setting=171&option=4
    171IntervalSet photo single interval (id: 171) to 5s (id: 5)GET/gopro/camera/setting?setting=171&option=5
    171IntervalSet photo single interval (id: 171) to 10s (id: 6)GET/gopro/camera/setting?setting=171&option=6
    171IntervalSet photo single interval (id: 171) to 30s (id: 7)GET/gopro/camera/setting?setting=171&option=7
    171IntervalSet photo single interval (id: 171) to 60s (id: 8)GET/gopro/camera/setting?setting=171&option=8
    171IntervalSet photo single interval (id: 171) to 120s (id: 9)GET/gopro/camera/setting?setting=171&option=9
    171IntervalSet photo single interval (id: 171) to 3s (id: 10)GET/gopro/camera/setting?setting=171&option=10
    172DurationSet photo interval duration (id: 172) to off (id: 0)GET/gopro/camera/setting?setting=172&option=0
    172DurationSet photo interval duration (id: 172) to 15 seconds (id: 1)GET/gopro/camera/setting?setting=172&option=1
    172DurationSet photo interval duration (id: 172) to 30 seconds (id: 2)GET/gopro/camera/setting?setting=172&option=2
    172DurationSet photo interval duration (id: 172) to 1 minute (id: 3)GET/gopro/camera/setting?setting=172&option=3
    172DurationSet photo interval duration (id: 172) to 5 minutes (id: 4)GET/gopro/camera/setting?setting=172&option=4
    172DurationSet photo interval duration (id: 172) to 15 minutes (id: 5)GET/gopro/camera/setting?setting=172&option=5
    172DurationSet photo interval duration (id: 172) to 30 minutes (id: 6)GET/gopro/camera/setting?setting=172&option=6
    172DurationSet photo interval duration (id: 172) to 1 hour (id: 7)GET/gopro/camera/setting?setting=172&option=7
    172DurationSet photo interval duration (id: 172) to 2 hours (id: 8)GET/gopro/camera/setting?setting=172&option=8
    172DurationSet photo interval duration (id: 172) to 3 hours (id: 9)GET/gopro/camera/setting?setting=172&option=9
    173Video Performance ModeSet video performance mode (id: 173) to maximum video performance (id: 0)GET/gopro/camera/setting?setting=173&option=0>= v01.16.00
    173Video Performance ModeSet video performance mode (id: 173) to extended battery (id: 1)GET/gopro/camera/setting?setting=173&option=1>= v01.16.00
    173Video Performance ModeSet video performance mode (id: 173) to tripod / stationary video (id: 2)GET/gopro/camera/setting?setting=173&option=2>= v01.16.00
    175ControlsSet controls (id: 175) to easy (id: 0)GET/gopro/camera/setting?setting=175&option=0
    175ControlsSet controls (id: 175) to pro (id: 1)GET/gopro/camera/setting?setting=175&option=1
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (id: 0)GET/gopro/camera/setting?setting=176&option=0
    176SpeedSet speed (id: 176) to 4x super slo-mo (id: 1)GET/gopro/camera/setting?setting=176&option=1
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 2)GET/gopro/camera/setting?setting=176&option=2
    176SpeedSet speed (id: 176) to 1x (low light) (id: 3)GET/gopro/camera/setting?setting=176&option=3
    176SpeedSet speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4)GET/gopro/camera/setting?setting=176&option=4
    176SpeedSet speed (id: 176) to 2x slo-mo (ext. batt) (id: 5)GET/gopro/camera/setting?setting=176&option=5
    176SpeedSet speed (id: 176) to 1x (ext. batt, low light) (id: 6)GET/gopro/camera/setting?setting=176&option=6
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7)GET/gopro/camera/setting?setting=176&option=7
    176SpeedSet speed (id: 176) to 4x super slo-mo (50hz) (id: 8)GET/gopro/camera/setting?setting=176&option=8
    176SpeedSet speed (id: 176) to 2x slo-mo (50hz) (id: 9)GET/gopro/camera/setting?setting=176&option=9
    176SpeedSet speed (id: 176) to 1x (low light, 50hz) (id: 10)GET/gopro/camera/setting?setting=176&option=10
    176SpeedSet speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11)GET/gopro/camera/setting?setting=176&option=11
    176SpeedSet speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12)GET/gopro/camera/setting?setting=176&option=12
    176SpeedSet speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13)GET/gopro/camera/setting?setting=176&option=13
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14)GET/gopro/camera/setting?setting=176&option=14>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15)GET/gopro/camera/setting?setting=176&option=15>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16)GET/gopro/camera/setting?setting=176&option=16>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (long. batt) (id: 17)GET/gopro/camera/setting?setting=176&option=17>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (long. batt) (id: 18)GET/gopro/camera/setting?setting=176&option=18>= v02.01.00
    176SpeedSet speed (id: 176) to 1x (long. batt, low light) (id: 19)GET/gopro/camera/setting?setting=176&option=19>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20)GET/gopro/camera/setting?setting=176&option=20>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21)GET/gopro/camera/setting?setting=176&option=21>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22)GET/gopro/camera/setting?setting=176&option=22>= v02.01.00
    176SpeedSet speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23)GET/gopro/camera/setting?setting=176&option=23>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (4k) (id: 24)GET/gopro/camera/setting?setting=176&option=24>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (2.7k) (id: 25)GET/gopro/camera/setting?setting=176&option=25>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26)GET/gopro/camera/setting?setting=176&option=26>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27)GET/gopro/camera/setting?setting=176&option=27>= v02.01.00
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 28)GET/gopro/camera/setting?setting=176&option=28
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 29)GET/gopro/camera/setting?setting=176&option=29
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 30)GET/gopro/camera/setting?setting=176&option=30
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 31)GET/gopro/camera/setting?setting=176&option=31
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 32)GET/gopro/camera/setting?setting=176&option=32
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 33)GET/gopro/camera/setting?setting=176&option=33
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 34)GET/gopro/camera/setting?setting=176&option=34
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 35)GET/gopro/camera/setting?setting=176&option=35
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 36)GET/gopro/camera/setting?setting=176&option=36
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 37)GET/gopro/camera/setting?setting=176&option=37
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 38)GET/gopro/camera/setting?setting=176&option=38
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 39)GET/gopro/camera/setting?setting=176&option=39
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 40)GET/gopro/camera/setting?setting=176&option=40
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 41)GET/gopro/camera/setting?setting=176&option=41
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 42)GET/gopro/camera/setting?setting=176&option=42
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 43)GET/gopro/camera/setting?setting=176&option=43
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 44)GET/gopro/camera/setting?setting=176&option=44
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 45)GET/gopro/camera/setting?setting=176&option=45
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 46)GET/gopro/camera/setting?setting=176&option=46
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 47)GET/gopro/camera/setting?setting=176&option=47
    177Enable Night PhotoSet enable night photo (id: 177) to off (id: 0)GET/gopro/camera/setting?setting=177&option=0
    177Enable Night PhotoSet enable night photo (id: 177) to on (id: 1)GET/gopro/camera/setting?setting=177&option=1
    178Wireless BandSet wireless band (id: 178) to 2.4ghz (id: 0)GET/gopro/camera/setting?setting=178&option=0
    178Wireless BandSet wireless band (id: 178) to 5ghz (id: 1)GET/gopro/camera/setting?setting=178&option=1
    179Trail LengthSet trail length (id: 179) to short (id: 1)GET/gopro/camera/setting?setting=179&option=1
    179Trail LengthSet trail length (id: 179) to long (id: 2)GET/gopro/camera/setting?setting=179&option=2
    179Trail LengthSet trail length (id: 179) to max (id: 3)GET/gopro/camera/setting?setting=179&option=3
    180Video ModeSet video mode (id: 180) to highest quality (id: 0)GET/gopro/camera/setting?setting=180&option=0
    180Video ModeSet video mode (id: 180) to extended battery (id: 1)GET/gopro/camera/setting?setting=180&option=1
    180Video ModeSet video mode (id: 180) to extended battery (green icon) (id: 101)GET/gopro/camera/setting?setting=180&option=101>= v02.01.00
    180Video ModeSet video mode (id: 180) to longest battery (green icon) (id: 102)GET/gopro/camera/setting?setting=180&option=102>= v02.01.00
    182Bit RateSet system video bit rate (id: 182) to standard (id: 0)GET/gopro/camera/setting?setting=182&option=0
    182Bit RateSet system video bit rate (id: 182) to high (id: 1)GET/gopro/camera/setting?setting=182&option=1
    183Bit DepthSet system video bit depth (id: 183) to 8-bit (id: 0)GET/gopro/camera/setting?setting=183&option=0
    183Bit DepthSet system video bit depth (id: 183) to 10-bit (id: 2)GET/gopro/camera/setting?setting=183&option=2
    184ProfilesSet video profile (id: 184) to standard (id: 0)GET/gopro/camera/setting?setting=184&option=0
    184ProfilesSet video profile (id: 184) to hdr (id: 1)GET/gopro/camera/setting?setting=184&option=1
    184ProfilesSet video profile (id: 184) to log (id: 2)GET/gopro/camera/setting?setting=184&option=2
    185Aspect RatioSet video easy aspect ratio (id: 185) to widescreen (id: 0)GET/gopro/camera/setting?setting=185&option=0
    185Aspect RatioSet video easy aspect ratio (id: 185) to mobile (id: 1)GET/gopro/camera/setting?setting=185&option=1
    185Aspect RatioSet video easy aspect ratio (id: 185) to universal (id: 2)GET/gopro/camera/setting?setting=185&option=2
    186Video ModeSet video easy presets (id: 186) to highest quality (id: 0)GET/gopro/camera/setting?setting=186&option=0
    186Video ModeSet video easy presets (id: 186) to standard quality (id: 1)GET/gopro/camera/setting?setting=186&option=1
    186Video ModeSet video easy presets (id: 186) to basic quality (id: 2)GET/gopro/camera/setting?setting=186&option=2
    187Lapse ModeSet multi shot easy presets (id: 187) to timewarp (id: 0)GET/gopro/camera/setting?setting=187&option=0
    187Lapse ModeSet multi shot easy presets (id: 187) to star trails (id: 1)GET/gopro/camera/setting?setting=187&option=1
    187Lapse ModeSet multi shot easy presets (id: 187) to light painting (id: 2)GET/gopro/camera/setting?setting=187&option=2
    187Lapse ModeSet multi shot easy presets (id: 187) to vehicle lights (id: 3)GET/gopro/camera/setting?setting=187&option=3
    187Lapse ModeSet multi shot easy presets (id: 187) to max timewarp (id: 4)GET/gopro/camera/setting?setting=187&option=4
    187Lapse ModeSet multi shot easy presets (id: 187) to max star trails (id: 5)GET/gopro/camera/setting?setting=187&option=5
    187Lapse ModeSet multi shot easy presets (id: 187) to max light painting (id: 6)GET/gopro/camera/setting?setting=187&option=6
    187Lapse ModeSet multi shot easy presets (id: 187) to max vehicle lights (id: 7)GET/gopro/camera/setting?setting=187&option=7
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to widescreen (id: 0)GET/gopro/camera/setting?setting=188&option=0
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to mobile (id: 1)GET/gopro/camera/setting?setting=188&option=1
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to universal (id: 2)GET/gopro/camera/setting?setting=188&option=2
    189Max Lens ModSet system addon lens active (id: 189) to none (id: 0)GET/gopro/camera/setting?setting=189&option=0
    189Max Lens ModSet system addon lens active (id: 189) to max lens 1.0 (id: 1)GET/gopro/camera/setting?setting=189&option=1
    189Max Lens ModSet system addon lens active (id: 189) to max lens 2.0 (id: 2)GET/gopro/camera/setting?setting=189&option=2
    190Max Lens Mod EnableSet system addon lens status (id: 190) to off (id: 0)GET/gopro/camera/setting?setting=190&option=0
    190Max Lens Mod EnableSet system addon lens status (id: 190) to on (id: 1)GET/gopro/camera/setting?setting=190&option=1
    191Photo ModeSet photo easy presets (id: 191) to super photo (id: 0)GET/gopro/camera/setting?setting=191&option=0
    191Photo ModeSet photo easy presets (id: 191) to night photo (id: 1)GET/gopro/camera/setting?setting=191&option=1
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0)GET/gopro/camera/setting?setting=192&option=0
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1)GET/gopro/camera/setting?setting=192&option=1
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3)GET/gopro/camera/setting?setting=192&option=3
    193FramingSet video easy framing (id: 193) to widescreen (id: 0)GET/gopro/camera/setting?setting=193&option=0
    193FramingSet video easy framing (id: 193) to vertical (id: 1)GET/gopro/camera/setting?setting=193&option=1
    193FramingSet video easy framing (id: 193) to full frame (id: 2)GET/gopro/camera/setting?setting=193&option=2
    + +

    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. +

    + +

    Note about Dependency Ordering and Blacklisting

    +

    +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. +

    + +

    Example

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraCommand 1Command 2Command 3Command 4Command 5Guaranteed Valid?
    HERO10 BlackRes: 1080Anti-Flicker: 60Hz (NTSC)FPS: 240FOV: WideHypersmooth: OFF
    HERO10 BlackFPS: 240Anti-Flicker: 60Hz (NTSC)Res: 1080FOV: WideHypersmooth: 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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    DocumentsProductRelease
    +capabilities.xlsx
    capabilities.json +
    HERO12 Blackv01.30.00
    v01.20.00
    v01.10.00
    HERO11 Black Miniv02.30.00
    v02.20.00
    v02.10.00
    v02.00.00
    v01.10.00
    HERO11 Blackv02.12.00
    v02.10.00
    v02.01.00
    v01.20.00
    v01.12.00
    v01.10.00
    HERO10 Blackv01.50.00
    v01.46.00
    v01.42.00
    v01.40.00
    v01.30.00
    v01.20.00
    v01.16.00
    v01.10.00
    HERO9 Blackv01.72.00
    v01.70.00
    + +

    Spreadsheet Format

    +

    +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 Format

    +

    +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. +

    + +

    +Below is a simplified example of the capabilities JSON file; a formal schema is also available here: +capabilities_schema.json +

    + +
    {
    +    "(PRODUCT_NAME)": {
    +        "(RELEASE_VERSION)": {
    +            "states": [
    +                [
    +                    {"setting_name": "(str)", "setting_id": (int), "option_name": "(str)", "option_id": (int)},
    +                    ...
    +                ],
    +                ...
    +            ],
    +        },
    +        ...
    +    },
    +    ...
    +}
    +
    + +

    Media

    +

    +The camera provides an endpoint to query basic details about media captured on the sdcard. +

    + +

    Chapters

    +

    +All GoPro cameras break longer videos into chapters. +GoPro cameras currently limit file sizes on sdcards to 4GB for both FAT32 and exFAT file systems. +This limitation is most commonly seen when recording longer (10+ minute) videos. +In practice, the camera will split video media into chapters named Gqccmmmm.MP4 (and ones for THM/LRV) such that: +

    + +
      +
    • q: Quality Level (X: Extreme, H: High, M: Medium, L: Low)
    • +
    • cc: Chapter Number (01-99)
    • +
    • mmmm: Media ID (0001-9999)
    • +
    + +

    +When media becomes chaptered, the camera increments subsequent Chapter Numbers while leaving the Media ID unchanged. +For example, if the user records a long High-quality video that results in 4 chapters, the files on the sdcard may +look like the following: +

    + +
    -rwxrwxrwx@ 1 gopro  123456789  4006413091 Jan  1 00:00 GH010078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17663 Jan  1 00:00 GH010078.THM
    +-rwxrwxrwx@ 1 gopro  123456789  4006001541 Jan  1 00:00 GH020078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17357 Jan  1 00:00 GH020078.THM
    +-rwxrwxrwx@ 1 gopro  123456789  4006041985 Jan  1 00:00 GH030078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17204 Jan  1 00:00 GH030078.THM
    +-rwxrwxrwx@ 1 gopro  123456789   756706872 Jan  1 00:00 GH040078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17420 Jan  1 00:00 GH040078.THM
    +-rwxrwxrwx@ 1 gopro  123456789   184526939 Jan  1 00:00 GL010078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789   184519787 Jan  1 00:00 GL020078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789   184517614 Jan  1 00:00 GL030078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789    34877660 Jan  1 00:00 GL040078.LRV
    +
    + +

    Media Info Format

    +

    +The Media: Info command provides additional details about a media above and beyond its counterpart, the Media: List command. +Such information includes resolution, frame rate, duration, hilight info, etc. +

    + +

    Example Video Info:

    +
    {
    +    "cre": "1613676644",
    +    "s": "11305367",
    +    "mahs": "1",
    +    "us": "0",
    +    "mos": [],
    +    "eis": "0",
    +    "pta": "1",
    +    "ao": "stereo",
    +    "tr": "0",
    +    "mp": "0",
    +    "ct": "0",
    +    "rot": "0",
    +    "fov": "4",
    +    "lc": "0",
    +    "prjn": "6",
    +    "gumi": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    +    "ls": "1072714",
    +    "cl": "0",
    +    "avc_profile": "4",
    +    "profile": "42",
    +    "hc": "0",
    +    "hi": [],
    +    "dur": "2",
    +    "w": "1920",
    +    "h": "1080",
    +    "fps": "60000",
    +    "fps_denom": "1001",
    +    "prog": "1",
    +    "subsample": "0"
    +}
    +
    + +

    Common Keys (Video / Photo)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescriptionExamples
    aostringAudio Optionoff, stereo, wind, auto
    avc_profileuint8Advanced Video Codec Profile0..255
    clboolFile clipped from another source?0:false, 1:true
    creuint32File creation timestamp (sec since epoch)1692992748
    ctuint32Content type0..12
    duruint32Duration of video in seconds42
    eisboolFile made with Electronic Image Stabilization0:false, 1:true
    fpsuint32Frame rate (numerator)1001
    fps_denomuint32Frme rate (denominator)30000
    gumistringGlobally Unique Media ID“xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”
    huint32Video height in pixels1080
    hcuint32Hilight countvideo:0..99, photo:0..1
    hdrboolPhoto taken with High Dynamic Range?0:false, 1:true
    hiArray of uint32Offset to hilights in media in milliseconds[1500, 4700]
    lcuint32Spherical Lens Config0:front, 1:rear
    lsint32Low Resolution Video file size in bytes (or -1 if no LRV file)-1, 1234567890
    mosArray of stringMobile Offload State“app”, “pc”, “other”
    mpboolMetadata Present?0:no metadata, 1:metadata exists
    profileuint8Advanced Video Codec Level0..255
    progboolIs video progressive?0:interlaced, 1:progressive
    ptaboolMedia has Protune audio file?0:false, 1:true
    rawboolPhoto has raw version?0:false, 1:true
    suint64File size in bytes1234567890
    subsampleboolIs video subsampled?0:false, 1:true
    trboolIs file transcoded?0:false, 1:true
    wuint32Width of media in pixels1920
    wdrboolPhoto taken with Wide Dynamic Range?0:false, 1:true
    + +

    Video Keys

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescriptionExamples
    aostringAudio Optionoff, stereo, wind, auto
    avc_profileuint8Advanced Video Codec Profile0..255
    clboolFile clipped from another source?0:false, 1:true
    duruint32Duration of video in seconds42
    fpsuint32Frame rate (numerator)1001
    fps_denomuint32Frme rate (denominator)30000
    hiArray of uint32Offset to hilights in media in milliseconds[1500, 4700]
    lsint32Low Resolution Video file size in bytes (or -1 if no LRV file)-1, 1234567890
    profileuint8Advanced Video Codec Level0..255
    progboolIs video progressive?0:interlaced, 1:progressive
    ptaboolMedia has Protune audio file?0:false, 1:true
    subsampleboolIs video subsampled?0:false, 1:true
    + +

    Photo Keys

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescriptionExamples
    hdrboolPhoto taken with High Dynamic Range?0:false, 1:true
    rawboolPhoto has raw version?0:false, 1:true
    wdrboolPhoto taken with Wide Dynamic Range?0:false, 1:true
    + +

    Media Info: Content Type

    +

    +The "ct" (Content Type) metadata indicates what mode (or group) the media was captured in. +

    + +

    +Note: All Time Lapse modes that result in MPEG media use the same content type ID. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    Video0
    Looping1
    Chaptered Video2
    Time Lapse3
    Single Photo4
    Burst Photo5
    Time Lapse Photo6
    Night Lapse Photo8
    Night Photo9
    Continuous Photo10
    Raw Photo11
    Live Burst12
    + +

    Media List Format

    +

    +The format of the media list is given below. +

    + +
    {
    +    "id": "<MEDIA SESSION ID>",
    +    "media": [
    +        {
    +            "d": "<DIRECTORY NAME>",
    +            "fs": [
    +                {<MEDIA ITEM INFO>},
    +                ...
    +            ]
    +        },
    +        ...
    +    ]
    +}
    +
    + +

    Media List Keys

    +

    The outer structure of the media list and the inner structure of individual media items use the keys in the table below.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyDescription
    bID of first member of a group (for grouped media items)
    creCreation timestamp (seconds since epoch)
    dDirectory name
    fsFile system. Contains listing of media items in directory
    gGroup ID (if grouped media item)
    glrvLow resolution video file size
    idMedia list session identifier
    lID of last member of a group (for grouped media items)
    mList of missing/deleted group member IDs (for grouped media items)
    mediaContains media info for for each directory (e.g. 100GOPRO/, 101GOPRO/, …)
    modLast modified time (seconds since epoch)
    nMedia filename
    sSize of (group) media in bytes
    tGroup type (for grouped media items) (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse)
    + +

    Grouped Media Items

    +

    +To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos, +Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys +that allow the user to extrapolate individual filenames for each member of the group. +

    + +

    +Filenames for group media items have the form "GXXXYYYY.ZZZ" +where XXX is the group ID, YYY is the group member ID and ZZZ is the file extension. +

    + +

    +For example, take the media list below, which contains a Time Lapse Photo group media item: +

    + +
    {
    +    "id": "2530266050123724003",
    +    "media": [
    +        {
    +            "d": "100GOPRO",
    +            "fs": [
    +                {
    +                    "b": "8",
    +                    "cre": "1613669353",
    +                    "g": "1",
    +                    "l": "396",
    +                    "m": ['75', '139'],
    +                    "mod": "1613669353",
    +                    "n": "G0010008.JPG",
    +                    "s": "773977407",
    +                    "t": "t"
    +                }
    +            ]
    +        }
    +    ]
    +}
    +
    + +

    +The first filename in the group is "G0010008.JPG" (key: "n").
    +The ID of the first group member in this case is "008" (key: "b").
    +The ID of the last group member in this case is "396" (key: "l").
    +The IDs of deleted members in this case are "75" and "139" (key: "m")
    +Given this information, the user can extrapolate that the group currently contains +

    + +

    +G0010008.JPG, G0010009.JPG, G0010010.JPG,
    +...,
    +G0010074.JPG, G0010076.JPG,
    +...,
    +G0010138.JPG, G0010140.JPG,
    +...,
    +G0010394.JPG, G0010395.JPG. G0010396.JPG
    +

    + +

    Media HiLights

    +

    +The HiLight Tags feature allows the user to tag moments of interest either during video +capture or on existing media. +

    + +

    Add/Remove HiLights

    +

    +Below is a table of all HiLight commands. +For details on how to send HiLight commands, see Commands Quick Reference. + +

    + + + + + + + + + + + + + + + + + + + +
    CommandDescription
    Media: HiLight (Add)Video: Add a tag at a specific time offset (ms)
    Photo: Add a tag
    Media: HiLight (Remove)Video: Remove a tag at a specific time offset (ms)
    Photo: Remove tag
    Media: HiLight MomentAdd a tag to the current time offset (ms) while encoding video
    + +

    +Note: Attempting to add a HiLight tag at a time offset that exceeds the duration of the video +or removing a non-existent HiLight tag will result in an HTTP/500 error. +

    + +

    Get HiLights

    +

    +Once HiLight tags have been added, they can be queried by calling the Media: Info command; +the response content will be JSON that contains HiLight information: +

    + + + + + + + + + + + + + + + + + + + + + + + +
    Media TypeKeyValue
    PhotohcHiLight Count
    VideohcHiLight Count
    VideohiHiLights (list of time offsets in ms)
    + +

    Example

    +

    +The JSON sample below shows media that contains three HiLights at time offsets 2502ms, 5839ms, and 11478ms. +Note: Photo info will not have an "hi":[...] key-value pair. +

    + +
    {
    +  ...,
    +  "hc":"3",
    +  "hi":[2502,5839,11478],
    +  ...,
    +}
    +
    + +

    Downloading Media

    +

    +The URL to download/stream media from the DCIM/ directory on the sdcard is the Base URL plus /videos/DCIM/XXX/YYY +where XXX is the directory name within DCIM/ given by the media list and YYY is the target media filename. +

    + +

    +For example: Given the following media list: +

    + +
    {
    +    "id": "3586667939918700960",
    +    "media": [
    +        {
    +            "d": "100GOPRO",
    +            "fs": [
    +                {
    +                    "n": "GH010397.MP4",
    +                    "cre": "1613672729",
    +                    "mod": "1613672729",
    +                    "glrv": "1895626",
    +                    "ls": "-1",
    +                    "s": "19917136"
    +                },
    +                {
    +                    "cre": "1614340213",
    +                    "mod": "1614340213",
    +                    "n": "GOPR0001.JPG",
    +                    "s": "6961371"
    +                }
    +            ]
    +        }
    +    ]
    +}
    +
    + +

    +The URL to download GH010397.MP4 over WiFi would be +http://10.5.5.9:8080/videos/DCIM/100GOPRO/GH010397.MP4 +

    + +

    +The URL to download GOPR0001.JPG over WiFi would be +http://10.5.5.9:8080/videos/DCIM/100GOPRO/GOPR0001.JPG +

    + +

    Turbo Transfer

    +

    +Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. +This special mode should only be used during media offload. +It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. +For details on which cameras are supported and how to enable and disable Turbo Transfer, see +Commands Quick Reference. +

    + +

    Downloading Preview Stream

    +

    +When the preview stream is started, the camera starts up a UDP client and begins writing MPEG Transport Stream data to the client on port 8554. +In order to stream this data, the client must implement a UDP connection that binds to the same port and decode the data. +

    + +

    Camera State

    +

    +The camera provides multiple types of state, all of which can be queried: +

    + +
      +
    • Camera state: Contains information about camera status (photos taken, date, is-camera-encoding, etc) and settings (current video resolution, current frame rate, etc)
    • +
    • Preset State: How presets are arranged into preset groups, their titles, icons, settings closely associated with each preset, etc
    • +
    + +

    Camera State Format

    +

    Camera state is given in the following form:

    + +
    {
    +    "status": {
    +        "1": <status 1 value>,
    +        "2": <status 2 value>,
    +        ...
    +    },
    +    "settings: {
    +        "2": <setting 2 value>,
    +        "3": <setting 3 value>,
    +        ...
    +    }
    +}
    +
    + +

    +Where status X value and setting X value are almost always integer values. +See Status Codes table in this document for exceptions. +

    + +

    +For status, keys are status codes and values are status values. +

    + +

    +For settings, keys are setting IDs, and values are option values +

    + +

    Status IDs

    +

    +Below is a table of supported status IDs.
    +* Indicates that item is experimental
    + Indicates support for all Open GoPro firmware versions.
    + Indicates a lack of support for all Open GoPro firmware versions.
    +>= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Status IDNameDescriptionTypeValuesHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    1Internal battery presentIs the system’s internal battery present?boolean0: False
    1: True
    +
    2Internal battery levelRough approximation of internal battery level in bars (or charging)integer0: Zero
    1: One
    2: Two
    3: Three
    4: Charging
    +
    6System hotIs the system currently overheating?boolean0: False
    1: True
    +
    8System busyIs the camera busy?boolean0: False
    1: True
    +
    9Quick capture activeIs Quick Capture feature enabled?boolean0: False
    1: True
    +
    10Encoding activeIs the system encoding right now?boolean0: False
    1: True
    +
    11Lcd lock activeIs LCD lock active?boolean0: False
    1: True
    +
    13Video progress counterWhen encoding video, this is the duration (seconds) of the video so far; 0 otherwiseinteger*
    17EnableAre Wireless Connections enabled?boolean0: False
    1: True
    +
    19StateThe pairing state of the camerainteger0: Never Started
    1: Started
    2: Aborted
    3: Cancelled
    4: Completed
    +
    20TypeThe last type of pairing that the camera was engaged ininteger0: Not Pairing
    1: Pairing App
    2: Pairing Remote Control
    3: Pairing Bluetooth Device
    +
    21Pair timeTime (milliseconds) since boot of last successful pairing complete actioninteger*
    22StateState of current scan for WiFi Access Points. Appears to only change for CAH-related scansinteger0: Never started
    1: Started
    2: Aborted
    3: Canceled
    4: Completed
    +
    23Scan time msecThe time, in milliseconds since boot that the WiFi Access Point scan completedinteger*
    24Provision statusWiFi AP provisioning stateinteger0: Never started
    1: Started
    2: Aborted
    3: Canceled
    4: Completed
    +
    26Remote control versionWireless remote control versioninteger*
    27Remote control connectedIs a wireless remote control connected?boolean0: False
    1: True
    +
    28PairingWireless Pairing Stateinteger*
    29Wlan ssidSSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded intstring*
    30Ap ssidThe camera’s WiFi SSID. On BLE connection, value is big-endian byte-encoded intstring*
    31App countThe number of wireless devices connected to the camerainteger*
    32EnableIs Preview Stream enabled?boolean0: False
    1: True
    +
    33Sd statusPrimary Storage Statusinteger-1: Unknown
    0: OK
    1: SD Card Full
    2: SD Card Removed
    3: SD Card Format Error
    4: SD Card Busy
    8: SD Card Swapped
    +
    34Remaining photosHow many photos can be taken before sdcard is fullinteger*
    35Remaining video timeHow many minutes of video can be captured with current settings before sdcard is fullinteger*
    How many group photos can be taken with current settings before sdcard is full38Num total photosTotal number of photos on sdcardinteger*
    39Num total videosTotal number of videos on sdcardinteger*
    41Ota statusThe current status of Over The Air (OTA) updateinteger0: Idle
    1: Downloading
    2: Verifying
    3: Download Failed
    4: Verify Failed
    5: Ready
    6: GoPro App: Downloading
    7: GoPro App: Verifying
    8: GoPro App: Download Failed
    9: GoPro App: Verify Failed
    10: GoPro App: Ready
    +
    42Download cancel request pendingIs there a pending request to cancel a firmware update download?boolean0: False
    1: True
    +
    45Camera locate activeIs locate camera feature active?boolean0: False
    1: True
    +
    49Multi shot count downThe current timelapse interval countdown value (e.g. 5…4…3…2…1…)integer*
    54Remaining spaceRemaining space on the sdcard in Kilobytesinteger*
    55SupportedIs preview stream supported in current recording/mode/secondary-stream?boolean0: False
    1: True
    +
    56Wifi barsWiFi signal strength in barsinteger*
    58Num hilightsThe number of hilights in encoding video (set to 0 when encoding stops)integer*
    59Last hilight time msecTime since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops)integer*
    60Next poll msecThe min time between camera status updates (msec). Do not poll for status more often than thisinteger*
    64Remaining timelapse timeHow many min of Timelapse video can be captured with current settings before sdcard is fullinteger*
    65Exposure select typeLiveview Exposure Select Modeinteger0: Disabled
    1: Auto
    2: ISO Lock
    3: Hemisphere
    +
    66Exposure select xLiveview Exposure Select: y-coordinate (percent)percent0-100
    67Exposure select yLiveview Exposure Select: y-coordinate (percent)percent0-100
    68Gps statusDoes the camera currently have a GPS lock?boolean0: False
    1: True
    +
    69Ap stateIs the camera in AP Mode?boolean0: False
    1: True
    +
    70Internal battery percentageInternal battery level (percent)percent0-100
    74Acc mic statusMicrophone Accesstory statusinteger0: Microphone mod not connected
    1: Microphone mod connected
    2: Microphone mod connected and microphone plugged into Microphone mod
    +
    75Digital zoomDigital Zoom level (percent)percent0-100
    76Wireless bandWireless Bandinteger0: 2.4 GHz
    1: 5 GHz
    2: Max
    +
    77Digital zoom activeIs Digital Zoom feature available?boolean0: False
    1: True
    +
    78Mobile friendly videoAre current video settings mobile friendly? (related to video compression and frame rate)boolean0: False
    1: True
    +
    79First time useIs the camera currently in First Time Use (FTU) UI flow?boolean0: False
    1: True
    +
    81Band 5ghz availIs 5GHz wireless band available?boolean0: False
    1: True
    +
    82System readyIs the system ready to accept commands?boolean0: False
    1: True
    +
    83Batt okay for otaIs the internal battery charged sufficiently to start Over The Air (OTA) update?boolean0: False
    1: True
    +
    85Video low temp alertIs the camera getting too cold to continue recording?boolean0: False
    1: True
    +
    86Actual orientationThe rotational orientation of the camerainteger0: 0 degrees (upright)
    1: 180 degrees (upside down)
    2: 90 degrees (laying on right side)
    3: 270 degrees (laying on left side)
    +
    88Zoom while encodingIs this camera capable of zooming while encoding (static value based on model, not settings)boolean0: False
    1: True
    +
    89Current modeCurrent flatmode IDinteger*
    93Active video presetsCurrent Video Preset (ID)integer*
    94Active photo presetsCurrent Photo Preset (ID)integer*
    95Active timelapse presetsCurrent Timelapse Preset (ID)integer*
    96Active presets groupCurrent Preset Group (ID)integer*
    97Active presetCurrent Preset (ID)integer*
    98Preset modifiedPreset Modified Status, which contains an event ID and a preset (group) IDinteger*
    99Remaining live burstsHow many Live Bursts can be captured before sdcard is fullinteger*
    100Num total live burstsTotal number of Live Bursts on sdcardinteger*
    101Capture delay activeIs Capture Delay currently active (i.e. counting down)?boolean0: False
    1: True
    +
    102Media mod mic statusMedia mod Stateinteger0: Media mod microphone removed
    2: Media mod microphone only
    3: Media mod microphone with external microphone
    +
    103Timewarp speed ramp activeTime Warp Speedinteger0: 15x
    1: 30x
    2: 60x
    3: 150x
    4: 300x
    5: 900x
    6: 1800x
    7: 2x
    8: 5x
    9: 10x
    10: Auto
    11: 1x (realtime)
    12: 1/2x (slow-motion)
    +
    104Linux core activeIs the system’s Linux core active?boolean0: False
    1: True
    +
    105Camera lens typeCamera lens type (reflects changes to setting 162 or setting 189)integer0: Default
    1: Max Lens
    2: Max Lens 2.0
    +
    106Video hindsight capture activeIs Video Hindsight Capture Active?boolean0: False
    1: True
    +
    107Scheduled presetScheduled Capture Preset IDinteger*
    108Scheduled enabledIs Scheduled Capture set?boolean0: False
    1: True
    +
    110Media mod statusMedia Mode Status (bitmasked)integer0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False
    1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True
    2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False
    3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True
    4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False
    5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True
    6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False
    7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True
    +
    111Sd rating check errorDoes sdcard meet specified minimum write speed?boolean0: False
    1: True
    +
    112Sd write speed errorNumber of sdcard write speed errors since device bootedinteger*
    113Turbo transferIs Turbo Transfer active?boolean0: False
    1: True
    +
    114Camera control statusCamera control status IDinteger0: Camera Idle: No one is attempting to change camera settings
    1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control
    2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings
    +
    115Usb connectedIs the camera connected to a PC via USB?boolean0: False
    1: True
    +
    116Allow control over usbCamera control over USB stateinteger0: Disabled
    1: Enabled
    +
    >= v01.30.00
    117Total sd space kbTotal SD card capacity in Kilobytesinteger*
    + +

    Preset Status Format

    +

    +Preset Status is returned as JSON, whose content is the serialization of the protobuf message: +NotifyPresetStatus. +Using Google protobuf APIs, the JSON can be converted back into a programmatic object in the user's language of choice. +

    + +

    Features

    + +

    Presets

    +

    +The camera organizes modes of operation into presets. +A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. +

    + +

    +Depending on the camera's state, different collections of presets will be available for immediate loading and use. +Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDSetting
    162Max Lens
    173Video Performance Mode
    175Controls
    177Enable Night Photo
    180Video Mode
    186Video Mode
    187Lapse Mode
    189Max Lens Mod
    190Max Lens Mod Enable
    191Photo Mode
    + +

    +To determine which presets are available for immediate use, get Preset Status. +

    + +

    Preset Status

    +

    +All cameras support basic query and subscription mechanics that allow the user to: +

    + +
      +
    • Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state
    • + +
    + +

    +Preset Status should not be confused with camera status: +

    +
      +
    • Preset Status contains information about current preset groups and presets
    • +
    • Camera status contains numerous statuses about current settings and camera system state
    • +
    + + +

    Preset Groups

    +

    +Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. +

    + +

    Presets

    +

    +Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, +whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of +Settings associated with the Preset. +

    + +

    +Important Note: The Preset ID is required to load a Preset via the Presets: Load command. +

    + +

    Global Behaviors

    +

    +In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a +connected app is discouraged. +

    + +

    +Best practice for synchronizing user/app control is to use the Set Camera Control Status command and +corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: +

    + +IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera + + + + + + + + + + + + + + + + + + + + +
    Control StatusID
    IDLE0
    CONTROL1
    EXTERNAL_CONTROL2
    + +

    Set Camera Control Status

    +

    +This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. +This causes the camera to immediately exit any contextual menus and return to the idle screen. +Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. +If the user returns the camera UI to the idle screen, the camera updates control status to Idle. +

    + +

    +Note: +

    +
      +
    • The entity currently claiming control of the camera is advertised in camera status 114
    • +
    • Information about whether the camera is in a contextual menu or not is advertised in camera status 63.
    • +
    + + +

    OTA Update

    + +

    +The Over The Air (OTA) update feature allows the user to update the camera's firmware via HTTP connection. +There are two ways to perform OTA updates: Simple OTA Update and Resumable OTA Update. +

    + +

    +Firmware update files can be obtained from GoPro's update page or programmatically using the +firmware catalog. +

    + +

    +Note: In order to complete the firmware update process, the camera will reboot one or more times. +This will cause any existing HTTP connections to be lost. +

    + +

    Simple OTA Update

    +

    +The simple OTA update process is done by sending an entire update file to the camera in a single HTTP/POST. +Details can be found in the diagram below. +

    + +Simple OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/POST: /gp/gpUpdateContent-Type: multipart/form-dataData:DirectToSD=1update=1sha1=<SHA1_HASH>file=<UPDATE.zip>HTTP/200 (OK)JSON: { "status":"0" }WiFi connection terminatesCamera displays "Update Complete" OSD, reboots 1-2 times + +

    Resumable OTA Update

    +

    +The resumable OTA update process involves uploading chunks (or all) of a file, marking the file complete and then telling the camera to begin the update process. +Chunks are stored until they are explicitly deleted, allowing the client to stop and resume as needed. +Details can be found in the diagram below. +

    + +Resumable OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/GET: /gp/gpSoftUpdate?request=deleteDelete any old/cached dataHTTP/200 (OK)JSON {"status":0,"message":"OK","sha1":"","bytes_complete":0,"complete":false}HTTP/GET: /gp/gpSoftUpdate?request=showuiDisplay update OSD on camera UI (optional)HTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"","bytes_complete":0,"complete":false}loop[read CHUNK_BYTES of UPDATE.zip, starting at OFFSET]HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>offset=<OFFSET>file=<CHUNK_BYTES>HTTP/200 (OK)JSON: {"status": 0,"message": "OK","sha1": "SHA1_HASH","bytes_complete": (total uploaded bytes),"complete": false}HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>complete=trueHTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"SHA1_HASH","bytes_complete":(size of UPDATE.zip),"complete":true}HTTP/GET: /gp/gpSoftUpdate?request=startStart updating firmwareHTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"SHA1_HASH","bytes_complete":(size of UPDATE.zip),"complete":true}loop[while camera updates firmware]HTTP/GET: /gp/gpSoftUpdate?request=progressJSON: {"status":11,"message":"Firmware update in progress"}WiFi connection lostCamera displays OSD "Update Complete", reboots 1-2 times + +

    OTA Update Status Codes

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDStatusDescription
    0OkNo errors occurred
    1Unknown RequestServer did not recognize the request
    2Bad ParamsParameter values not recognized
    3SHA1 Send MismatchSHA1 for chunk did not match SHA1 of previous chunk(s)
    4SHA1 Calculates MismatchCalculated SHA1 did not match user-specified SHA1
    5HTTP Boundary ErrorHTTP Post malformed
    6HTTP Post ErrorUnexpected HTTP/POST Content Type
    7Server BusyHTTP server is busy
    8Offset MismatchTried to upload chunk with offset that did not align with previous chunk
    9Bad Post DataServer failed to parse POST data
    10File IncompleteTried to start update before server finished validating .zip file
    11Update in ProgressFirmware update in progress
    12Insufficient SpaceInsufficient space on the sdcard to hold (decompressed) update file
    + +

    Webcam

    + +

    +The webcam feature enables developers who are interested in writing custom drivers to broadcast the camera's video preview with a limited set of resolution, field of view, port, and protocol options. +

    + +

    +While active, the webcam feature sends raw data to the connected client using a supported protocol. +To enable multi-cam support, some cameras support running on a user-specified port. +Protocol and port details are provided in a table below. +

    + +

    +To test basic functionality, start the webcam, and use an application such as VLC to open a network stream: +

    + + + + + + + + + + + + + + + +
    ProtocolVLC Network URL
    TSudp://@:{PORT}
    RTSPrtsp://{CAMERA_IP}:554/live
    + + +

    +For readers interested in using a GoPro camera as a webcam with preexisting tools, please see How to use GoPro as a Webcam. +

    + +

    Webcam Finite State Machine

    +PREREQUISITEWired USB Control disabledREADYWebcam ready to startStatus is either OFF (0) or IDLE (1)High Power PreviewStatus: 2Low Power PreviewStatus: 3Connect USB to cameraStopExitStartStopExitPreviewStopExitStartPreviewStartPreview + +

    Webcam Commands

    +

    +Note: For USB connections, prior to issuing webcam commands, Wired USB Control should be disabled. +For details about how to send this and webcam commands, see Commands Quick Reference. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CommandConnectionsDescription
    Webcam: StartUSB, WIFI*Enters webcam mode, uses default resolution and last-used fov, starts high-res stream to the IP address of caller
    Webcam: Start (with args)USB, WIFI*Enters webcam mode, uses specified res/fov/protocol/port, starts streaming to the IP address of caller
    Webcam: PreviewUSB, WIFI*Enters webcam mode, sets stream resolution and bitrate, starts low-res stream to the IP address of caller.
    Can set Webcam Digital Lenses and Digital Zoom levels while streaming
    Webcam: StopUSB, WIFI*Stops the webcam stream
    Webcam: ExitUSB, WIFI*Stops the webcam stream and exits webcam mode
    Webcam: StatusUSB, WIFIReturns the current state of the webcam endpoint, including status and error codes (see tables below)
    Webcam: VersionUSB, WIFIProvides version information about webcam implementation in JSON format
    +

    * Indicates that connection is supported in HERO12 Black v01.10.00 and newer versions/models

    + +

    Status Codes

    + + + + + + + + + + + + + + + + + + + + + + + +
    StatusCode
    OFF0
    IDLE1
    HIGH_POWER_PREVIEW2
    LOW_POWER_PREVIEW3
    + +

    Error Codes

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusCode
    NONE0
    SET_PRESET1
    SET_WINDOW_SIZE2
    EXEC_STREAM3
    SHUTTER4
    COM_TIMEOUT5
    INVALID_PARAM6
    UNAVAILABLE7
    EXIT8
    + +

    Webcam Capabilities

    + +

    +Webcam supports setting resolution and field of view. +Changing other settings while in IDLE state such as Hypersmooth may succeed but are not officially supported. +

    + +

    +There is a known issue on some cameras in which the webcam status will be wrongly reported as IDLE instead of OFF after a new USB connection. +The best workaround for this is to call Webcam: Start followed by the Webcam: Stop after connecting USB in order to attain the true IDLE state. +

    + +

    Default Parameter Values

    + + + + + + + + + + + + + + + + + + + +
    ParameterDefault Value
    res12 (1080p)
    fovLast-used or 0 (Wide) if FOV not previously set
    protocol“TS”
    + +

    Webcam Capabilities

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraResolutionFOV
    HERO12 Black720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO11 Black720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO10 Black480p (id: 4)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO9 Black480p (id: 4)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    + +

    Supported Protocols

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraProtocolDefault PortSupports User-Defined Port?
    HERO12 BlackTS8554
    RTSP554
    HERO11 BlackTS8554
    HERO10 BlackTS8554
    HERO9 BlackTS8554
    + +

    Webcam Stabilization

    + +

    +Should the client require stabilization, the Hypersmooth setting can be used while in the state: READY (Status: OFF). +This setting can only be set while webcam is disabled, which requires either sending the Webcam: Exit command or reseating the USB-C connection to the camera. +

    + +

    +Note: The Low Hypersmooth option provides lower/lighter stabilization when used in Webcam mode vs other camera modes. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraVersionSupported Hypersmooth Options
    HERO12 Blackv01.10.00+Off (id: 0), Low (id: 1), Auto Boost (id: 4)
    HERO11 Black Miniv01.10.00+Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4)
    HERO11 Blackv01.10.00+Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4)
    HERO10 Blackv01.10.00+Off (id: 0), High (id: 2), Boost (id: 3), Standard (id: 100)
    HERO9 Blackv01.70.00+Off (id: 0), Low (id: 1), High (id: 2), Boost (id: 3)
    + +

    Camera On the Home Network (COHN)

    +

    +Some cameras support Camera On the Home Network (COHN). +This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. +For security purposes, all communications are performed over HTTPS. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraSupported
    HERO12 Black
    HERO11 Black Mini
    HERO11 Black
    HERO10 Black
    HERO9 Black
    + +

    Provisioning COHN

    +

    +In order to use the COHN capability, the camera must first be provisioned for COHN. +

    + +

    Send Messages via HTTPS

    +

    +Once the camera is provisioned, the client can issue +commands +and set settings +via HTTPS using the COHN certificate and Basic authorization (username/password) credentials obtained during provisioning or subsequently by querying for COHN status. +

    + +

    HTTPS Headers

    + +

    +All HTTPS messages must contain Basic access authentication headers, using the username and password from the COHN status obtained during or after provisioning. +

    + +

    COHN Commands

    + +

    Command

    + + + + + + + + + + + + + + + + + + +
    CommandResponse FormatDescription
    /GoProRootCA.crtTextGet COHN cert
    /gopro/cohn/statusJSONGet current COHN status
    + +

    Get COHN Cert

    +

    +The /GoProRootCA.crt endpoint provides a way to obtain the COHN cert via HTTP(S). +The response content is in plain text. For example: +

    + +
    -----BEGIN CERTIFICATE-----
    +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    +-----END CERTIFICATE-----
    +
    + +

    Get COHN Status

    +

    +The /gopro/cohn/status endpoint provides a way to get the current status of COHN. +The status's format is NotifyCOHNStatus (a Google Procol Buffer v2 message) converted into JSON. +

    + +

    +Example: +

    +
    {
    + "status": "COHN_PROVISIONED",
    + "state": "COHN_STATE_NetworkConnected",
    + "username": "gopro",
    + "password": "xxxxxxxxxxxx",
    + "ipaddress": "xxx.xxx.xxx.xxx",
    + "enabled": true
    +}
    +
    + +

    Limitations

    + +

    HERO12 Black

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference +
    • +
    +

    HERO11 Black Mini

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference +
    • +
    +

    HERO11 Black

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference +
    • +
    +

    HERO10 Black

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference +
    • +
    +

    HERO9 Black

    +
      +
    • The HTTP server is not available while the camera is encoding, which means shutter controls are not supported over WiFi. This limitation can be overcome by using Bluetooth Low Energy for command and control and HTTP/REST for querying media content such as media list, media info, preview stream, etc.
    • +
    • USB command and control is not supported on HERO9 Black.
    • +
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference +
    • +
    + +

    General

    + +
      +
    • Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds.
    • +
    • In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode).
    • +
    + + +
    + +
    + + + + + + + +
    + + + + +
    + + +
    + + + +
    + +
    + + +
    +
    +
    + + +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + diff --git a/http.html b/http.html index 22d7f7da..16b78f22 100644 --- a/http.html +++ b/http.html @@ -1,16 +1,24787 @@ - - - - - - Redirecting… - - - - - - -

    Redirecting…

    - Click here if you are not redirected. - - + + + + + OpenGoPro HTTP API + + + + + + + + + +

    OpenGoPro HTTP API (2.0)

    Download OpenAPI specification:Download

    The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera.

    +

    Overview

    The GoPro API allows you to control and query the camera to:

    +
      +
    • Capture photo/video media
    • +
    • Get media list
    • +
    • Change settings
    • +
    • Get and set the date/time
    • +
    • Get camera status
    • +
    • Get media metadata (file size, width, height, duration, tags, etc)
    • +
    • and more!
    • +
    +

    Supported Cameras

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Model IDModel CodeMarketing NameMinimal Firmware Version
    62H23.01HERO12 Blackv01.10.00
    60H22.03HERO11 Black Miniv01.10.00
    58H22.01HERO11 Blackv01.10.00
    57H21.01HERO10 Blackv01.10.00
    55HD9.01HERO9 Blackv01.70.00
    +

    Setup

    Connection

    +

    WiFi

    +

    Connection to the camera via WiFi requires that the camera's WiFi Access Point be enabled. This can be done by +connecting to the camera via Bluetooth Low Energy and sending a command to +enable AP Mode.

    +

    USB

    +

    Open GoPro systems that utilize USB must support the Network Control Model (NCM) protocol. Connecting via USB +requires the following steps:

    +
      +
    1. Physically connect the camera's USB-C port to your system
    2. +
    3. Send HTTP command to enable wired USB control
    4. +
    +

    Authentication

    +

    WiFi

    +

    Once the WiFi Access Point has been turned on, authentication with the camera simply requires connecting with the +correct SSID and password. This information can be obtained in two ways:

    + +

    USB

    +

    No authentication is necessary.

    +

    Socket Address

    +

    WiFi

    +

    The socket address for WiFi connections is 10.5.5.9:8080.

    +

    USB

    +

    The socket address for USB connections is 172.2X.1YZ.51:8080 where XYZ are the last three digits of the camera's +serial number.

    +

    The camera's serial number can be obtained in any of the following ways:

    +
      +
    • Reading the sticker inside the camera's battery enclosure
    • +
    • Camera UI: Preferences >> About >> Camera Info
    • +
    • Bluetooth Low Energy: By reading directly from Hardware Info
    • +
    +

    For example, if the camera's serial number is C0000123456789, the IP address for USB connections would be +172.27.189.51.

    +

    Alternatively, the IP address can be discovered via mDNS as the camera registers the _gopro-web service.

    +

    General Usage

    Commands

    +

    Using the Open GoPro API, a client can perform various command, control, and query operations.

    +

    Depending on the camera's state, it may not be ready to accept specific commands. +This ready state is dependent on the System Busy and the Encoding Active status flags. For example:

    +
      +
    • System Busy flag is set while loading presets, changing settings, formatting sdcard
    • +
    • Encoding Active flag is set while capturing photo/video media
    • +
    +

    If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the +System Busy and Encode Active flags to be unset before sending messages other than camera status queries. +For details regarding camera state, see the Get State Operation

    +

    Keep Alive

    +

    It is necessary to periodically send a keep-alive signal to maintain the connection.

    +

    Camera Control

    +

    In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a +connected app is discouraged. A third party client should use the Set Camera Control Status +command to tell the camera that the client wishes to claim control of the camera.

    +

    Limitations

    +

    HERO12 Black:

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given the order defined in the spec
    • +
    +

    HERO11 Black Mini

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order defined in the spec
    • +
    +

    HERO11 Black

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order defined in the spec
    • +
    +

    HERO10 Black

    +
      +
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • +
    • HTTP command arguments must be given in the order defined in the spec
    • +
    +

    HERO9 Black

    +
      +
    • The HTTP server is not available while the camera is encoding, which means shutter controls are not supported over WiFi. +This limitation can be overcome by using Bluetooth Low Energy for command and control and HTTP/REST +for querying media content such as media list, media info, preview stream, etc.
    • +
    • USB command and control is not supported on HERO9 Black.
    • +
    • HTTP command arguments must be given in the order defined in the spec
    • +
    +

    General

    +
      +
    • In general, querying the value for a setting that is not associated with the current preset/core mode results +in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) +value while in Standard preset (Video mode).
    • +
    +

    Analytics

    Query / Configure Analytics

    +

    Set Client as Third Party


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    COHN

    The Camera On the Home Network (COHN) capability allows the client to perform command and control with the camera +indirectly through an access point such as a router at home.

    +

    For security purposes, all communications are performed over HTTPS.

    +

    The following cameras support COHN:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraSupported
    HERO12 Black
    HERO11 Black Mini
    HERO11 Black
    HERO10 Black
    HERO9 Black
    +

    Provisioning COHN

    In order to use the COHN capability, the camera must first be provisioned for COHN. +For instructions on how to do this, see the Open GoPro BLE spec.

    +

    Send Messages via HTTPS

    Once the camera is provisioned, the client can issue commands and set settings +via HTTPS using the COHN certificate and Basic authorization (username/password) credentials obtained during +provisioning or subsequently by querying for COHN status.

    +

    HTTPS Headers

    All HTTPS messages must contain Basic access authentication +headers, using the username and password from the COHN status obtained during or after provisioning.

    +

    Configure COHN Settings


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +
    Request Body schema: application/json
    cohn_active
    integer
    Enum: 0 1

    1 to enable, 0 to disable

    +

    When cohn_active == 1, STA Mode connection will be dropped and camera will not +automatically re-connect for COHN.

    +

    Responses

    Response Schema: application/json
    object

    Request samples

    Content type
    application/json
    {
    • "cohn_active": 0
    }

    Response samples

    Content type
    application/json
    { }

    Create the COHN Certificates

    This creates the Camera On the Home Network SSL/TLS certs certs. +The created certificate(s) can be obtained via Get COHN Certificate and +used for SSL/TLS communications

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +
    Request Body schema: application/json
    override
    integer
    Enum: 0 1

    If 1, replace existing Root CA cert with a newly-generated one.

    +

    Responses

    Response Schema: application/json
    object

    Request samples

    Content type
    application/json
    {
    • "override": 0
    }

    Response samples

    Content type
    application/json
    { }

    Delete COHN Certificates


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Get COHN Certificate


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: text/plain
    string

    Response samples

    Content type
    text/plain
    -----BEGIN CERTIFICATE-----
    +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    +-----END CERTIFICATE----
    +

    Get COHN Status


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: application/json
    enabled
    integer
    Enum: 0 1

    Is COHN currently enabled?

    +
    ipaddress
    string
    Example: "123.45.67.890"

    Camera's IP address on the local network

    +
    macaddress
    string

    MAC address of the wifi adapter

    +
    password
    string

    Password used for http basic auth header

    +
    ssid
    string

    Currently connected SSID

    +
    state
    integer (EnumCOHNNetworkState)
    Enum: 0 1 2 5 27 28 29 30
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0COHN_STATE_Init
    1COHN_STATE_Error
    2COHN_STATE_Exit
    5COHN_STATE_Idle
    27COHN_STATE_NetworkConnected
    28COHN_STATE_NetworkDisconnected
    29COHN_STATE_ConnectingToNetwork
    30COHN_STATE_Invalid
    +
    status
    integer (EnumCOHNStatus)
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0COHN_UNPROVISIONED
    1COHN_PROVISIONED
    +
    username
    string

    Username used for http basic auth header

    +

    Response samples

    Content type
    application/json
    {
    • "enabled": 0,
    • "ipaddress": "123.45.67.890",
    • "macaddress": "string",
    • "password": "string",
    • "ssid": "string",
    • "state": 0,
    • "status": 0,
    • "username": "string"
    }

    Control

    Command and control of the camera

    +

    Configure Turbo Transfer

    Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly.

    +

    This special mode should only be used during media offload.

    +

    It is recommended that the user check for and, if necessary, disable Turbo Transfer on connection.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    p
    integer
    Enum: 0 1

    0 to disable, 1 to enable

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Enable Wired camera control over USB


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    p
    integer
    Enum: 0 1

    If 1, enable wired usb control; If 0, disable usb control

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Keep Alive

    In order to maximize battery life, GoPro cameras automatically go to sleep after some time. +This logic is handled by a combination of the Auto Power Down setting which most (but not all) cameras support +and a Keep Alive message that the user can regularly send to the camera.

    +

    The camera will automatically go to sleep if both timers reach zero.

    +

    The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera, +programmatically (un)sets the shutter, sets a setting, or loads a Preset.

    +

    The Keep Alive timer is reset when the user sends a keep alive message.

    +

    The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages +every 3.0 seconds after a connection is established.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Set Camera Control Status

    This command is used to tell the camera that a client (i.e. External Control) wishes to claim control of the camera. +This causes the camera to immediately exit any contextual menus and return to the idle screen. Any interaction with the +camera's physical buttons will cause the camera to reclaim control and update control status accordingly. If the user +returns the camera UI to the idle screen, the camera updates control status to Idle.

    +

    Note:

    +
      +
    • The entity currently claiming control of the camera is advertised in camera status 114
    • +
    • Information about whether the camera is in a contextual menu or not is advertised in camera status 63.
    • +
    +

    See the below diagram for a state diagram of Camera Control:

    +

    global behaviors state diagram

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    p
    integer (EnumCameraControlStatus)
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0CAMERA_IDLE
    1CAMERA_CONTROLCan only be set by camera, not by app or third party
    2CAMERA_EXTERNAL_CONTROL
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Set Date / Time


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    date
    string
    Example: date=2023_12_31

    current date in format YYYY_MM_DD

    +
    time
    string
    Example: time=21_12_13

    current time in format HH_MM_SS in 24 hour format

    +
    tzone
    integer
    Example: tzone=-480

    Timezone offset in minutes. See here for a +listing of all UTC offsets.

    +

    Not supported on:

    +
      +
    • Hero 10 Black
    • +
    • Hero 9 Black
    • +
    +
    dst
    integer
    Enum: 0 1

    Is daylight savings time active?

    +

    Not supported on:

    +
      +
    • Hero 10 Black
    • +
    • Hero 9 Black
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Set Digital Zoom


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    percent
    integer [ 0 .. 100 ]
    Example: percent=50

    Zoom Level (0-100)

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Set Shutter


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    path Parameters
    mode
    string
    Enum: "start" "stop"

    Start / stop encoding.

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Hilights

    The HiLight Tags +feature allows the user to tag moments of interest either during video capture or on existing media.

    +

    Once HiLight tags have been added, they can be queried via Media Info

    +

    Hilight a Media File

    Add a hilight / tag to an existing photo or media file.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    required
    string
    Example: path=100GOPRO/GOPR0002.MP4

    The path to a file on the camera to HiLight

    +
    ms
    integer
    Example: ms=1

    The offset from the beginning of a video file, in milliseconds

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Hilight While Recording

    Add hilight at current time while recording video

    +

    This can only be used during recording.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Remove Hilight

    Remove an existing hilight from a photo or video file.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    required
    string
    Example: path=100GOPRO/GOPR0002.MP4

    The path to a file on the camera to remove a HiLight from

    +
    ms
    integer
    Example: ms=1

    The offset from the beginning of a video file, in milliseconds

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Media

    This section describes the operations to query basic details about media captured on the sdcard.

    +

    Chapters

    All GoPro cameras break longer videos into chapters. +GoPro cameras currently limit file sizes on sdcards to 4GB for both FAT32 and exFAT file systems. +This limitation is most commonly seen when recording longer (10+ minute) videos. +In practice, the camera will split video media into chapters named Gqccmmmm.MP4 (and ones for THM/LRV) such that:

    +
      +
    • q: Quality Level (X: Extreme, H: High, M: Medium, L: Low)
    • +
    • cc: Chapter Number (01-99)
    • +
    • mmmm: Media ID (0001-9999)
    • +
    +

    When media becomes chaptered, the camera increments subsequent Chapter Numbers while leaving the Media ID unchanged. +For example, if the user records a long High-quality video that results in 4 chapters, the files on the sdcard may +look like the following:

    +
    -rwxrwxrwx@ 1 gopro  123456789  4006413091 Jan  1 00:00 GH010078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17663 Jan  1 00:00 GH010078.THM
    +-rwxrwxrwx@ 1 gopro  123456789  4006001541 Jan  1 00:00 GH020078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17357 Jan  1 00:00 GH020078.THM
    +-rwxrwxrwx@ 1 gopro  123456789  4006041985 Jan  1 00:00 GH030078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17204 Jan  1 00:00 GH030078.THM
    +-rwxrwxrwx@ 1 gopro  123456789   756706872 Jan  1 00:00 GH040078.MP4
    +-rwxrwxrwx@ 1 gopro  123456789       17420 Jan  1 00:00 GH040078.THM
    +-rwxrwxrwx@ 1 gopro  123456789   184526939 Jan  1 00:00 GL010078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789   184519787 Jan  1 00:00 GL020078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789   184517614 Jan  1 00:00 GL030078.LRV
    +-rwxrwxrwx@ 1 gopro  123456789    34877660 Jan  1 00:00 GL040078.LRV
    +
    +

    Download a Media File

    Note that this is the same endpoint for all media (photos, video, etc.).

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    path Parameters
    directory
    required
    string
    Example: 100GOPRO

    Case sensitive directory that media resides in

    +
    filename
    required
    string
    Examples:
    • GOPR0001.JPG - Sample photo file
    • GH010397.MP4 - Sample video file

    Case sensitive media filename

    +

    Get Last Captured Media

    This will return the complete path of the last captured media. Depending on the type of media captured, it will return:

    +
      +
    • single photo / video: The single media path
    • +
    • any grouped media: The path to the first captured media in the group
    • +
    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: application/json
    file
    string
    Example: "GOPR0002.JPG"

    Filename of media

    +
    folder
    string
    Example: "100GOPRO"

    Directory that the media is contained in

    +

    Response samples

    Content type
    application/json
    {
    • "file": "GOPR0002.JPG",
    • "folder": "100GOPRO"
    }

    Get Media File GPMF

    None

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    string
    Example: path=100GOPRO/GOPR0002.JPG

    media file name

    +

    Responses

    Response Schema: application/octet-stream
    string <binary>

    Get Media File Info


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    string
    Example: path=100GOPRO/GOPR0002.JPG

    media file name

    +

    Responses

    Response Schema: application/json
    Any of
    ao
    required
    string
    Enum: "auto" "wind" "stereo" "off"
    Example: "auto"

    Audio option

    +
    avc_profile
    required
    integer [ 0 .. 255 ]
    Example: "0"

    Advanced Video Code Profile

    +
    cl
    required
    integer
    Enum: 0 1

    1 if clipped, 0 otherwise

    +
    cre
    required
    integer
    Example: "1692992748"

    Creation time in seconds since epoch

    +
    ct
    required
    integer
    Enum: 0 1 2 3 4 5 6 8 9 10 11 12

    Media content type

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    Video0
    Looping1
    Chaptered Video2
    Time Lapse3
    Single Photo4
    Burst Photo5
    Time Lapse Photo6
    Night Lapse Photo8
    Night Photo9
    Continuous Photo10
    Raw Photo11
    Live Burst12
    +
    dur
    required
    integer
    Example: "42"

    Video duration in seconds

    +
    eis
    required
    integer
    Enum: 0 1

    1 if stabilized, 0 otherwise

    +
    fov
    string

    Field of View

    +
    fps
    required
    integer
    Example: "1001"

    Video frame rate numerator

    +
    fps_denom
    required
    integer
    Example: "30000"

    Video frame rate denominator

    +
    gumi
    required
    string
    Example: "12345678998765443211234567899875"

    Globally Unique Media ID

    +
    h
    required
    integer
    Example: "1080"

    Height of media in pixels

    +
    hc
    required
    integer [ 0 .. 99 ]

    Number of hilights in media

    +
    hi
    Array of integers
    Example: "1500,4700"

    List of hilights in ms offset from start of video

    +
    lc
    integer
    Enum: 0 1

    Lens configuration ==> 0 for front, 1 for rear

    +
    ls
    required
    integer [ -1 .. 1234567890 ]

    Low Resolution Video file size in bytes. -1 if there is no LRV file

    +
    mos
    Array of strings
    Items Enum: "app" "pc" "other"
    Example: "app,pc"

    List of offload states

    +
    mp
    required
    integer
    Enum: 0 1

    1 if metadata is present, 0 otherwise

    +
    prjn
    integer
    Enum: 0 1 2 3 4 5 6 7 8

    Lens projection

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    EAC0
    ERP1
    EAC, split horizontally in the middle for 2 output2
    ERP, cropped for panorama3
    Bypass stitch algorithm, side by side circles4
    Stitch is disabled, stitch algorithm is enabled for offline stitch5
    Stitch is disabled6
    Bypass stitch algorithm for EAC split7
    Hemisheric8
    +
    profile
    required
    integer [ 0 .. 255 ]

    Advanced Video Codec Level

    +
    progr
    integer
    Enum: 0 1

    Is video progressive? 1 if progressive, 0 if interlaced

    +
    pta
    required
    integer
    Enum: 0 1

    1 if protune audio is present, 0 otherwise

    +
    rot
    required
    string

    Deprecated

    +
    s
    required
    integer
    Example: "1234567890"

    File size in bytes

    +
    subsample
    required
    integer
    Enum: 0 1

    1 if subsampled from other video, 0 otherwise

    +
    tr
    required
    integer
    Enum: 0 1

    1 if file is transcoded, 0 otherwise

    +
    us
    required
    integer
    Enum: 0 1

    Has the file been uploaded? 0 if no, 1 if yes

    +
    w
    required
    integer
    Example: "1920"

    Width of media in pixels

    +

    Response samples

    Content type
    application/json
    Example
    {
    • "ao": "auto",
    • "avc_profile": 0,
    • "cl": 0,
    • "cre": 1692992748,
    • "ct": 0,
    • "dur": 42,
    • "eis": 0,
    • "fov": "string",
    • "fps": 1001,
    • "fps_denom": 30000,
    • "gumi": "12345678998765443211234567899875",
    • "h": 1080,
    • "hc": 99,
    • "hi": [
      ],
    • "lc": 0,
    • "ls": -1,
    • "mos": [
      ],
    • "mp": 0,
    • "prjn": 0,
    • "profile": 255,
    • "progr": 0,
    • "pta": 0,
    • "rot": "string",
    • "s": 1234567890,
    • "subsample": 0,
    • "tr": 0,
    • "us": 0,
    • "w": 1920
    }

    Get Media File Screennail

    A screennail is a low-res preview image that is higher resolution than a thumbnail.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    string
    Example: path=100GOPRO/GOPR0002.JPG

    media file name

    +

    Responses

    Response Schema: application/octet-stream
    string <binary>

    Get Media File Telemetry

    Get Media File Telemetry track data

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    string
    Example: path=100GOPRO/GOPR0002.JPG

    media file name

    +

    Responses

    Response Schema: application/octet-stream
    string <binary>

    Get Media File Thumbnail


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    path
    string
    Example: path=100GOPRO/GOPR0002.JPG

    media file name

    +

    Responses

    Response Schema: application/octet-stream
    string <binary>

    Get Media List

    To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos, + Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys + that allow the user to extrapolate individual filenames for each member of the group.

    +

    Filenames for group media items have the form "GXXXYYYY.ZZZ" +where XXX is the group ID, YYY is the group member ID and ZZZ is the file extension.

    +

    For example, take the media list below, which contains a Time Lapse Photo group media item:

    +
    {
    +    "id": "2530266050123724003",
    +    "media": [
    +        {
    +            "d": "100GOPRO",
    +            "fs" : [
    +                {
    +                    "b": "8",
    +                    "cre": "1613669353",
    +                    "g": "1",
    +                    "l": "396",
    +                    "m": ["75", "139"],
    +                    "mod": "1613669353",
    +                    "n": "G0010008.JPG",
    +                    "s": "773977407",
    +                    "t": "t"
    +                }
    +            ]
    +        }
    +    ]
    +}
    +
    +

    The first filename in the group is G0010008.JP (key: n).

    +

    The ID of the first group member in this case is 008 (key: b).

    +

    The ID of the last group member in this case is 396 (key: l).

    +

    The IDs of deleted members in this case are 75 and 139 (key: m)

    +

    Given this information, the user can extrapolate that the group currently contains

    +
    G0010008.JPG, G0010009.JPG, G0010010.JPG,
    +...,
    +G0010074.JPG, G0010076.JPG,
    +...,
    +G0010138.JPG, G0010140.JPG,
    +...,
    +G0010394.JPG, G0010395.JPG. G0010396.JPG
    +
    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    id
    required
    string
    Example: "1554375628411872255"

    media list identifier

    +
    required
    Array of objects
    Array
    d
    required
    string
    Example: "100GOPRO"

    directory that the media files reside in

    +
    required
    Array of SingleMediaListItem (object) or GroupedMediaListItem (object)

    list of files

    +
    Array
    Any of
    cre
    required
    integer
    Example: "1696600109"

    Creation time in seconds since epoch

    +
    glrv
    integer
    Example: "817767"

    Low resolution video size

    +
    ls
    integer
    Example: "-1"

    Low resolution file size. -1 if there is no LRV file

    +
    mod
    required
    integer
    Example: "1696600109"

    Time file was last modified in seconds since epoch

    +
    n
    required
    string
    Example: "GOPR0001.JPG"

    Media filename

    +
    s
    required
    integer
    Example: "2806303"

    Size of media in bytes

    +

    Response samples

    Content type
    application/json
    {
    • "id": "1554375628411872255",
    • "media": [
      ]
    }

    Models

    Common data models used across operations

    +

    GroupedMediaListItem

    b
    required
    integer
    Example: "1"

    ID of first member in the group

    +
    cre
    required
    integer
    Example: "1696600109"

    Creation time in seconds since epoch

    +
    g
    required
    integer
    Example: "1"

    Group Identifier

    +
    glrv
    integer
    Example: "817767"

    Low resolution video size

    +
    id
    string

    Media list session identifier

    +
    l
    required
    integer
    Example: "6"

    ID of last member in the group

    +
    ls
    integer
    Example: "-1"

    Low resolution file size. -1 if there is no LRV file

    +
    m
    required
    Array of integers
    Example: "1,2"

    File ID's that are missing or deleted

    +
    mod
    required
    integer
    Example: "1696600109"

    Time file was last modified in seconds since epoch

    +
    n
    required
    string
    Example: "G0010011.MP4"

    Media filename

    +
    s
    required
    integer
    Example: "5"

    Number of files in the group

    +
    t
    required
    string
    Enum: "b" "c" "n" "t"

    Group Type (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse)

    +
    {
    • "b": 1,
    • "cre": 1696600109,
    • "g": 1,
    • "glrv": 817767,
    • "id": "string",
    • "l": 6,
    • "ls": -1,
    • "m": [
      ],
    • "mod": 1696600109,
    • "n": "G0010011.MP4",
    • "s": 5,
    • "t": "b"
    }

    MediaList

    id
    required
    string
    Example: "1554375628411872255"

    media list identifier

    +
    required
    Array of objects
    Array
    d
    required
    string
    Example: "100GOPRO"

    directory that the media files reside in

    +
    required
    Array of SingleMediaListItem (object) or GroupedMediaListItem (object)

    list of files

    +
    Array
    Any of
    cre
    required
    integer
    Example: "1696600109"

    Creation time in seconds since epoch

    +
    glrv
    integer
    Example: "817767"

    Low resolution video size

    +
    ls
    integer
    Example: "-1"

    Low resolution file size. -1 if there is no LRV file

    +
    mod
    required
    integer
    Example: "1696600109"

    Time file was last modified in seconds since epoch

    +
    n
    required
    string
    Example: "GOPR0001.JPG"

    Media filename

    +
    s
    required
    integer
    Example: "2806303"

    Size of media in bytes

    +
    {
    • "id": "1554375628411872255",
    • "media": [
      ]
    }

    PhotoMetadata

    cre
    required
    integer
    Example: "1692992748"

    Creation time in seconds since epoch

    +
    ct
    required
    integer
    Enum: 0 1 2 3 4 5 6 8 9 10 11 12

    Media content type

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    Video0
    Looping1
    Chaptered Video2
    Time Lapse3
    Single Photo4
    Burst Photo5
    Time Lapse Photo6
    Night Lapse Photo8
    Night Photo9
    Continuous Photo10
    Raw Photo11
    Live Burst12
    +
    eis
    required
    integer
    Enum: 0 1

    1 if stabilized, 0 otherwise

    +
    fov
    string

    Field of View

    +
    gumi
    required
    string
    Example: "12345678998765443211234567899875"

    Globally Unique Media ID

    +
    h
    required
    integer
    Example: "1080"

    Height of media in pixels

    +
    hc
    required
    integer [ 0 .. 99 ]

    Number of hilights in media

    +
    hdr
    integer
    Enum: 0 1

    1 if photo taken with high dynamic range, 0 otherwise

    +
    lc
    integer
    Enum: 0 1

    Lens configuration ==> 0 for front, 1 for rear

    +
    mos
    Array of strings
    Items Enum: "app" "pc" "other"
    Example: "app,pc"

    List of offload states

    +
    mp
    required
    integer
    Enum: 0 1

    1 if metadata is present, 0 otherwise

    +
    prjn
    integer
    Enum: 0 1 2 3 4 5 6 7 8

    Lens projection

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    EAC0
    ERP1
    EAC, split horizontally in the middle for 2 output2
    ERP, cropped for panorama3
    Bypass stitch algorithm, side by side circles4
    Stitch is disabled, stitch algorithm is enabled for offline stitch5
    Stitch is disabled6
    Bypass stitch algorithm for EAC split7
    Hemisheric8
    +
    raw
    integer
    Enum: 0 1

    1 if photo has raw version, 0 otherwise

    +
    rot
    required
    string

    Deprecated

    +
    s
    required
    integer
    Example: "1234567890"

    File size in bytes

    +
    tr
    required
    integer
    Enum: 0 1

    1 if file is transcoded, 0 otherwise

    +
    us
    required
    integer
    Enum: 0 1

    Has the file been uploaded? 0 if no, 1 if yes

    +
    w
    required
    integer
    Example: "1920"

    Width of media in pixels

    +
    wdr
    integer
    Enum: 0 1

    1 if photo taken with wide dynamic range, 0 otherwise

    +
    {
    • "cre": 1692992748,
    • "ct": 0,
    • "eis": 0,
    • "fov": "string",
    • "gumi": "12345678998765443211234567899875",
    • "h": 1080,
    • "hc": 99,
    • "hdr": 0,
    • "lc": 0,
    • "mos": [
      ],
    • "mp": 0,
    • "prjn": 0,
    • "raw": 0,
    • "rot": "string",
    • "s": 1234567890,
    • "tr": 0,
    • "us": 0,
    • "w": 1920,
    • "wdr": 0
    }

    Preset

    icon
    integer (EnumPresetIcon)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 1000 1001
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_ICON_VIDEO
    1PRESET_ICON_ACTIVITY
    2PRESET_ICON_CINEMATIC
    3PRESET_ICON_PHOTO
    4PRESET_ICON_LIVE_BURST
    5PRESET_ICON_BURST
    6PRESET_ICON_PHOTO_NIGHT
    7PRESET_ICON_TIMEWARP
    8PRESET_ICON_TIMELAPSE
    9PRESET_ICON_NIGHTLAPSE
    10PRESET_ICON_SNAIL
    11PRESET_ICON_VIDEO_2
    13PRESET_ICON_PHOTO_2
    14PRESET_ICON_PANORAMA
    15PRESET_ICON_BURST_2
    16PRESET_ICON_TIMEWARP_2
    17PRESET_ICON_TIMELAPSE_2
    18PRESET_ICON_CUSTOM
    19PRESET_ICON_AIR
    20PRESET_ICON_BIKE
    21PRESET_ICON_EPIC
    22PRESET_ICON_INDOOR
    23PRESET_ICON_MOTOR
    24PRESET_ICON_MOUNTED
    25PRESET_ICON_OUTDOOR
    26PRESET_ICON_POV
    27PRESET_ICON_SELFIE
    28PRESET_ICON_SKATE
    29PRESET_ICON_SNOW
    30PRESET_ICON_TRAIL
    31PRESET_ICON_TRAVEL
    32PRESET_ICON_WATER
    33PRESET_ICON_LOOPING
    58PRESET_ICON_BASIC
    59PRESET_ICON_ULTRA_SLO_MO
    60PRESET_ICON_STANDARD_ENDURANCE
    61PRESET_ICON_ACTIVITY_ENDURANCE
    62PRESET_ICON_CINEMATIC_ENDURANCE
    63PRESET_ICON_SLOMO_ENDURANCE
    64PRESET_ICON_STATIONARY_1
    65PRESET_ICON_STATIONARY_2
    66PRESET_ICON_STATIONARY_3
    67PRESET_ICON_STATIONARY_4
    70PRESET_ICON_SIMPLE_SUPER_PHOTO
    71PRESET_ICON_SIMPLE_NIGHT_PHOTO
    73PRESET_ICON_HIGHEST_QUALITY_VIDEO
    74PRESET_ICON_STANDARD_QUALITY_VIDEO
    75PRESET_ICON_BASIC_QUALITY_VIDEO
    76PRESET_ICON_STAR_TRAIL
    77PRESET_ICON_LIGHT_PAINTING
    78PRESET_ICON_LIGHT_TRAIL
    79PRESET_ICON_FULL_FRAME
    1000PRESET_ICON_TIMELAPSE_PHOTO
    1001PRESET_ICON_NIGHTLAPSE_PHOTO
    +
    id
    integer <int32>

    Unique preset identifier

    +
    is_fixed
    boolean

    Is this preset mutable?

    +
    is_modified
    boolean

    Has the preset been modified from the factory defaults?

    +
    mode
    integer (EnumFlatMode)
    Enum: -1 4 5 12 13 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    -1FLAT_MODE_UNKNOWN
    4FLAT_MODE_PLAYBACK
    5FLAT_MODE_SETUP
    12FLAT_MODE_VIDEO
    13FLAT_MODE_TIME_LAPSE_VIDEO
    15FLAT_MODE_LOOPING
    16FLAT_MODE_PHOTO_SINGLE
    17FLAT_MODE_PHOTO
    18FLAT_MODE_PHOTO_NIGHT
    19FLAT_MODE_PHOTO_BURST
    20FLAT_MODE_TIME_LAPSE_PHOTO
    21FLAT_MODE_NIGHT_LAPSE_PHOTO
    22FLAT_MODE_BROADCAST_RECORD
    23FLAT_MODE_BROADCAST_BROADCAST
    24FLAT_MODE_TIME_WARP_VIDEO
    25FLAT_MODE_LIVE_BURST
    26FLAT_MODE_NIGHT_LAPSE_VIDEO
    27FLAT_MODE_SLOMO
    28FLAT_MODE_IDLE
    29FLAT_MODE_VIDEO_STAR_TRAIL
    30FLAT_MODE_VIDEO_LIGHT_PAINTING
    31FLAT_MODE_VIDEO_LIGHT_TRAIL
    +
    Array of objects (PresetSetting)
    Array
    id
    integer <int32>

    Setting identifier

    +
    is_caption
    boolean

    Does this setting appear on the Preset "pill" in the camera UI?

    +
    value
    integer <int32>

    Setting value

    +
    title_id
    integer (EnumPresetTitle)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 16 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 82 83 93 94
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_TITLE_ACTIVITY
    1PRESET_TITLE_STANDARD
    2PRESET_TITLE_CINEMATIC
    3PRESET_TITLE_PHOTO
    4PRESET_TITLE_LIVE_BURST
    5PRESET_TITLE_BURST
    6PRESET_TITLE_NIGHT
    7PRESET_TITLE_TIME_WARP
    8PRESET_TITLE_TIME_LAPSE
    9PRESET_TITLE_NIGHT_LAPSE
    10PRESET_TITLE_VIDEO
    11PRESET_TITLE_SLOMO
    13PRESET_TITLE_PHOTO_2
    14PRESET_TITLE_PANORAMA
    16PRESET_TITLE_TIME_WARP_2
    18PRESET_TITLE_CUSTOM
    19PRESET_TITLE_AIR
    20PRESET_TITLE_BIKE
    21PRESET_TITLE_EPIC
    22PRESET_TITLE_INDOOR
    23PRESET_TITLE_MOTOR
    24PRESET_TITLE_MOUNTED
    25PRESET_TITLE_OUTDOOR
    26PRESET_TITLE_POV
    27PRESET_TITLE_SELFIE
    28PRESET_TITLE_SKATE
    29PRESET_TITLE_SNOW
    30PRESET_TITLE_TRAIL
    31PRESET_TITLE_TRAVEL
    32PRESET_TITLE_WATER
    33PRESET_TITLE_LOOPING
    58PRESET_TITLE_BASIC
    59PRESET_TITLE_ULTRA_SLO_MO
    60PRESET_TITLE_STANDARD_ENDURANCE
    61PRESET_TITLE_ACTIVITY_ENDURANCE
    62PRESET_TITLE_CINEMATIC_ENDURANCE
    63PRESET_TITLE_SLOMO_ENDURANCE
    64PRESET_TITLE_STATIONARY_1
    65PRESET_TITLE_STATIONARY_2
    66PRESET_TITLE_STATIONARY_3
    67PRESET_TITLE_STATIONARY_4
    68PRESET_TITLE_SIMPLE_VIDEO
    69PRESET_TITLE_SIMPLE_TIME_WARP
    70PRESET_TITLE_SIMPLE_SUPER_PHOTO
    71PRESET_TITLE_SIMPLE_NIGHT_PHOTO
    72PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE
    73PRESET_TITLE_HIGHEST_QUALITY
    74PRESET_TITLE_EXTENDED_BATTERY
    75PRESET_TITLE_LONGEST_BATTERY
    76PRESET_TITLE_STAR_TRAIL
    77PRESET_TITLE_LIGHT_PAINTING
    78PRESET_TITLE_LIGHT_TRAIL
    79PRESET_TITLE_FULL_FRAME
    82PRESET_TITLE_STANDARD_QUALITY_VIDEO
    83PRESET_TITLE_BASIC_QUALITY_VIDEO
    93PRESET_TITLE_HIGHEST_QUALITY_VIDEO
    94PRESET_TITLE_USER_DEFINED_CUSTOM_NAME
    +
    title_number
    integer <int32>

    Preset title number

    +
    user_defined
    boolean

    Is this preset user defined?

    +
    {
    • "icon": 0,
    • "id": 0,
    • "is_fixed": true,
    • "is_modified": true,
    • "mode": -1,
    • "setting_array": [
      ],
    • "title_id": 0,
    • "title_number": 0,
    • "user_defined": true
    }

    PresetGroup

    can_add_preset
    boolean

    Is there room in the group to add additional Presets?

    +
    icon
    integer (EnumPresetGroupIcon)
    Enum: 0 1 2 3 4 5 6 7
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_GROUP_VIDEO_ICON_ID
    1PRESET_GROUP_PHOTO_ICON_ID
    2PRESET_GROUP_TIMELAPSE_ICON_ID
    3PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID
    4PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID
    5PRESET_GROUP_MAX_VIDEO_ICON_ID
    6PRESET_GROUP_MAX_PHOTO_ICON_ID
    7PRESET_GROUP_MAX_TIMELAPSE_ICON_ID
    +
    id
    integer (EnumPresetGroup)
    Enum: 1000 1001 1002
    + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    1000PRESET_GROUP_ID_VIDEO
    1001PRESET_GROUP_ID_PHOTO
    1002PRESET_GROUP_ID_TIMELAPSE
    +
    Array of objects (Preset)

    Array of Presets contained in this Preset Group

    +
    Array
    icon
    integer (EnumPresetIcon)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 1000 1001
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_ICON_VIDEO
    1PRESET_ICON_ACTIVITY
    2PRESET_ICON_CINEMATIC
    3PRESET_ICON_PHOTO
    4PRESET_ICON_LIVE_BURST
    5PRESET_ICON_BURST
    6PRESET_ICON_PHOTO_NIGHT
    7PRESET_ICON_TIMEWARP
    8PRESET_ICON_TIMELAPSE
    9PRESET_ICON_NIGHTLAPSE
    10PRESET_ICON_SNAIL
    11PRESET_ICON_VIDEO_2
    13PRESET_ICON_PHOTO_2
    14PRESET_ICON_PANORAMA
    15PRESET_ICON_BURST_2
    16PRESET_ICON_TIMEWARP_2
    17PRESET_ICON_TIMELAPSE_2
    18PRESET_ICON_CUSTOM
    19PRESET_ICON_AIR
    20PRESET_ICON_BIKE
    21PRESET_ICON_EPIC
    22PRESET_ICON_INDOOR
    23PRESET_ICON_MOTOR
    24PRESET_ICON_MOUNTED
    25PRESET_ICON_OUTDOOR
    26PRESET_ICON_POV
    27PRESET_ICON_SELFIE
    28PRESET_ICON_SKATE
    29PRESET_ICON_SNOW
    30PRESET_ICON_TRAIL
    31PRESET_ICON_TRAVEL
    32PRESET_ICON_WATER
    33PRESET_ICON_LOOPING
    58PRESET_ICON_BASIC
    59PRESET_ICON_ULTRA_SLO_MO
    60PRESET_ICON_STANDARD_ENDURANCE
    61PRESET_ICON_ACTIVITY_ENDURANCE
    62PRESET_ICON_CINEMATIC_ENDURANCE
    63PRESET_ICON_SLOMO_ENDURANCE
    64PRESET_ICON_STATIONARY_1
    65PRESET_ICON_STATIONARY_2
    66PRESET_ICON_STATIONARY_3
    67PRESET_ICON_STATIONARY_4
    70PRESET_ICON_SIMPLE_SUPER_PHOTO
    71PRESET_ICON_SIMPLE_NIGHT_PHOTO
    73PRESET_ICON_HIGHEST_QUALITY_VIDEO
    74PRESET_ICON_STANDARD_QUALITY_VIDEO
    75PRESET_ICON_BASIC_QUALITY_VIDEO
    76PRESET_ICON_STAR_TRAIL
    77PRESET_ICON_LIGHT_PAINTING
    78PRESET_ICON_LIGHT_TRAIL
    79PRESET_ICON_FULL_FRAME
    1000PRESET_ICON_TIMELAPSE_PHOTO
    1001PRESET_ICON_NIGHTLAPSE_PHOTO
    +
    id
    integer <int32>

    Unique preset identifier

    +
    is_fixed
    boolean

    Is this preset mutable?

    +
    is_modified
    boolean

    Has the preset been modified from the factory defaults?

    +
    mode
    integer (EnumFlatMode)
    Enum: -1 4 5 12 13 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    -1FLAT_MODE_UNKNOWN
    4FLAT_MODE_PLAYBACK
    5FLAT_MODE_SETUP
    12FLAT_MODE_VIDEO
    13FLAT_MODE_TIME_LAPSE_VIDEO
    15FLAT_MODE_LOOPING
    16FLAT_MODE_PHOTO_SINGLE
    17FLAT_MODE_PHOTO
    18FLAT_MODE_PHOTO_NIGHT
    19FLAT_MODE_PHOTO_BURST
    20FLAT_MODE_TIME_LAPSE_PHOTO
    21FLAT_MODE_NIGHT_LAPSE_PHOTO
    22FLAT_MODE_BROADCAST_RECORD
    23FLAT_MODE_BROADCAST_BROADCAST
    24FLAT_MODE_TIME_WARP_VIDEO
    25FLAT_MODE_LIVE_BURST
    26FLAT_MODE_NIGHT_LAPSE_VIDEO
    27FLAT_MODE_SLOMO
    28FLAT_MODE_IDLE
    29FLAT_MODE_VIDEO_STAR_TRAIL
    30FLAT_MODE_VIDEO_LIGHT_PAINTING
    31FLAT_MODE_VIDEO_LIGHT_TRAIL
    +
    Array of objects (PresetSetting)
    Array
    id
    integer <int32>

    Setting identifier

    +
    is_caption
    boolean

    Does this setting appear on the Preset "pill" in the camera UI?

    +
    value
    integer <int32>

    Setting value

    +
    title_id
    integer (EnumPresetTitle)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 16 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 82 83 93 94
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_TITLE_ACTIVITY
    1PRESET_TITLE_STANDARD
    2PRESET_TITLE_CINEMATIC
    3PRESET_TITLE_PHOTO
    4PRESET_TITLE_LIVE_BURST
    5PRESET_TITLE_BURST
    6PRESET_TITLE_NIGHT
    7PRESET_TITLE_TIME_WARP
    8PRESET_TITLE_TIME_LAPSE
    9PRESET_TITLE_NIGHT_LAPSE
    10PRESET_TITLE_VIDEO
    11PRESET_TITLE_SLOMO
    13PRESET_TITLE_PHOTO_2
    14PRESET_TITLE_PANORAMA
    16PRESET_TITLE_TIME_WARP_2
    18PRESET_TITLE_CUSTOM
    19PRESET_TITLE_AIR
    20PRESET_TITLE_BIKE
    21PRESET_TITLE_EPIC
    22PRESET_TITLE_INDOOR
    23PRESET_TITLE_MOTOR
    24PRESET_TITLE_MOUNTED
    25PRESET_TITLE_OUTDOOR
    26PRESET_TITLE_POV
    27PRESET_TITLE_SELFIE
    28PRESET_TITLE_SKATE
    29PRESET_TITLE_SNOW
    30PRESET_TITLE_TRAIL
    31PRESET_TITLE_TRAVEL
    32PRESET_TITLE_WATER
    33PRESET_TITLE_LOOPING
    58PRESET_TITLE_BASIC
    59PRESET_TITLE_ULTRA_SLO_MO
    60PRESET_TITLE_STANDARD_ENDURANCE
    61PRESET_TITLE_ACTIVITY_ENDURANCE
    62PRESET_TITLE_CINEMATIC_ENDURANCE
    63PRESET_TITLE_SLOMO_ENDURANCE
    64PRESET_TITLE_STATIONARY_1
    65PRESET_TITLE_STATIONARY_2
    66PRESET_TITLE_STATIONARY_3
    67PRESET_TITLE_STATIONARY_4
    68PRESET_TITLE_SIMPLE_VIDEO
    69PRESET_TITLE_SIMPLE_TIME_WARP
    70PRESET_TITLE_SIMPLE_SUPER_PHOTO
    71PRESET_TITLE_SIMPLE_NIGHT_PHOTO
    72PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE
    73PRESET_TITLE_HIGHEST_QUALITY
    74PRESET_TITLE_EXTENDED_BATTERY
    75PRESET_TITLE_LONGEST_BATTERY
    76PRESET_TITLE_STAR_TRAIL
    77PRESET_TITLE_LIGHT_PAINTING
    78PRESET_TITLE_LIGHT_TRAIL
    79PRESET_TITLE_FULL_FRAME
    82PRESET_TITLE_STANDARD_QUALITY_VIDEO
    83PRESET_TITLE_BASIC_QUALITY_VIDEO
    93PRESET_TITLE_HIGHEST_QUALITY_VIDEO
    94PRESET_TITLE_USER_DEFINED_CUSTOM_NAME
    +
    title_number
    integer <int32>

    Preset title number

    +
    user_defined
    boolean

    Is this preset user defined?

    +
    {
    • "can_add_preset": true,
    • "icon": 0,
    • "id": 1000,
    • "preset_array": [
      ]
    }

    PresetSetting

    id
    integer <int32>

    Setting identifier

    +
    is_caption
    boolean

    Does this setting appear on the Preset "pill" in the camera UI?

    +
    value
    integer <int32>

    Setting value

    +
    {
    • "id": 0,
    • "is_caption": true,
    • "value": 0
    }

    SingleMediaListItem

    cre
    required
    integer
    Example: "1696600109"

    Creation time in seconds since epoch

    +
    glrv
    integer
    Example: "817767"

    Low resolution video size

    +
    ls
    integer
    Example: "-1"

    Low resolution file size. -1 if there is no LRV file

    +
    mod
    required
    integer
    Example: "1696600109"

    Time file was last modified in seconds since epoch

    +
    n
    required
    string
    Example: "GOPR0001.JPG"

    Media filename

    +
    s
    required
    integer
    Example: "2806303"

    Size of media in bytes

    +
    {
    • "cre": 1696600109,
    • "glrv": 817767,
    • "ls": -1,
    • "mod": 1696600109,
    • "n": "GOPR0001.JPG",
    • "s": 2806303
    }

    State

    object

    All currently known setting values indexed by setting ID

    +
    2
    integer
    Enum: 1 4 6 7 9 18 24 25 26 27 28 100 107 108 109 110 111

    Video Resolution

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    1Video Resolution 4KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Resolution 2 7KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Video Resolution 2 7K 4By3HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    7Video Resolution 1440HERO9 Black
    9Video Resolution 1080HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    18Video Resolution 4K 4By3HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    24Video Resolution 5KHERO9 Black
    25Video Resolution 5K 4By3HERO10 Black
    26Video Resolution 5 3K 8By7HERO11 Black Mini, HERO11 Black
    27Video Resolution 5 3K 4By3HERO11 Black Mini, HERO11 Black
    28Video Resolution 4K 8By7HERO11 Black Mini, HERO11 Black
    100Video Resolution 5 3KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black
    107Video Resolution 5 3K 8By7 V2HERO12 Black
    108Video Resolution 4K 8By7 V2HERO12 Black
    109Video Resolution 4K 9By16 V2HERO12 Black
    110Video Resolution 1080 9By16 V2HERO12 Black
    111Video Resolution 2 7K 4By3 V2HERO12 Black
    +
    3
    integer
    Enum: 0 1 2 5 6 8 9 10 13

    Video Fps

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Fps 240HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Video Fps 120HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Video Fps 100HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    5Video Fps 60HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Video Fps 50HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    8Video Fps 30HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    9Video Fps 25HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    10Video Fps 24HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    13Video Fps 200HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    43
    integer
    Enum: 0 2 3 4

    Broadcast Fov

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Broadcast Fov WideHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Broadcast Fov NarrowHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    3Broadcast Fov SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Broadcast Fov LinearHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    59
    integer
    Enum: 0 1 4 6 7 11 12

    Setup Auto Power Down

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Setup Auto Power Down NeverHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Setup Auto Power Down 1 MinHERO12 Black, HERO11 Black Mini, HERO11 Black
    4Setup Auto Power Down 5 MinHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Setup Auto Power Down 15 MinHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    7Setup Auto Power Down 30 MinHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    11Setup Auto Power Down 8 SecondsHERO11 Black Mini
    12Setup Auto Power Down 30 SecondsHERO11 Black Mini
    +
    108
    integer
    Enum: 0 1 3 4

    Video Aspect Ratio

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Aspect Ratio 4By3HERO12 Black
    1Video Aspect Ratio 16By9HERO12 Black
    3Video Aspect Ratio 8By7HERO12 Black
    4Video Aspect Ratio 9By16HERO12 Black
    +
    121
    integer
    Enum: 0 2 3 4 7 8 9 10 11

    Video Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Digital Lenses WideHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Video Digital Lenses NarrowHERO10 Black, HERO9 Black
    3Video Digital Lenses SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Digital Lenses LinearHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    7Video Digital Lenses Max SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    8Video Digital Lenses Linear Plus Horizon LevelingHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    9Video Digital Lenses HyperviewHERO12 Black, HERO11 Black Mini, HERO11 Black
    10Video Digital Lenses Linear Plus Horizon LockHERO12 Black, HERO11 Black Mini, HERO11 Black
    11Video Digital Lenses Max HyperviewHERO12 Black
    +
    122
    integer
    Enum: 19 100 101 102

    Photo Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    19Photo Digital Lenses NarrowHERO10 Black, HERO9 Black
    100Photo Digital Lenses Max SuperviewHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    101Photo Digital Lenses WideHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    102Photo Digital Lenses LinearHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    123
    integer
    Enum: 19 100 101 102

    Multi Shot Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    19Multi Shot Digital Lenses NarrowHERO10 Black, HERO9 Black
    100Multi Shot Digital Lenses Max SuperviewHERO10 Black
    101Multi Shot Digital Lenses WideHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    102Multi Shot Digital Lenses LinearHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    128
    integer
    Enum: 13 20 21 26

    General Format

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    13General Format Time Lapse VideoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    20General Format Time Lapse PhotoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    21General Format Night Lapse PhotoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    26General Format Night Lapse VideoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    134
    integer
    Enum: 2 3

    Setup Anti Flicker

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    2Setup Anti Flicker 60 HzHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    3Setup Anti Flicker 50 HzHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    135
    integer
    Enum: 0 1 2 3 4 100

    Video Hypersmooth

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Hypersmooth OffHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Video Hypersmooth OnHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO9 Black
    2Video Hypersmooth HighHERO10 Black, HERO9 Black
    3Video Hypersmooth BoostHERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Hypersmooth Auto BoostHERO12 Black, HERO11 Black Mini, HERO11 Black
    100Video Hypersmooth StandardHERO10 Black
    +
    150
    integer
    Enum: 0 2

    Video Horizon Levelling

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Horizon Levelling OffHERO11 Black
    2Video Horizon Levelling LockedHERO11 Black
    +
    151
    integer
    Enum: 0 2

    Photo Horizon Levelling

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Horizon Levelling OffHERO11 Black
    2Photo Horizon Levelling LockedHERO11 Black
    +
    162
    integer
    Enum: 0 1

    Mods Max Lens Enable

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Mods Max Lens Enable OffHERO11 Black, HERO10 Black, HERO9 Black
    1Mods Max Lens Enable OnHERO11 Black, HERO10 Black, HERO9 Black
    +
    167
    integer
    Enum: 2 3 4

    Video Hindsight Length

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    2Video Hindsight Length 15 SecondsHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    3Video Hindsight Length 30 SecondsHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Hindsight Length OffHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    171
    integer
    Enum: 0 2 3 4 5 6 7 8 9 10

    Photo Single Interval

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Single Interval OffHERO12 Black
    2Photo Single Interval 0 5 SecondsHERO12 Black
    3Photo Single Interval 1 SecondHERO12 Black
    4Photo Single Interval 2 SecondsHERO12 Black
    5Photo Single Interval 5 SecondsHERO12 Black
    6Photo Single Interval 10 SecondsHERO12 Black
    7Photo Single Interval 30 SecondsHERO12 Black
    8Photo Single Interval 60 SecondsHERO12 Black
    9Photo Single Interval 120 SecondsHERO12 Black
    10Photo Single Interval 3 SecondsHERO12 Black
    +
    172
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9

    Photo Interval Duration

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Interval Duration OffHERO12 Black
    1Photo Interval Duration 15 SecondsHERO12 Black
    2Photo Interval Duration 30 SecondsHERO12 Black
    3Photo Interval Duration 1 MinuteHERO12 Black
    4Photo Interval Duration 5 MinutesHERO12 Black
    5Photo Interval Duration 15 MinutesHERO12 Black
    6Photo Interval Duration 30 MinutesHERO12 Black
    7Photo Interval Duration 1 HourHERO12 Black
    8Photo Interval Duration 2 HoursHERO12 Black
    9Photo Interval Duration 3 HoursHERO12 Black
    +
    173
    integer
    Enum: 0 1 2

    System Power Profile

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Power Profile Maximum Video PerformanceHERO10 Black
    1System Power Profile Extended BatteryHERO10 Black
    2System Power Profile Tripod Stationary VideoHERO10 Black
    +
    175
    integer
    Enum: 0 1

    Setup Camera Ux Mode

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Setup Camera Ux Mode EasyHERO12 Black, HERO11 Black
    1Setup Camera Ux Mode ProHERO12 Black, HERO11 Black
    +
    176
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

    Video Easy Mode Speed

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Mode Speed 8X Ultra Slo MoHERO11 Black
    1Video Easy Mode Speed 4X Super Slo MoHERO11 Black
    2Video Easy Mode Speed 2X Slo MoHERO11 Black
    3Video Easy Mode Speed 1X Speed Low LightHERO11 Black
    4Video Easy Mode Speed Eb 4X Super Slo MoHERO11 Black
    5Video Easy Mode Speed Eb 2X Slo MoHERO11 Black
    6Video Easy Mode Speed Eb 1X Speed Low LightHERO11 Black
    7Video Easy Mode Speed 8X Ultra Slo Mo 50HzHERO11 Black
    8Video Easy Mode Speed 4X Super Slo Mo 50HzHERO11 Black
    9Video Easy Mode Speed 2X Slo Mo 50HzHERO11 Black
    10Video Easy Mode Speed 1X Speed Low Light 50HzHERO11 Black
    11Video Easy Mode Speed Eb 4X Super Slo Mo 50HzHERO11 Black
    12Video Easy Mode Speed Eb 2X Slo Mo 50HzHERO11 Black
    13Video Easy Mode Speed Eb 1X Speed Low Light 50HzHERO11 Black
    14Video Easy Mode Speed Eb 8X Ultra Slo MoHERO11 Black
    15Video Easy Mode Speed Eb 8X Ultra Slo Mo 50HzHERO11 Black
    16Video Easy Mode Speed Lb 8X Ultra Slo MoHERO11 Black
    17Video Easy Mode Speed Lb 4X Super Slo MoHERO11 Black
    18Video Easy Mode Speed Lb 2X Slo MoHERO11 Black
    19Video Easy Mode Speed Lb 1X Speed Low LightHERO11 Black
    20Video Easy Mode Speed Lb 8X Ultra Slo Mo 50HzHERO11 Black
    21Video Easy Mode Speed Lb 4X Super Slo Mo 50HzHERO11 Black
    22Video Easy Mode Speed Lb 2X Slo Mo 50HzHERO11 Black
    23Video Easy Mode Speed Lb 1X Speed Low Light 50HzHERO11 Black
    24Video Easy Mode Speed 2X Slo Mo 4KHERO11 Black
    25Video Easy Mode Speed 4X Super Slo Mo 2 7KHERO11 Black
    26Video Easy Mode Speed 2X Slo Mo 4K 50HzHERO11 Black
    27Video Easy Mode Speed 4X Super Slo Mo 2 7K 50HzHERO11 Black
    100Video Easy Mode Speed 8X Ultra Slo Mo V2HERO12 Black
    101Video Easy Mode Speed 4X Super Slo Mo V2HERO12 Black
    102Video Easy Mode Speed 2X Slo Mo V2HERO12 Black
    103Video Easy Mode Speed 1X Speed Low Light V2HERO12 Black
    104Video Easy Mode Speed 8X Ultra Slo Mo 50Hz V2HERO12 Black
    105Video Easy Mode Speed 4X Super Slo Mo 50Hz V2HERO12 Black
    106Video Easy Mode Speed 2X Slo Mo 50Hz V2HERO12 Black
    107Video Easy Mode Speed 1X Speed Low Light 50Hz V2HERO12 Black
    108Video Easy Mode Speed Lb 8X Ultra Slo Mo V2HERO12 Black
    109Video Easy Mode Speed Lb 4X Super Slo Mo V2HERO12 Black
    110Video Easy Mode Speed Lb 2X Slo Mo V2HERO12 Black
    111Video Easy Mode Speed Lb 1X Speed Low Light V2HERO12 Black
    112Video Easy Mode Speed Lb 8X Ultra Slo Mo 50Hz V2HERO12 Black
    113Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz V2HERO12 Black
    114Video Easy Mode Speed Lb 2X Slo Mo 50Hz V2HERO12 Black
    115Video Easy Mode Speed Lb 1X Speed Low Light 50Hz V2HERO12 Black
    116Video Easy Mode Speed 2X Slo Mo 4K V2HERO12 Black
    117Video Easy Mode Speed 2X Slo Mo 4K 50Hz V2HERO12 Black
    118Video Easy Mode Speed Mobile 1X Speed Low Light V2HERO12 Black
    119Video Easy Mode Speed Mobile 1X Speed Low Light 50Hz V2HERO12 Black
    120Video Easy Mode Speed Mobile 2X Slo Mo V2HERO12 Black
    121Video Easy Mode Speed Mobile 2X Slo Mo 50Hz V2HERO12 Black
    122Video Easy Mode Speed Universal 1X Speed Low Light V2HERO12 Black
    123Video Easy Mode Speed Universal 1X Speed Low Light 50Hz V2HERO12 Black
    124Video Easy Mode Speed Universal 2X Slo Mo V2HERO12 Black
    125Video Easy Mode Speed Universal 2X Slo Mo 50Hz V2HERO12 Black
    126Video Easy Mode Speed 1X Speed Low Light 4K V2HERO12 Black
    127Video Easy Mode Speed 1X Speed Low Light 4K 50Hz V2HERO12 Black
    128Video Easy Mode Speed 1X Speed Low Light 2 7K V2HERO12 Black
    129Video Easy Mode Speed 1X Speed Low Light 2 7K 50Hz V2HERO12 Black
    130Video Easy Mode Speed 2X Slo Mo 2 7K V2HERO12 Black
    131Video Easy Mode Speed 2X Slo Mo 2 7K 50Hz V2HERO12 Black
    132Video Easy Mode Speed Mobile Lb 2X Slo Mo V2HERO12 Black
    133Video Easy Mode Speed Mobile Lb 2X Slo Mo 50Hz V2HERO12 Black
    134Video Easy Mode Speed Mobile Lb 1X Speed Low Light V2HERO12 Black
    135Video Easy Mode Speed Mobile Lb 1X Speed Low Light 50Hz V2HERO12 Black
    136Video Easy Mode Speed Universal 1X Speed Low Light 4K V2HERO12 Black
    137Video Easy Mode Speed Universal 1X Speed Low Light 4K 50Hz V2HERO12 Black
    +
    177
    integer
    Enum: 0 1

    Photo Easy Mode Night Photo

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Easy Mode Night Photo OffHERO11 Black
    1Photo Easy Mode Night Photo OnHERO11 Black
    +
    178
    integer
    Enum: 0 1

    Wireless Wireless Band

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Wireless Wireless Band 2 4 GhzHERO12 Black, HERO11 Black Mini, HERO11 Black
    1Wireless Wireless Band 5 GhzHERO12 Black, HERO11 Black Mini, HERO11 Black
    +
    179
    integer
    Enum: 1 2 3

    Multi Shot Trail Length

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    1Multi Shot Trail Length ShortHERO12 Black, HERO11 Black Mini, HERO11 Black
    2Multi Shot Trail Length LongHERO12 Black, HERO11 Black Mini, HERO11 Black
    3Multi Shot Trail Length MaxHERO12 Black, HERO11 Black Mini, HERO11 Black
    +
    180
    integer
    Enum: 0 101 102

    System Video Mode

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Mode Highest QualityHERO11 Black
    101System Video Mode Extended Battery GreenHERO11 Black
    102System Video Mode Longest Battery GreenHERO11 Black
    +
    182
    integer
    Enum: 0 1

    System Video Bit Rate

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Bit Rate StandardHERO12 Black
    1System Video Bit Rate HighHERO12 Black
    +
    183
    integer
    Enum: 0 2

    System Video Bit Depth

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Bit Depth 8BitHERO12 Black
    2System Video Bit Depth 10BitHERO12 Black
    +
    184
    integer
    Enum: 0 1 2

    Video Profile

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Profile StandardHERO12 Black
    1Video Profile HdrHERO12 Black
    2Video Profile 10 Bit LogHERO12 Black
    +
    186
    integer
    Enum: 0 1 2

    Video Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Presets Highest QualityHERO12 Black
    1Video Easy Presets Standard QualityHERO12 Black
    2Video Easy Presets Basic QualityHERO12 Black
    +
    187
    integer
    Enum: 0 1 2 3 4 5 6 7

    Multi Shot Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Multi Shot Easy Presets Lapse Mode Time WarpHERO12 Black
    1Multi Shot Easy Presets Lapse Mode Star TrailsHERO12 Black
    2Multi Shot Easy Presets Lapse Mode Light PaintingHERO12 Black
    3Multi Shot Easy Presets Lapse Mode Vehicle LightsHERO12 Black
    4Multi Shot Easy Presets Max Lapse Mode Time WarpHERO12 Black
    5Multi Shot Easy Presets Max Lapse Mode Star TrailsHERO12 Black
    6Multi Shot Easy Presets Max Lapse Mode Light PaintingHERO12 Black
    7Multi Shot Easy Presets Max Lapse Mode Vehicle LightsHERO12 Black
    +
    189
    integer
    Enum: 0 1 2

    System Addon Lens Active

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Addon Lens Active NoneHERO12 Black
    1System Addon Lens Active Max Lens 1 0HERO12 Black
    2System Addon Lens Active Max Lens 2 0HERO12 Black
    +
    190
    integer
    Enum: 0 1

    System Addon Lens Status

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Addon Lens Status OffHERO12 Black
    1System Addon Lens Status OnHERO12 Black
    +
    191
    integer
    Enum: 0 1

    Photo Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Easy Presets Super PhotoHERO12 Black
    1Photo Easy Presets Night PhotoHERO12 Black
    +
    192
    integer
    Enum: 0 1 3

    Multi Shot Nlv Aspect Ratio

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Multi Shot Nlv Aspect Ratio 4By3HERO12 Black
    1Multi Shot Nlv Aspect Ratio 16By9HERO12 Black
    3Multi Shot Nlv Aspect Ratio 8By7HERO12 Black
    +
    193
    integer
    Enum: 0 1 2

    Video Easy Framing

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Framing WidescreenHERO12 Black
    1Video Easy Framing VerticalHERO12 Black
    2Video Easy Framing Full FrameHERO12 Black
    +
    object

    All currently known status values indexed by status ID

    +
    1
    integer
    Enum: 0 1

    Is the system's internal battery present?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    2
    integer
    Enum: 0 1 2 3

    Rough approximation of internal battery level in bars

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Zero
    1One
    2Two
    3Three
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    6
    integer
    Enum: 0 1

    Is the system currently overheating?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    8
    integer
    Enum: 0 1

    Is the camera busy?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    9
    integer
    Enum: 0 1

    Is Quick Capture feature enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    10
    integer
    Enum: 0 1

    Is the system encoding right now?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    11
    integer
    Enum: 0 1

    Is LCD lock active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    13
    integer

    When encoding video, this is the duration (seconds) of the video so far; 0 otherwise

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    17
    integer
    Enum: 0 1

    Are Wireless Connections enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    19
    integer
    Enum: 0 1 2 3 4

    The pairing state of the camera

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never Started
    1Started
    2Aborted
    3Cancelled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    20
    integer
    Enum: 0 1 2 3

    The last type of pairing that the camera was engaged in

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Not Pairing
    1Pairing App
    2Pairing Remote Control
    3Pairing Bluetooth Device
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    21
    integer

    Time (milliseconds) since boot of last successful pairing complete action

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    22
    integer
    Enum: 0 1 2 3 4

    State of current scan for WiFi Access Points. Appears to only change for CAH-related scans

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never started
    1Started
    2Aborted
    3Canceled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    23
    integer

    The time, in milliseconds since boot that the WiFi Access Point scan completed

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    24
    integer
    Enum: 0 1 2 3 4

    WiFi AP provisioning state

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never started
    1Started
    2Aborted
    3Canceled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    26
    integer

    Wireless remote control version

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    27
    integer
    Enum: 0 1

    Is a wireless remote control connected?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    28
    integer

    Wireless Pairing State. Each bit contains state information (see WirelessPairingStateFlags)

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    29
    string

    Provisioned WIFI AP SSID. On BLE connection, value is big-endian byte-encoded int

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    30
    string

    Camera's WIFI SSID. On BLE connection, value is big-endian byte-encoded int

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    31
    integer

    The number of wireless devices connected to the camera

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    32
    integer
    Enum: 0 1

    Is Preview Stream enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    33
    integer
    Enum: -1 0 1 2 3 4 8

    Primary Storage Status

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    -1Unknown
    0OK
    1SD Card Full
    2SD Card Removed
    3SD Card Format Error
    4SD Card Busy
    8SD Card Swapped
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    34
    integer

    How many photos can be taken before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    35
    integer

    How many minutes of video can be captured with current settings before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    38
    integer

    Total number of photos on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    39
    integer

    Total number of videos on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    41
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10

    The current status of Over The Air (OTA) update

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Idle
    1Downloading
    2Verifying
    3Download Failed
    4Verify Failed
    5Ready
    6GoPro App: Downloading
    7GoPro App: Verifying
    8GoPro App: Download Failed
    9GoPro App: Verify Failed
    10GoPro App: Ready
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    42
    integer
    Enum: 0 1

    Is there a pending request to cancel a firmware update download?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    45
    integer
    Enum: 0 1

    Is locate camera feature active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    49
    integer

    The current timelapse interval countdown value (e.g. 5...4...3...2...1...)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    54
    integer

    Remaining space on the sdcard in Kilobytes

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    55
    integer
    Enum: 0 1

    Is preview stream supported in current recording/mode/secondary-stream?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    56
    integer

    WiFi signal strength in bars

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    58
    integer

    The number of hilights in encoding video (set to 0 when encoding stops)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    59
    integer

    Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    60
    integer

    The min time between camera status updates (msec). Do not poll for status more often than this

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    64
    integer

    How many min of Timelapse video can be captured with current settings before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    65
    integer
    Enum: 0 1 2 3

    Liveview Exposure Select Mode

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Disabled
    1Auto
    2ISO Lock
    3Hemisphere
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    66
    integer [ 0 .. 100 ]

    Liveview Exposure Select: y-coordinate (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    67
    integer [ 0 .. 100 ]

    Liveview Exposure Select: y-coordinate (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    68
    integer
    Enum: 0 1

    Does the camera currently have a GPS lock?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    69
    integer
    Enum: 0 1

    Is the camera in AP Mode?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    70
    integer [ 0 .. 100 ]

    Internal battery level (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    74
    integer
    Enum: 0 1 2

    Microphone Accesstory (Garter) status

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Garter not connected
    1Garter connected
    2Garter connected and microphone plugged into Garter
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    75
    integer [ 0 .. 100 ]

    Digital Zoom level (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    76
    integer
    Enum: 0 1 2

    Wireless Band

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    02.4 GHz
    15 GHz
    2Max
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    77
    integer
    Enum: 0 1

    Is Digital Zoom feature available?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    78
    integer
    Enum: 0 1

    Are current video settings mobile friendly? (related to video compression and frame rate)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    79
    integer
    Enum: 0 1

    Is the camera currently in First Time Use (FTU) UI flow?

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    81
    integer
    Enum: 0 1

    Is 5GHz wireless band available?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    82
    integer
    Enum: 0 1

    Is the system ready to accept commands?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    83
    integer
    Enum: 0 1

    Is the internal battery charged sufficiently to start Over The Air (OTA) update?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    85
    integer
    Enum: 0 1

    Is the camera getting too cold to continue recording?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    86
    integer
    Enum: 0 1 2 3

    The rotational orientation of the camera

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    00 degrees (upright)
    1180 degrees (upside down)
    290 degrees (laying on right side)
    3270 degrees (laying on left side)
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    88
    integer
    Enum: 0 1

    Is this camera capable of zooming while encoding (static value based on model, not settings)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    89
    integer

    Current flatmode ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    93
    integer

    Current Video Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    94
    integer

    Current Photo Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    95
    integer

    Current Timelapse Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    96
    integer

    Current Preset Group (ID) (corresponds to ui_mode_groups in settings.json)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    97
    integer

    Current Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    98
    integer

    Preset Modified Status, which contains an event ID and a preset (group) ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    99
    integer

    How many Live Bursts can be captured before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    100
    integer

    Total number of Live Bursts on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    101
    integer
    Enum: 0 1

    Is Capture Delay currently active (i.e. counting down)?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    102
    integer
    Enum: 0 2 3

    Borg State

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Borg microphone removed
    2Borg microphone only
    3Borg microphone with external microphone
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    103
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12

    Time Warp Speed

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    015x
    130x
    260x
    3150x
    4300x
    5900x
    61800x
    72x
    85x
    910x
    10Auto
    111x (realtime)
    121/2x (slow-motion)
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    104
    integer
    Enum: 0 1

    Is the system's Linux core active?

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    105
    integer
    Enum: 0 1 2

    Camera lens type (reflects changes to setting 162 or setting 189)

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Default
    1Max Lens
    2Max Lens 2.0
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    106
    integer
    Enum: 0 1

    Is Video Hindsight Capture Active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    107
    integer

    Scheduled Capture Preset ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    108
    integer
    Enum: 0 1

    Is Scheduled Capture set?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    110
    integer
    Enum: 0 1 2 3 4 5 6 7

    Media Mode Status (bitmasked)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0000 = Headroom: 0, HDMI: 0, Media Mod Connected: False
    1001 = Headroom: 0, HDMI: 0, Media Mod Connected: True
    2010 = Headroom: 0, HDMI: 1, Media Mod Connected: False
    3011 = Headroom: 0, HDMI: 1, Media Mod Connected: True
    4100 = Headroom: 1, HDMI: 0, Media Mod Connected: False
    5101 = Headroom: 1, HDMI: 0, Media Mod Connected: True
    6110 = Headroom: 1, HDMI: 1, Media Mod Connected: False
    7111 = Headroom: 1, HDMI: 1, Media Mod Connected: True
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    111
    integer
    Enum: 0 1

    Does sdcard meet specified minimum write speed?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    112
    integer

    Number of sdcard write speed errors since device booted

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    113
    integer
    Enum: 0 1

    Is Turbo Transfer active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    114
    integer
    Enum: 0 1 2

    Camera control status ID

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Camera Idle: No one is attempting to change camera settings
    1Camera Control: Camera is in a menu or changing settings. To intervene, app must request control
    2Camera External Control: An outside entity (app) has control and is in a menu or modifying settings
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    115
    integer
    Enum: 0 1

    Is the camera connected to a PC via USB?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    116
    integer
    Enum: 0 1

    Camera control over USB state

    + + + + + + + + + + + + + + + +
    ValueMeaning
    0Disabled
    1Enabled
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    117
    integer

    Total SD card capacity in Kilobytes

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    +
    {
    • "settings": {
      },
    • "status": {
      }
    }

    VideoMetadata

    ao
    required
    string
    Enum: "auto" "wind" "stereo" "off"
    Example: "auto"

    Audio option

    +
    avc_profile
    required
    integer [ 0 .. 255 ]
    Example: "0"

    Advanced Video Code Profile

    +
    cl
    required
    integer
    Enum: 0 1

    1 if clipped, 0 otherwise

    +
    cre
    required
    integer
    Example: "1692992748"

    Creation time in seconds since epoch

    +
    ct
    required
    integer
    Enum: 0 1 2 3 4 5 6 8 9 10 11 12

    Media content type

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    Video0
    Looping1
    Chaptered Video2
    Time Lapse3
    Single Photo4
    Burst Photo5
    Time Lapse Photo6
    Night Lapse Photo8
    Night Photo9
    Continuous Photo10
    Raw Photo11
    Live Burst12
    +
    dur
    required
    integer
    Example: "42"

    Video duration in seconds

    +
    eis
    required
    integer
    Enum: 0 1

    1 if stabilized, 0 otherwise

    +
    fov
    string

    Field of View

    +
    fps
    required
    integer
    Example: "1001"

    Video frame rate numerator

    +
    fps_denom
    required
    integer
    Example: "30000"

    Video frame rate denominator

    +
    gumi
    required
    string
    Example: "12345678998765443211234567899875"

    Globally Unique Media ID

    +
    h
    required
    integer
    Example: "1080"

    Height of media in pixels

    +
    hc
    required
    integer [ 0 .. 99 ]

    Number of hilights in media

    +
    hi
    Array of integers
    Example: "1500,4700"

    List of hilights in ms offset from start of video

    +
    lc
    integer
    Enum: 0 1

    Lens configuration ==> 0 for front, 1 for rear

    +
    ls
    required
    integer [ -1 .. 1234567890 ]

    Low Resolution Video file size in bytes. -1 if there is no LRV file

    +
    mos
    Array of strings
    Items Enum: "app" "pc" "other"
    Example: "app,pc"

    List of offload states

    +
    mp
    required
    integer
    Enum: 0 1

    1 if metadata is present, 0 otherwise

    +
    prjn
    integer
    Enum: 0 1 2 3 4 5 6 7 8

    Lens projection

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMode
    EAC0
    ERP1
    EAC, split horizontally in the middle for 2 output2
    ERP, cropped for panorama3
    Bypass stitch algorithm, side by side circles4
    Stitch is disabled, stitch algorithm is enabled for offline stitch5
    Stitch is disabled6
    Bypass stitch algorithm for EAC split7
    Hemisheric8
    +
    profile
    required
    integer [ 0 .. 255 ]

    Advanced Video Codec Level

    +
    progr
    integer
    Enum: 0 1

    Is video progressive? 1 if progressive, 0 if interlaced

    +
    pta
    required
    integer
    Enum: 0 1

    1 if protune audio is present, 0 otherwise

    +
    rot
    required
    string

    Deprecated

    +
    s
    required
    integer
    Example: "1234567890"

    File size in bytes

    +
    subsample
    required
    integer
    Enum: 0 1

    1 if subsampled from other video, 0 otherwise

    +
    tr
    required
    integer
    Enum: 0 1

    1 if file is transcoded, 0 otherwise

    +
    us
    required
    integer
    Enum: 0 1

    Has the file been uploaded? 0 if no, 1 if yes

    +
    w
    required
    integer
    Example: "1920"

    Width of media in pixels

    +
    {
    • "ao": "auto",
    • "avc_profile": 0,
    • "cl": 0,
    • "cre": 1692992748,
    • "ct": 0,
    • "dur": 42,
    • "eis": 0,
    • "fov": "string",
    • "fps": 1001,
    • "fps_denom": 30000,
    • "gumi": "12345678998765443211234567899875",
    • "h": 1080,
    • "hc": 99,
    • "hi": [
      ],
    • "lc": 0,
    • "ls": -1,
    • "mos": [
      ],
    • "mp": 0,
    • "prjn": 0,
    • "profile": 255,
    • "progr": 0,
    • "pta": 0,
    • "rot": "string",
    • "s": 1234567890,
    • "subsample": 0,
    • "tr": 0,
    • "us": 0,
    • "w": 1920
    }

    OTA

    The Over The Air (OTA) update feature allows the user to update the camera's firmware via HTTP connection. There are +two ways to perform OTA updates: Simple OTA Update and Resumable OTA Update.

    +

    Firmware update files can be obtained from GoPro's update page or programmatically +using the firmware catalog.

    +
    +

    In order to complete the firmware update process, the camera will reboot one or more times. This will cause any +existing HTTP connections to be lost.

    +
    +

    Simple OTA Update

    The simple OTA update process is done by sending an entire update file to the camera in a single HTTP/POST. Details can +be found in the diagram below.

    +

    simple ota state diagram

    +

    Resumable OTA Update

    The resumable OTA update process involves uploading chunks (or all) of a file, marking the file complete and then telling +the camera to begin the update process. Chunks are stored until they are explicitly deleted, allowing the client to stop +and resume as needed. Details can be found in the diagram below.

    +

    simple ota state diagram

    +

    Resumable OTA Update

    Perform Resumable OTA Update

    +

    To send a portion of the OTA image as per the requestBody specification, do not use the request parameter.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    request
    string
    Enum: "delete" "showui" "start" "progress" "cancelled"

    Optional request parameter to control / query OTA functionality.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterBehavior
    deleteDelete any old / cached OTA data
    showuiDisplay the update OSD on the camera UI
    startStart updating firmware with received OTA image
    progressGet the current firmware update progress
    cancelledshow canceled/failed ui on the camera
    +
    Request Body schema: multipart/form-data

    OTA image chunk used when executed with no request parameter

    +
    file
    string <binary>

    Binary file

    +
    offset
    integer

    Offset (in bytes) into the file data to start reading from

    +
    sha1
    string

    SHA of the complete firmware upload zip file

    +

    Responses

    Response Schema: application/json
    bytes_complete
    integer
    complete
    boolean
    message
    string
    sha1
    string
    status
    integer (OtaStatus)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12

    OTA Status

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDStatusDescription
    0OKNo errors occurred
    1Unknown RequestServer did not recognize the request
    2Bad ParamsParameter values not recognized
    3SHA1 Send MismatchSHA1 for chunk did not match SHA1 of previous chunk(s)
    4SHA1 Calculated MismatchCalculated SHA1 did not match user-specified SHA1
    5HTTP Boundary ErrorHTTP Post was malformed
    6HTTP Post ErrorUnexpected HTTP / Post Content Type
    7Server BusyHTTP server is busy
    8Offset MismatchAttempt to upload chunk with offset that did not align with previous chunk
    9Bad Post DataServer failed to parse POST data
    10File IncompleteTried to start update before server finished validating .zip file
    11Update in progressFirmware update is in progress
    12Insufficient SpaceInsufficient space on the sdcard to hold decompressed update file
    +

    Response samples

    Content type
    application/json
    {
    • "bytes_complete": 0,
    • "complete": true,
    • "message": "string",
    • "sha1": "string",
    • "status": 0
    }

    Simple OTA Update


    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    Request Body schema: multipart/form-data
    DirectToSD
    integer

    Always set to 1

    +
    file
    string <binary>

    Binary file

    +
    sha1
    string

    SHA of the complete firmware upload zip file

    +
    update
    integer

    Always set to 1

    +

    Responses

    Response Schema: application/json
    status
    integer (OtaStatus)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12

    OTA Status

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDStatusDescription
    0OKNo errors occurred
    1Unknown RequestServer did not recognize the request
    2Bad ParamsParameter values not recognized
    3SHA1 Send MismatchSHA1 for chunk did not match SHA1 of previous chunk(s)
    4SHA1 Calculated MismatchCalculated SHA1 did not match user-specified SHA1
    5HTTP Boundary ErrorHTTP Post was malformed
    6HTTP Post ErrorUnexpected HTTP / Post Content Type
    7Server BusyHTTP server is busy
    8Offset MismatchAttempt to upload chunk with offset that did not align with previous chunk
    9Bad Post DataServer failed to parse POST data
    10File IncompleteTried to start update before server finished validating .zip file
    11Update in progressFirmware update is in progress
    12Insufficient SpaceInsufficient space on the sdcard to hold decompressed update file
    +

    Response samples

    Content type
    application/json
    {
    • "status": 0
    }

    Presets

    Presets

    The camera organizes modes of operation into Presets.

    +
    +

    Note: The Preset ID is required to load a Preset via Load Preset.

    +
    +

    Depending on the camera's state, different collections of presets will be available for immediate loading and use. +Below is a table of settings that affect the current preset collection and thereby which presets can be loaded:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDSetting
    162Max Lens
    173Video Performance Mode
    175Controls
    177Enable Night Photo
    180Video Mode
    186Video Mode
    187Lapse Mode
    189Max Lens Mod
    190Max Lens Mod Enable
    191Photo Mode
    +

    Preset Groups

    Presets are organized into Preset Groups.

    +

    To find the currently available Presets / Preset Groups, use Get Preset Status.

    +

    Get Available Presets

    Get the currently available Preset Groups and Presets, the set of which +depends on the current camera settings.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    Array of objects (PresetGroup)

    Array of Preset Groups

    +
    Array
    can_add_preset
    boolean

    Is there room in the group to add additional Presets?

    +
    icon
    integer (EnumPresetGroupIcon)
    Enum: 0 1 2 3 4 5 6 7
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_GROUP_VIDEO_ICON_ID
    1PRESET_GROUP_PHOTO_ICON_ID
    2PRESET_GROUP_TIMELAPSE_ICON_ID
    3PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID
    4PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID
    5PRESET_GROUP_MAX_VIDEO_ICON_ID
    6PRESET_GROUP_MAX_PHOTO_ICON_ID
    7PRESET_GROUP_MAX_TIMELAPSE_ICON_ID
    +
    id
    integer (EnumPresetGroup)
    Enum: 1000 1001 1002
    + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    1000PRESET_GROUP_ID_VIDEO
    1001PRESET_GROUP_ID_PHOTO
    1002PRESET_GROUP_ID_TIMELAPSE
    +
    Array of objects (Preset)

    Array of Presets contained in this Preset Group

    +
    Array
    icon
    integer (EnumPresetIcon)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 1000 1001
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_ICON_VIDEO
    1PRESET_ICON_ACTIVITY
    2PRESET_ICON_CINEMATIC
    3PRESET_ICON_PHOTO
    4PRESET_ICON_LIVE_BURST
    5PRESET_ICON_BURST
    6PRESET_ICON_PHOTO_NIGHT
    7PRESET_ICON_TIMEWARP
    8PRESET_ICON_TIMELAPSE
    9PRESET_ICON_NIGHTLAPSE
    10PRESET_ICON_SNAIL
    11PRESET_ICON_VIDEO_2
    13PRESET_ICON_PHOTO_2
    14PRESET_ICON_PANORAMA
    15PRESET_ICON_BURST_2
    16PRESET_ICON_TIMEWARP_2
    17PRESET_ICON_TIMELAPSE_2
    18PRESET_ICON_CUSTOM
    19PRESET_ICON_AIR
    20PRESET_ICON_BIKE
    21PRESET_ICON_EPIC
    22PRESET_ICON_INDOOR
    23PRESET_ICON_MOTOR
    24PRESET_ICON_MOUNTED
    25PRESET_ICON_OUTDOOR
    26PRESET_ICON_POV
    27PRESET_ICON_SELFIE
    28PRESET_ICON_SKATE
    29PRESET_ICON_SNOW
    30PRESET_ICON_TRAIL
    31PRESET_ICON_TRAVEL
    32PRESET_ICON_WATER
    33PRESET_ICON_LOOPING
    58PRESET_ICON_BASIC
    59PRESET_ICON_ULTRA_SLO_MO
    60PRESET_ICON_STANDARD_ENDURANCE
    61PRESET_ICON_ACTIVITY_ENDURANCE
    62PRESET_ICON_CINEMATIC_ENDURANCE
    63PRESET_ICON_SLOMO_ENDURANCE
    64PRESET_ICON_STATIONARY_1
    65PRESET_ICON_STATIONARY_2
    66PRESET_ICON_STATIONARY_3
    67PRESET_ICON_STATIONARY_4
    70PRESET_ICON_SIMPLE_SUPER_PHOTO
    71PRESET_ICON_SIMPLE_NIGHT_PHOTO
    73PRESET_ICON_HIGHEST_QUALITY_VIDEO
    74PRESET_ICON_STANDARD_QUALITY_VIDEO
    75PRESET_ICON_BASIC_QUALITY_VIDEO
    76PRESET_ICON_STAR_TRAIL
    77PRESET_ICON_LIGHT_PAINTING
    78PRESET_ICON_LIGHT_TRAIL
    79PRESET_ICON_FULL_FRAME
    1000PRESET_ICON_TIMELAPSE_PHOTO
    1001PRESET_ICON_NIGHTLAPSE_PHOTO
    +
    id
    integer <int32>

    Unique preset identifier

    +
    is_fixed
    boolean

    Is this preset mutable?

    +
    is_modified
    boolean

    Has the preset been modified from the factory defaults?

    +
    mode
    integer (EnumFlatMode)
    Enum: -1 4 5 12 13 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    -1FLAT_MODE_UNKNOWN
    4FLAT_MODE_PLAYBACK
    5FLAT_MODE_SETUP
    12FLAT_MODE_VIDEO
    13FLAT_MODE_TIME_LAPSE_VIDEO
    15FLAT_MODE_LOOPING
    16FLAT_MODE_PHOTO_SINGLE
    17FLAT_MODE_PHOTO
    18FLAT_MODE_PHOTO_NIGHT
    19FLAT_MODE_PHOTO_BURST
    20FLAT_MODE_TIME_LAPSE_PHOTO
    21FLAT_MODE_NIGHT_LAPSE_PHOTO
    22FLAT_MODE_BROADCAST_RECORD
    23FLAT_MODE_BROADCAST_BROADCAST
    24FLAT_MODE_TIME_WARP_VIDEO
    25FLAT_MODE_LIVE_BURST
    26FLAT_MODE_NIGHT_LAPSE_VIDEO
    27FLAT_MODE_SLOMO
    28FLAT_MODE_IDLE
    29FLAT_MODE_VIDEO_STAR_TRAIL
    30FLAT_MODE_VIDEO_LIGHT_PAINTING
    31FLAT_MODE_VIDEO_LIGHT_TRAIL
    +
    Array of objects (PresetSetting)
    Array
    id
    integer <int32>

    Setting identifier

    +
    is_caption
    boolean

    Does this setting appear on the Preset "pill" in the camera UI?

    +
    value
    integer <int32>

    Setting value

    +
    title_id
    integer (EnumPresetTitle)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 16 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 82 83 93 94
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_TITLE_ACTIVITY
    1PRESET_TITLE_STANDARD
    2PRESET_TITLE_CINEMATIC
    3PRESET_TITLE_PHOTO
    4PRESET_TITLE_LIVE_BURST
    5PRESET_TITLE_BURST
    6PRESET_TITLE_NIGHT
    7PRESET_TITLE_TIME_WARP
    8PRESET_TITLE_TIME_LAPSE
    9PRESET_TITLE_NIGHT_LAPSE
    10PRESET_TITLE_VIDEO
    11PRESET_TITLE_SLOMO
    13PRESET_TITLE_PHOTO_2
    14PRESET_TITLE_PANORAMA
    16PRESET_TITLE_TIME_WARP_2
    18PRESET_TITLE_CUSTOM
    19PRESET_TITLE_AIR
    20PRESET_TITLE_BIKE
    21PRESET_TITLE_EPIC
    22PRESET_TITLE_INDOOR
    23PRESET_TITLE_MOTOR
    24PRESET_TITLE_MOUNTED
    25PRESET_TITLE_OUTDOOR
    26PRESET_TITLE_POV
    27PRESET_TITLE_SELFIE
    28PRESET_TITLE_SKATE
    29PRESET_TITLE_SNOW
    30PRESET_TITLE_TRAIL
    31PRESET_TITLE_TRAVEL
    32PRESET_TITLE_WATER
    33PRESET_TITLE_LOOPING
    58PRESET_TITLE_BASIC
    59PRESET_TITLE_ULTRA_SLO_MO
    60PRESET_TITLE_STANDARD_ENDURANCE
    61PRESET_TITLE_ACTIVITY_ENDURANCE
    62PRESET_TITLE_CINEMATIC_ENDURANCE
    63PRESET_TITLE_SLOMO_ENDURANCE
    64PRESET_TITLE_STATIONARY_1
    65PRESET_TITLE_STATIONARY_2
    66PRESET_TITLE_STATIONARY_3
    67PRESET_TITLE_STATIONARY_4
    68PRESET_TITLE_SIMPLE_VIDEO
    69PRESET_TITLE_SIMPLE_TIME_WARP
    70PRESET_TITLE_SIMPLE_SUPER_PHOTO
    71PRESET_TITLE_SIMPLE_NIGHT_PHOTO
    72PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE
    73PRESET_TITLE_HIGHEST_QUALITY
    74PRESET_TITLE_EXTENDED_BATTERY
    75PRESET_TITLE_LONGEST_BATTERY
    76PRESET_TITLE_STAR_TRAIL
    77PRESET_TITLE_LIGHT_PAINTING
    78PRESET_TITLE_LIGHT_TRAIL
    79PRESET_TITLE_FULL_FRAME
    82PRESET_TITLE_STANDARD_QUALITY_VIDEO
    83PRESET_TITLE_BASIC_QUALITY_VIDEO
    93PRESET_TITLE_HIGHEST_QUALITY_VIDEO
    94PRESET_TITLE_USER_DEFINED_CUSTOM_NAME
    +
    title_number
    integer <int32>

    Preset title number

    +
    user_defined
    boolean

    Is this preset user defined?

    +

    Response samples

    Content type
    application/json
    {
    • "presetGroupArray": [
      ]
    }

    Load Preset by ID

    Preset ID's are not constant and must be retrieved via Get Preset Status

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    id
    integer

    Preset to load

    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Load Preset Group by ID


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    id
    integer (EnumPresetGroup)
    Enum: 1000 1001 1002
    + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    1000PRESET_GROUP_ID_VIDEO
    1001PRESET_GROUP_ID_PHOTO
    1002PRESET_GROUP_ID_TIMELAPSE
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Update Custom Preset

    This only operates on the currently active Preset and will fail if the current +Preset is not custom.

    +

    The use cases are:

    +
      +
    1. Update the Custom Preset Icon

      +
        +
      • icon_id is always optional and can always be passed
      • +
      +
    2. +
    +

    and / or

    +
      +
    1. Update the Custom Preset Title to a...

      +
        +
      • Factory Preset Title: Set title_id to a non-94 value
      • +
      • Custom Preset Name: Set title_id to 94 and specify a custom_name
      • +
      +
    2. +
    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +
    Request Body schema: application/json
    required
    custom_name
    string

    utf-8 encoded target custom preset name which obeys the following:

    +
      +
    • must be between 1 and 16 characters (inclusive)
    • +
    • No special characters outside of the following languages: English, French, +Italian, German, Spanish, Portuguese, Swedish, Russian
    • +
    +
    icon_id
    integer (EnumPresetIcon)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 1000 1001
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_ICON_VIDEO
    1PRESET_ICON_ACTIVITY
    2PRESET_ICON_CINEMATIC
    3PRESET_ICON_PHOTO
    4PRESET_ICON_LIVE_BURST
    5PRESET_ICON_BURST
    6PRESET_ICON_PHOTO_NIGHT
    7PRESET_ICON_TIMEWARP
    8PRESET_ICON_TIMELAPSE
    9PRESET_ICON_NIGHTLAPSE
    10PRESET_ICON_SNAIL
    11PRESET_ICON_VIDEO_2
    13PRESET_ICON_PHOTO_2
    14PRESET_ICON_PANORAMA
    15PRESET_ICON_BURST_2
    16PRESET_ICON_TIMEWARP_2
    17PRESET_ICON_TIMELAPSE_2
    18PRESET_ICON_CUSTOM
    19PRESET_ICON_AIR
    20PRESET_ICON_BIKE
    21PRESET_ICON_EPIC
    22PRESET_ICON_INDOOR
    23PRESET_ICON_MOTOR
    24PRESET_ICON_MOUNTED
    25PRESET_ICON_OUTDOOR
    26PRESET_ICON_POV
    27PRESET_ICON_SELFIE
    28PRESET_ICON_SKATE
    29PRESET_ICON_SNOW
    30PRESET_ICON_TRAIL
    31PRESET_ICON_TRAVEL
    32PRESET_ICON_WATER
    33PRESET_ICON_LOOPING
    58PRESET_ICON_BASIC
    59PRESET_ICON_ULTRA_SLO_MO
    60PRESET_ICON_STANDARD_ENDURANCE
    61PRESET_ICON_ACTIVITY_ENDURANCE
    62PRESET_ICON_CINEMATIC_ENDURANCE
    63PRESET_ICON_SLOMO_ENDURANCE
    64PRESET_ICON_STATIONARY_1
    65PRESET_ICON_STATIONARY_2
    66PRESET_ICON_STATIONARY_3
    67PRESET_ICON_STATIONARY_4
    70PRESET_ICON_SIMPLE_SUPER_PHOTO
    71PRESET_ICON_SIMPLE_NIGHT_PHOTO
    73PRESET_ICON_HIGHEST_QUALITY_VIDEO
    74PRESET_ICON_STANDARD_QUALITY_VIDEO
    75PRESET_ICON_BASIC_QUALITY_VIDEO
    76PRESET_ICON_STAR_TRAIL
    77PRESET_ICON_LIGHT_PAINTING
    78PRESET_ICON_LIGHT_TRAIL
    79PRESET_ICON_FULL_FRAME
    1000PRESET_ICON_TIMELAPSE_PHOTO
    1001PRESET_ICON_NIGHTLAPSE_PHOTO
    +
    title_id
    integer (EnumPresetTitle)
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 13 14 16 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 82 83 93 94
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDNameSummary
    0PRESET_TITLE_ACTIVITY
    1PRESET_TITLE_STANDARD
    2PRESET_TITLE_CINEMATIC
    3PRESET_TITLE_PHOTO
    4PRESET_TITLE_LIVE_BURST
    5PRESET_TITLE_BURST
    6PRESET_TITLE_NIGHT
    7PRESET_TITLE_TIME_WARP
    8PRESET_TITLE_TIME_LAPSE
    9PRESET_TITLE_NIGHT_LAPSE
    10PRESET_TITLE_VIDEO
    11PRESET_TITLE_SLOMO
    13PRESET_TITLE_PHOTO_2
    14PRESET_TITLE_PANORAMA
    16PRESET_TITLE_TIME_WARP_2
    18PRESET_TITLE_CUSTOM
    19PRESET_TITLE_AIR
    20PRESET_TITLE_BIKE
    21PRESET_TITLE_EPIC
    22PRESET_TITLE_INDOOR
    23PRESET_TITLE_MOTOR
    24PRESET_TITLE_MOUNTED
    25PRESET_TITLE_OUTDOOR
    26PRESET_TITLE_POV
    27PRESET_TITLE_SELFIE
    28PRESET_TITLE_SKATE
    29PRESET_TITLE_SNOW
    30PRESET_TITLE_TRAIL
    31PRESET_TITLE_TRAVEL
    32PRESET_TITLE_WATER
    33PRESET_TITLE_LOOPING
    58PRESET_TITLE_BASIC
    59PRESET_TITLE_ULTRA_SLO_MO
    60PRESET_TITLE_STANDARD_ENDURANCE
    61PRESET_TITLE_ACTIVITY_ENDURANCE
    62PRESET_TITLE_CINEMATIC_ENDURANCE
    63PRESET_TITLE_SLOMO_ENDURANCE
    64PRESET_TITLE_STATIONARY_1
    65PRESET_TITLE_STATIONARY_2
    66PRESET_TITLE_STATIONARY_3
    67PRESET_TITLE_STATIONARY_4
    68PRESET_TITLE_SIMPLE_VIDEO
    69PRESET_TITLE_SIMPLE_TIME_WARP
    70PRESET_TITLE_SIMPLE_SUPER_PHOTO
    71PRESET_TITLE_SIMPLE_NIGHT_PHOTO
    72PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE
    73PRESET_TITLE_HIGHEST_QUALITY
    74PRESET_TITLE_EXTENDED_BATTERY
    75PRESET_TITLE_LONGEST_BATTERY
    76PRESET_TITLE_STAR_TRAIL
    77PRESET_TITLE_LIGHT_PAINTING
    78PRESET_TITLE_LIGHT_TRAIL
    79PRESET_TITLE_FULL_FRAME
    82PRESET_TITLE_STANDARD_QUALITY_VIDEO
    83PRESET_TITLE_BASIC_QUALITY_VIDEO
    93PRESET_TITLE_HIGHEST_QUALITY_VIDEO
    94PRESET_TITLE_USER_DEFINED_CUSTOM_NAME
    +

    Responses

    Response Schema: application/json
    object

    Request samples

    Content type
    application/json
    {
    • "custom_name": "string",
    • "icon_id": 0,
    • "title_id": 0
    }

    Response samples

    Content type
    application/json
    { }

    Preview Stream

    When the preview stream is started, the camera starts up a UDP client and begins writing MPEG Transport +Stream data to the client on port 8554. In order to stream this data, the client must implement a UDP +connection that binds to the same port and decode the data.

    +

    Start the Preview Stream


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    port
    integer
    Example: port=8556

    Port to use for Preview Stream. Defaults to 8554 if not set

    +

    Not supported on:

    +
      +
    • Hero 11 Black Mini
    • +
    • Hero 11 Black
    • +
    • Hero 10 Black
    • +
    • Hero 9 Black
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Stop the Preview Stream


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Query

    Get information about the camera

    +

    Get Camera State

    Get all camera settings and statuses.

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    All currently known setting values indexed by setting ID

    +
    2
    integer
    Enum: 1 4 6 7 9 18 24 25 26 27 28 100 107 108 109 110 111

    Video Resolution

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    1Video Resolution 4KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Resolution 2 7KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Video Resolution 2 7K 4By3HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    7Video Resolution 1440HERO9 Black
    9Video Resolution 1080HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    18Video Resolution 4K 4By3HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    24Video Resolution 5KHERO9 Black
    25Video Resolution 5K 4By3HERO10 Black
    26Video Resolution 5 3K 8By7HERO11 Black Mini, HERO11 Black
    27Video Resolution 5 3K 4By3HERO11 Black Mini, HERO11 Black
    28Video Resolution 4K 8By7HERO11 Black Mini, HERO11 Black
    100Video Resolution 5 3KHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black
    107Video Resolution 5 3K 8By7 V2HERO12 Black
    108Video Resolution 4K 8By7 V2HERO12 Black
    109Video Resolution 4K 9By16 V2HERO12 Black
    110Video Resolution 1080 9By16 V2HERO12 Black
    111Video Resolution 2 7K 4By3 V2HERO12 Black
    +
    3
    integer
    Enum: 0 1 2 5 6 8 9 10 13

    Video Fps

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Fps 240HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Video Fps 120HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Video Fps 100HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    5Video Fps 60HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Video Fps 50HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    8Video Fps 30HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    9Video Fps 25HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    10Video Fps 24HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    13Video Fps 200HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    43
    integer
    Enum: 0 2 3 4

    Broadcast Fov

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Broadcast Fov WideHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Broadcast Fov NarrowHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    3Broadcast Fov SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Broadcast Fov LinearHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    59
    integer
    Enum: 0 1 4 6 7 11 12

    Setup Auto Power Down

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Setup Auto Power Down NeverHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Setup Auto Power Down 1 MinHERO12 Black, HERO11 Black Mini, HERO11 Black
    4Setup Auto Power Down 5 MinHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    6Setup Auto Power Down 15 MinHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    7Setup Auto Power Down 30 MinHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    11Setup Auto Power Down 8 SecondsHERO11 Black Mini
    12Setup Auto Power Down 30 SecondsHERO11 Black Mini
    +
    108
    integer
    Enum: 0 1 3 4

    Video Aspect Ratio

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Aspect Ratio 4By3HERO12 Black
    1Video Aspect Ratio 16By9HERO12 Black
    3Video Aspect Ratio 8By7HERO12 Black
    4Video Aspect Ratio 9By16HERO12 Black
    +
    121
    integer
    Enum: 0 2 3 4 7 8 9 10 11

    Video Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Digital Lenses WideHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    2Video Digital Lenses NarrowHERO10 Black, HERO9 Black
    3Video Digital Lenses SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Digital Lenses LinearHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    7Video Digital Lenses Max SuperviewHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    8Video Digital Lenses Linear Plus Horizon LevelingHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    9Video Digital Lenses HyperviewHERO12 Black, HERO11 Black Mini, HERO11 Black
    10Video Digital Lenses Linear Plus Horizon LockHERO12 Black, HERO11 Black Mini, HERO11 Black
    11Video Digital Lenses Max HyperviewHERO12 Black
    +
    122
    integer
    Enum: 19 100 101 102

    Photo Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    19Photo Digital Lenses NarrowHERO10 Black, HERO9 Black
    100Photo Digital Lenses Max SuperviewHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    101Photo Digital Lenses WideHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    102Photo Digital Lenses LinearHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    123
    integer
    Enum: 19 100 101 102

    Multi Shot Digital Lenses

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    19Multi Shot Digital Lenses NarrowHERO10 Black, HERO9 Black
    100Multi Shot Digital Lenses Max SuperviewHERO10 Black
    101Multi Shot Digital Lenses WideHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    102Multi Shot Digital Lenses LinearHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    128
    integer
    Enum: 13 20 21 26

    General Format

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    13General Format Time Lapse VideoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    20General Format Time Lapse PhotoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    21General Format Night Lapse PhotoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    26General Format Night Lapse VideoHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    134
    integer
    Enum: 2 3

    Setup Anti Flicker

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    2Setup Anti Flicker 60 HzHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    3Setup Anti Flicker 50 HzHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    +
    135
    integer
    Enum: 0 1 2 3 4 100

    Video Hypersmooth

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Hypersmooth OffHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    1Video Hypersmooth OnHERO12 Black, HERO11 Black Mini, HERO11 Black, HERO9 Black
    2Video Hypersmooth HighHERO10 Black, HERO9 Black
    3Video Hypersmooth BoostHERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Hypersmooth Auto BoostHERO12 Black, HERO11 Black Mini, HERO11 Black
    100Video Hypersmooth StandardHERO10 Black
    +
    150
    integer
    Enum: 0 2

    Video Horizon Levelling

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Horizon Levelling OffHERO11 Black
    2Video Horizon Levelling LockedHERO11 Black
    +
    151
    integer
    Enum: 0 2

    Photo Horizon Levelling

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Horizon Levelling OffHERO11 Black
    2Photo Horizon Levelling LockedHERO11 Black
    +
    162
    integer
    Enum: 0 1

    Mods Max Lens Enable

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Mods Max Lens Enable OffHERO11 Black, HERO10 Black, HERO9 Black
    1Mods Max Lens Enable OnHERO11 Black, HERO10 Black, HERO9 Black
    +
    167
    integer
    Enum: 2 3 4

    Video Hindsight Length

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    2Video Hindsight Length 15 SecondsHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    3Video Hindsight Length 30 SecondsHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    4Video Hindsight Length OffHERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black
    +
    171
    integer
    Enum: 0 2 3 4 5 6 7 8 9 10

    Photo Single Interval

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Single Interval OffHERO12 Black
    2Photo Single Interval 0 5 SecondsHERO12 Black
    3Photo Single Interval 1 SecondHERO12 Black
    4Photo Single Interval 2 SecondsHERO12 Black
    5Photo Single Interval 5 SecondsHERO12 Black
    6Photo Single Interval 10 SecondsHERO12 Black
    7Photo Single Interval 30 SecondsHERO12 Black
    8Photo Single Interval 60 SecondsHERO12 Black
    9Photo Single Interval 120 SecondsHERO12 Black
    10Photo Single Interval 3 SecondsHERO12 Black
    +
    172
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9

    Photo Interval Duration

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Interval Duration OffHERO12 Black
    1Photo Interval Duration 15 SecondsHERO12 Black
    2Photo Interval Duration 30 SecondsHERO12 Black
    3Photo Interval Duration 1 MinuteHERO12 Black
    4Photo Interval Duration 5 MinutesHERO12 Black
    5Photo Interval Duration 15 MinutesHERO12 Black
    6Photo Interval Duration 30 MinutesHERO12 Black
    7Photo Interval Duration 1 HourHERO12 Black
    8Photo Interval Duration 2 HoursHERO12 Black
    9Photo Interval Duration 3 HoursHERO12 Black
    +
    173
    integer
    Enum: 0 1 2

    System Power Profile

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Power Profile Maximum Video PerformanceHERO10 Black
    1System Power Profile Extended BatteryHERO10 Black
    2System Power Profile Tripod Stationary VideoHERO10 Black
    +
    175
    integer
    Enum: 0 1

    Setup Camera Ux Mode

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Setup Camera Ux Mode EasyHERO12 Black, HERO11 Black
    1Setup Camera Ux Mode ProHERO12 Black, HERO11 Black
    +
    176
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

    Video Easy Mode Speed

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Mode Speed 8X Ultra Slo MoHERO11 Black
    1Video Easy Mode Speed 4X Super Slo MoHERO11 Black
    2Video Easy Mode Speed 2X Slo MoHERO11 Black
    3Video Easy Mode Speed 1X Speed Low LightHERO11 Black
    4Video Easy Mode Speed Eb 4X Super Slo MoHERO11 Black
    5Video Easy Mode Speed Eb 2X Slo MoHERO11 Black
    6Video Easy Mode Speed Eb 1X Speed Low LightHERO11 Black
    7Video Easy Mode Speed 8X Ultra Slo Mo 50HzHERO11 Black
    8Video Easy Mode Speed 4X Super Slo Mo 50HzHERO11 Black
    9Video Easy Mode Speed 2X Slo Mo 50HzHERO11 Black
    10Video Easy Mode Speed 1X Speed Low Light 50HzHERO11 Black
    11Video Easy Mode Speed Eb 4X Super Slo Mo 50HzHERO11 Black
    12Video Easy Mode Speed Eb 2X Slo Mo 50HzHERO11 Black
    13Video Easy Mode Speed Eb 1X Speed Low Light 50HzHERO11 Black
    14Video Easy Mode Speed Eb 8X Ultra Slo MoHERO11 Black
    15Video Easy Mode Speed Eb 8X Ultra Slo Mo 50HzHERO11 Black
    16Video Easy Mode Speed Lb 8X Ultra Slo MoHERO11 Black
    17Video Easy Mode Speed Lb 4X Super Slo MoHERO11 Black
    18Video Easy Mode Speed Lb 2X Slo MoHERO11 Black
    19Video Easy Mode Speed Lb 1X Speed Low LightHERO11 Black
    20Video Easy Mode Speed Lb 8X Ultra Slo Mo 50HzHERO11 Black
    21Video Easy Mode Speed Lb 4X Super Slo Mo 50HzHERO11 Black
    22Video Easy Mode Speed Lb 2X Slo Mo 50HzHERO11 Black
    23Video Easy Mode Speed Lb 1X Speed Low Light 50HzHERO11 Black
    24Video Easy Mode Speed 2X Slo Mo 4KHERO11 Black
    25Video Easy Mode Speed 4X Super Slo Mo 2 7KHERO11 Black
    26Video Easy Mode Speed 2X Slo Mo 4K 50HzHERO11 Black
    27Video Easy Mode Speed 4X Super Slo Mo 2 7K 50HzHERO11 Black
    100Video Easy Mode Speed 8X Ultra Slo Mo V2HERO12 Black
    101Video Easy Mode Speed 4X Super Slo Mo V2HERO12 Black
    102Video Easy Mode Speed 2X Slo Mo V2HERO12 Black
    103Video Easy Mode Speed 1X Speed Low Light V2HERO12 Black
    104Video Easy Mode Speed 8X Ultra Slo Mo 50Hz V2HERO12 Black
    105Video Easy Mode Speed 4X Super Slo Mo 50Hz V2HERO12 Black
    106Video Easy Mode Speed 2X Slo Mo 50Hz V2HERO12 Black
    107Video Easy Mode Speed 1X Speed Low Light 50Hz V2HERO12 Black
    108Video Easy Mode Speed Lb 8X Ultra Slo Mo V2HERO12 Black
    109Video Easy Mode Speed Lb 4X Super Slo Mo V2HERO12 Black
    110Video Easy Mode Speed Lb 2X Slo Mo V2HERO12 Black
    111Video Easy Mode Speed Lb 1X Speed Low Light V2HERO12 Black
    112Video Easy Mode Speed Lb 8X Ultra Slo Mo 50Hz V2HERO12 Black
    113Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz V2HERO12 Black
    114Video Easy Mode Speed Lb 2X Slo Mo 50Hz V2HERO12 Black
    115Video Easy Mode Speed Lb 1X Speed Low Light 50Hz V2HERO12 Black
    116Video Easy Mode Speed 2X Slo Mo 4K V2HERO12 Black
    117Video Easy Mode Speed 2X Slo Mo 4K 50Hz V2HERO12 Black
    118Video Easy Mode Speed Mobile 1X Speed Low Light V2HERO12 Black
    119Video Easy Mode Speed Mobile 1X Speed Low Light 50Hz V2HERO12 Black
    120Video Easy Mode Speed Mobile 2X Slo Mo V2HERO12 Black
    121Video Easy Mode Speed Mobile 2X Slo Mo 50Hz V2HERO12 Black
    122Video Easy Mode Speed Universal 1X Speed Low Light V2HERO12 Black
    123Video Easy Mode Speed Universal 1X Speed Low Light 50Hz V2HERO12 Black
    124Video Easy Mode Speed Universal 2X Slo Mo V2HERO12 Black
    125Video Easy Mode Speed Universal 2X Slo Mo 50Hz V2HERO12 Black
    126Video Easy Mode Speed 1X Speed Low Light 4K V2HERO12 Black
    127Video Easy Mode Speed 1X Speed Low Light 4K 50Hz V2HERO12 Black
    128Video Easy Mode Speed 1X Speed Low Light 2 7K V2HERO12 Black
    129Video Easy Mode Speed 1X Speed Low Light 2 7K 50Hz V2HERO12 Black
    130Video Easy Mode Speed 2X Slo Mo 2 7K V2HERO12 Black
    131Video Easy Mode Speed 2X Slo Mo 2 7K 50Hz V2HERO12 Black
    132Video Easy Mode Speed Mobile Lb 2X Slo Mo V2HERO12 Black
    133Video Easy Mode Speed Mobile Lb 2X Slo Mo 50Hz V2HERO12 Black
    134Video Easy Mode Speed Mobile Lb 1X Speed Low Light V2HERO12 Black
    135Video Easy Mode Speed Mobile Lb 1X Speed Low Light 50Hz V2HERO12 Black
    136Video Easy Mode Speed Universal 1X Speed Low Light 4K V2HERO12 Black
    137Video Easy Mode Speed Universal 1X Speed Low Light 4K 50Hz V2HERO12 Black
    +
    177
    integer
    Enum: 0 1

    Photo Easy Mode Night Photo

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Easy Mode Night Photo OffHERO11 Black
    1Photo Easy Mode Night Photo OnHERO11 Black
    +
    178
    integer
    Enum: 0 1

    Wireless Wireless Band

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Wireless Wireless Band 2 4 GhzHERO12 Black, HERO11 Black Mini, HERO11 Black
    1Wireless Wireless Band 5 GhzHERO12 Black, HERO11 Black Mini, HERO11 Black
    +
    179
    integer
    Enum: 1 2 3

    Multi Shot Trail Length

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    1Multi Shot Trail Length ShortHERO12 Black, HERO11 Black Mini, HERO11 Black
    2Multi Shot Trail Length LongHERO12 Black, HERO11 Black Mini, HERO11 Black
    3Multi Shot Trail Length MaxHERO12 Black, HERO11 Black Mini, HERO11 Black
    +
    180
    integer
    Enum: 0 101 102

    System Video Mode

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Mode Highest QualityHERO11 Black
    101System Video Mode Extended Battery GreenHERO11 Black
    102System Video Mode Longest Battery GreenHERO11 Black
    +
    182
    integer
    Enum: 0 1

    System Video Bit Rate

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Bit Rate StandardHERO12 Black
    1System Video Bit Rate HighHERO12 Black
    +
    183
    integer
    Enum: 0 2

    System Video Bit Depth

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Video Bit Depth 8BitHERO12 Black
    2System Video Bit Depth 10BitHERO12 Black
    +
    184
    integer
    Enum: 0 1 2

    Video Profile

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Profile StandardHERO12 Black
    1Video Profile HdrHERO12 Black
    2Video Profile 10 Bit LogHERO12 Black
    +
    186
    integer
    Enum: 0 1 2

    Video Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Presets Highest QualityHERO12 Black
    1Video Easy Presets Standard QualityHERO12 Black
    2Video Easy Presets Basic QualityHERO12 Black
    +
    187
    integer
    Enum: 0 1 2 3 4 5 6 7

    Multi Shot Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Multi Shot Easy Presets Lapse Mode Time WarpHERO12 Black
    1Multi Shot Easy Presets Lapse Mode Star TrailsHERO12 Black
    2Multi Shot Easy Presets Lapse Mode Light PaintingHERO12 Black
    3Multi Shot Easy Presets Lapse Mode Vehicle LightsHERO12 Black
    4Multi Shot Easy Presets Max Lapse Mode Time WarpHERO12 Black
    5Multi Shot Easy Presets Max Lapse Mode Star TrailsHERO12 Black
    6Multi Shot Easy Presets Max Lapse Mode Light PaintingHERO12 Black
    7Multi Shot Easy Presets Max Lapse Mode Vehicle LightsHERO12 Black
    +
    189
    integer
    Enum: 0 1 2

    System Addon Lens Active

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Addon Lens Active NoneHERO12 Black
    1System Addon Lens Active Max Lens 1 0HERO12 Black
    2System Addon Lens Active Max Lens 2 0HERO12 Black
    +
    190
    integer
    Enum: 0 1

    System Addon Lens Status

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0System Addon Lens Status OffHERO12 Black
    1System Addon Lens Status OnHERO12 Black
    +
    191
    integer
    Enum: 0 1

    Photo Easy Presets

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Photo Easy Presets Super PhotoHERO12 Black
    1Photo Easy Presets Night PhotoHERO12 Black
    +
    192
    integer
    Enum: 0 1 3

    Multi Shot Nlv Aspect Ratio

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Multi Shot Nlv Aspect Ratio 4By3HERO12 Black
    1Multi Shot Nlv Aspect Ratio 16By9HERO12 Black
    3Multi Shot Nlv Aspect Ratio 8By7HERO12 Black
    +
    193
    integer
    Enum: 0 1 2

    Video Easy Framing

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaningSupported Cameras
    0Video Easy Framing WidescreenHERO12 Black
    1Video Easy Framing VerticalHERO12 Black
    2Video Easy Framing Full FrameHERO12 Black
    +
    object

    All currently known status values indexed by status ID

    +
    1
    integer
    Enum: 0 1

    Is the system's internal battery present?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    2
    integer
    Enum: 0 1 2 3

    Rough approximation of internal battery level in bars

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Zero
    1One
    2Two
    3Three
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    6
    integer
    Enum: 0 1

    Is the system currently overheating?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    8
    integer
    Enum: 0 1

    Is the camera busy?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    9
    integer
    Enum: 0 1

    Is Quick Capture feature enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    10
    integer
    Enum: 0 1

    Is the system encoding right now?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    11
    integer
    Enum: 0 1

    Is LCD lock active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    13
    integer

    When encoding video, this is the duration (seconds) of the video so far; 0 otherwise

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    17
    integer
    Enum: 0 1

    Are Wireless Connections enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    19
    integer
    Enum: 0 1 2 3 4

    The pairing state of the camera

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never Started
    1Started
    2Aborted
    3Cancelled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    20
    integer
    Enum: 0 1 2 3

    The last type of pairing that the camera was engaged in

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Not Pairing
    1Pairing App
    2Pairing Remote Control
    3Pairing Bluetooth Device
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    21
    integer

    Time (milliseconds) since boot of last successful pairing complete action

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    22
    integer
    Enum: 0 1 2 3 4

    State of current scan for WiFi Access Points. Appears to only change for CAH-related scans

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never started
    1Started
    2Aborted
    3Canceled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    23
    integer

    The time, in milliseconds since boot that the WiFi Access Point scan completed

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    24
    integer
    Enum: 0 1 2 3 4

    WiFi AP provisioning state

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Never started
    1Started
    2Aborted
    3Canceled
    4Completed
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    26
    integer

    Wireless remote control version

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    27
    integer
    Enum: 0 1

    Is a wireless remote control connected?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    28
    integer

    Wireless Pairing State. Each bit contains state information (see WirelessPairingStateFlags)

    +

    Supported Cameras:

    +
      +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    29
    string

    Provisioned WIFI AP SSID. On BLE connection, value is big-endian byte-encoded int

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    30
    string

    Camera's WIFI SSID. On BLE connection, value is big-endian byte-encoded int

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    31
    integer

    The number of wireless devices connected to the camera

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    32
    integer
    Enum: 0 1

    Is Preview Stream enabled?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    33
    integer
    Enum: -1 0 1 2 3 4 8

    Primary Storage Status

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    -1Unknown
    0OK
    1SD Card Full
    2SD Card Removed
    3SD Card Format Error
    4SD Card Busy
    8SD Card Swapped
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    34
    integer

    How many photos can be taken before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    35
    integer

    How many minutes of video can be captured with current settings before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    38
    integer

    Total number of photos on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    39
    integer

    Total number of videos on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    41
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10

    The current status of Over The Air (OTA) update

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Idle
    1Downloading
    2Verifying
    3Download Failed
    4Verify Failed
    5Ready
    6GoPro App: Downloading
    7GoPro App: Verifying
    8GoPro App: Download Failed
    9GoPro App: Verify Failed
    10GoPro App: Ready
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    42
    integer
    Enum: 0 1

    Is there a pending request to cancel a firmware update download?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    45
    integer
    Enum: 0 1

    Is locate camera feature active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    49
    integer

    The current timelapse interval countdown value (e.g. 5...4...3...2...1...)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    54
    integer

    Remaining space on the sdcard in Kilobytes

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    55
    integer
    Enum: 0 1

    Is preview stream supported in current recording/mode/secondary-stream?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    56
    integer

    WiFi signal strength in bars

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    58
    integer

    The number of hilights in encoding video (set to 0 when encoding stops)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    59
    integer

    Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    60
    integer

    The min time between camera status updates (msec). Do not poll for status more often than this

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    64
    integer

    How many min of Timelapse video can be captured with current settings before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    65
    integer
    Enum: 0 1 2 3

    Liveview Exposure Select Mode

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Disabled
    1Auto
    2ISO Lock
    3Hemisphere
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    66
    integer [ 0 .. 100 ]

    Liveview Exposure Select: y-coordinate (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    67
    integer [ 0 .. 100 ]

    Liveview Exposure Select: y-coordinate (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    68
    integer
    Enum: 0 1

    Does the camera currently have a GPS lock?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    69
    integer
    Enum: 0 1

    Is the camera in AP Mode?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    70
    integer [ 0 .. 100 ]

    Internal battery level (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    74
    integer
    Enum: 0 1 2

    Microphone Accesstory (Garter) status

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Garter not connected
    1Garter connected
    2Garter connected and microphone plugged into Garter
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    75
    integer [ 0 .. 100 ]

    Digital Zoom level (percent)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    76
    integer
    Enum: 0 1 2

    Wireless Band

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    02.4 GHz
    15 GHz
    2Max
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    77
    integer
    Enum: 0 1

    Is Digital Zoom feature available?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    78
    integer
    Enum: 0 1

    Are current video settings mobile friendly? (related to video compression and frame rate)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    79
    integer
    Enum: 0 1

    Is the camera currently in First Time Use (FTU) UI flow?

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    81
    integer
    Enum: 0 1

    Is 5GHz wireless band available?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    82
    integer
    Enum: 0 1

    Is the system ready to accept commands?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    83
    integer
    Enum: 0 1

    Is the internal battery charged sufficiently to start Over The Air (OTA) update?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    85
    integer
    Enum: 0 1

    Is the camera getting too cold to continue recording?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    86
    integer
    Enum: 0 1 2 3

    The rotational orientation of the camera

    + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    00 degrees (upright)
    1180 degrees (upside down)
    290 degrees (laying on right side)
    3270 degrees (laying on left side)
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    88
    integer
    Enum: 0 1

    Is this camera capable of zooming while encoding (static value based on model, not settings)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    89
    integer

    Current flatmode ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    93
    integer

    Current Video Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    94
    integer

    Current Photo Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    95
    integer

    Current Timelapse Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    96
    integer

    Current Preset Group (ID) (corresponds to ui_mode_groups in settings.json)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    97
    integer

    Current Preset (ID)

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    98
    integer

    Preset Modified Status, which contains an event ID and a preset (group) ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    99
    integer

    How many Live Bursts can be captured before sdcard is full

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    100
    integer

    Total number of Live Bursts on sdcard

    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    101
    integer
    Enum: 0 1

    Is Capture Delay currently active (i.e. counting down)?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    102
    integer
    Enum: 0 2 3

    Borg State

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Borg microphone removed
    2Borg microphone only
    3Borg microphone with external microphone
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    103
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12

    Time Warp Speed

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    015x
    130x
    260x
    3150x
    4300x
    5900x
    61800x
    72x
    85x
    910x
    10Auto
    111x (realtime)
    121/2x (slow-motion)
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    104
    integer
    Enum: 0 1

    Is the system's Linux core active?

    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    105
    integer
    Enum: 0 1 2

    Camera lens type (reflects changes to setting 162 or setting 189)

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Default
    1Max Lens
    2Max Lens 2.0
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    106
    integer
    Enum: 0 1

    Is Video Hindsight Capture Active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    107
    integer

    Scheduled Capture Preset ID

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    108
    integer
    Enum: 0 1

    Is Scheduled Capture set?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    110
    integer
    Enum: 0 1 2 3 4 5 6 7

    Media Mode Status (bitmasked)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0000 = Headroom: 0, HDMI: 0, Media Mod Connected: False
    1001 = Headroom: 0, HDMI: 0, Media Mod Connected: True
    2010 = Headroom: 0, HDMI: 1, Media Mod Connected: False
    3011 = Headroom: 0, HDMI: 1, Media Mod Connected: True
    4100 = Headroom: 1, HDMI: 0, Media Mod Connected: False
    5101 = Headroom: 1, HDMI: 0, Media Mod Connected: True
    6110 = Headroom: 1, HDMI: 1, Media Mod Connected: False
    7111 = Headroom: 1, HDMI: 1, Media Mod Connected: True
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    111
    integer
    Enum: 0 1

    Does sdcard meet specified minimum write speed?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    112
    integer

    Number of sdcard write speed errors since device booted

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    113
    integer
    Enum: 0 1

    Is Turbo Transfer active?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    114
    integer
    Enum: 0 1 2

    Camera control status ID

    + + + + + + + + + + + + + + + + + + + +
    ValueMeaning
    0Camera Idle: No one is attempting to change camera settings
    1Camera Control: Camera is in a menu or changing settings. To intervene, app must request control
    2Camera External Control: An outside entity (app) has control and is in a menu or modifying settings
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    115
    integer
    Enum: 0 1

    Is the camera connected to a PC via USB?

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    116
    integer
    Enum: 0 1

    Camera control over USB state

    + + + + + + + + + + + + + + + +
    ValueMeaning
    0Disabled
    1Enabled
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    117
    integer

    Total SD card capacity in Kilobytes

    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    +

    Response samples

    Content type
    application/json
    {
    • "settings": {
      },
    • "status": {
      }
    }

    Get Date / Time


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    date
    required
    string
    Example: "2023_12_31"

    current date in format YYYY_MM_DD

    +
    dst
    integer
    Enum: 0 1

    Is daylight savings time active?

    +
    time
    required
    string
    Example: "11_05_45"

    current time in format HH_MM_SS

    +
    tzone
    integer
    Example: "-480"

    Timezone offset in minutes

    +

    Response samples

    Content type
    application/json
    {
    • "date": "2023_12_31",
    • "dst": 0,
    • "time": "11_05_45",
    • "tzone": -480
    }

    Get Hardware Info


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object
    ap_mac_addr
    string
    Example: "065747046ceb"

    Camera's Access Point MAC address

    +
    ap_ssid
    string
    Example: "GP24645504"

    Camera's ACcess Point SSID name

    +
    firmware_version
    string <version>
    Example: "H23.01.01.10.00"

    Camera Firmware version

    +
    model_name
    string
    Example: "Hero12 Black"

    Camera Model Name

    +
    model_number
    string
    Example: "62"

    Camera Model integer (as string)

    +
    serial_number
    string
    Example: "C3501324645504"

    Camera serial number

    +

    Response samples

    Content type
    application/json
    {
    • "info": {
      }
    }

    Get Last Captured Media

    This will return the complete path of the last captured media. Depending on the type of media captured, it will return:

    +
      +
    • single photo / video: The single media path
    • +
    • any grouped media: The path to the first captured media in the group
    • +
    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: application/json
    file
    string
    Example: "GOPR0002.JPG"

    Filename of media

    +
    folder
    string
    Example: "100GOPRO"

    Directory that the media is contained in

    +

    Response samples

    Content type
    application/json
    {
    • "file": "GOPR0002.JPG",
    • "folder": "100GOPRO"
    }

    Get Open GoPro Version


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • WIFI
    • +
    • USB
    • +
    +

    Responses

    Response Schema: application/json
    version
    string <version>
    Example: "2.0"

    Open GoPro version

    +

    Response samples

    Content type
    application/json
    {
    • "version": "2.0"
    }

    settings

    GoPro cameras have hundreds of setting options to choose from, all of which can be set using a single endpoint. The endpoint is configured with a setting id and an option value. Note that setting option values are not globally unique. While most option values are enumerated values, some are complex bit-masked values.

    +

    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.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CameraCommand 1Command 2Command 3Command 4Command 5Guaranteed Valid?
    HERO10 BlackRes: 1080Anti-Flicker: 60Hz (NTSC)FPS: 240FOV: WideHypersmooth: OFF
    HERO10 BlackFPS: 240Anti-Flicker: 60Hz (NTSC)Res: 1080FOV: WideHypersmooth: 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

    +

    Broadcast Fov (43)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2 3 4
    Example: 3
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Broadcast Fov WideHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    2Broadcast Fov NarrowHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    3Broadcast Fov SuperviewHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    4Broadcast Fov LinearHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    General Format (128)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 13 20 21 26
    Example: 13
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    13General Format Time Lapse VideoHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    20General Format Time Lapse PhotoHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    21General Format Night Lapse PhotoHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    26General Format Night Lapse VideoHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Mods Max Lens Enable (162)


    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Mods Max Lens Enable OffHERO9 Black, HERO10 Black, HERO11 Black
    1Mods Max Lens Enable OnHERO9 Black, HERO10 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Multi Shot Digital Lenses (123)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 19 100 101 102
    Example: 101
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    19Multi Shot Digital Lenses NarrowHERO9 Black, HERO10 Black
    100Multi Shot Digital Lenses Max SuperviewHERO10 Black
    101Multi Shot Digital Lenses WideHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    102Multi Shot Digital Lenses LinearHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Multi Shot Easy Presets (187)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2 3 4 5 6 7
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Multi Shot Easy Presets Lapse Mode Time WarpHERO12 Black
    1Multi Shot Easy Presets Lapse Mode Star TrailsHERO12 Black
    2Multi Shot Easy Presets Lapse Mode Light PaintingHERO12 Black
    3Multi Shot Easy Presets Lapse Mode Vehicle LightsHERO12 Black
    4Multi Shot Easy Presets Max Lapse Mode Time WarpHERO12 Black
    5Multi Shot Easy Presets Max Lapse Mode Star TrailsHERO12 Black
    6Multi Shot Easy Presets Max Lapse Mode Light PaintingHERO12 Black
    7Multi Shot Easy Presets Max Lapse Mode Vehicle LightsHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Multi Shot Nlv Aspect Ratio (192)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 3
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Multi Shot Nlv Aspect Ratio 4By3HERO12 Black
    1Multi Shot Nlv Aspect Ratio 16By9HERO12 Black
    3Multi Shot Nlv Aspect Ratio 8By7HERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Multi Shot Trail Length (179)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 1 2 3
    Example: 3
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    1Multi Shot Trail Length ShortHERO11 Black Mini, HERO12 Black, HERO11 Black
    2Multi Shot Trail Length LongHERO11 Black Mini, HERO12 Black, HERO11 Black
    3Multi Shot Trail Length MaxHERO11 Black Mini, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Digital Lenses (122)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 19 100 101 102
    Example: 100
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    19Photo Digital Lenses NarrowHERO9 Black, HERO10 Black
    100Photo Digital Lenses Max SuperviewHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    101Photo Digital Lenses WideHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    102Photo Digital Lenses LinearHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Easy Mode Night Photo (177)


    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Photo Easy Mode Night Photo OffHERO11 Black
    1Photo Easy Mode Night Photo OnHERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Easy Presets (191)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Photo Easy Presets Super PhotoHERO12 Black
    1Photo Easy Presets Night PhotoHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Horizon Levelling (151)


    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Photo Horizon Levelling OffHERO11 Black
    2Photo Horizon Levelling LockedHERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Interval Duration (172)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Photo Interval Duration OffHERO12 Black
    1Photo Interval Duration 15 SecondsHERO12 Black
    2Photo Interval Duration 30 SecondsHERO12 Black
    3Photo Interval Duration 1 MinuteHERO12 Black
    4Photo Interval Duration 5 MinutesHERO12 Black
    5Photo Interval Duration 15 MinutesHERO12 Black
    6Photo Interval Duration 30 MinutesHERO12 Black
    7Photo Interval Duration 1 HourHERO12 Black
    8Photo Interval Duration 2 HoursHERO12 Black
    9Photo Interval Duration 3 HoursHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Photo Single Interval (171)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2 3 4 5 6 7 8 9 10
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Photo Single Interval OffHERO12 Black
    2Photo Single Interval 0 5 SecondsHERO12 Black
    3Photo Single Interval 1 SecondHERO12 Black
    4Photo Single Interval 2 SecondsHERO12 Black
    5Photo Single Interval 5 SecondsHERO12 Black
    6Photo Single Interval 10 SecondsHERO12 Black
    7Photo Single Interval 30 SecondsHERO12 Black
    8Photo Single Interval 60 SecondsHERO12 Black
    9Photo Single Interval 120 SecondsHERO12 Black
    10Photo Single Interval 3 SecondsHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Setup Anti Flicker (134)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 2 3
    Example: 2
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    2Setup Anti Flicker 60 HzHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    3Setup Anti Flicker 50 HzHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Setup Auto Power Down (59)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 4 6 7 11 12
    Example: 4
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Setup Auto Power Down NeverHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    1Setup Auto Power Down 1 MinHERO11 Black Mini, HERO12 Black, HERO11 Black
    4Setup Auto Power Down 5 MinHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    6Setup Auto Power Down 15 MinHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    7Setup Auto Power Down 30 MinHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    11Setup Auto Power Down 8 SecondsHERO11 Black Mini
    12Setup Auto Power Down 30 SecondsHERO11 Black Mini
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Setup Camera Ux Mode (175)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Setup Camera Ux Mode EasyHERO12 Black, HERO11 Black
    1Setup Camera Ux Mode ProHERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Addon Lens Active (189)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Addon Lens Active NoneHERO12 Black
    1System Addon Lens Active Max Lens 1 0HERO12 Black
    2System Addon Lens Active Max Lens 2 0HERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Addon Lens Status (190)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Addon Lens Status OffHERO12 Black
    1System Addon Lens Status OnHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Power Profile (173)


    +

    Supported Cameras:

    +
      +
    • HERO10 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Power Profile Maximum Video PerformanceHERO10 Black
    1System Power Profile Extended BatteryHERO10 Black
    2System Power Profile Tripod Stationary VideoHERO10 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Video Bit Depth (183)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Video Bit Depth 8BitHERO12 Black
    2System Video Bit Depth 10BitHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Video Bit Rate (182)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    Example: 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Video Bit Rate StandardHERO12 Black
    1System Video Bit Rate HighHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    System Video Mode (180)


    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 101 102
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0System Video Mode Highest QualityHERO11 Black
    101System Video Mode Extended Battery GreenHERO11 Black
    102System Video Mode Longest Battery GreenHERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Aspect Ratio (108)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 3 4
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Aspect Ratio 4By3HERO12 Black
    1Video Aspect Ratio 16By9HERO12 Black
    3Video Aspect Ratio 8By7HERO12 Black
    4Video Aspect Ratio 9By16HERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Digital Lenses (121)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2 3 4 7 8 9 10 11
    Example: 7
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Digital Lenses WideHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    2Video Digital Lenses NarrowHERO9 Black, HERO10 Black
    3Video Digital Lenses SuperviewHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    4Video Digital Lenses LinearHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    7Video Digital Lenses Max SuperviewHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    8Video Digital Lenses Linear Plus Horizon LevelingHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    9Video Digital Lenses HyperviewHERO11 Black Mini, HERO12 Black, HERO11 Black
    10Video Digital Lenses Linear Plus Horizon LockHERO11 Black Mini, HERO12 Black, HERO11 Black
    11Video Digital Lenses Max HyperviewHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Easy Framing (193)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Easy Framing WidescreenHERO12 Black
    1Video Easy Framing VerticalHERO12 Black
    2Video Easy Framing Full FrameHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Easy Mode Speed (176)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    Example: 103
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Easy Mode Speed 8X Ultra Slo MoHERO11 Black
    1Video Easy Mode Speed 4X Super Slo MoHERO11 Black
    2Video Easy Mode Speed 2X Slo MoHERO11 Black
    3Video Easy Mode Speed 1X Speed Low LightHERO11 Black
    4Video Easy Mode Speed Eb 4X Super Slo MoHERO11 Black
    5Video Easy Mode Speed Eb 2X Slo MoHERO11 Black
    6Video Easy Mode Speed Eb 1X Speed Low LightHERO11 Black
    7Video Easy Mode Speed 8X Ultra Slo Mo 50HzHERO11 Black
    8Video Easy Mode Speed 4X Super Slo Mo 50HzHERO11 Black
    9Video Easy Mode Speed 2X Slo Mo 50HzHERO11 Black
    10Video Easy Mode Speed 1X Speed Low Light 50HzHERO11 Black
    11Video Easy Mode Speed Eb 4X Super Slo Mo 50HzHERO11 Black
    12Video Easy Mode Speed Eb 2X Slo Mo 50HzHERO11 Black
    13Video Easy Mode Speed Eb 1X Speed Low Light 50HzHERO11 Black
    14Video Easy Mode Speed Eb 8X Ultra Slo MoHERO11 Black
    15Video Easy Mode Speed Eb 8X Ultra Slo Mo 50HzHERO11 Black
    16Video Easy Mode Speed Lb 8X Ultra Slo MoHERO11 Black
    17Video Easy Mode Speed Lb 4X Super Slo MoHERO11 Black
    18Video Easy Mode Speed Lb 2X Slo MoHERO11 Black
    19Video Easy Mode Speed Lb 1X Speed Low LightHERO11 Black
    20Video Easy Mode Speed Lb 8X Ultra Slo Mo 50HzHERO11 Black
    21Video Easy Mode Speed Lb 4X Super Slo Mo 50HzHERO11 Black
    22Video Easy Mode Speed Lb 2X Slo Mo 50HzHERO11 Black
    23Video Easy Mode Speed Lb 1X Speed Low Light 50HzHERO11 Black
    24Video Easy Mode Speed 2X Slo Mo 4KHERO11 Black
    25Video Easy Mode Speed 4X Super Slo Mo 2 7KHERO11 Black
    26Video Easy Mode Speed 2X Slo Mo 4K 50HzHERO11 Black
    27Video Easy Mode Speed 4X Super Slo Mo 2 7K 50HzHERO11 Black
    100Video Easy Mode Speed 8X Ultra Slo Mo V2HERO12 Black
    101Video Easy Mode Speed 4X Super Slo Mo V2HERO12 Black
    102Video Easy Mode Speed 2X Slo Mo V2HERO12 Black
    103Video Easy Mode Speed 1X Speed Low Light V2HERO12 Black
    104Video Easy Mode Speed 8X Ultra Slo Mo 50Hz V2HERO12 Black
    105Video Easy Mode Speed 4X Super Slo Mo 50Hz V2HERO12 Black
    106Video Easy Mode Speed 2X Slo Mo 50Hz V2HERO12 Black
    107Video Easy Mode Speed 1X Speed Low Light 50Hz V2HERO12 Black
    108Video Easy Mode Speed Lb 8X Ultra Slo Mo V2HERO12 Black
    109Video Easy Mode Speed Lb 4X Super Slo Mo V2HERO12 Black
    110Video Easy Mode Speed Lb 2X Slo Mo V2HERO12 Black
    111Video Easy Mode Speed Lb 1X Speed Low Light V2HERO12 Black
    112Video Easy Mode Speed Lb 8X Ultra Slo Mo 50Hz V2HERO12 Black
    113Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz V2HERO12 Black
    114Video Easy Mode Speed Lb 2X Slo Mo 50Hz V2HERO12 Black
    115Video Easy Mode Speed Lb 1X Speed Low Light 50Hz V2HERO12 Black
    116Video Easy Mode Speed 2X Slo Mo 4K V2HERO12 Black
    117Video Easy Mode Speed 2X Slo Mo 4K 50Hz V2HERO12 Black
    118Video Easy Mode Speed Mobile 1X Speed Low Light V2HERO12 Black
    119Video Easy Mode Speed Mobile 1X Speed Low Light 50Hz V2HERO12 Black
    120Video Easy Mode Speed Mobile 2X Slo Mo V2HERO12 Black
    121Video Easy Mode Speed Mobile 2X Slo Mo 50Hz V2HERO12 Black
    122Video Easy Mode Speed Universal 1X Speed Low Light V2HERO12 Black
    123Video Easy Mode Speed Universal 1X Speed Low Light 50Hz V2HERO12 Black
    124Video Easy Mode Speed Universal 2X Slo Mo V2HERO12 Black
    125Video Easy Mode Speed Universal 2X Slo Mo 50Hz V2HERO12 Black
    126Video Easy Mode Speed 1X Speed Low Light 4K V2HERO12 Black
    127Video Easy Mode Speed 1X Speed Low Light 4K 50Hz V2HERO12 Black
    128Video Easy Mode Speed 1X Speed Low Light 2 7K V2HERO12 Black
    129Video Easy Mode Speed 1X Speed Low Light 2 7K 50Hz V2HERO12 Black
    130Video Easy Mode Speed 2X Slo Mo 2 7K V2HERO12 Black
    131Video Easy Mode Speed 2X Slo Mo 2 7K 50Hz V2HERO12 Black
    132Video Easy Mode Speed Mobile Lb 2X Slo Mo V2HERO12 Black
    133Video Easy Mode Speed Mobile Lb 2X Slo Mo 50Hz V2HERO12 Black
    134Video Easy Mode Speed Mobile Lb 1X Speed Low Light V2HERO12 Black
    135Video Easy Mode Speed Mobile Lb 1X Speed Low Light 50Hz V2HERO12 Black
    136Video Easy Mode Speed Universal 1X Speed Low Light 4K V2HERO12 Black
    137Video Easy Mode Speed Universal 1X Speed Low Light 4K 50Hz V2HERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Easy Presets (186)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Easy Presets Highest QualityHERO12 Black
    1Video Easy Presets Standard QualityHERO12 Black
    2Video Easy Presets Basic QualityHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Fps (3)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2 5 6 8 9 10 13
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Fps 240HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    1Video Fps 120HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    2Video Fps 100HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    5Video Fps 60HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    6Video Fps 50HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    8Video Fps 30HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    9Video Fps 25HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    10Video Fps 24HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    13Video Fps 200HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Hindsight Length (167)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 2 3 4
    Example: 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    2Video Hindsight Length 15 SecondsHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    3Video Hindsight Length 30 SecondsHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    4Video Hindsight Length OffHERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Horizon Levelling (150)


    +

    Supported Cameras:

    +
      +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 2
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Horizon Levelling OffHERO11 Black
    2Video Horizon Levelling LockedHERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Hypersmooth (135)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2 3 4 100
    Example: 3
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Hypersmooth OffHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    1Video Hypersmooth OnHERO11 Black Mini, HERO9 Black, HERO12 Black, HERO11 Black
    2Video Hypersmooth HighHERO9 Black, HERO10 Black
    3Video Hypersmooth BoostHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO11 Black
    4Video Hypersmooth Auto BoostHERO11 Black Mini, HERO12 Black, HERO11 Black
    100Video Hypersmooth StandardHERO10 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Profile (184)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1 2
    + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Video Profile StandardHERO12 Black
    1Video Profile HdrHERO12 Black
    2Video Profile 10 Bit LogHERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Video Resolution (2)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    • HERO9 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 1 4 6 7 9 18 24 25 26 27 28 100 107 108 109 110 111
    Example: 24
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    1Video Resolution 4KHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    4Video Resolution 2 7KHERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    6Video Resolution 2 7K 4By3HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO11 Black
    7Video Resolution 1440HERO9 Black
    9Video Resolution 1080HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    18Video Resolution 4K 4By3HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black
    24Video Resolution 5KHERO9 Black
    25Video Resolution 5K 4By3HERO10 Black
    26Video Resolution 5 3K 8By7HERO11 Black Mini, HERO11 Black
    27Video Resolution 5 3K 4By3HERO11 Black Mini, HERO11 Black
    28Video Resolution 4K 8By7HERO11 Black Mini, HERO11 Black
    100Video Resolution 5 3KHERO11 Black Mini, HERO10 Black, HERO12 Black, HERO11 Black
    107Video Resolution 5 3K 8By7 V2HERO12 Black
    108Video Resolution 4K 8By7 V2HERO12 Black
    109Video Resolution 4K 9By16 V2HERO12 Black
    110Video Resolution 1080 9By16 V2HERO12 Black
    111Video Resolution 2 7K 4By3 V2HERO12 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Wireless Wireless Band (178)


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black Mini
    • +
    • HERO11 Black
    • +
    +
    path Parameters
    option
    required
    integer
    Enum: 0 1
    + + + + + + + + + + + + + + + + + +
    IDMeaningCameras
    0Wireless Wireless Band 2 4 GhzHERO11 Black Mini, HERO12 Black, HERO11 Black
    1Wireless Wireless Band 5 GhzHERO11 Black Mini, HERO12 Black, HERO11 Black
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Webcam

    The webcam feature enables developers who are interested in writing custom drivers to broadcast the camera's video +preview with a limited set of resolution, field of view, port, and protocol options.

    +

    While active, the webcam feature sends raw data to the connected client using a supported protocol. To enable +multi-cam support, some cameras support running on a user-specified port. Protocol and port details are provided in a +table below.

    +

    To test basic functionality, start the webcam, and use an application such as VLC to open a network stream:

    + + + + + + + + + + + + + + + +
    ProtocolPort
    TSudp://@:{PORT}
    RTSPrtsp://{CAMERA_IP}:554/live
    +

    For readers interested in using a GoPro camera as a webcam with preexisting tools, please see +How to use GoPro as a Webcam.

    +

    Webcam via USB

    +

    For USB connections, prior to issuing webcam commands, Wired USB Control should +be disabled.

    +

    Webcam State Diagram

    +

    webcam state diagram

    +

    Webcam Stabilization

    +

    Should the client require stabilization, the +Hypersmooth setting +can be used while in the state: READY (Status: OFF). This setting can only be set while webcam is disabled, which +requires either sending the Webcam Exit command or reseating the USB-C connection to the camera.

    +
    +

    Note! The Low Hypersmooth option provides lower/lighter stabilization when used in Webcam mode vs other camera modes.

    +
    +

    Enter Webcam Preview

    Not supported on WiFi for: + - Hero 11 Black Mini + - Hero 11 Black + - Hero 10 Black + - Hero 9 Black

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Exit Webcam Mode

    Not supported on WiFi for: + - Hero 11 Black Mini + - Hero 11 Black + - Hero 10 Black + - Hero 9 Black

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Get Webcam Status


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    error
    integer
    Enum: 0 1 2 3 4 5 6 7 8

    Current webcam error (if status was not successful)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CodeStatus
    0None
    1Set Preset
    2Set Window Size
    3Exec Stream
    4Shutter
    5Com timeout
    6Invalid param
    7Unavailable
    8Exit
    +
    status
    integer
    Enum: 0 1 2 3

    Current webcam status

    + + + + + + + + + + + + + + + + + + + + + + + +
    CodeStatus
    0Off
    1Idle
    2High Power Preview
    3Low Power Preview
    +

    Response samples

    Content type
    application/json
    {
    • "error": 0,
    • "status": 0
    }

    Get Webcam Version


    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    max_lens_support
    boolean

    Does the webcam support Max Lens Mod?

    +
    usb_3_1_compatible
    boolean

    Is the webcam USB 3.1 compatible?

    +
    version
    integer

    Current webcam version

    +

    Response samples

    Content type
    application/json
    {
    • "max_lens_support": true,
    • "usb_3_1_compatible": true,
    • "version": 0
    }

    Start Webcam

    Not supported on WiFi for: + - Hero 11 Black Mini + - Hero 11 Black + - Hero 10 Black + - Hero 9 Black

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +
    query Parameters
    res
    integer

    Webcam Resolution

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDSetting
    162Max Lens
    173Video Performance Mode
    175Controls
    177Enable Night Photo
    180Video Mode
    186Video Mode
    187Lapse Mode
    189Max Lens Mod
    190Max Lens Mod Enable
    191Photo Mode
    +
    fov
    integer

    Webcam field-of-view

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    IDSetting
    162Max Lens
    173Video Performance Mode
    175Controls
    177Enable Night Photo
    180Video Mode
    186Video Mode
    187Lapse Mode
    189Max Lens Mod
    190Max Lens Mod Enable
    191Photo Mode
    +
    port
    integer
    Example: port=8556

    Port to use for Webcam Stream. Defaults to 8554 if not set

    +

    Not supported on:

    +
      +
    • Hero 11 Black Mini
    • +
    • Hero 10 Black
    • +
    • Hero 9 Black
    • +
    +
    protocol
    string
    Enum: "RTSP" "TS"

    Streaming protocol to use.

    +

    Not supported on:

    +
      +
    • Hero 11 Black Mini
    • +
    • Hero 11 Black
    • +
    • Hero 10 Black
    • +
    • Hero 9 Black
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }

    Stop Webcam

    Not supported on WiFi for: + - Hero 11 Black Mini + - Hero 11 Black + - Hero 10 Black + - Hero 9 Black

    +
    +

    Supported Cameras:

    +
      +
    • HERO12 Black
    • +
    • HERO11 Black
    • +
    • HERO10 Black
    • +
    +
    +

    Supported Protocols:

    +
      +
    • USB
    • +
    • WIFI
    • +
    +

    Responses

    Response Schema: application/json
    object

    Response samples

    Content type
    application/json
    { }
    + + + + \ No newline at end of file diff --git a/http_2_0.html b/http_2_0.html index 17a55913..77c90bc5 100644 --- a/http_2_0.html +++ b/http_2_0.html @@ -1,6856 +1,14 @@ - - - - - -HTTP Specification v2.0 : Open GoPro - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    -
    - -
    -
    -
    - - -
    - - - - - - - - - - - - - -
    - - - - - -
    - - - - - -
    - -
    -

    HTTP Specification v2.0 -

    - - -

    - - - - - - - - - - - - 62 minute read - - - -

    - - -
    - - -
    - - - -

    Overview

    - -

    -The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera. -

    - -

    What can you do with the GoPro API?

    - -

    -The GoPro API allows you to control and query the camera: -

    -
      -
    • Capture photo/video media
    • -
    • Get media list
    • -
    • Change settings
    • -
    • Get and set the date/time
    • -
    • Get camera status
    • -
    • Get media metadata (file size, width, height, duration, tags, etc)
    • -
    • and more!
    • -
    - - -

    Supported Cameras

    - -

    -Below is a table of cameras that support GoPro's public HTTP API: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Model IDModel CodeMarketing NameMinimal Firmware Version
    62H23.01HERO12 Blackv01.10.00
    60H22.03HERO11 Black Miniv01.10.00
    58H22.01HERO11 Blackv01.10.00
    57H21.01HERO10 Blackv01.10.00
    55HD9.01HERO9 Blackv01.70.00
    - -

    The Basics

    - -

    Connection

    -

    WiFi

    -

    -Connection to the camera via WiFi requires that the camera's WiFi Access Point be enabled. -This can be done by connecting to the camera via -Bluetooth Low Energy (BLE) -and sending a command to enable AP Mode. -

    - -

    USB

    -

    -OpenGoPro systems that utilize USB must support the Network Control Model (NCM) protocol. -Connecting via USB requires the following steps: -

    -
      -
    1. Physically connect the camera's USB-C port to your system
    2. -
    3. Send HTTP command to enable wired USB control
    4. -
    - - -

    Authentication

    - -

    WiFi

    - -

    -Once the WiFi Access Point has been turned on, authentication with the camera simply requires connecting with the -correct SSID and password. This information can be obtained in two ways: - -

    -
      -
    • Put the camera into pairing mode and tap the info button in the top-right corner of the screen.
    • -
    • Read the SSID/password directly via Bluetooth Low Energy. See Services and Characteristics section in BLE Specification for details.
    • -
    - - -

    USB

    -

    -No authentication is necessary. -

    - -

    Socket Address

    - -

    WiFi

    -

    -The socket address for WiFi connections is 10.5.5.9:8080. -

    - -

    USB

    -

    -The socket address for USB connections is 172.2X.1YZ.51:8080 where: - -

    -
      -
    • X is the 100's digit from the camera serial number
    • -
    • Y is the 10's digit from the camera serial number
    • -
    • Z is the 1's digit from the camera serial number
    • -
    - - -

    -The camera's serial number can be obtained in any of the following ways: -

    -
      -
    • Reading the sticker inside the camera's battery enclosure
    • -
    • Camera UI: Preferences >> About >> Camera Info
    • -
    • Bluetooth Low Energy: By reading directly from Hardware Info -
    • -
    - - -

    -For example, if the camera's serial number is C0000123456789, the IP address for USB connections would be 172.27.189.51. -

    - -

    -Alternatively, the IP address can be discovered via mDNS as the camera registers the _gopro-web service. -

    - -

    Request and Response Formats

    -

    -Most commands are sent via HTTP/GET and require no special headers. -Responses come in two parts: The standard HTTP return codes and JSON containing any additional information. -

    - -

    -The typical use case is that the camera accepts a valid command, returns HTTP/200 (OK) and empty JSON -(i.e. { }) and begins asynchronously working on the command. -If an error occurs, the camera will return a standard HTTP error code and JSON with helpful error/debug information. -

    - -

    -Depending on the command sent, the camera can return JSON, binary, or Protobuf data. Some examples are listed below: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CommandReturn Type
    Get Camera StateJSON
    Get Media InfoJSON
    Get Media GPMF -Binary
    Get Media ListJSON
    Get Media Screennail (JPEG)Binary
    Get Media Thumbnail (JPEG)Binary
    Get PresetsJSON
    - -

    Sending Commands

    - -

    -Depending on the camera's state, it may not be ready to accept specific commands. -This ready state is dependent on the System Busy and the Encoding Active status flags. For example: - -

    -
      -
    • System Busy flag is set while loading presets, changing settings, formatting sdcard, ...
    • -
    • Encoding Active flag is set while capturing photo/video media
    • -
    - - -

    -If the system is not ready, it should reject an incoming command; however, best practice is to always wait for the -System Busy and Encode Active flags to be unset before sending messages other than camera status queries. -For details regarding camera state, see Status Codes. -

    - -

    Keep Alive

    -

    -In order to maximize battery life, GoPro cameras automatically go to sleep after some time. -This logic is handled by a combination of an Auto Power Down setting which most (but not all) cameras support -and a Keep Alive message that the user can regularly send to the camera. -The camera will automatically go to sleep if both timers reach zero. -

    - -

    -The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera or -programmatically (un)sets the shutter, sets a setting, or loads a Preset. -

    - -

    -The Keep Alive timer is reset when the user sends a keep alive message. -

    - -

    -The best practice to prevent the camera from inadvertently going to sleep is to start sending Keep Alive messages -every 3.0 seconds after a connection is established. -

    - -

    Command

    - - - - - - - - - - - -
    HTTP/GETDescription
    /gopro/camera/keep_aliveSend keep-alive
    - -

    Commands

    -

    Using the Open GoPro API, a client can perform various command, control, and query operations!

    - -

    Commands Quick Reference

    -

    -Below is a table of commands that can be sent to the camera and how to send them.
    -* Indicates that item is experimental
    - Indicates support for all Open GoPro firmware versions.
    - Indicates a lack of support for all Open GoPro firmware versions.
    ->= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CommandDescriptionHTTP MethodEndpointHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    AnalyticsSet third party clientGET/gopro/camera/analytics/set_client_info>= v01.30.00>= v01.70.00
    COHN: Get certGet cohn certGET/GoProRootCA.crt
    COHN: Get statusGet cohn statusPOST/gopro/cohn/status
    COHN: Get statusGet cohn statusPOST/gopro/cohn/status
    Camera: Get StateGet camera state (status + settings)GET/gopro/camera/state
    Digital ZoomDigital zoom 50%GET/gopro/camera/digital_zoom?percent=50
    Get Date/TimeGet date/timeGET/gopro/camera/get_date_time>= v01.30.00>= v01.70.00
    Get Hardware InfoGet camera hardware infoGET/gopro/camera/info
    Keep-aliveSend keep-aliveGET/gopro/camera/keep_alive
    Media: GPMFGet GPMF data (JPG)GET/gopro/media/gpmf?path=100GOPRO/XXX.JPG
    Media: GPMFGet GPMF data (MP4)GET/gopro/media/gpmf?path=100GOPRO/XXX.MP4
    Media: HiLight (Add)Add hilight to 100GOPRO/xxx.JPGGET/gopro/media/hilight/file?path=100GOPRO/XXX.JPG>= v01.30.00>= v01.70.00
    Media: HiLight (Add)Add hilight to 100GOPRO/xxx.MP4 at offset 2500 msGET/gopro/media/hilight/file?path=100GOPRO/XXX.MP4&ms=2500>= v01.30.00>= v01.70.00
    Media: HiLight (Remove)Remove hilight from 100GOPRO/xxx.JPGGET/gopro/media/hilight/remove?path=100GOPRO/XXX.JPG>= v01.30.00>= v01.70.00
    Media: HiLight (Remove)Remove hilight from 100GOPRO/xxx.MP4 at offset 2500msGET/gopro/media/hilight/remove?path=100GOPRO/XXX.MP4&ms=2500>= v01.30.00>= v01.70.00
    Media: HiLight MomentHilight moment during encodingGET/gopro/media/hilight/moment>= v01.30.00
    Media: InfoGet media info (JPG)GET/gopro/media/info?path=100GOPRO/XXX.JPG
    Media: InfoGet media info (MP4)GET/gopro/media/info?path=100GOPRO/XXX.MP4
    Media: ListGet media listGET/gopro/media/list
    Media: ScreennailGet screennail for “100GOPRO/xxx.JPG”GET/gopro/media/screennail?path=100GOPRO/XXX.JPG
    Media: ScreennailGet screennail for “100GOPRO/xxx.MP4”GET/gopro/media/screennail?path=100GOPRO/XXX.MP4
    Media: TelemetryGet telemetry track data (JPG)GET/gopro/media/telemetry?path=100GOPRO/XXX.JPG
    Media: TelemetryGet telemetry track data (MP4)GET/gopro/media/telemetry?path=100GOPRO/XXX.MP4
    Media: ThumbnailGet thumbnail for “100GOPRO/xxx.JPG”GET/gopro/media/thumbnail?path=100GOPRO/XXX.JPG
    Media: ThumbnailGet thumbnail for “100GOPRO/xxx.MP4”GET/gopro/media/thumbnail?path=100GOPRO/XXX.MP4
    Media: Turbo TransferTurbo transfer: offGET/gopro/media/turbo_transfer?p=0
    Media: Turbo TransferTurbo transfer: onGET/gopro/media/turbo_transfer?p=1
    OTA UpdateSoft update: upload 12345 bytes starting at offset 67890POST/gp/gpSoftUpdate (plus data)
    OTA UpdateSoft update: mark upload completePOST/gp/gpSoftUpdate (plus data)
    Open GoProGet versionGET/gopro/version
    Presets: Get StatusGet preset statusGET/gopro/camera/presets/get
    Presets: LoadExample preset id: 0x1234ABCDGET/gopro/camera/presets/load?id=305441741
    Presets: Load GroupVideoGET/gopro/camera/presets/set_group?id=1000
    Presets: Load GroupPhotoGET/gopro/camera/presets/set_group?id=1001
    Presets: Load GroupTimelapseGET/gopro/camera/presets/set_group?id=1002
    Set Camera Control StatusSet camera control status to idleGET/gopro/camera/control/set_ui_controller?p=0>= v01.20.00
    Set Camera Control StatusSet camera control status to external_controlGET/gopro/camera/control/set_ui_controller?p=2>= v01.20.00
    Set Date/TimeSet date/time to 2023-01-31 03:04:05GET/gopro/camera/set_date_time?date=2023_1_31&time=3_4_5>= v01.30.00>= v01.70.00
    Set Local Date/TimeSet local date/time to: 2023-01-31 03:04:05 (utc-02:00) (dst: on)GET/gopro/camera/set_date_time?date=2023_1_31&time=3_4_5&tzone=-120&dst=1
    Set shutterShutter: onGET/gopro/camera/shutter/start
    Set shutterShutter: offGET/gopro/camera/shutter/stop
    Simple OTA UpdateSimple ota update with file: update.zipPOST/gp/gpUpdate (plus data)
    Soft UpdateSoft update: show canceled/failed ui on the cameraGET/gp/gpSoftUpdate?request=canceled
    Soft UpdateSoft update: delete cached update filesGET/gp/gpSoftUpdate?request=delete
    Soft UpdateSoft update: get current update stateGET/gp/gpSoftUpdate?request=progress
    Soft UpdateSoft update: display update ui on cameraGET/gp/gpSoftUpdate?request=showui
    Soft UpdateSoft update: initiate firmware updateGET/gp/gpSoftUpdate?request=start
    Stream: StartStart preview streamGET/gopro/camera/stream/start
    Stream: StopStop preview streamGET/gopro/camera/stream/stop
    Webcam: ExitExit webcam modeGET/gopro/webcam/exit
    Webcam: PreviewStart preview streamGET/gopro/webcam/preview
    Webcam: StartStart webcamGET/gopro/webcam/start>= v01.40.00
    Webcam: StartStart webcam (port: 12345)GET/gopro/webcam/start?port=12345>= v02.01.00
    Webcam: StartStart webcam (port: 12345, protocol: rtsp)GET/gopro/webcam/start?port=12345&protocol=RTSP
    Webcam: StartStart webcam (port: 12345, protocol: ts)GET/gopro/webcam/start?port=12345&protocol=TS
    Webcam: StartStart webcam (res: resolution_1080, fov: wide)GET/gopro/webcam/start?res=12&fov=0
    Webcam: StatusGet webcam statusGET/gopro/webcam/status
    Webcam: StopStop webcamGET/gopro/webcam/stop
    Webcam: VersionGet webcam api versionGET/gopro/webcam/version
    Wired USB ControlDisable wired usb controlGET/gopro/camera/control/wired_usb?p=0>= v01.30.00
    Wired USB ControlEnable wired usb controlGET/gopro/camera/control/wired_usb?p=1>= v01.30.00
    - -

    Settings

    -

    -GoPro cameras have hundreds of setting options to choose from, all of which can be set using a single endpoint. -The endpoint is configured with a setting id and an option value. -Note that setting option values are not globally unique. -While most option values are enumerated values, some are complex bitmasked values. -

    - -

    Settings Quick Reference

    -

    -Below is a table of setting options detailing how to set every option supported by Open GoPro cameras.
    -* Indicates that item is experimental
    - Indicates support for all Open GoPro firmware versions.
    - Indicates a lack of support for all Open GoPro firmware versions.
    ->= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Setting IDSettingOptionHTTP MethodEndpointHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    2ResolutionSet video resolution (id: 2) to 4k (id: 1)GET/gopro/camera/setting?setting=2&option=1
    2ResolutionSet video resolution (id: 2) to 2.7k (id: 4)GET/gopro/camera/setting?setting=2&option=4
    2ResolutionSet video resolution (id: 2) to 2.7k 4:3 (id: 6)GET/gopro/camera/setting?setting=2&option=6
    2ResolutionSet video resolution (id: 2) to 1440 (id: 7)GET/gopro/camera/setting?setting=2&option=7
    2ResolutionSet video resolution (id: 2) to 1080 (id: 9)GET/gopro/camera/setting?setting=2&option=9
    2ResolutionSet video resolution (id: 2) to 4k 4:3 (id: 18)GET/gopro/camera/setting?setting=2&option=18
    2ResolutionSet video resolution (id: 2) to 5k (id: 24)GET/gopro/camera/setting?setting=2&option=24
    2ResolutionSet video resolution (id: 2) to 5k 4:3 (id: 25)GET/gopro/camera/setting?setting=2&option=25
    2ResolutionSet video resolution (id: 2) to 5.3k 8:7 (id: 26)GET/gopro/camera/setting?setting=2&option=26
    2ResolutionSet video resolution (id: 2) to 5.3k 4:3 (id: 27)GET/gopro/camera/setting?setting=2&option=27
    2ResolutionSet video resolution (id: 2) to 4k 8:7 (id: 28)GET/gopro/camera/setting?setting=2&option=28
    2ResolutionSet video resolution (id: 2) to 4k 9:16 (id: 29)GET/gopro/camera/setting?setting=2&option=29
    2ResolutionSet video resolution (id: 2) to 1080 9:16 (id: 30)GET/gopro/camera/setting?setting=2&option=30
    2ResolutionSet video resolution (id: 2) to 5.3k (id: 100)GET/gopro/camera/setting?setting=2&option=100
    2ResolutionSet video resolution (id: 2) to 5.3k 16:9 (id: 101)GET/gopro/camera/setting?setting=2&option=101
    2ResolutionSet video resolution (id: 2) to 4k 16:9 (id: 102)GET/gopro/camera/setting?setting=2&option=102
    2ResolutionSet video resolution (id: 2) to 4k 4:3 (id: 103)GET/gopro/camera/setting?setting=2&option=103
    2ResolutionSet video resolution (id: 2) to 2.7k 16:9 (id: 104)GET/gopro/camera/setting?setting=2&option=104
    2ResolutionSet video resolution (id: 2) to 2.7k 4:3 (id: 105)GET/gopro/camera/setting?setting=2&option=105
    2ResolutionSet video resolution (id: 2) to 1080 16:9 (id: 106)GET/gopro/camera/setting?setting=2&option=106
    3Frames Per SecondSet video fps (id: 3) to 240 (id: 0)GET/gopro/camera/setting?setting=3&option=0
    3Frames Per SecondSet video fps (id: 3) to 120 (id: 1)GET/gopro/camera/setting?setting=3&option=1
    3Frames Per SecondSet video fps (id: 3) to 100 (id: 2)GET/gopro/camera/setting?setting=3&option=2
    3Frames Per SecondSet video fps (id: 3) to 60 (id: 5)GET/gopro/camera/setting?setting=3&option=5
    3Frames Per SecondSet video fps (id: 3) to 50 (id: 6)GET/gopro/camera/setting?setting=3&option=6
    3Frames Per SecondSet video fps (id: 3) to 30 (id: 8)GET/gopro/camera/setting?setting=3&option=8
    3Frames Per SecondSet video fps (id: 3) to 25 (id: 9)GET/gopro/camera/setting?setting=3&option=9
    3Frames Per SecondSet video fps (id: 3) to 24 (id: 10)GET/gopro/camera/setting?setting=3&option=10
    3Frames Per SecondSet video fps (id: 3) to 200 (id: 13)GET/gopro/camera/setting?setting=3&option=13
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to wide (id: 0)GET/gopro/camera/setting?setting=43&option=0
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to narrow (id: 2)GET/gopro/camera/setting?setting=43&option=2
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to superview (id: 3)GET/gopro/camera/setting?setting=43&option=3
    43Webcam Digital LensesSet webcam digital lenses (id: 43) to linear (id: 4)GET/gopro/camera/setting?setting=43&option=4
    59Auto Power DownSet auto power down (id: 59) to never (id: 0)GET/gopro/camera/setting?setting=59&option=0>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 1 min (id: 1)GET/gopro/camera/setting?setting=59&option=1>= v02.10.00>= v02.01.00
    59Auto Power DownSet auto power down (id: 59) to 5 min (id: 4)GET/gopro/camera/setting?setting=59&option=4>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 15 min (id: 6)GET/gopro/camera/setting?setting=59&option=6
    59Auto Power DownSet auto power down (id: 59) to 30 min (id: 7)GET/gopro/camera/setting?setting=59&option=7
    59Auto Power DownSet auto power down (id: 59) to 8 seconds (id: 11)GET/gopro/camera/setting?setting=59&option=11>= v02.10.00
    59Auto Power DownSet auto power down (id: 59) to 30 seconds (id: 12)GET/gopro/camera/setting?setting=59&option=12>= v02.10.00
    108Aspect RatioSet video aspect ratio (id: 108) to 4:3 (id: 0)GET/gopro/camera/setting?setting=108&option=0
    108Aspect RatioSet video aspect ratio (id: 108) to 16:9 (id: 1)GET/gopro/camera/setting?setting=108&option=1
    108Aspect RatioSet video aspect ratio (id: 108) to 8:7 (id: 3)GET/gopro/camera/setting?setting=108&option=3
    108Aspect RatioSet video aspect ratio (id: 108) to 9:16 (id: 4)GET/gopro/camera/setting?setting=108&option=4
    121Video Digital LensesSet video digital lenses (id: 121) to wide (id: 0)GET/gopro/camera/setting?setting=121&option=0
    121Video Digital LensesSet video digital lenses (id: 121) to narrow (id: 2)GET/gopro/camera/setting?setting=121&option=2
    121Video Digital LensesSet video digital lenses (id: 121) to superview (id: 3)GET/gopro/camera/setting?setting=121&option=3
    121Video Digital LensesSet video digital lenses (id: 121) to linear (id: 4)GET/gopro/camera/setting?setting=121&option=4
    121Video Digital LensesSet video digital lenses (id: 121) to max superview (id: 7)GET/gopro/camera/setting?setting=121&option=7>= v02.00.00
    121Video Digital LensesSet video digital lenses (id: 121) to linear + horizon leveling (id: 8)GET/gopro/camera/setting?setting=121&option=8
    121Video Digital LensesSet video digital lenses (id: 121) to hyperview (id: 9)GET/gopro/camera/setting?setting=121&option=9
    121Video Digital LensesSet video digital lenses (id: 121) to linear + horizon lock (id: 10)GET/gopro/camera/setting?setting=121&option=10
    121Video Digital LensesSet video digital lenses (id: 121) to max hyperview (id: 11)GET/gopro/camera/setting?setting=121&option=11
    122Photo Digital LensesSet photo digital lenses (id: 122) to narrow (id: 19)GET/gopro/camera/setting?setting=122&option=19
    122Photo Digital LensesSet photo digital lenses (id: 122) to max superview (id: 100)GET/gopro/camera/setting?setting=122&option=100
    122Photo Digital LensesSet photo digital lenses (id: 122) to wide (id: 101)GET/gopro/camera/setting?setting=122&option=101
    122Photo Digital LensesSet photo digital lenses (id: 122) to linear (id: 102)GET/gopro/camera/setting?setting=122&option=102
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to narrow (id: 19)GET/gopro/camera/setting?setting=123&option=19
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to max superview (id: 100)GET/gopro/camera/setting?setting=123&option=100
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to wide (id: 101)GET/gopro/camera/setting?setting=123&option=101
    123Time Lapse Digital LensesSet time lapse digital lenses (id: 123) to linear (id: 102)GET/gopro/camera/setting?setting=123&option=102
    128Media FormatSet media format (id: 128) to time lapse video (id: 13)GET/gopro/camera/setting?setting=128&option=13
    128Media FormatSet media format (id: 128) to time lapse photo (id: 20)GET/gopro/camera/setting?setting=128&option=20
    128Media FormatSet media format (id: 128) to night lapse photo (id: 21)GET/gopro/camera/setting?setting=128&option=21
    128Media FormatSet media format (id: 128) to night lapse video (id: 26)GET/gopro/camera/setting?setting=128&option=26
    134Anti-FlickerSet setup anti flicker (id: 134) to 60hz (id: 2)GET/gopro/camera/setting?setting=134&option=2
    134Anti-FlickerSet setup anti flicker (id: 134) to 50hz (id: 3)GET/gopro/camera/setting?setting=134&option=3
    135HypersmoothSet video hypersmooth (id: 135) to off (id: 0)GET/gopro/camera/setting?setting=135&option=0
    135HypersmoothSet video hypersmooth (id: 135) to low (id: 1)GET/gopro/camera/setting?setting=135&option=1
    135HypersmoothSet video hypersmooth (id: 135) to high (id: 2)GET/gopro/camera/setting?setting=135&option=2
    135HypersmoothSet video hypersmooth (id: 135) to boost (id: 3)GET/gopro/camera/setting?setting=135&option=3
    135HypersmoothSet video hypersmooth (id: 135) to auto boost (id: 4)GET/gopro/camera/setting?setting=135&option=4
    135HypersmoothSet video hypersmooth (id: 135) to standard (id: 100)GET/gopro/camera/setting?setting=135&option=100
    150Horizon LevelingSet video horizon levelling (id: 150) to off (id: 0)GET/gopro/camera/setting?setting=150&option=0>= v02.00.00
    150Horizon LevelingSet video horizon levelling (id: 150) to on (id: 1)GET/gopro/camera/setting?setting=150&option=1>= v02.00.00
    150Horizon LevelingSet video horizon levelling (id: 150) to locked (id: 2)GET/gopro/camera/setting?setting=150&option=2
    151Horizon LevelingSet photo horizon levelling (id: 151) to off (id: 0)GET/gopro/camera/setting?setting=151&option=0
    151Horizon LevelingSet photo horizon levelling (id: 151) to locked (id: 2)GET/gopro/camera/setting?setting=151&option=2
    162Max LensSet max lens (id: 162) to off (id: 0)GET/gopro/camera/setting?setting=162&option=0>= v01.20.00
    162Max LensSet max lens (id: 162) to on (id: 1)GET/gopro/camera/setting?setting=162&option=1>= v01.20.00
    167Hindsight*Set hindsight (id: 167) to 15 seconds (id: 2)GET/gopro/camera/setting?setting=167&option=2
    167Hindsight*Set hindsight (id: 167) to 30 seconds (id: 3)GET/gopro/camera/setting?setting=167&option=3
    167Hindsight*Set hindsight (id: 167) to off (id: 4)GET/gopro/camera/setting?setting=167&option=4
    171IntervalSet photo single interval (id: 171) to off (id: 0)GET/gopro/camera/setting?setting=171&option=0
    171IntervalSet photo single interval (id: 171) to 0.5s (id: 2)GET/gopro/camera/setting?setting=171&option=2
    171IntervalSet photo single interval (id: 171) to 1s (id: 3)GET/gopro/camera/setting?setting=171&option=3
    171IntervalSet photo single interval (id: 171) to 2s (id: 4)GET/gopro/camera/setting?setting=171&option=4
    171IntervalSet photo single interval (id: 171) to 5s (id: 5)GET/gopro/camera/setting?setting=171&option=5
    171IntervalSet photo single interval (id: 171) to 10s (id: 6)GET/gopro/camera/setting?setting=171&option=6
    171IntervalSet photo single interval (id: 171) to 30s (id: 7)GET/gopro/camera/setting?setting=171&option=7
    171IntervalSet photo single interval (id: 171) to 60s (id: 8)GET/gopro/camera/setting?setting=171&option=8
    171IntervalSet photo single interval (id: 171) to 120s (id: 9)GET/gopro/camera/setting?setting=171&option=9
    171IntervalSet photo single interval (id: 171) to 3s (id: 10)GET/gopro/camera/setting?setting=171&option=10
    172DurationSet photo interval duration (id: 172) to off (id: 0)GET/gopro/camera/setting?setting=172&option=0
    172DurationSet photo interval duration (id: 172) to 15 seconds (id: 1)GET/gopro/camera/setting?setting=172&option=1
    172DurationSet photo interval duration (id: 172) to 30 seconds (id: 2)GET/gopro/camera/setting?setting=172&option=2
    172DurationSet photo interval duration (id: 172) to 1 minute (id: 3)GET/gopro/camera/setting?setting=172&option=3
    172DurationSet photo interval duration (id: 172) to 5 minutes (id: 4)GET/gopro/camera/setting?setting=172&option=4
    172DurationSet photo interval duration (id: 172) to 15 minutes (id: 5)GET/gopro/camera/setting?setting=172&option=5
    172DurationSet photo interval duration (id: 172) to 30 minutes (id: 6)GET/gopro/camera/setting?setting=172&option=6
    172DurationSet photo interval duration (id: 172) to 1 hour (id: 7)GET/gopro/camera/setting?setting=172&option=7
    172DurationSet photo interval duration (id: 172) to 2 hours (id: 8)GET/gopro/camera/setting?setting=172&option=8
    172DurationSet photo interval duration (id: 172) to 3 hours (id: 9)GET/gopro/camera/setting?setting=172&option=9
    173Video Performance ModeSet video performance mode (id: 173) to maximum video performance (id: 0)GET/gopro/camera/setting?setting=173&option=0>= v01.16.00
    173Video Performance ModeSet video performance mode (id: 173) to extended battery (id: 1)GET/gopro/camera/setting?setting=173&option=1>= v01.16.00
    173Video Performance ModeSet video performance mode (id: 173) to tripod / stationary video (id: 2)GET/gopro/camera/setting?setting=173&option=2>= v01.16.00
    175ControlsSet controls (id: 175) to easy (id: 0)GET/gopro/camera/setting?setting=175&option=0
    175ControlsSet controls (id: 175) to pro (id: 1)GET/gopro/camera/setting?setting=175&option=1
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (id: 0)GET/gopro/camera/setting?setting=176&option=0
    176SpeedSet speed (id: 176) to 4x super slo-mo (id: 1)GET/gopro/camera/setting?setting=176&option=1
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 2)GET/gopro/camera/setting?setting=176&option=2
    176SpeedSet speed (id: 176) to 1x (low light) (id: 3)GET/gopro/camera/setting?setting=176&option=3
    176SpeedSet speed (id: 176) to 4x super slo-mo (ext. batt) (id: 4)GET/gopro/camera/setting?setting=176&option=4
    176SpeedSet speed (id: 176) to 2x slo-mo (ext. batt) (id: 5)GET/gopro/camera/setting?setting=176&option=5
    176SpeedSet speed (id: 176) to 1x (ext. batt, low light) (id: 6)GET/gopro/camera/setting?setting=176&option=6
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (50hz) (id: 7)GET/gopro/camera/setting?setting=176&option=7
    176SpeedSet speed (id: 176) to 4x super slo-mo (50hz) (id: 8)GET/gopro/camera/setting?setting=176&option=8
    176SpeedSet speed (id: 176) to 2x slo-mo (50hz) (id: 9)GET/gopro/camera/setting?setting=176&option=9
    176SpeedSet speed (id: 176) to 1x (low light, 50hz) (id: 10)GET/gopro/camera/setting?setting=176&option=10
    176SpeedSet speed (id: 176) to 4x super slo-mo (ext. batt, 50hz) (id: 11)GET/gopro/camera/setting?setting=176&option=11
    176SpeedSet speed (id: 176) to 2x slo-mo (ext. batt, 50hz) (id: 12)GET/gopro/camera/setting?setting=176&option=12
    176SpeedSet speed (id: 176) to 1x (ext. batt, low light, 50hz) (id: 13)GET/gopro/camera/setting?setting=176&option=13
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (ext. batt) (id: 14)GET/gopro/camera/setting?setting=176&option=14>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (ext. batt, 50hz) (id: 15)GET/gopro/camera/setting?setting=176&option=15>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (long. batt) (id: 16)GET/gopro/camera/setting?setting=176&option=16>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (long. batt) (id: 17)GET/gopro/camera/setting?setting=176&option=17>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (long. batt) (id: 18)GET/gopro/camera/setting?setting=176&option=18>= v02.01.00
    176SpeedSet speed (id: 176) to 1x (long. batt, low light) (id: 19)GET/gopro/camera/setting?setting=176&option=19>= v02.01.00
    176SpeedSet speed (id: 176) to 8x ultra slo-mo (long. batt, 50hz) (id: 20)GET/gopro/camera/setting?setting=176&option=20>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (long. batt, 50hz) (id: 21)GET/gopro/camera/setting?setting=176&option=21>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (long. batt, 50hz) (id: 22)GET/gopro/camera/setting?setting=176&option=22>= v02.01.00
    176SpeedSet speed (id: 176) to 1x (long. batt, low light, 50hz) (id: 23)GET/gopro/camera/setting?setting=176&option=23>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (4k) (id: 24)GET/gopro/camera/setting?setting=176&option=24>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (2.7k) (id: 25)GET/gopro/camera/setting?setting=176&option=25>= v02.01.00
    176SpeedSet speed (id: 176) to 2x slo-mo (4k, 50hz) (id: 26)GET/gopro/camera/setting?setting=176&option=26>= v02.01.00
    176SpeedSet speed (id: 176) to 4x super slo-mo (2.7k, 50hz) (id: 27)GET/gopro/camera/setting?setting=176&option=27>= v02.01.00
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 28)GET/gopro/camera/setting?setting=176&option=28
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 29)GET/gopro/camera/setting?setting=176&option=29
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 30)GET/gopro/camera/setting?setting=176&option=30
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 31)GET/gopro/camera/setting?setting=176&option=31
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 32)GET/gopro/camera/setting?setting=176&option=32
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 33)GET/gopro/camera/setting?setting=176&option=33
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 34)GET/gopro/camera/setting?setting=176&option=34
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 35)GET/gopro/camera/setting?setting=176&option=35
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 36)GET/gopro/camera/setting?setting=176&option=36
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 37)GET/gopro/camera/setting?setting=176&option=37
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 38)GET/gopro/camera/setting?setting=176&option=38
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 39)GET/gopro/camera/setting?setting=176&option=39
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 40)GET/gopro/camera/setting?setting=176&option=40
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 41)GET/gopro/camera/setting?setting=176&option=41
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 42)GET/gopro/camera/setting?setting=176&option=42
    176SpeedSet speed (id: 176) to 2x slo-mo (id: 43)GET/gopro/camera/setting?setting=176&option=43
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 44)GET/gopro/camera/setting?setting=176&option=44
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 45)GET/gopro/camera/setting?setting=176&option=45
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 46)GET/gopro/camera/setting?setting=176&option=46
    176SpeedSet speed (id: 176) to 1x speed / low light (id: 47)GET/gopro/camera/setting?setting=176&option=47
    177Enable Night PhotoSet enable night photo (id: 177) to off (id: 0)GET/gopro/camera/setting?setting=177&option=0
    177Enable Night PhotoSet enable night photo (id: 177) to on (id: 1)GET/gopro/camera/setting?setting=177&option=1
    178Wireless BandSet wireless band (id: 178) to 2.4ghz (id: 0)GET/gopro/camera/setting?setting=178&option=0
    178Wireless BandSet wireless band (id: 178) to 5ghz (id: 1)GET/gopro/camera/setting?setting=178&option=1
    179Trail LengthSet trail length (id: 179) to short (id: 1)GET/gopro/camera/setting?setting=179&option=1
    179Trail LengthSet trail length (id: 179) to long (id: 2)GET/gopro/camera/setting?setting=179&option=2
    179Trail LengthSet trail length (id: 179) to max (id: 3)GET/gopro/camera/setting?setting=179&option=3
    180Video ModeSet video mode (id: 180) to highest quality (id: 0)GET/gopro/camera/setting?setting=180&option=0
    180Video ModeSet video mode (id: 180) to extended battery (id: 1)GET/gopro/camera/setting?setting=180&option=1
    180Video ModeSet video mode (id: 180) to extended battery (green icon) (id: 101)GET/gopro/camera/setting?setting=180&option=101>= v02.01.00
    180Video ModeSet video mode (id: 180) to longest battery (green icon) (id: 102)GET/gopro/camera/setting?setting=180&option=102>= v02.01.00
    182Bit RateSet system video bit rate (id: 182) to standard (id: 0)GET/gopro/camera/setting?setting=182&option=0
    182Bit RateSet system video bit rate (id: 182) to high (id: 1)GET/gopro/camera/setting?setting=182&option=1
    183Bit DepthSet system video bit depth (id: 183) to 8-bit (id: 0)GET/gopro/camera/setting?setting=183&option=0
    183Bit DepthSet system video bit depth (id: 183) to 10-bit (id: 2)GET/gopro/camera/setting?setting=183&option=2
    184ProfilesSet video profile (id: 184) to standard (id: 0)GET/gopro/camera/setting?setting=184&option=0
    184ProfilesSet video profile (id: 184) to hdr (id: 1)GET/gopro/camera/setting?setting=184&option=1
    184ProfilesSet video profile (id: 184) to log (id: 2)GET/gopro/camera/setting?setting=184&option=2
    185Aspect RatioSet video easy aspect ratio (id: 185) to widescreen (id: 0)GET/gopro/camera/setting?setting=185&option=0
    185Aspect RatioSet video easy aspect ratio (id: 185) to mobile (id: 1)GET/gopro/camera/setting?setting=185&option=1
    185Aspect RatioSet video easy aspect ratio (id: 185) to universal (id: 2)GET/gopro/camera/setting?setting=185&option=2
    186Video ModeSet video easy presets (id: 186) to highest quality (id: 0)GET/gopro/camera/setting?setting=186&option=0
    186Video ModeSet video easy presets (id: 186) to standard quality (id: 1)GET/gopro/camera/setting?setting=186&option=1
    186Video ModeSet video easy presets (id: 186) to basic quality (id: 2)GET/gopro/camera/setting?setting=186&option=2
    187Lapse ModeSet multi shot easy presets (id: 187) to timewarp (id: 0)GET/gopro/camera/setting?setting=187&option=0
    187Lapse ModeSet multi shot easy presets (id: 187) to star trails (id: 1)GET/gopro/camera/setting?setting=187&option=1
    187Lapse ModeSet multi shot easy presets (id: 187) to light painting (id: 2)GET/gopro/camera/setting?setting=187&option=2
    187Lapse ModeSet multi shot easy presets (id: 187) to vehicle lights (id: 3)GET/gopro/camera/setting?setting=187&option=3
    187Lapse ModeSet multi shot easy presets (id: 187) to max timewarp (id: 4)GET/gopro/camera/setting?setting=187&option=4
    187Lapse ModeSet multi shot easy presets (id: 187) to max star trails (id: 5)GET/gopro/camera/setting?setting=187&option=5
    187Lapse ModeSet multi shot easy presets (id: 187) to max light painting (id: 6)GET/gopro/camera/setting?setting=187&option=6
    187Lapse ModeSet multi shot easy presets (id: 187) to max vehicle lights (id: 7)GET/gopro/camera/setting?setting=187&option=7
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to widescreen (id: 0)GET/gopro/camera/setting?setting=188&option=0
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to mobile (id: 1)GET/gopro/camera/setting?setting=188&option=1
    188Aspect RatioSet multi shot easy aspect ratio (id: 188) to universal (id: 2)GET/gopro/camera/setting?setting=188&option=2
    189Max Lens ModSet system addon lens active (id: 189) to none (id: 0)GET/gopro/camera/setting?setting=189&option=0
    189Max Lens ModSet system addon lens active (id: 189) to max lens 1.0 (id: 1)GET/gopro/camera/setting?setting=189&option=1
    189Max Lens ModSet system addon lens active (id: 189) to max lens 2.0 (id: 2)GET/gopro/camera/setting?setting=189&option=2
    190Max Lens Mod EnableSet system addon lens status (id: 190) to off (id: 0)GET/gopro/camera/setting?setting=190&option=0
    190Max Lens Mod EnableSet system addon lens status (id: 190) to on (id: 1)GET/gopro/camera/setting?setting=190&option=1
    191Photo ModeSet photo easy presets (id: 191) to super photo (id: 0)GET/gopro/camera/setting?setting=191&option=0
    191Photo ModeSet photo easy presets (id: 191) to night photo (id: 1)GET/gopro/camera/setting?setting=191&option=1
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 4:3 (id: 0)GET/gopro/camera/setting?setting=192&option=0
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 16:9 (id: 1)GET/gopro/camera/setting?setting=192&option=1
    192Aspect RatioSet multi shot nlv aspect ratio (id: 192) to 8:7 (id: 3)GET/gopro/camera/setting?setting=192&option=3
    193FramingSet video easy framing (id: 193) to widescreen (id: 0)GET/gopro/camera/setting?setting=193&option=0
    193FramingSet video easy framing (id: 193) to vertical (id: 1)GET/gopro/camera/setting?setting=193&option=1
    193FramingSet video easy framing (id: 193) to full frame (id: 2)GET/gopro/camera/setting?setting=193&option=2
    - -

    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. -

    - -

    Note about Dependency Ordering and Blacklisting

    -

    -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. -

    - -

    Example

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CameraCommand 1Command 2Command 3Command 4Command 5Guaranteed Valid?
    HERO10 BlackRes: 1080Anti-Flicker: 60Hz (NTSC)FPS: 240FOV: WideHypersmooth: OFF
    HERO10 BlackFPS: 240Anti-Flicker: 60Hz (NTSC)Res: 1080FOV: WideHypersmooth: 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

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    DocumentsProductRelease
    -capabilities.xlsx
    capabilities.json -
    HERO12 Blackv01.30.00
    v01.20.00
    v01.10.00
    HERO11 Black Miniv02.30.00
    v02.20.00
    v02.10.00
    v02.00.00
    v01.10.00
    HERO11 Blackv02.12.00
    v02.10.00
    v02.01.00
    v01.20.00
    v01.12.00
    v01.10.00
    HERO10 Blackv01.50.00
    v01.46.00
    v01.42.00
    v01.40.00
    v01.30.00
    v01.20.00
    v01.16.00
    v01.10.00
    HERO9 Blackv01.72.00
    v01.70.00
    - -

    Spreadsheet Format

    -

    -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 Format

    -

    -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. -

    - -

    -Below is a simplified example of the capabilities JSON file; a formal schema is also available here: -capabilities_schema.json -

    - -
    {
    -    "(PRODUCT_NAME)": {
    -        "(RELEASE_VERSION)": {
    -            "states": [
    -                [
    -                    {"setting_name": "(str)", "setting_id": (int), "option_name": "(str)", "option_id": (int)},
    -                    ...
    -                ],
    -                ...
    -            ],
    -        },
    -        ...
    -    },
    -    ...
    -}
    -
    - -

    Media

    -

    -The camera provides an endpoint to query basic details about media captured on the sdcard. -

    - -

    Chapters

    -

    -All GoPro cameras break longer videos into chapters. -GoPro cameras currently limit file sizes on sdcards to 4GB for both FAT32 and exFAT file systems. -This limitation is most commonly seen when recording longer (10+ minute) videos. -In practice, the camera will split video media into chapters named Gqccmmmm.MP4 (and ones for THM/LRV) such that: -

    - -
      -
    • q: Quality Level (X: Extreme, H: High, M: Medium, L: Low)
    • -
    • cc: Chapter Number (01-99)
    • -
    • mmmm: Media ID (0001-9999)
    • -
    - -

    -When media becomes chaptered, the camera increments subsequent Chapter Numbers while leaving the Media ID unchanged. -For example, if the user records a long High-quality video that results in 4 chapters, the files on the sdcard may -look like the following: -

    - -
    -rwxrwxrwx@ 1 gopro  123456789  4006413091 Jan  1 00:00 GH010078.MP4
    --rwxrwxrwx@ 1 gopro  123456789       17663 Jan  1 00:00 GH010078.THM
    --rwxrwxrwx@ 1 gopro  123456789  4006001541 Jan  1 00:00 GH020078.MP4
    --rwxrwxrwx@ 1 gopro  123456789       17357 Jan  1 00:00 GH020078.THM
    --rwxrwxrwx@ 1 gopro  123456789  4006041985 Jan  1 00:00 GH030078.MP4
    --rwxrwxrwx@ 1 gopro  123456789       17204 Jan  1 00:00 GH030078.THM
    --rwxrwxrwx@ 1 gopro  123456789   756706872 Jan  1 00:00 GH040078.MP4
    --rwxrwxrwx@ 1 gopro  123456789       17420 Jan  1 00:00 GH040078.THM
    --rwxrwxrwx@ 1 gopro  123456789   184526939 Jan  1 00:00 GL010078.LRV
    --rwxrwxrwx@ 1 gopro  123456789   184519787 Jan  1 00:00 GL020078.LRV
    --rwxrwxrwx@ 1 gopro  123456789   184517614 Jan  1 00:00 GL030078.LRV
    --rwxrwxrwx@ 1 gopro  123456789    34877660 Jan  1 00:00 GL040078.LRV
    -
    - -

    Media Info Format

    -

    -The Media: Info command provides additional details about a media above and beyond its counterpart, the Media: List command. -Such information includes resolution, frame rate, duration, hilight info, etc. -

    - -

    Example Video Info:

    -
    {
    -    "cre": "1613676644",
    -    "s": "11305367",
    -    "mahs": "1",
    -    "us": "0",
    -    "mos": [],
    -    "eis": "0",
    -    "pta": "1",
    -    "ao": "stereo",
    -    "tr": "0",
    -    "mp": "0",
    -    "ct": "0",
    -    "rot": "0",
    -    "fov": "4",
    -    "lc": "0",
    -    "prjn": "6",
    -    "gumi": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    -    "ls": "1072714",
    -    "cl": "0",
    -    "avc_profile": "4",
    -    "profile": "42",
    -    "hc": "0",
    -    "hi": [],
    -    "dur": "2",
    -    "w": "1920",
    -    "h": "1080",
    -    "fps": "60000",
    -    "fps_denom": "1001",
    -    "prog": "1",
    -    "subsample": "0"
    -}
    -
    - -

    Common Keys (Video / Photo)

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescriptionExamples
    aostringAudio Optionoff, stereo, wind, auto
    avc_profileuint8Advanced Video Codec Profile0..255
    clboolFile clipped from another source?0:false, 1:true
    creuint32File creation timestamp (sec since epoch)1692992748
    ctuint32Content type0..12
    duruint32Duration of video in seconds42
    eisboolFile made with Electronic Image Stabilization0:false, 1:true
    fpsuint32Frame rate (numerator)1001
    fps_denomuint32Frme rate (denominator)30000
    gumistringGlobally Unique Media ID“xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”
    huint32Video height in pixels1080
    hcuint32Hilight countvideo:0..99, photo:0..1
    hdrboolPhoto taken with High Dynamic Range?0:false, 1:true
    hiArray of uint32Offset to hilights in media in milliseconds[1500, 4700]
    lcuint32Spherical Lens Config0:front, 1:rear
    lsint32Low Resolution Video file size in bytes (or -1 if no LRV file)-1, 1234567890
    mosArray of stringMobile Offload State“app”, “pc”, “other”
    mpboolMetadata Present?0:no metadata, 1:metadata exists
    profileuint8Advanced Video Codec Level0..255
    progboolIs video progressive?0:interlaced, 1:progressive
    ptaboolMedia has Protune audio file?0:false, 1:true
    rawboolPhoto has raw version?0:false, 1:true
    suint64File size in bytes1234567890
    subsampleboolIs video subsampled?0:false, 1:true
    trboolIs file transcoded?0:false, 1:true
    wuint32Width of media in pixels1920
    wdrboolPhoto taken with Wide Dynamic Range?0:false, 1:true
    - -

    Video Keys

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescriptionExamples
    aostringAudio Optionoff, stereo, wind, auto
    avc_profileuint8Advanced Video Codec Profile0..255
    clboolFile clipped from another source?0:false, 1:true
    duruint32Duration of video in seconds42
    fpsuint32Frame rate (numerator)1001
    fps_denomuint32Frme rate (denominator)30000
    hiArray of uint32Offset to hilights in media in milliseconds[1500, 4700]
    lsint32Low Resolution Video file size in bytes (or -1 if no LRV file)-1, 1234567890
    profileuint8Advanced Video Codec Level0..255
    progboolIs video progressive?0:interlaced, 1:progressive
    ptaboolMedia has Protune audio file?0:false, 1:true
    subsampleboolIs video subsampled?0:false, 1:true
    - -

    Photo Keys

    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescriptionExamples
    hdrboolPhoto taken with High Dynamic Range?0:false, 1:true
    rawboolPhoto has raw version?0:false, 1:true
    wdrboolPhoto taken with Wide Dynamic Range?0:false, 1:true
    - -

    Media Info: Content Type

    -

    -The "ct" (Content Type) metadata indicates what mode (or group) the media was captured in. -

    - -

    -Note: All Time Lapse modes that result in MPEG media use the same content type ID. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    IDMode
    Video0
    Looping1
    Chaptered Video2
    Time Lapse3
    Single Photo4
    Burst Photo5
    Time Lapse Photo6
    Night Lapse Photo8
    Night Photo9
    Continuous Photo10
    Raw Photo11
    Live Burst12
    - -

    Media List Format

    -

    -The format of the media list is given below. -

    - -
    {
    -    "id": "<MEDIA SESSION ID>",
    -    "media": [
    -        {
    -            "d": "<DIRECTORY NAME>",
    -            "fs": [
    -                {<MEDIA ITEM INFO>},
    -                ...
    -            ]
    -        },
    -        ...
    -    ]
    -}
    -
    - -

    Media List Keys

    -

    The outer structure of the media list and the inner structure of individual media items use the keys in the table below.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyDescription
    bID of first member of a group (for grouped media items)
    creCreation timestamp (seconds since epoch)
    dDirectory name
    fsFile system. Contains listing of media items in directory
    gGroup ID (if grouped media item)
    glrvLow resolution video file size
    idMedia list session identifier
    lID of last member of a group (for grouped media items)
    mList of missing/deleted group member IDs (for grouped media items)
    mediaContains media info for for each directory (e.g. 100GOPRO/, 101GOPRO/, …)
    modLast modified time (seconds since epoch)
    nMedia filename
    sSize of (group) media in bytes
    tGroup type (for grouped media items) (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse)
    - -

    Grouped Media Items

    -

    -To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos, -Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys -that allow the user to extrapolate individual filenames for each member of the group. -

    - -

    -Filenames for group media items have the form "GXXXYYYY.ZZZ" -where XXX is the group ID, YYY is the group member ID and ZZZ is the file extension. -

    - -

    -For example, take the media list below, which contains a Time Lapse Photo group media item: -

    - -
    {
    -    "id": "2530266050123724003",
    -    "media": [
    -        {
    -            "d": "100GOPRO",
    -            "fs": [
    -                {
    -                    "b": "8",
    -                    "cre": "1613669353",
    -                    "g": "1",
    -                    "l": "396",
    -                    "m": ['75', '139'],
    -                    "mod": "1613669353",
    -                    "n": "G0010008.JPG",
    -                    "s": "773977407",
    -                    "t": "t"
    -                }
    -            ]
    -        }
    -    ]
    -}
    -
    - -

    -The first filename in the group is "G0010008.JPG" (key: "n").
    -The ID of the first group member in this case is "008" (key: "b").
    -The ID of the last group member in this case is "396" (key: "l").
    -The IDs of deleted members in this case are "75" and "139" (key: "m")
    -Given this information, the user can extrapolate that the group currently contains -

    - -

    -G0010008.JPG, G0010009.JPG, G0010010.JPG,
    -...,
    -G0010074.JPG, G0010076.JPG,
    -...,
    -G0010138.JPG, G0010140.JPG,
    -...,
    -G0010394.JPG, G0010395.JPG. G0010396.JPG
    -

    - -

    Media HiLights

    -

    -The HiLight Tags feature allows the user to tag moments of interest either during video -capture or on existing media. -

    - -

    Add/Remove HiLights

    -

    -Below is a table of all HiLight commands. -For details on how to send HiLight commands, see Commands Quick Reference. - -

    - - - - - - - - - - - - - - - - - - - -
    CommandDescription
    Media: HiLight (Add)Video: Add a tag at a specific time offset (ms)
    Photo: Add a tag
    Media: HiLight (Remove)Video: Remove a tag at a specific time offset (ms)
    Photo: Remove tag
    Media: HiLight MomentAdd a tag to the current time offset (ms) while encoding video
    - -

    -Note: Attempting to add a HiLight tag at a time offset that exceeds the duration of the video -or removing a non-existent HiLight tag will result in an HTTP/500 error. -

    - -

    Get HiLights

    -

    -Once HiLight tags have been added, they can be queried by calling the Media: Info command; -the response content will be JSON that contains HiLight information: -

    - - - - - - - - - - - - - - - - - - - - - - - -
    Media TypeKeyValue
    PhotohcHiLight Count
    VideohcHiLight Count
    VideohiHiLights (list of time offsets in ms)
    - -

    Example

    -

    -The JSON sample below shows media that contains three HiLights at time offsets 2502ms, 5839ms, and 11478ms. -Note: Photo info will not have an "hi":[...] key-value pair. -

    - -
    {
    -  ...,
    -  "hc":"3",
    -  "hi":[2502,5839,11478],
    -  ...,
    -}
    -
    - -

    Downloading Media

    -

    -The URL to download/stream media from the DCIM/ directory on the sdcard is the Base URL plus /videos/DCIM/XXX/YYY -where XXX is the directory name within DCIM/ given by the media list and YYY is the target media filename. -

    - -

    -For example: Given the following media list: -

    - -
    {
    -    "id": "3586667939918700960",
    -    "media": [
    -        {
    -            "d": "100GOPRO",
    -            "fs": [
    -                {
    -                    "n": "GH010397.MP4",
    -                    "cre": "1613672729",
    -                    "mod": "1613672729",
    -                    "glrv": "1895626",
    -                    "ls": "-1",
    -                    "s": "19917136"
    -                },
    -                {
    -                    "cre": "1614340213",
    -                    "mod": "1614340213",
    -                    "n": "GOPR0001.JPG",
    -                    "s": "6961371"
    -                }
    -            ]
    -        }
    -    ]
    -}
    -
    - -

    -The URL to download GH010397.MP4 over WiFi would be -http://10.5.5.9:8080/videos/DCIM/100GOPRO/GH010397.MP4 -

    - -

    -The URL to download GOPR0001.JPG over WiFi would be -http://10.5.5.9:8080/videos/DCIM/100GOPRO/GOPR0001.JPG -

    - -

    Turbo Transfer

    -

    -Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly. -This special mode should only be used during media offload. -It is recommended that the user check for and--if necessary--disable Turbo Transfer on connect. -For details on which cameras are supported and how to enable and disable Turbo Transfer, see -Commands Quick Reference. -

    - -

    Downloading Preview Stream

    -

    -When the preview stream is started, the camera starts up a UDP client and begins writing MPEG Transport Stream data to the client on port 8554. -In order to stream this data, the client must implement a UDP connection that binds to the same port and decode the data. -

    - -

    Camera State

    -

    -The camera provides multiple types of state, all of which can be queried: -

    - -
      -
    • Camera state: Contains information about camera status (photos taken, date, is-camera-encoding, etc) and settings (current video resolution, current frame rate, etc)
    • -
    • Preset State: How presets are arranged into preset groups, their titles, icons, settings closely associated with each preset, etc
    • -
    - -

    Camera State Format

    -

    Camera state is given in the following form:

    - -
    {
    -    "status": {
    -        "1": <status 1 value>,
    -        "2": <status 2 value>,
    -        ...
    -    },
    -    "settings: {
    -        "2": <setting 2 value>,
    -        "3": <setting 3 value>,
    -        ...
    -    }
    -}
    -
    - -

    -Where status X value and setting X value are almost always integer values. -See Status Codes table in this document for exceptions. -

    - -

    -For status, keys are status codes and values are status values. -

    - -

    -For settings, keys are setting IDs, and values are option values -

    - -

    Status IDs

    -

    -Below is a table of supported status IDs.
    -* Indicates that item is experimental
    - Indicates support for all Open GoPro firmware versions.
    - Indicates a lack of support for all Open GoPro firmware versions.
    ->= vXX.YY.ZZ indicates support for firmware versions equal to or newer than vXX.YY.ZZ -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Status IDNameDescriptionTypeValuesHERO12 BlackHERO11 Black MiniHERO11 BlackHERO10 BlackHERO9 Black
    1Internal battery presentIs the system’s internal battery present?boolean0: False
    1: True
    -
    2Internal battery levelRough approximation of internal battery level in bars (or charging)integer0: Zero
    1: One
    2: Two
    3: Three
    4: Charging
    -
    6System hotIs the system currently overheating?boolean0: False
    1: True
    -
    8System busyIs the camera busy?boolean0: False
    1: True
    -
    9Quick capture activeIs Quick Capture feature enabled?boolean0: False
    1: True
    -
    10Encoding activeIs the system encoding right now?boolean0: False
    1: True
    -
    11Lcd lock activeIs LCD lock active?boolean0: False
    1: True
    -
    13Video progress counterWhen encoding video, this is the duration (seconds) of the video so far; 0 otherwiseinteger*
    17EnableAre Wireless Connections enabled?boolean0: False
    1: True
    -
    19StateThe pairing state of the camerainteger0: Never Started
    1: Started
    2: Aborted
    3: Cancelled
    4: Completed
    -
    20TypeThe last type of pairing that the camera was engaged ininteger0: Not Pairing
    1: Pairing App
    2: Pairing Remote Control
    3: Pairing Bluetooth Device
    -
    21Pair timeTime (milliseconds) since boot of last successful pairing complete actioninteger*
    22StateState of current scan for WiFi Access Points. Appears to only change for CAH-related scansinteger0: Never started
    1: Started
    2: Aborted
    3: Canceled
    4: Completed
    -
    23Scan time msecThe time, in milliseconds since boot that the WiFi Access Point scan completedinteger*
    24Provision statusWiFi AP provisioning stateinteger0: Never started
    1: Started
    2: Aborted
    3: Canceled
    4: Completed
    -
    26Remote control versionWireless remote control versioninteger*
    27Remote control connectedIs a wireless remote control connected?boolean0: False
    1: True
    -
    28PairingWireless Pairing Stateinteger*
    29Wlan ssidSSID of the AP the camera is currently connected to. On BLE connection, value is big-endian byte-encoded intstring*
    30Ap ssidThe camera’s WiFi SSID. On BLE connection, value is big-endian byte-encoded intstring*
    31App countThe number of wireless devices connected to the camerainteger*
    32EnableIs Preview Stream enabled?boolean0: False
    1: True
    -
    33Sd statusPrimary Storage Statusinteger-1: Unknown
    0: OK
    1: SD Card Full
    2: SD Card Removed
    3: SD Card Format Error
    4: SD Card Busy
    8: SD Card Swapped
    -
    34Remaining photosHow many photos can be taken before sdcard is fullinteger*
    35Remaining video timeHow many minutes of video can be captured with current settings before sdcard is fullinteger*
    38Num total photosTotal number of photos on sdcardinteger*
    39Num total videosTotal number of videos on sdcardinteger*
    41Ota statusThe current status of Over The Air (OTA) updateinteger0: Idle
    1: Downloading
    2: Verifying
    3: Download Failed
    4: Verify Failed
    5: Ready
    6: GoPro App: Downloading
    7: GoPro App: Verifying
    8: GoPro App: Download Failed
    9: GoPro App: Verify Failed
    10: GoPro App: Ready
    -
    42Download cancel request pendingIs there a pending request to cancel a firmware update download?boolean0: False
    1: True
    -
    45Camera locate activeIs locate camera feature active?boolean0: False
    1: True
    -
    49Multi shot count downThe current timelapse interval countdown value (e.g. 5…4…3…2…1…)integer*
    54Remaining spaceRemaining space on the sdcard in Kilobytesinteger*
    55SupportedIs preview stream supported in current recording/mode/secondary-stream?boolean0: False
    1: True
    -
    56Wifi barsWiFi signal strength in barsinteger*
    58Num hilightsThe number of hilights in encoding video (set to 0 when encoding stops)integer*
    59Last hilight time msecTime since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops)integer*
    60Next poll msecThe min time between camera status updates (msec). Do not poll for status more often than thisinteger*
    64Remaining timelapse timeHow many min of Timelapse video can be captured with current settings before sdcard is fullinteger*
    65Exposure select typeLiveview Exposure Select Modeinteger0: Disabled
    1: Auto
    2: ISO Lock
    3: Hemisphere
    -
    66Exposure select xLiveview Exposure Select: y-coordinate (percent)percent0-100
    67Exposure select yLiveview Exposure Select: y-coordinate (percent)percent0-100
    68Gps statusDoes the camera currently have a GPS lock?boolean0: False
    1: True
    -
    69Ap stateIs the camera in AP Mode?boolean0: False
    1: True
    -
    70Internal battery percentageInternal battery level (percent)percent0-100
    74Acc mic statusMicrophone Accesstory statusinteger0: Microphone mod not connected
    1: Microphone mod connected
    2: Microphone mod connected and microphone plugged into Microphone mod
    -
    75Digital zoomDigital Zoom level (percent)percent0-100
    76Wireless bandWireless Bandinteger0: 2.4 GHz
    1: 5 GHz
    2: Max
    -
    77Digital zoom activeIs Digital Zoom feature available?boolean0: False
    1: True
    -
    78Mobile friendly videoAre current video settings mobile friendly? (related to video compression and frame rate)boolean0: False
    1: True
    -
    79First time useIs the camera currently in First Time Use (FTU) UI flow?boolean0: False
    1: True
    -
    81Band 5ghz availIs 5GHz wireless band available?boolean0: False
    1: True
    -
    82System readyIs the system ready to accept commands?boolean0: False
    1: True
    -
    83Batt okay for otaIs the internal battery charged sufficiently to start Over The Air (OTA) update?boolean0: False
    1: True
    -
    85Video low temp alertIs the camera getting too cold to continue recording?boolean0: False
    1: True
    -
    86Actual orientationThe rotational orientation of the camerainteger0: 0 degrees (upright)
    1: 180 degrees (upside down)
    2: 90 degrees (laying on right side)
    3: 270 degrees (laying on left side)
    -
    88Zoom while encodingIs this camera capable of zooming while encoding (static value based on model, not settings)boolean0: False
    1: True
    -
    89Current modeCurrent flatmode IDinteger*
    93Active video presetsCurrent Video Preset (ID)integer*
    94Active photo presetsCurrent Photo Preset (ID)integer*
    95Active timelapse presetsCurrent Timelapse Preset (ID)integer*
    96Active presets groupCurrent Preset Group (ID)integer*
    97Active presetCurrent Preset (ID)integer*
    98Preset modifiedPreset Modified Status, which contains an event ID and a preset (group) IDinteger*
    99Remaining live burstsHow many Live Bursts can be captured before sdcard is fullinteger*
    100Num total live burstsTotal number of Live Bursts on sdcardinteger*
    101Capture delay activeIs Capture Delay currently active (i.e. counting down)?boolean0: False
    1: True
    -
    102Media mod mic statusMedia mod Stateinteger0: Media mod microphone removed
    2: Media mod microphone only
    3: Media mod microphone with external microphone
    -
    103Timewarp speed ramp activeTime Warp Speedinteger0: 15x
    1: 30x
    2: 60x
    3: 150x
    4: 300x
    5: 900x
    6: 1800x
    7: 2x
    8: 5x
    9: 10x
    10: Auto
    11: 1x (realtime)
    12: 1/2x (slow-motion)
    -
    104Linux core activeIs the system’s Linux core active?boolean0: False
    1: True
    -
    105Camera lens typeCamera lens type (reflects changes to setting 162 or setting 189)integer0: Default
    1: Max Lens
    2: Max Lens 2.0
    -
    106Video hindsight capture activeIs Video Hindsight Capture Active?boolean0: False
    1: True
    -
    107Scheduled presetScheduled Capture Preset IDinteger*
    108Scheduled enabledIs Scheduled Capture set?boolean0: False
    1: True
    -
    110Media mod statusMedia Mode Status (bitmasked)integer0: 000 = Selfie mod: 0, HDMI: 0, Media Mod Connected: False
    1: 001 = Selfie mod: 0, HDMI: 0, Media Mod Connected: True
    2: 010 = Selfie mod: 0, HDMI: 1, Media Mod Connected: False
    3: 011 = Selfie mod: 0, HDMI: 1, Media Mod Connected: True
    4: 100 = Selfie mod: 1, HDMI: 0, Media Mod Connected: False
    5: 101 = Selfie mod: 1, HDMI: 0, Media Mod Connected: True
    6: 110 = Selfie mod: 1, HDMI: 1, Media Mod Connected: False
    7: 111 = Selfie mod: 1, HDMI: 1, Media Mod Connected: True
    -
    111Sd rating check errorDoes sdcard meet specified minimum write speed?boolean0: False
    1: True
    -
    112Sd write speed errorNumber of sdcard write speed errors since device bootedinteger*
    113Turbo transferIs Turbo Transfer active?boolean0: False
    1: True
    -
    114Camera control statusCamera control status IDinteger0: Camera Idle: No one is attempting to change camera settings
    1: Camera Control: Camera is in a menu or changing settings. To intervene, app must request control
    2: Camera External Control: An outside entity (app) has control and is in a menu or modifying settings
    -
    115Usb connectedIs the camera connected to a PC via USB?boolean0: False
    1: True
    -
    116Allow control over usbCamera control over USB stateinteger0: Disabled
    1: Enabled
    -
    >= v01.30.00
    117Total sd space kbTotal SD card capacity in Kilobytesinteger*
    - -

    Preset Status Format

    -

    -Preset Status is returned as JSON, whose content is the serialization of the protobuf message: -NotifyPresetStatus. -Using Google protobuf APIs, the JSON can be converted back into a programmatic object in the user's language of choice. -

    - -

    Features

    - -

    Presets

    -

    -The camera organizes modes of operation into presets. -A preset is a logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different styles of capturing media. -

    - -

    -Depending on the camera's state, different collections of presets will be available for immediate loading and use. -Below is a table of settings that affect the current preset collection and thereby which presets can be loaded: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    IDSetting
    162Max Lens
    173Video Performance Mode
    175Controls
    177Enable Night Photo
    180Video Mode
    186Video Mode
    187Lapse Mode
    189Max Lens Mod
    190Max Lens Mod Enable
    191Photo Mode
    - -

    -To determine which presets are available for immediate use, get Preset Status. -

    - -

    Preset Status

    -

    -All cameras support basic query and subscription mechanics that allow the user to: -

    - -
      -
    • Get hierarchical data describing the Preset Groups, Presets, and Settings that are available in the camera's current state
    • - -
    - -

    -Preset Status should not be confused with camera status: -

    -
      -
    • Preset Status contains information about current preset groups and presets
    • -
    • Camera status contains numerous statuses about current settings and camera system state
    • -
    - - -

    Preset Groups

    -

    -Each Preset Group contains an ID, whether additional presets can be added, and an array of existing Presets. -

    - -

    Presets

    -

    -Each Preset contains information about its ID, associated core mode, title, icon, whether it's a user-defined preset, -whether the preset has been modified from its factory-default state (for factory-default presets only) and an array of -Settings associated with the Preset. -

    - -

    -Important Note: The Preset ID is required to load a Preset via the Presets: Load command. -

    - -

    Global Behaviors

    -

    -In order to prevent undefined behavior between the camera and a connected app, simultaneous use of the camera and a -connected app is discouraged. -

    - -

    -Best practice for synchronizing user/app control is to use the Set Camera Control Status command and -corresponding Camera Control Status (CCS) camera statuses in alignment with the finite state machine below: -

    - -IDLEControl Status: IdleCAMERA_CONTROLControl Status: Camera ControlEXTERNAL_CONTROLControl Status: External ControlApp sets CCS: IdleUser interacts with cameraUser returns camera to idle screenApp sets CCS: IdleApp sets CCS: External ControlApp sets CCS: IdleUser interacts with cameraUser interacts with cameraApp sets CCS: External ControlUser interacts with camera - - - - - - - - - - - - - - - - - - - - -
    Control StatusID
    IDLE0
    CONTROL1
    EXTERNAL_CONTROL2
    - -

    Set Camera Control Status

    -

    -This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera. -This causes the camera to immediately exit any contextual menus and return to the idle screen. -Any interaction with the camera's physical buttons will cause the camera to reclaim control and update control status accordingly. -If the user returns the camera UI to the idle screen, the camera updates control status to Idle. -

    - -

    -Note: -

    -
      -
    • The entity currently claiming control of the camera is advertised in camera status 114
    • -
    • Information about whether the camera is in a contextual menu or not is advertised in camera status 63.
    • -
    - - -

    OTA Update

    - -

    -The Over The Air (OTA) update feature allows the user to update the camera's firmware via HTTP connection. -There are two ways to perform OTA updates: Simple OTA Update and Resumable OTA Update. -

    - -

    -Firmware update files can be obtained from GoPro's update page or programmatically using the -firmware catalog. -

    - -

    -Note: In order to complete the firmware update process, the camera will reboot one or more times. -This will cause any existing HTTP connections to be lost. -

    - -

    Simple OTA Update

    -

    -The simple OTA update process is done by sending an entire update file to the camera in a single HTTP/POST. -Details can be found in the diagram below. -

    - -Simple OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/POST: /gp/gpUpdateContent-Type: multipart/form-dataData:DirectToSD=1update=1sha1=<SHA1_HASH>file=<UPDATE.zip>HTTP/200 (OK)JSON: { "status":"0" }WiFi connection terminatesCamera displays "Update Complete" OSD, reboots 1-2 times - -

    Resumable OTA Update

    -

    -The resumable OTA update process involves uploading chunks (or all) of a file, marking the file complete and then telling the camera to begin the update process. -Chunks are stored until they are explicitly deleted, allowing the client to stop and resume as needed. -Details can be found in the diagram below. -

    - -Resumable OTA UpdateClientClientCameraCameraObtain UPDATE.zip from update page or firmware catalogCalculate SHA1_HASH for UPDATE.zipHTTP/GET: /gp/gpSoftUpdate?request=deleteDelete any old/cached dataHTTP/200 (OK)JSON {"status":0,"message":"OK","sha1":"","bytes_complete":0,"complete":false}HTTP/GET: /gp/gpSoftUpdate?request=showuiDisplay update OSD on camera UI (optional)HTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"","bytes_complete":0,"complete":false}loop[read CHUNK_BYTES of UPDATE.zip, starting at OFFSET]HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>offset=<OFFSET>file=<CHUNK_BYTES>HTTP/200 (OK)JSON: {"status": 0,"message": "OK","sha1": "SHA1_HASH","bytes_complete": (total uploaded bytes),"complete": false}HTTP/POST: /gp/gpSoftUpdateContent-Type: multipart/form-dataData:sha1=<SHA1_HASH>complete=trueHTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"SHA1_HASH","bytes_complete":(size of UPDATE.zip),"complete":true}HTTP/GET: /gp/gpSoftUpdate?request=startStart updating firmwareHTTP/200 (OK)JSON: {"status":0,"message":"OK","sha1":"SHA1_HASH","bytes_complete":(size of UPDATE.zip),"complete":true}loop[while camera updates firmware]HTTP/GET: /gp/gpSoftUpdate?request=progressJSON: {"status":11,"message":"Firmware update in progress"}WiFi connection lostCamera displays OSD "Update Complete", reboots 1-2 times - -

    OTA Update Status Codes

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    IDStatusDescription
    0OkNo errors occurred
    1Unknown RequestServer did not recognize the request
    2Bad ParamsParameter values not recognized
    3SHA1 Send MismatchSHA1 for chunk did not match SHA1 of previous chunk(s)
    4SHA1 Calculates MismatchCalculated SHA1 did not match user-specified SHA1
    5HTTP Boundary ErrorHTTP Post malformed
    6HTTP Post ErrorUnexpected HTTP/POST Content Type
    7Server BusyHTTP server is busy
    8Offset MismatchTried to upload chunk with offset that did not align with previous chunk
    9Bad Post DataServer failed to parse POST data
    10File IncompleteTried to start update before server finished validating .zip file
    11Update in ProgressFirmware update in progress
    12Insufficient SpaceInsufficient space on the sdcard to hold (decompressed) update file
    - -

    Webcam

    - -

    -The webcam feature enables developers who are interested in writing custom drivers to broadcast the camera's video preview with a limited set of resolution, field of view, port, and protocol options. -

    - -

    -While active, the webcam feature sends raw data to the connected client using a supported protocol. -To enable multi-cam support, some cameras support running on a user-specified port. -Protocol and port details are provided in a table below. -

    - -

    -To test basic functionality, start the webcam, and use an application such as VLC to open a network stream: -

    - - - - - - - - - - - - - - - -
    ProtocolVLC Network URL
    TSudp://@:{PORT}
    RTSPrtsp://{CAMERA_IP}:554/live
    - - -

    -For readers interested in using a GoPro camera as a webcam with preexisting tools, please see How to use GoPro as a Webcam. -

    - -

    Webcam Finite State Machine

    -PREREQUISITEWired USB Control disabledREADYWebcam ready to startStatus is either OFF (0) or IDLE (1)High Power PreviewStatus: 2Low Power PreviewStatus: 3Connect USB to cameraStopExitStartStopExitPreviewStopExitStartPreviewStartPreview - -

    Webcam Commands

    -

    -Note: For USB connections, prior to issuing webcam commands, Wired USB Control should be disabled. -For details about how to send this and webcam commands, see Commands Quick Reference. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CommandConnectionsDescription
    Webcam: StartUSB, WIFI*Enters webcam mode, uses default resolution and last-used fov, starts high-res stream to the IP address of caller
    Webcam: Start (with args)USB, WIFI*Enters webcam mode, uses specified res/fov/protocol/port, starts streaming to the IP address of caller
    Webcam: PreviewUSB, WIFI*Enters webcam mode, sets stream resolution and bitrate, starts low-res stream to the IP address of caller.
    Can set Webcam Digital Lenses and Digital Zoom levels while streaming
    Webcam: StopUSB, WIFI*Stops the webcam stream
    Webcam: ExitUSB, WIFI*Stops the webcam stream and exits webcam mode
    Webcam: StatusUSB, WIFIReturns the current state of the webcam endpoint, including status and error codes (see tables below)
    Webcam: VersionUSB, WIFIProvides version information about webcam implementation in JSON format
    -

    * Indicates that connection is supported in HERO12 Black v01.10.00 and newer versions/models

    - -

    Status Codes

    - - - - - - - - - - - - - - - - - - - - - - - -
    StatusCode
    OFF0
    IDLE1
    HIGH_POWER_PREVIEW2
    LOW_POWER_PREVIEW3
    - -

    Error Codes

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    StatusCode
    NONE0
    SET_PRESET1
    SET_WINDOW_SIZE2
    EXEC_STREAM3
    SHUTTER4
    COM_TIMEOUT5
    INVALID_PARAM6
    UNAVAILABLE7
    EXIT8
    - -

    Webcam Capabilities

    - -

    -Webcam supports setting resolution and field of view. -Changing other settings while in IDLE state such as Hypersmooth may succeed but are not officially supported. -

    - -

    -There is a known issue on some cameras in which the webcam status will be wrongly reported as IDLE instead of OFF after a new USB connection. -The best workaround for this is to call Webcam: Start followed by the Webcam: Stop after connecting USB in order to attain the true IDLE state. -

    - -

    Default Parameter Values

    - - - - - - - - - - - - - - - - - - - -
    ParameterDefault Value
    res12 (1080p)
    fovLast-used or 0 (Wide) if FOV not previously set
    protocol“TS”
    - -

    Webcam Capabilities

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CameraResolutionFOV
    HERO12 Black720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO11 Black720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO10 Black480p (id: 4)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    HERO9 Black480p (id: 4)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    720p (id: 7)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    1080p (id: 12)Wide (id: 0), Narrow (id: 2), Superview (id: 3), Linear (id: 4)
    - -

    Supported Protocols

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CameraProtocolDefault PortSupports User-Defined Port?
    HERO12 BlackTS8554
    RTSP554
    HERO11 BlackTS8554
    HERO10 BlackTS8554
    HERO9 BlackTS8554
    - -

    Webcam Stabilization

    - -

    -Should the client require stabilization, the Hypersmooth setting can be used while in the state: READY (Status: OFF). -This setting can only be set while webcam is disabled, which requires either sending the Webcam: Exit command or reseating the USB-C connection to the camera. -

    - -

    -Note: The Low Hypersmooth option provides lower/lighter stabilization when used in Webcam mode vs other camera modes. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CameraVersionSupported Hypersmooth Options
    HERO12 Blackv01.10.00+Off (id: 0), Low (id: 1), Auto Boost (id: 4)
    HERO11 Black Miniv01.10.00+Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4)
    HERO11 Blackv01.10.00+Off (id: 0), Low (id: 1), Boost (id: 3), Auto Boost (id: 4)
    HERO10 Blackv01.10.00+Off (id: 0), High (id: 2), Boost (id: 3), Standard (id: 100)
    HERO9 Blackv01.70.00+Off (id: 0), Low (id: 1), High (id: 2), Boost (id: 3)
    - -

    Camera On the Home Network (COHN)

    -

    -Some cameras support Camera On the Home Network (COHN). -This capability allows the client to perform command and control with the camera indirectly through an access point such as a router at home. -For security purposes, all communications are performed over HTTPS. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CameraSupported
    HERO12 Black
    HERO11 Black Mini
    HERO11 Black
    HERO10 Black
    HERO9 Black
    - -

    Provisioning COHN

    -

    -In order to use the COHN capability, the camera must first be provisioned for COHN. -For instructions on how to do this, see Open GoPro BLE spec. -

    - -

    Send Messages via HTTPS

    -

    -Once the camera is provisioned, the client can issue -commands -and set settings -via HTTPS using the COHN certificate and Basic authorization (username/password) credentials obtained during provisioning or subsequently by querying for COHN status. -

    - -

    HTTPS Headers

    - -

    -All HTTPS messages must contain Basic access authentication headers, using the username and password from the COHN status obtained during or after provisioning. -

    - -

    COHN Commands

    - -

    Command

    - - - - - - - - - - - - - - - - - - -
    CommandResponse FormatDescription
    /GoProRootCA.crtTextGet COHN cert
    /gopro/cohn/statusJSONGet current COHN status
    - -

    Get COHN Cert

    -

    -The /GoProRootCA.crt endpoint provides a way to obtain the COHN cert via HTTP(S). -The response content is in plain text. For example: -

    - -
    -----BEGIN CERTIFICATE-----
    -xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    -xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    -xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    ------END CERTIFICATE-----
    -
    - -

    Get COHN Status

    -

    -The /gopro/cohn/status endpoint provides a way to get the current status of COHN. -The status's format is NotifyCOHNStatus (a Google Procol Buffer v2 message) converted into JSON. -

    - -

    -Example: -

    -
    {
    - "status": "COHN_PROVISIONED",
    - "state": "COHN_STATE_NetworkConnected",
    - "username": "gopro",
    - "password": "xxxxxxxxxxxx",
    - "ipaddress": "xxx.xxx.xxx.xxx",
    - "enabled": true
    -}
    -
    - -

    Limitations

    - -

    HERO12 Black

    -
      -
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • -
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference -
    • -
    -

    HERO11 Black Mini

    -
      -
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • -
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference -
    • -
    -

    HERO11 Black

    -
      -
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • -
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference -
    • -
    -

    HERO10 Black

    -
      -
    • The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user cannot change settings
    • -
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference -
    • -
    -

    HERO9 Black

    -
      -
    • The HTTP server is not available while the camera is encoding, which means shutter controls are not supported over WiFi. This limitation can be overcome by using Bluetooth Low Energy for command and control and HTTP/REST for querying media content such as media list, media info, preview stream, etc.
    • -
    • USB command and control is not supported on HERO9 Black.
    • -
    • HTTP command arguments must be given in the order outlined in Commands Quick Reference -
    • -
    - -

    General

    - -
      -
    • Unless changed by the user, GoPro cameras will automatically power off after some time (e.g. 5min, 15min, 30min). The Auto Power Down watchdog timer can be reset by sending periodic keep-alive messages to the camera. It is recommended to send a keep-alive at least once every 120 seconds.
    • -
    • In general, querying the value for a setting that is not associated with the current preset/core mode results in an undefined value. For example, the user should not try to query the current Photo Digital Lenses (FOV) value while in Standard preset (Video mode).
    • -
    - - -
    - -
    - - - - - - - -
    - - - - -
    - - -
    - - - -
    - -
    - - -
    -
    -
    - - -
    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - + + + Open GoPro HTTP specs + + + + +

    + This page has been moved. If you are not redirected within 3 seconds, click + here to go to the HubSpot homepage. +

    + diff --git a/index.html b/index.html index 0dc37f84..17a4bfef 100644 --- a/index.html +++ b/index.html @@ -140,7 +140,7 @@ Tutorials
  • - Demos + Demos
  • FAQ @@ -252,7 +252,7 @@

    Docs

    BLE Specs →
    - HTTP Spec → + HTTP Spec → @@ -331,7 +331,7 @@

    WiFi

    WiFi needs to be switched on by a BLE command. Besides command & control, Wi-Fi also allows for video streaming and media manipulation. With the exception of live-streaming, the camera always acts as an Wi-Fi access point that other devices need to connect to. For more information, see the -Wifi Specification

    +Wifi Specification

    USB

    diff --git a/protos.html b/protos.html index cb919e3e..03c77adb 100644 --- a/protos.html +++ b/protos.html @@ -1,3697 +1,16 @@ - + - - -Protocol Documentation : Open GoPro - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Redirecting… + + + + - - - - - - - - -
    -
    -
    - -
    -
    -
    - - -
    - - - - - - - - - - - - - -
    - - - - - -
    - - - - - -
    - -
    -

    Protocol Documentation -

    - - - -
    - - -
    - - - -

    This page provides documentation for all of the protobuf message fields.

    - -

    Protobuf Files

    - - - -

    - -

    cohn.proto

    - -

    - -

    NotifyCOHNStatus

    -

    Current COHN status triggered by a RequestGetCOHNStatus

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statusEnumCOHNStatusoptionalCurrent COHN status
    stateEnumCOHNNetworkStateoptionalCurrent COHN network state
    usernamestringoptionalUsername used for http basic auth header
    passwordstringoptionalPassword used for http basic auth header
    ipaddressstringoptionalCamera’s IP address on the local network
    enabledbooloptionalIs COHN currently enabled
    ssidstringoptionalCurrently connected SSID
    macaddressstringoptionalMAC address of the wifi adapter
    - -

    - -

    RequestCOHNCert

    -

    Get the COHN certificate.

    - -

    Returns a @ref ResponseCOHNCert

    - -

    - -

    RequestClearCOHNCert

    -

    Clear the COHN certificate.

    - -

    Returns a @ref ResponseGeneric with the status of the clear

    - -

    - -

    RequestCreateCOHNCert

    -

    Create the COHN certificate.

    - -

    Returns a @ref ResponseGeneric with the status of the creation

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    overridebooloptionalOverride current provisioning and create new cert
    - -

    - -

    RequestGetCOHNStatus

    -

    Get the current COHN status.

    - -

    This always returns a @ref NotifyCOHNStatus

    - -

    Additionally, asynchronous updates can also be registerd to return more @ref NotifyCOHNStatus when a value -changes.

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    register_cohn_statusbooloptional1 to register, 0 to unregister
    - -

    - -

    RequestSetCOHNSetting

    -

    Enable and disable COHN if provisioned

    - -

    Returns a @ref ResponseGeneric

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    cohn_activebooloptional1 to enable, 0 to disable
    - -

    - -

    ResponseCOHNCert

    -

    COHN Certificate response triggered by RequestCOHNCert

    - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericoptionalWas request successful?
    certstringoptionalRoot CA cert (ASCII text)
    - -

    - -

    - -

    EnumCOHNNetworkState

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    COHN_STATE_Init0 
    COHN_STATE_Error1 
    COHN_STATE_Exit2 
    COHN_STATE_Idle5 
    COHN_STATE_NetworkConnected27 
    COHN_STATE_NetworkDisconnected28 
    COHN_STATE_ConnectingToNetwork29 
    COHN_STATE_Invalid30 
    - -

    - -

    EnumCOHNStatus

    - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    COHN_UNPROVISIONED0 
    COHN_PROVISIONED1 
    - -

    - -

    - -

    - -

    - -

    live_streaming.proto

    - -

    - -

    NotifyLiveStreamStatus

    -

    Live Stream status

    - -

    Sent either:

    -
      -
    • as a syncrhonous response to initial @ref RequestGetLiveStreamStatus
    • -
    • as asynchronous notifications registered for via @ref RequestGetLiveStreamStatus
    • -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    live_stream_statusEnumLiveStreamStatusoptionalLive stream status
    live_stream_errorEnumLiveStreamErroroptionalLive stream error
    live_stream_encodebooloptionalIs live stream encoding?
    live_stream_bitrateint32optionalLive stream bitrate (Kbps)
    live_stream_window_size_supported_arrayEnumWindowSizerepeatedList of supported resolutions returned when live stream is registered or requested
    - -
      -
    1. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      register –> camera 2. register response (with capabilities) –> mobile 3. async notifications (without capabilities) –> mobile    
       live_stream_encode_supportedbooloptionalDoes the camera support encoding while live streaming?
       live_stream_max_lens_unsupportedbooloptionalIs the Max Lens feature NOT supported?
       live_stream_minimum_stream_bitrateint32optionalCamera-defined minimum bitrate (static) (Kbps)
       live_stream_maximum_stream_bitrateint32optionalCamera-defined maximum bitrate (static) (Kbps)
       live_stream_lens_supportedbooloptionalDoes camera support setting lens for live streaming?
       live_stream_lens_supported_arrayEnumLensrepeatedArray of supported lenses for live streaming
      -
    2. -
    - -

    - -

    RequestGetLiveStreamStatus

    -

    Get the current livestream status (and optionally register for future status changes)

    - -

    Both current status and future status changes are sent via @ref NotifyLiveStreamStatus

    - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    register_live_stream_statusEnumRegisterLiveStreamStatusrepeatedArray of live stream statuses to be notified about
    unregister_live_stream_statusEnumRegisterLiveStreamStatusrepeatedArray of live stream statuses to stop being notified about
    - -

    - -

    RequestSetLiveStreamMode

    -

    Configure lives streaming

    - -

    The current livestream status can be queried via @ref RequestGetLiveStreamStatus

    - -

    TODO What is the response?

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    urlstringoptionalRTMP(S) URL used for live stream
    encodebooloptionalSave media to sdcard while streaming?
    window_sizeEnumWindowSizeoptionalLive stream resolution
    certbytesoptionalCertificate for servers that require it
    minimum_bitrateint32optionalMinimum desired bitrate (may or may not be honored)
    maximum_bitrateint32optionalMaximum desired bitrate (may or may not be honored)
    starting_bitrateint32optionalStarting bitrate
    lensEnumLensoptionalLens to use for live stream (see NotifyLiveStreamStatus.live_stream_lens_supported)
    - -

    - -

    - -

    EnumLens

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    LENS_WIDE0 
    LENS_LINEAR4 
    LENS_SUPERVIEW3 
    - -

    - -

    EnumLiveStreamError

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    LIVE_STREAM_ERROR_NONE0No error (success)
    LIVE_STREAM_ERROR_NETWORK1General network error during the stream
    LIVE_STREAM_ERROR_CREATESTREAM2Startup error: bad URL or valid with live stream server
    LIVE_STREAM_ERROR_OUTOFMEMORY3Not enough memory on camera to complete task
    LIVE_STREAM_ERROR_INPUTSTREAM4Failed to get stream from low level camera system
    LIVE_STREAM_ERROR_INTERNET5No internet access detected on startup of streamer
    LIVE_STREAM_ERROR_OSNETWORK6Error occured in linux networking stack. usually means the server closed the connection
    LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT7Timed out attemping to connect to the wifi network when attemping live stream
    LIVE_STREAM_ERROR_SSL_HANDSHAKE8SSL handshake failed (commonly caused due to incorrect time / time zone)
    LIVE_STREAM_ERROR_CAMERA_BLOCKED9Low level camera system rejected attempt to start live stream
    LIVE_STREAM_ERROR_UNKNOWN10Unknown
    LIVE_STREAM_ERROR_SD_CARD_FULL40Can not perform livestream because sd card is full
    LIVE_STREAM_ERROR_SD_CARD_REMOVED41Livestream stopped because sd card was removed
    - -

    - -

    EnumLiveStreamStatus

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    LIVE_STREAM_STATE_IDLE0Initial status. Livestream has not yet been configured
    LIVE_STREAM_STATE_CONFIG1Livestream is being configured
    LIVE_STREAM_STATE_READY2Livestream has finished configuration and is ready to start streaming
    LIVE_STREAM_STATE_STREAMING3Livestream is actively streaming
    LIVE_STREAM_STATE_COMPLETE_STAY_ON4Live stream is exiting. No errors occured.
    LIVE_STREAM_STATE_FAILED_STAY_ON5Live stream is exiting. An error occurred.
    LIVE_STREAM_STATE_RECONNECTING6An error occurred during livestream and stream is attempting to reconnect.
    - -

    - -

    EnumRegisterLiveStreamStatus

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    REGISTER_LIVE_STREAM_STATUS_STATUS1 
    REGISTER_LIVE_STREAM_STATUS_ERROR2 
    REGISTER_LIVE_STREAM_STATUS_MODE3 
    REGISTER_LIVE_STREAM_STATUS_BITRATE4 
    - -

    - -

    EnumWindowSize

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    WINDOW_SIZE_4804 
    WINDOW_SIZE_7207 
    WINDOW_SIZE_108012 
    - -

    - -

    - -

    - -

    - -

    network_management.proto

    - -

    - -

    NotifProvisioningState

    -

    Provision state notification

    - -

    TODO refernce where this is triggered

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    provisioning_stateEnumProvisioningrequiredProvisioning / connection state
    - -

    - -

    NotifStartScanning

    -

    Scanning state notification

    - -

    Triggered via @ref RequestStartScan

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    scanning_stateEnumScanningrequiredScanning state
    scan_idint32optionalID associated with scan results (included if scan was successful)
    total_entriesint32optionalNumber of APs found during scan (included if scan was successful)
    total_configured_ssidint32requiredTotal count of camera’s provisioned SSIDs
    - -

    - -

    RequestConnect

    -

    Connect to (but do not authenticate with) an Access Point

    - -

    This is intended to be used to connect to a previously-connected Access Point

    - -

    Response: @ref ResponseConnect

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    ssidstringrequiredAP SSID
    - -

    - -

    RequestConnectNew

    -

    Connect to and authenticate with an Access Point

    - -

    This is only intended to be used if the AP is not previously provisioned.

    - -

    Response: @ref ResponseConnectNew sent immediately

    - -

    Notification: @ref NotifProvisioningState sent periodically as provisioning state changes

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    ssidstringrequiredAP SSID
    passwordstringrequiredAP password
    static_ipbytesoptionalStatic IP address
    gatewaybytesoptionalGateway IP address
    subnetbytesoptionalSubnet mask
    dns_primarybytesoptionalPrimary DNS
    dns_secondarybytesoptionalSecondary DNS
    - -

    - -

    RequestGetApEntries

    -

    Get a list of Access Points found during a @ref RequestStartScan

    - -

    Response: @ref ResponseGetApEntries

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    start_indexint32requiredUsed for paging. 0 <= start_index < @ref ResponseGetApEntries .total_entries
    max_entriesint32requiredUsed for paging. Value must be < @ref ResponseGetApEntries .total_entries
    scan_idint32requiredID corresponding to a set of scan results (i.e. @ref ResponseGetApEntries .scan_id)
    - -

    - -

    RequestReleaseNetwork

    -

    Request to disconnect from current AP network

    - -

    Response: @ref ResponseGeneric

    - -

    - -

    RequestStartScan

    -

    Start scanning for Access Points

    - -

    @note Serialization of this object is zero bytes.

    - -

    Response: @ref ResponseStartScanning are sent immediately after the camera receives this command

    - -

    Notifications: @ref NotifStartScanning are sent periodically as scanning state changes. Use to detect scan complete.

    - -

    - -

    ResponseConnect

    -

    The status of an attempt to connect to an Access Point

    - -

    Sent as the initial response to @ref RequestConnect

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericrequiredGeneric pass/fail/error info
    provisioning_stateEnumProvisioningrequiredProvisioning/connection state
    timeout_secondsint32requiredNetwork connection timeout (seconds)
    - -

    - -

    ResponseConnectNew

    -

    The status of an attempt to connect to an Access Point

    - -

    Sent as the initial response to @ref RequestConnectNew

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericrequiredStatus of Connect New request
    provisioning_stateEnumProvisioningrequiredCurrent provisioning state of the network
    timeout_secondsint32requirednumber of seconds camera will wait before declaring a network connection attempt failed.
    - -

    - -

    ResponseGetApEntries

    -

    A list of scan entries describing a scanned Access Point

    - -

    This is sent in response to a @ref RequestGetApEntries

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericrequiredGeneric pass/fail/error info
    scan_idint32requiredID associated with this batch of results
    entriesResponseGetApEntries.ScanEntryrepeatedArray containing details about discovered APs
    - -

    - -

    ResponseGetApEntries.ScanEntry

    -

    The individual Scan Entry model

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    ssidstringrequiredAP SSID
    signal_strength_barsint32requiredSignal strength (3 bars: >-70 dBm; 2 bars: >-85 dBm; 1 bar: <=-85 dBm)
    signal_frequency_mhzint32requiredSignal frequency (MHz)
    scan_entry_flagsint32requiredBitmasked value from @ref EnumScanEntryFlags
    - -

    - -

    ResponseStartScanning

    -

    The current scanning state.

    - -

    This is the initial response to a @ref RequestStartScan

    - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericrequiredGeneric pass/fail/error info
    scanning_stateEnumScanningrequiredScanning state
    - -

    - -

    - -

    EnumProvisioning

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    PROVISIONING_UNKNOWN0 
    PROVISIONING_NEVER_STARTED1 
    PROVISIONING_STARTED2 
    PROVISIONING_ABORTED_BY_SYSTEM3 
    PROVISIONING_CANCELLED_BY_USER4 
    PROVISIONING_SUCCESS_NEW_AP5 
    PROVISIONING_SUCCESS_OLD_AP6 
    PROVISIONING_ERROR_FAILED_TO_ASSOCIATE7 
    PROVISIONING_ERROR_PASSWORD_AUTH8 
    PROVISIONING_ERROR_EULA_BLOCKING9 
    PROVISIONING_ERROR_NO_INTERNET10 
    PROVISIONING_ERROR_UNSUPPORTED_TYPE11 
    - -

    - -

    EnumScanEntryFlags

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    SCAN_FLAG_OPEN0This network does not require authentication
    SCAN_FLAG_AUTHENTICATED1This network requires authentication
    SCAN_FLAG_CONFIGURED2This network has been previously provisioned
    SCAN_FLAG_BEST_SSID4 
    SCAN_FLAG_ASSOCIATED8camera is connected to this AP
    SCAN_FLAG_UNSUPPORTED_TYPE16 
    - -

    - -

    EnumScanning

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    SCANNING_UNKNOWN0 
    SCANNING_NEVER_STARTED1 
    SCANNING_STARTED2 
    SCANNING_ABORTED_BY_SYSTEM3 
    SCANNING_CANCELLED_BY_USER4 
    SCANNING_SUCCESS5 
    - -

    - -

    - -

    - -

    - -

    preset_status.proto

    - -

    - -

    NotifyPresetStatus

    -

    Current Preset status

    - -

    Sent either:

    -
      -
    • synchronously via initial response to @ref RequestGetPresetStatus
    • -
    • asynchronously when Preset change if registered in @rev RequestGetPresetStatus
    • -
    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    preset_group_arrayPresetGrouprepeatedArray of currently available Preset Groups
    - -

    - -

    Preset

    -

    An individual preset.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    idint32optionalPreset ID
    modeEnumFlatModeoptionalPreset flatmode ID
    title_idEnumPresetTitleoptionalPreset Title ID
    title_numberint32optionalPreset Title Number (e.g. 1/2/3 in Custom1, Custom2, Custom3)
    user_definedbooloptionalIs the Preset custom/user-defined?
    iconEnumPresetIconoptionalPreset Icon ID
    setting_arrayPresetSettingrepeatedArray of settings associated with this Preset
    is_modifiedbooloptionalHas Preset been modified from factory defaults? (False for user-defined Presets)
    is_fixedbooloptionalIs this Preset mutable?
    custom_namestringoptionalCustom string name given to this preset via @ref RequestCustomPresetUpdate
    - -

    - -

    PresetGroup

    -

    Preset Group meta information and contained Presets

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    idEnumPresetGroupoptionalPreset Group ID
    preset_arrayPresetrepeatedArray of Presets contained in this Preset Group
    can_add_presetbooloptionalIs there room in the group to add additional Presets?
    iconEnumPresetGroupIconoptionalThe icon to display for this preset group
    - -

    - -

    PresetSetting

    -

    Setting representation that comprises a @ref Preset

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    idint32optionalSetting ID
    valueint32optionalSetting value
    is_captionbooloptionalDoes this setting appear on the Preset “pill” in the camera UI?
    - -

    - -

    - -

    EnumFlatMode

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    FLAT_MODE_UNKNOWN-1 
    FLAT_MODE_PLAYBACK4 
    FLAT_MODE_SETUP5 
    FLAT_MODE_VIDEO12 
    FLAT_MODE_TIME_LAPSE_VIDEO13 
    FLAT_MODE_LOOPING15 
    FLAT_MODE_PHOTO_SINGLE16 
    FLAT_MODE_PHOTO17 
    FLAT_MODE_PHOTO_NIGHT18 
    FLAT_MODE_PHOTO_BURST19 
    FLAT_MODE_TIME_LAPSE_PHOTO20 
    FLAT_MODE_NIGHT_LAPSE_PHOTO21 
    FLAT_MODE_BROADCAST_RECORD22 
    FLAT_MODE_BROADCAST_BROADCAST23 
    FLAT_MODE_TIME_WARP_VIDEO24 
    FLAT_MODE_LIVE_BURST25 
    FLAT_MODE_NIGHT_LAPSE_VIDEO26 
    FLAT_MODE_SLOMO27 
    FLAT_MODE_IDLE28 
    FLAT_MODE_VIDEO_STAR_TRAIL29 
    FLAT_MODE_VIDEO_LIGHT_PAINTING30 
    FLAT_MODE_VIDEO_LIGHT_TRAIL31 
    - -

    - -

    EnumPresetGroup

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    PRESET_GROUP_ID_VIDEO1000 
    PRESET_GROUP_ID_PHOTO1001 
    PRESET_GROUP_ID_TIMELAPSE1002 
    PRESET_GROUP_ID_VIDEO_DUAL_LENS1003 
    PRESET_GROUP_ID_PHOTO_DUAL_LENS1004 
    PRESET_GROUP_ID_TIMELAPSE_DUAL_LENS1005 
    PRESET_GROUP_ID_SPECIAL1006 
    - -

    - -

    EnumPresetGroupIcon

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    PRESET_GROUP_VIDEO_ICON_ID0 
    PRESET_GROUP_PHOTO_ICON_ID1 
    PRESET_GROUP_TIMELAPSE_ICON_ID2 
    PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID3 
    PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID4 
    PRESET_GROUP_MAX_VIDEO_ICON_ID5 
    PRESET_GROUP_MAX_PHOTO_ICON_ID6 
    PRESET_GROUP_MAX_TIMELAPSE_ICON_ID7 
    - -

    - -

    EnumPresetIcon

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    PRESET_ICON_VIDEO0 
    PRESET_ICON_ACTIVITY1 
    PRESET_ICON_CINEMATIC2 
    PRESET_ICON_PHOTO3 
    PRESET_ICON_LIVE_BURST4 
    PRESET_ICON_BURST5 
    PRESET_ICON_PHOTO_NIGHT6 
    PRESET_ICON_TIMEWARP7 
    PRESET_ICON_TIMELAPSE8 
    PRESET_ICON_NIGHTLAPSE9 
    PRESET_ICON_SNAIL10 
    PRESET_ICON_VIDEO_211 
    PRESET_ICON_360_VIDEO12 
    PRESET_ICON_PHOTO_213 
    PRESET_ICON_PANORAMA14 
    PRESET_ICON_BURST_215 
    PRESET_ICON_TIMEWARP_216 
    PRESET_ICON_TIMELAPSE_217 
    PRESET_ICON_CUSTOM18 
    PRESET_ICON_AIR19 
    PRESET_ICON_BIKE20 
    PRESET_ICON_EPIC21 
    PRESET_ICON_INDOOR22 
    PRESET_ICON_MOTOR23 
    PRESET_ICON_MOUNTED24 
    PRESET_ICON_OUTDOOR25 
    PRESET_ICON_POV26 
    PRESET_ICON_SELFIE27 
    PRESET_ICON_SKATE28 
    PRESET_ICON_SNOW29 
    PRESET_ICON_TRAIL30 
    PRESET_ICON_TRAVEL31 
    PRESET_ICON_WATER32 
    PRESET_ICON_LOOPING33 
    PRESET_ICON_STARS34New custom icon (34 - 43)added for HERO 12
    PRESET_ICON_ACTION35 
    PRESET_ICON_FOLLOW_CAM36 
    PRESET_ICON_SURF37 
    PRESET_ICON_CITY38 
    PRESET_ICON_SHAKY39 
    PRESET_ICON_CHESTY40 
    PRESET_ICON_HELMET41 
    PRESET_ICON_BITE42 
    PRESET_ICON_MTB43 
    PRESET_ICON_MAX_VIDEO55Reserved 44 - 50 for Custom presets. Add icons below for new presets starting from 51
    PRESET_ICON_MAX_PHOTO56 
    PRESET_ICON_MAX_TIMEWARP57 
    PRESET_ICON_BASIC58 
    PRESET_ICON_ULTRA_SLO_MO59 
    PRESET_ICON_STANDARD_ENDURANCE60 
    PRESET_ICON_ACTIVITY_ENDURANCE61 
    PRESET_ICON_CINEMATIC_ENDURANCE62 
    PRESET_ICON_SLOMO_ENDURANCE63 
    PRESET_ICON_STATIONARY_164 
    PRESET_ICON_STATIONARY_265 
    PRESET_ICON_STATIONARY_366 
    PRESET_ICON_STATIONARY_467 
    PRESET_ICON_SIMPLE_SUPER_PHOTO70 
    PRESET_ICON_SIMPLE_NIGHT_PHOTO71 
    PRESET_ICON_HIGHEST_QUALITY_VIDEO73 
    PRESET_ICON_STANDARD_QUALITY_VIDEO74 
    PRESET_ICON_BASIC_QUALITY_VIDEO75 
    PRESET_ICON_STAR_TRAIL76 
    PRESET_ICON_LIGHT_PAINTING77 
    PRESET_ICON_LIGHT_TRAIL78 
    PRESET_ICON_FULL_FRAME79 
    PRESET_ICON_EASY_MAX_VIDEO80 
    PRESET_ICON_EASY_MAX_PHOTO81 
    PRESET_ICON_EASY_MAX_TIMEWARP82 
    PRESET_ICON_EASY_MAX_STAR_TRAIL83 
    PRESET_ICON_EASY_MAX_LIGHT_PAINTING84 
    PRESET_ICON_EASY_MAX_LIGHT_TRAIL85 
    PRESET_ICON_MAX_STAR_TRAIL89 
    PRESET_ICON_MAX_LIGHT_PAINTING90 
    PRESET_ICON_MAX_LIGHT_TRAIL91 
    PRESET_ICON_TIMELAPSE_PHOTO1000 
    PRESET_ICON_NIGHTLAPSE_PHOTO1001 
    - -

    - -

    EnumPresetTitle

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    PRESET_TITLE_ACTIVITY0 
    PRESET_TITLE_STANDARD1 
    PRESET_TITLE_CINEMATIC2 
    PRESET_TITLE_PHOTO3 
    PRESET_TITLE_LIVE_BURST4 
    PRESET_TITLE_BURST5 
    PRESET_TITLE_NIGHT6 
    PRESET_TITLE_TIME_WARP7 
    PRESET_TITLE_TIME_LAPSE8 
    PRESET_TITLE_NIGHT_LAPSE9 
    PRESET_TITLE_VIDEO10 
    PRESET_TITLE_SLOMO11 
    PRESET_TITLE_360_VIDEO12 
    PRESET_TITLE_PHOTO_213 
    PRESET_TITLE_PANORAMA14 
    PRESET_TITLE_360_PHOTO15 
    PRESET_TITLE_TIME_WARP_216 
    PRESET_TITLE_360_TIME_WARP17 
    PRESET_TITLE_CUSTOM18 
    PRESET_TITLE_AIR19 
    PRESET_TITLE_BIKE20 
    PRESET_TITLE_EPIC21 
    PRESET_TITLE_INDOOR22 
    PRESET_TITLE_MOTOR23 
    PRESET_TITLE_MOUNTED24 
    PRESET_TITLE_OUTDOOR25 
    PRESET_TITLE_POV26 
    PRESET_TITLE_SELFIE27 
    PRESET_TITLE_SKATE28 
    PRESET_TITLE_SNOW29 
    PRESET_TITLE_TRAIL30 
    PRESET_TITLE_TRAVEL31 
    PRESET_TITLE_WATER32 
    PRESET_TITLE_LOOPING33 
    PRESET_TITLE_STARS34New custom names (34 - 43)added for HERO 12
    PRESET_TITLE_ACTION35 
    PRESET_TITLE_FOLLOW_CAM36 
    PRESET_TITLE_SURF37 
    PRESET_TITLE_CITY38 
    PRESET_TITLE_SHAKY39 
    PRESET_TITLE_CHESTY40 
    PRESET_TITLE_HELMET41 
    PRESET_TITLE_BITE42 
    PRESET_TITLE_MTB43 
    PRESET_TITLE_360_TIMELAPSE51Reserved 44 - 50 for custom presets.
    PRESET_TITLE_360_NIGHT_LAPSE52 
    PRESET_TITLE_360_NIGHT_PHOTO53 
    PRESET_TITLE_PANO_TIME_LAPSE54 
    PRESET_TITLE_MAX_VIDEO55 
    PRESET_TITLE_MAX_PHOTO56 
    PRESET_TITLE_MAX_TIMEWARP57 
    PRESET_TITLE_BASIC58 
    PRESET_TITLE_ULTRA_SLO_MO59 
    PRESET_TITLE_STANDARD_ENDURANCE60 
    PRESET_TITLE_ACTIVITY_ENDURANCE61 
    PRESET_TITLE_CINEMATIC_ENDURANCE62 
    PRESET_TITLE_SLOMO_ENDURANCE63 
    PRESET_TITLE_STATIONARY_164 
    PRESET_TITLE_STATIONARY_265 
    PRESET_TITLE_STATIONARY_366 
    PRESET_TITLE_STATIONARY_467 
    PRESET_TITLE_SIMPLE_VIDEO68 
    PRESET_TITLE_SIMPLE_TIME_WARP69 
    PRESET_TITLE_SIMPLE_SUPER_PHOTO70 
    PRESET_TITLE_SIMPLE_NIGHT_PHOTO71 
    PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE72 
    PRESET_TITLE_HIGHEST_QUALITY73 
    PRESET_TITLE_EXTENDED_BATTERY74 
    PRESET_TITLE_LONGEST_BATTERY75 
    PRESET_TITLE_STAR_TRAIL76 
    PRESET_TITLE_LIGHT_PAINTING77 
    PRESET_TITLE_LIGHT_TRAIL78 
    PRESET_TITLE_FULL_FRAME79 
    PRESET_TITLE_MAX_LENS_VIDEO80 
    PRESET_TITLE_MAX_LENS_TIMEWARP81 
    PRESET_TITLE_STANDARD_QUALITY_VIDEO82 
    PRESET_TITLE_BASIC_QUALITY_VIDEO83 
    PRESET_TITLE_EASY_MAX_VIDEO84 
    PRESET_TITLE_EASY_MAX_PHOTO85 
    PRESET_TITLE_EASY_MAX_TIMEWARP86 
    PRESET_TITLE_EASY_MAX_STAR_TRAIL87 
    PRESET_TITLE_EASY_MAX_LIGHT_PAINTING88 
    PRESET_TITLE_EASY_MAX_LIGHT_TRAIL89 
    PRESET_TITLE_MAX_STAR_TRAIL90 
    PRESET_TITLE_MAX_LIGHT_PAINTING91 
    PRESET_TITLE_MAX_LIGHT_TRAIL92 
    PRESET_TITLE_HIGHEST_QUALITY_VIDEO93 
    PRESET_TITLE_USER_DEFINED_CUSTOM_NAME94 
    - -

    - -

    - -

    - -

    - -

    request_get_preset_status.proto

    - -

    - -

    RequestGetPresetStatus

    -

    Get preset status (and optionally register to be notified when it changes)

    - -

    Response: @ref NotifyPresetStatus sent immediately

    - -

    Notification: @ref NotifyPresetStatus sent periodically as preset status changes, if registered.

    - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    register_preset_statusEnumRegisterPresetStatusrepeatedArray of Preset statuses to be notified about
    unregister_preset_statusEnumRegisterPresetStatusrepeatedArray of Preset statuses to stop being notified about
    - -

    - -

    - -

    EnumRegisterPresetStatus

    - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    REGISTER_PRESET_STATUS_PRESET1Send notification when properties of a preset change
    REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY2Send notification when properties of a preset group change
    - -

    - -

    - -

    - -

    - -

    response_generic.proto

    - -

    - -

    ResponseGeneric

    -

    Generic Response used across most response / notification messages

    - -

    @ref EnumResultGeneric

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    resultEnumResultGenericrequiredGeneric pass/fail/error info
    - -

    - -

    - -

    EnumResultGeneric

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    RESULT_UNKNOWN0 
    RESULT_SUCCESS1 
    RESULT_ILL_FORMED2 
    RESULT_NOT_SUPPORTED3 
    RESULT_ARGUMENT_OUT_OF_BOUNDS4 
    RESULT_ARGUMENT_INVALID5 
    - -

    - -

    - -

    - -

    - -

    set_camera_control_status.proto

    - -

    - -

    RequestSetCameraControlStatus

    -

    Set Camera Control Status (as part of Global Behaviors feature)

    - -

    Response: @ref ResponseGeneric

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    camera_control_statusEnumCameraControlStatusrequiredDeclare who is taking control of the camera
    - -

    - -

    - -

    EnumCameraControlStatus

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    CAMERA_IDLE0 
    CAMERA_CONTROL1Can only be set by camera, not by app or third party
    CAMERA_EXTERNAL_CONTROL2 
    - -

    - -

    - -

    - -

    - -

    turbo_transfer.proto

    - -

    - -

    RequestSetTurboActive

    -

    Enable/disable display of “Transferring Media” UI

    - -

    Response: @ref ResponseGeneric

    - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    activeboolrequiredEnable or disable Turbo Transfer feature
    - -

    - -

    - -

    - -

    - -

    Scalar Value Types

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    .proto TypeNotesC++JavaPythonGoC#PHPRuby
    - double doubledoublefloatfloat64doublefloatFloat
    - float floatfloatfloatfloat32floatfloatFloat
    - int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
    - int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
    - uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
    - uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
    - sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
    - sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
    - fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
    - fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
    - sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
    - sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
    - bool boolbooleanbooleanboolboolbooleanTrueClass/FalseClass
    - stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
    - bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
    - - -
    - -
    - - - - - - - -
    - - - - -
    - - -
    - - - -
    - -
    - - -
    -
    -
    - - -
    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - + +

    Redirecting…

    + Click here if you are not redirected. + diff --git a/protos/open_gopro.html b/protos/open_gopro.html new file mode 100644 index 00000000..a9d3559d --- /dev/null +++ b/protos/open_gopro.html @@ -0,0 +1,3266 @@ + + + + + + +open_gopro Protobuf Documentation : Open GoPro + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + + +
    + + + + + + + + + + + + + +
    + + + + + +
    + + + + + +
    + +
    +

    open_gopro Protobuf Documentation +

    + + +

    + + + + + + + + + + + + 21 minute read + + + +

    + + +
    + + +
    + + + +

    EnumCOHNNetworkState

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    COHN_STATE_Init0 
    COHN_STATE_Error1 
    COHN_STATE_Exit2 
    COHN_STATE_Idle5 
    COHN_STATE_NetworkConnected27 
    COHN_STATE_NetworkDisconnected28 
    COHN_STATE_ConnectingToNetwork29 
    COHN_STATE_Invalid30 
    + +

    EnumCOHNStatus

    + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    COHN_UNPROVISIONED0 
    COHN_PROVISIONED1 
    + +

    EnumCameraControlStatus

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    CAMERA_IDLE0 
    CAMERA_CONTROL1Can only be set by camera, not by app or third party
    CAMERA_EXTERNAL_CONTROL2 
    + +

    EnumFlatMode

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    FLAT_MODE_UNKNOWN-1 
    FLAT_MODE_PLAYBACK4 
    FLAT_MODE_SETUP5 
    FLAT_MODE_VIDEO12 
    FLAT_MODE_TIME_LAPSE_VIDEO13 
    FLAT_MODE_LOOPING15 
    FLAT_MODE_PHOTO_SINGLE16 
    FLAT_MODE_PHOTO17 
    FLAT_MODE_PHOTO_NIGHT18 
    FLAT_MODE_PHOTO_BURST19 
    FLAT_MODE_TIME_LAPSE_PHOTO20 
    FLAT_MODE_NIGHT_LAPSE_PHOTO21 
    FLAT_MODE_BROADCAST_RECORD22 
    FLAT_MODE_BROADCAST_BROADCAST23 
    FLAT_MODE_TIME_WARP_VIDEO24 
    FLAT_MODE_LIVE_BURST25 
    FLAT_MODE_NIGHT_LAPSE_VIDEO26 
    FLAT_MODE_SLOMO27 
    FLAT_MODE_IDLE28 
    FLAT_MODE_VIDEO_STAR_TRAIL29 
    FLAT_MODE_VIDEO_LIGHT_PAINTING30 
    FLAT_MODE_VIDEO_LIGHT_TRAIL31 
    + +

    EnumLens

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    LENS_WIDE0 
    LENS_LINEAR4 
    LENS_SUPERVIEW3 
    + +

    EnumLiveStreamError

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    LIVE_STREAM_ERROR_NONE0No error (success)
    LIVE_STREAM_ERROR_NETWORK1General network error during the stream
    LIVE_STREAM_ERROR_CREATESTREAM2Startup error: bad URL or valid with live stream server
    LIVE_STREAM_ERROR_OUTOFMEMORY3Not enough memory on camera to complete task
    LIVE_STREAM_ERROR_INPUTSTREAM4Failed to get stream from low level camera system
    LIVE_STREAM_ERROR_INTERNET5No internet access detected on startup of streamer
    LIVE_STREAM_ERROR_OSNETWORK6Error occured in linux networking stack. usually means the server closed the connection
    LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT7Timed out attemping to connect to the wifi network when attemping live stream
    LIVE_STREAM_ERROR_SSL_HANDSHAKE8SSL handshake failed (commonly caused due to incorrect time / time zone)
    LIVE_STREAM_ERROR_CAMERA_BLOCKED9Low level camera system rejected attempt to start live stream
    LIVE_STREAM_ERROR_UNKNOWN10Unknown
    LIVE_STREAM_ERROR_SD_CARD_FULL40Can not perform livestream because sd card is full
    LIVE_STREAM_ERROR_SD_CARD_REMOVED41Livestream stopped because sd card was removed
    + +

    EnumLiveStreamStatus

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    LIVE_STREAM_STATE_IDLE0Initial status. Livestream has not yet been configured
    LIVE_STREAM_STATE_CONFIG1Livestream is being configured
    LIVE_STREAM_STATE_READY2Livestream has finished configuration and is ready to start streaming
    LIVE_STREAM_STATE_STREAMING3Livestream is actively streaming
    LIVE_STREAM_STATE_COMPLETE_STAY_ON4Live stream is exiting. No errors occured.
    LIVE_STREAM_STATE_FAILED_STAY_ON5Live stream is exiting. An error occurred.
    LIVE_STREAM_STATE_RECONNECTING6An error occurred during livestream and stream is attempting to reconnect.
    + +

    EnumPresetGroup

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    PRESET_GROUP_ID_VIDEO1000 
    PRESET_GROUP_ID_PHOTO1001 
    PRESET_GROUP_ID_TIMELAPSE1002 
    + +

    EnumPresetGroupIcon

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    PRESET_GROUP_VIDEO_ICON_ID0 
    PRESET_GROUP_PHOTO_ICON_ID1 
    PRESET_GROUP_TIMELAPSE_ICON_ID2 
    PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID3 
    PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID4 
    PRESET_GROUP_MAX_VIDEO_ICON_ID5 
    PRESET_GROUP_MAX_PHOTO_ICON_ID6 
    PRESET_GROUP_MAX_TIMELAPSE_ICON_ID7 
    + +

    EnumPresetIcon

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    PRESET_ICON_VIDEO0 
    PRESET_ICON_ACTIVITY1 
    PRESET_ICON_CINEMATIC2 
    PRESET_ICON_PHOTO3 
    PRESET_ICON_LIVE_BURST4 
    PRESET_ICON_BURST5 
    PRESET_ICON_PHOTO_NIGHT6 
    PRESET_ICON_TIMEWARP7 
    PRESET_ICON_TIMELAPSE8 
    PRESET_ICON_NIGHTLAPSE9 
    PRESET_ICON_SNAIL10 
    PRESET_ICON_VIDEO_211 
    PRESET_ICON_PHOTO_213 
    PRESET_ICON_PANORAMA14 
    PRESET_ICON_BURST_215 
    PRESET_ICON_TIMEWARP_216 
    PRESET_ICON_TIMELAPSE_217 
    PRESET_ICON_CUSTOM18 
    PRESET_ICON_AIR19 
    PRESET_ICON_BIKE20 
    PRESET_ICON_EPIC21 
    PRESET_ICON_INDOOR22 
    PRESET_ICON_MOTOR23 
    PRESET_ICON_MOUNTED24 
    PRESET_ICON_OUTDOOR25 
    PRESET_ICON_POV26 
    PRESET_ICON_SELFIE27 
    PRESET_ICON_SKATE28 
    PRESET_ICON_SNOW29 
    PRESET_ICON_TRAIL30 
    PRESET_ICON_TRAVEL31 
    PRESET_ICON_WATER32 
    PRESET_ICON_LOOPING33 
    PRESET_ICON_BASIC58 
    PRESET_ICON_ULTRA_SLO_MO59 
    PRESET_ICON_STANDARD_ENDURANCE60 
    PRESET_ICON_ACTIVITY_ENDURANCE61 
    PRESET_ICON_CINEMATIC_ENDURANCE62 
    PRESET_ICON_SLOMO_ENDURANCE63 
    PRESET_ICON_STATIONARY_164 
    PRESET_ICON_STATIONARY_265 
    PRESET_ICON_STATIONARY_366 
    PRESET_ICON_STATIONARY_467 
    PRESET_ICON_SIMPLE_SUPER_PHOTO70 
    PRESET_ICON_SIMPLE_NIGHT_PHOTO71 
    PRESET_ICON_HIGHEST_QUALITY_VIDEO73 
    PRESET_ICON_STANDARD_QUALITY_VIDEO74 
    PRESET_ICON_BASIC_QUALITY_VIDEO75 
    PRESET_ICON_STAR_TRAIL76 
    PRESET_ICON_LIGHT_PAINTING77 
    PRESET_ICON_LIGHT_TRAIL78 
    PRESET_ICON_FULL_FRAME79 
    PRESET_ICON_TIMELAPSE_PHOTO1000 
    PRESET_ICON_NIGHTLAPSE_PHOTO1001 
    + +

    EnumPresetTitle

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    PRESET_TITLE_ACTIVITY0 
    PRESET_TITLE_STANDARD1 
    PRESET_TITLE_CINEMATIC2 
    PRESET_TITLE_PHOTO3 
    PRESET_TITLE_LIVE_BURST4 
    PRESET_TITLE_BURST5 
    PRESET_TITLE_NIGHT6 
    PRESET_TITLE_TIME_WARP7 
    PRESET_TITLE_TIME_LAPSE8 
    PRESET_TITLE_NIGHT_LAPSE9 
    PRESET_TITLE_VIDEO10 
    PRESET_TITLE_SLOMO11 
    PRESET_TITLE_PHOTO_213 
    PRESET_TITLE_PANORAMA14 
    PRESET_TITLE_TIME_WARP_216 
    PRESET_TITLE_CUSTOM18 
    PRESET_TITLE_AIR19 
    PRESET_TITLE_BIKE20 
    PRESET_TITLE_EPIC21 
    PRESET_TITLE_INDOOR22 
    PRESET_TITLE_MOTOR23 
    PRESET_TITLE_MOUNTED24 
    PRESET_TITLE_OUTDOOR25 
    PRESET_TITLE_POV26 
    PRESET_TITLE_SELFIE27 
    PRESET_TITLE_SKATE28 
    PRESET_TITLE_SNOW29 
    PRESET_TITLE_TRAIL30 
    PRESET_TITLE_TRAVEL31 
    PRESET_TITLE_WATER32 
    PRESET_TITLE_LOOPING33 
    PRESET_TITLE_BASIC58 
    PRESET_TITLE_ULTRA_SLO_MO59 
    PRESET_TITLE_STANDARD_ENDURANCE60 
    PRESET_TITLE_ACTIVITY_ENDURANCE61 
    PRESET_TITLE_CINEMATIC_ENDURANCE62 
    PRESET_TITLE_SLOMO_ENDURANCE63 
    PRESET_TITLE_STATIONARY_164 
    PRESET_TITLE_STATIONARY_265 
    PRESET_TITLE_STATIONARY_366 
    PRESET_TITLE_STATIONARY_467 
    PRESET_TITLE_SIMPLE_VIDEO68 
    PRESET_TITLE_SIMPLE_TIME_WARP69 
    PRESET_TITLE_SIMPLE_SUPER_PHOTO70 
    PRESET_TITLE_SIMPLE_NIGHT_PHOTO71 
    PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE72 
    PRESET_TITLE_HIGHEST_QUALITY73 
    PRESET_TITLE_EXTENDED_BATTERY74 
    PRESET_TITLE_LONGEST_BATTERY75 
    PRESET_TITLE_STAR_TRAIL76 
    PRESET_TITLE_LIGHT_PAINTING77 
    PRESET_TITLE_LIGHT_TRAIL78 
    PRESET_TITLE_FULL_FRAME79 
    PRESET_TITLE_STANDARD_QUALITY_VIDEO82 
    PRESET_TITLE_BASIC_QUALITY_VIDEO83 
    PRESET_TITLE_HIGHEST_QUALITY_VIDEO93 
    PRESET_TITLE_USER_DEFINED_CUSTOM_NAME94 
    + +

    EnumProvisioning

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    PROVISIONING_UNKNOWN0 
    PROVISIONING_NEVER_STARTED1 
    PROVISIONING_STARTED2 
    PROVISIONING_ABORTED_BY_SYSTEM3 
    PROVISIONING_CANCELLED_BY_USER4 
    PROVISIONING_SUCCESS_NEW_AP5 
    PROVISIONING_SUCCESS_OLD_AP6 
    PROVISIONING_ERROR_FAILED_TO_ASSOCIATE7 
    PROVISIONING_ERROR_PASSWORD_AUTH8 
    PROVISIONING_ERROR_EULA_BLOCKING9 
    PROVISIONING_ERROR_NO_INTERNET10 
    PROVISIONING_ERROR_UNSUPPORTED_TYPE11 
    + +

    EnumRegisterLiveStreamStatus

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    REGISTER_LIVE_STREAM_STATUS_STATUS1 
    REGISTER_LIVE_STREAM_STATUS_ERROR2 
    REGISTER_LIVE_STREAM_STATUS_MODE3 
    REGISTER_LIVE_STREAM_STATUS_BITRATE4 
    + +

    EnumRegisterPresetStatus

    + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    REGISTER_PRESET_STATUS_PRESET1Send notification when properties of a preset change
    REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY2Send notification when properties of a preset group change
    + +

    EnumResultGeneric

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    RESULT_UNKNOWN0 
    RESULT_SUCCESS1 
    RESULT_ILL_FORMED2 
    RESULT_NOT_SUPPORTED3 
    RESULT_ARGUMENT_OUT_OF_BOUNDS4 
    RESULT_ARGUMENT_INVALID5 
    RESULT_RESOURCE_NOT_AVAILABLE6 
    + +

    EnumScanEntryFlags

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    SCAN_FLAG_OPEN0x00This network does not require authentication
    SCAN_FLAG_AUTHENTICATED0x01This network requires authentication
    SCAN_FLAG_CONFIGURED0x02This network has been previously provisioned
    SCAN_FLAG_BEST_SSID0x04 
    SCAN_FLAG_ASSOCIATED0x08camera is connected to this AP
    SCAN_FLAG_UNSUPPORTED_TYPE0x10 
    + +

    EnumScanning

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    SCANNING_UNKNOWN0 
    SCANNING_NEVER_STARTED1 
    SCANNING_STARTED2 
    SCANNING_ABORTED_BY_SYSTEM3 
    SCANNING_CANCELLED_BY_USER4 
    SCANNING_SUCCESS5 
    + +

    EnumWindowSize

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameValueSummary
    WINDOW_SIZE_4804 
    WINDOW_SIZE_7207 
    WINDOW_SIZE_108012 
    + +

    Media

    + +

    A reusable model to represent a media file

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    folderoptionalstring1Directory that the media is contained in
    fileoptionalstring2Filename of media
    + +

    NotifProvisioningState

    + +

    Provision state notification

    + +

    TODO refernce where this is triggered

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    provisioning_staterequiredEnumProvisioning1Provisioning / connection state
    + +

    NotifStartScanning

    + +

    Scanning state notification

    + +

    Triggered via RequestStartScan

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    scanning_staterequiredEnumScanning1Scanning state
    scan_idoptionalint322ID associated with scan results (included if scan was successful)
    total_entriesoptionalint323Number of APs found during scan (included if scan was successful)
    total_configured_ssidrequiredint324Total count of camera’s provisioned SSIDs
    + +

    NotifyCOHNStatus

    + +

    Current COHN status triggered by a RequestGetCOHNStatus

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    statusoptionalEnumCOHNStatus1Current COHN status
    stateoptionalEnumCOHNNetworkState2Current COHN network state
    usernameoptionalstring3Username used for http basic auth header
    passwordoptionalstring4Password used for http basic auth header
    ipaddressoptionalstring5Camera’s IP address on the local network
    enabledoptionalbool6Is COHN currently enabled
    ssidoptionalstring7Currently connected SSID
    macaddressoptionalstring8MAC address of the wifi adapter
    + +

    NotifyLiveStreamStatus

    + +

    Live Stream status

    + +

    Sent either:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    live_stream_statusoptionalEnumLiveStreamStatus1Live stream status
    live_stream_erroroptionalEnumLiveStreamError2Live stream error
    live_stream_encodeoptionalbool3Is live stream encoding?
    live_stream_bitrateoptionalint324Live stream bitrate (Kbps)
    live_stream_window_size_supported_arrayrepeatedEnumWindowSize5Set of currently supported resolutions
    live_stream_encode_supportedoptionalbool6Does the camera support encoding while live streaming?
    live_stream_max_lens_unsupportedoptionalbool7Is the Max Lens feature NOT supported?
    live_stream_minimum_stream_bitrateoptionalint328Camera-defined minimum bitrate (static) (Kbps)
    live_stream_maximum_stream_bitrateoptionalint329Camera-defined maximum bitrate (static) (Kbps)
    live_stream_lens_supportedoptionalbool10Does camera support setting lens for live streaming?
    live_stream_lens_supported_arrayrepeatedEnumLens11Set of currently supported FOV options
    + +

    NotifyPresetStatus

    + +

    Current Preset status

    + +

    Sent either:

    +
      +
    • synchronously via initial response to RequestGetPresetStatus +
    • +
    • asynchronously when Preset change if registered in @rev RequestGetPresetStatus
    • +
    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    preset_group_arrayrepeatedPresetGroup1Array of currently available Preset Groups
    + +

    Preset

    + +

    An individual preset.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    idoptionalint321Preset ID
    modeoptionalEnumFlatMode2Preset flatmode ID
    title_idoptionalEnumPresetTitle3Preset Title ID
    title_numberoptionalint324Preset Title Number (e.g. 1/2/3 in Custom1, Custom2, Custom3)
    user_definedoptionalbool5Is the Preset custom/user-defined?
    iconoptionalEnumPresetIcon6Preset Icon ID
    setting_arrayrepeatedPresetSetting7Array of settings associated with this Preset
    is_modifiedoptionalbool8Has Preset been modified from factory defaults? (False for user-defined Presets)
    is_fixedoptionalbool9Is this Preset mutable?
    custom_nameoptionalstring10Custom string name given to this preset via RequestCustomPresetUpdate +
    + +

    PresetGroup

    + +

    Preset Group meta information and contained Presets

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    idoptionalEnumPresetGroup1Preset Group ID
    preset_arrayrepeatedPreset2Array of Presets contained in this Preset Group
    can_add_presetoptionalbool3Is there room in the group to add additional Presets?
    iconoptionalEnumPresetGroupIcon4The icon to display for this preset group
    + +

    PresetSetting

    + +

    Setting representation that comprises a Preset

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    idoptionalint321Setting ID
    valueoptionalint322Setting value
    is_captionoptionalbool3Does this setting appear on the Preset “pill” in the camera UI?
    + +

    RequestCOHNCert

    + +

    Get the COHN certificate.

    + +

    Returns a ResponseCOHNCert

    + +

    RequestClearCOHNCert

    + +

    Clear the COHN certificate.

    + +

    Returns a ResponseGeneric with the status of the clear

    + +

    RequestConnect

    + +

    Connect to (but do not authenticate with) an Access Point

    + +

    This is intended to be used to connect to a previously-connected Access Point

    + +

    Response: ResponseConnect

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    ssidrequiredstring1AP SSID
    + +

    RequestConnectNew

    + +

    Connect to and authenticate with an Access Point

    + +

    This is only intended to be used if the AP is not previously provisioned.

    + +

    Response: ResponseConnectNew sent immediately

    + +

    Notification: NotifProvisioningState sent periodically as provisioning state changes

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    ssidrequiredstring1AP SSID
    passwordrequiredstring2AP password
    static_ipoptionalbytes3Static IP address
    gatewayoptionalbytes4Gateway IP address
    subnetoptionalbytes5Subnet mask
    dns_primaryoptionalbytes6Primary DNS
    dns_secondaryoptionalbytes7Secondary DNS
    + +

    RequestCreateCOHNCert

    + +

    Create the COHN certificate.

    + +

    Returns a ResponseGeneric with the status of the creation

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    overrideoptionalbool1Override current provisioning and create new cert
    + +

    RequestCustomPresetUpdate

    + +

    Request to update the active custom preset

    + +

    This only operates on the currently active Preset and will fail if the current + Preset is not custom.

    + +

    The use cases are:

    + +
      +
    1. Update the Custom Preset Icon +
        +
      • +icon_id is always optional and can always be passed
      • +
      +
    2. +
    + +

    and / or

    + +
      +
    1. Update the Custom Preset Title to a… +
        +
      • +Factory Preset Title: Set title_id to a non-94 value
      • +
      • +Custom Preset Name: Set title_id to 94 and specify a custom_name +
      • +
      +
    2. +
    + +

    Returns a ResponseGeneric with the status of the preset update request.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    title_idoptionalEnumPresetTitle1Preset Title ID The range of acceptable custom title ID’s can be found in the initial NotifyPresetStatus response to RequestGetPresetStatus +
    custom_nameoptionalstring2utf-8 encoded target custom preset name
    icon_idoptionalEnumPresetIcon3Preset Icon ID The range of acceptable custom icon ID’s can be found in the initial NotifyPresetStatus response to RequestGetPresetStatus +
    + +

    RequestGetApEntries

    + +

    Get a list of Access Points found during a RequestStartScan

    + +

    Response: ResponseGetApEntries

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    start_indexrequiredint321Used for paging. 0 <= start_index < ResponseGetApEntries .total_entries
    max_entriesrequiredint322Used for paging. Value must be < ResponseGetApEntries .total_entries
    scan_idrequiredint323ID corresponding to a set of scan results (i.e. ResponseGetApEntries .scan_id)
    + +

    RequestGetCOHNStatus

    + +

    Get the current COHN status.

    + +

    This always returns a NotifyCOHNStatus

    + +

    Additionally, asynchronous updates can also be registerd to return more NotifyCOHNStatus when a value + changes.

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    register_cohn_statusoptionalbool11 to register, 0 to unregister
    + +

    RequestGetLastCapturedMedia

    + +

    Get the last captured media filename

    + +

    Returns a ResponseLastCapturedMedia

    + +

    RequestGetLiveStreamStatus

    + +

    Get the current livestream status (and optionally register for future status changes)

    + +

    Both current status and future status changes are sent via NotifyLiveStreamStatus

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    register_live_stream_statusrepeatedEnumRegisterLiveStreamStatus1Array of live stream statuses to be notified about
    unregister_live_stream_statusrepeatedEnumRegisterLiveStreamStatus2Array of live stream statuses to stop being notified about
    + +

    RequestGetPresetStatus

    + +

    Get preset status (and optionally register to be notified when it changes)

    + +

    Response: NotifyPresetStatus sent immediately

    + +

    Notification: NotifyPresetStatus sent periodically as preset status changes, if registered.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    register_preset_statusrepeatedEnumRegisterPresetStatus1Array of Preset statuses to be notified about
    unregister_preset_statusrepeatedEnumRegisterPresetStatus2Array of Preset statuses to stop being notified about
    + +

    RequestReleaseNetwork

    + +

    Request to disconnect from current AP network

    + +

    Response: ResponseGeneric

    + +

    RequestSetCOHNSetting

    + +

    Enable and disable COHN if provisioned

    + +

    Returns a ResponseGeneric

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    cohn_activeoptionalbool11 to enable, 0 to disable
    + +

    RequestSetCameraControlStatus

    + +

    Set Camera Control Status (as part of Global Behaviors feature)

    + +

    Response: ResponseGeneric

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    camera_control_statusrequiredEnumCameraControlStatus1Declare who is taking control of the camera
    + +

    RequestSetLiveStreamMode

    + +

    Configure lives streaming

    + +

    The current livestream status can be queried via RequestGetLiveStreamStatus

    + +

    Response: ResponseGeneric

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    urloptionalstring1RTMP(S) URL used for live stream
    encodeoptionalbool2Save media to sdcard while streaming?
    window_sizeoptionalEnumWindowSize3Resolution to use for live stream The set of supported lenses is only available from the live_stream_window_size_supported_array in NotifyLiveStreamStatus)
    certoptionalbytes6Certificate for servers that require it
    minimum_bitrateoptionalint327Minimum desired bitrate (may or may not be honored)
    maximum_bitrateoptionalint328Maximum desired bitrate (may or may not be honored)
    starting_bitrateoptionalint329Starting bitrate
    lensoptionalEnumLens10Lens to use for live stream The set of supported lenses is only available from the live_stream_lens_supported_array in NotifyLiveStreamStatus)
    + +

    RequestSetTurboActive

    + +

    Enable/disable display of “Transferring Media” UI

    + +

    Response: ResponseGeneric

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    activerequiredbool1Enable or disable Turbo Transfer feature
    + +

    RequestStartScan

    + +

    Start scanning for Access Points

    + +
    +

    Serialization of this object is zero bytes.

    +
    + +

    Response: ResponseStartScanning are sent immediately after the camera receives this command

    + +

    Notifications: NotifStartScanning are sent periodically as scanning state changes. Use to detect scan complete.

    + +

    ResponseCOHNCert

    + +

    COHN Certificate response triggered by RequestCOHNCert

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultoptionalEnumResultGeneric1Was request successful?
    certoptionalstring2Root CA cert (ASCII text)
    + +

    ResponseConnect

    + +

    The status of an attempt to connect to an Access Point

    + +

    Sent as the initial response to RequestConnect

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultrequiredEnumResultGeneric1Generic pass/fail/error info
    provisioning_staterequiredEnumProvisioning2Provisioning/connection state
    timeout_secondsrequiredint323Network connection timeout (seconds)
    + +

    ResponseConnectNew

    + +

    The status of an attempt to connect to an Access Point

    + +

    Sent as the initial response to RequestConnectNew

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultrequiredEnumResultGeneric1Status of Connect New request
    provisioning_staterequiredEnumProvisioning2Current provisioning state of the network
    timeout_secondsrequiredint323number of seconds camera will wait before declaring a network connection attempt failed.
    + +

    ResponseGeneric

    + +

    Generic Response used across most response / notification messages

    + +

    EnumResultGeneric

    + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultrequiredEnumResultGeneric1Generic pass/fail/error info
    + +

    ResponseGetApEntries

    + +

    A list of scan entries describing a scanned Access Point

    + +

    This is sent in response to a RequestGetApEntries

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultrequiredEnumResultGeneric1Generic pass/fail/error info
    scan_idrequiredint322ID associated with this batch of results
    entriesrepeatedScanEntry3Array containing details about discovered APs
    + +

    ResponseLastCapturedMedia

    + +

    Message sent in response to a RequestGetLastCapturedMedia

    + +

    This contains the complete path of the last captured media. Depending on the type of media captured, it will return:

    + +
      +
    • Single photo / video: The single media path
    • +
    • Any grouped media: The path to the first captured media in the group
    • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultoptionalEnumResultGeneric1Was the request successful?
    mediaoptionalMedia2Last captured media if result is RESULT_SUCCESS. Invalid if result is RESULT_RESOURCE_NOT_AVAILBLE.
    + +

    ResponseStartScanning

    + +

    The current scanning state.

    + +

    This is the initial response to a RequestStartScan

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    resultrequiredEnumResultGeneric1Generic pass/fail/error info
    scanning_staterequiredEnumScanning2Scanning state
    + +

    ScanEntry

    + +

    The individual Scan Entry model

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypespecValue TypeValueSummary
    ssidrequiredstring1AP SSID
    signal_strength_barsrequiredint322Signal strength (3 bars: >-70 dBm; 2 bars: >-85 dBm; 1 bar: <=-85 dBm)
    signal_frequency_mhzrequiredint324Signal frequency (MHz)
    scan_entry_flagsrequiredint325Bitmasked value from EnumScanEntryFlags +
    + + +
    + +
    + + + + + + + +
    + + + + +
    + + +
    + + + +
    + +
    + + +
    +
    +
    + + +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + diff --git a/protos/open_gopro.md b/protos/open_gopro.md new file mode 100644 index 00000000..b0c24046 --- /dev/null +++ b/protos/open_gopro.md @@ -0,0 +1,839 @@ +# open_gopro Protobuf Documentation + + +## EnumCOHNNetworkState + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| COHN_STATE_Init | 0 | | +| COHN_STATE_Error | 1 | | +| COHN_STATE_Exit | 2 | | +| COHN_STATE_Idle | 5 | | +| COHN_STATE_NetworkConnected | 27 | | +| COHN_STATE_NetworkDisconnected | 28 | | +| COHN_STATE_ConnectingToNetwork | 29 | | +| COHN_STATE_Invalid | 30 | | + +## EnumCOHNStatus + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| COHN_UNPROVISIONED | 0 | | +| COHN_PROVISIONED | 1 | | + +## EnumCameraControlStatus + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| CAMERA_IDLE | 0 | | +| CAMERA_CONTROL | 1 | Can only be set by camera, not by app or third party | +| CAMERA_EXTERNAL_CONTROL | 2 | | + +## EnumFlatMode + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| FLAT_MODE_UNKNOWN | -1 | | +| FLAT_MODE_PLAYBACK | 4 | | +| FLAT_MODE_SETUP | 5 | | +| FLAT_MODE_VIDEO | 12 | | +| FLAT_MODE_TIME_LAPSE_VIDEO | 13 | | +| FLAT_MODE_LOOPING | 15 | | +| FLAT_MODE_PHOTO_SINGLE | 16 | | +| FLAT_MODE_PHOTO | 17 | | +| FLAT_MODE_PHOTO_NIGHT | 18 | | +| FLAT_MODE_PHOTO_BURST | 19 | | +| FLAT_MODE_TIME_LAPSE_PHOTO | 20 | | +| FLAT_MODE_NIGHT_LAPSE_PHOTO | 21 | | +| FLAT_MODE_BROADCAST_RECORD | 22 | | +| FLAT_MODE_BROADCAST_BROADCAST | 23 | | +| FLAT_MODE_TIME_WARP_VIDEO | 24 | | +| FLAT_MODE_LIVE_BURST | 25 | | +| FLAT_MODE_NIGHT_LAPSE_VIDEO | 26 | | +| FLAT_MODE_SLOMO | 27 | | +| FLAT_MODE_IDLE | 28 | | +| FLAT_MODE_VIDEO_STAR_TRAIL | 29 | | +| FLAT_MODE_VIDEO_LIGHT_PAINTING | 30 | | +| FLAT_MODE_VIDEO_LIGHT_TRAIL | 31 | | + +## EnumLens + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| LENS_WIDE | 0 | | +| LENS_LINEAR | 4 | | +| LENS_SUPERVIEW | 3 | | + +## EnumLiveStreamError + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| LIVE_STREAM_ERROR_NONE | 0 | No error (success) | +| LIVE_STREAM_ERROR_NETWORK | 1 | General network error during the stream | +| LIVE_STREAM_ERROR_CREATESTREAM | 2 | Startup error: bad URL or valid with live stream server | +| LIVE_STREAM_ERROR_OUTOFMEMORY | 3 | Not enough memory on camera to complete task | +| LIVE_STREAM_ERROR_INPUTSTREAM | 4 | Failed to get stream from low level camera system | +| LIVE_STREAM_ERROR_INTERNET | 5 | No internet access detected on startup of streamer | +| LIVE_STREAM_ERROR_OSNETWORK | 6 | Error occured in linux networking stack. usually means the server closed the connection | +| LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT | 7 | Timed out attemping to connect to the wifi network when attemping live stream | +| LIVE_STREAM_ERROR_SSL_HANDSHAKE | 8 | SSL handshake failed (commonly caused due to incorrect time / time zone) | +| LIVE_STREAM_ERROR_CAMERA_BLOCKED | 9 | Low level camera system rejected attempt to start live stream | +| LIVE_STREAM_ERROR_UNKNOWN | 10 | Unknown | +| LIVE_STREAM_ERROR_SD_CARD_FULL | 40 | Can not perform livestream because sd card is full | +| LIVE_STREAM_ERROR_SD_CARD_REMOVED | 41 | Livestream stopped because sd card was removed | + +## EnumLiveStreamStatus + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| LIVE_STREAM_STATE_IDLE | 0 | Initial status. Livestream has not yet been configured | +| LIVE_STREAM_STATE_CONFIG | 1 | Livestream is being configured | +| LIVE_STREAM_STATE_READY | 2 | Livestream has finished configuration and is ready to start streaming | +| LIVE_STREAM_STATE_STREAMING | 3 | Livestream is actively streaming | +| LIVE_STREAM_STATE_COMPLETE_STAY_ON | 4 | Live stream is exiting. No errors occured. | +| LIVE_STREAM_STATE_FAILED_STAY_ON | 5 | Live stream is exiting. An error occurred. | +| LIVE_STREAM_STATE_RECONNECTING | 6 | An error occurred during livestream and stream is attempting to reconnect. | + +## EnumPresetGroup + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| PRESET_GROUP_ID_VIDEO | 1000 | | +| PRESET_GROUP_ID_PHOTO | 1001 | | +| PRESET_GROUP_ID_TIMELAPSE | 1002 | | + +## EnumPresetGroupIcon + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| PRESET_GROUP_VIDEO_ICON_ID | 0 | | +| PRESET_GROUP_PHOTO_ICON_ID | 1 | | +| PRESET_GROUP_TIMELAPSE_ICON_ID | 2 | | +| PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID | 3 | | +| PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID | 4 | | +| PRESET_GROUP_MAX_VIDEO_ICON_ID | 5 | | +| PRESET_GROUP_MAX_PHOTO_ICON_ID | 6 | | +| PRESET_GROUP_MAX_TIMELAPSE_ICON_ID | 7 | | + +## EnumPresetIcon + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| PRESET_ICON_VIDEO | 0 | | +| PRESET_ICON_ACTIVITY | 1 | | +| PRESET_ICON_CINEMATIC | 2 | | +| PRESET_ICON_PHOTO | 3 | | +| PRESET_ICON_LIVE_BURST | 4 | | +| PRESET_ICON_BURST | 5 | | +| PRESET_ICON_PHOTO_NIGHT | 6 | | +| PRESET_ICON_TIMEWARP | 7 | | +| PRESET_ICON_TIMELAPSE | 8 | | +| PRESET_ICON_NIGHTLAPSE | 9 | | +| PRESET_ICON_SNAIL | 10 | | +| PRESET_ICON_VIDEO_2 | 11 | | +| PRESET_ICON_PHOTO_2 | 13 | | +| PRESET_ICON_PANORAMA | 14 | | +| PRESET_ICON_BURST_2 | 15 | | +| PRESET_ICON_TIMEWARP_2 | 16 | | +| PRESET_ICON_TIMELAPSE_2 | 17 | | +| PRESET_ICON_CUSTOM | 18 | | +| PRESET_ICON_AIR | 19 | | +| PRESET_ICON_BIKE | 20 | | +| PRESET_ICON_EPIC | 21 | | +| PRESET_ICON_INDOOR | 22 | | +| PRESET_ICON_MOTOR | 23 | | +| PRESET_ICON_MOUNTED | 24 | | +| PRESET_ICON_OUTDOOR | 25 | | +| PRESET_ICON_POV | 26 | | +| PRESET_ICON_SELFIE | 27 | | +| PRESET_ICON_SKATE | 28 | | +| PRESET_ICON_SNOW | 29 | | +| PRESET_ICON_TRAIL | 30 | | +| PRESET_ICON_TRAVEL | 31 | | +| PRESET_ICON_WATER | 32 | | +| PRESET_ICON_LOOPING | 33 | | +| PRESET_ICON_BASIC | 58 | | +| PRESET_ICON_ULTRA_SLO_MO | 59 | | +| PRESET_ICON_STANDARD_ENDURANCE | 60 | | +| PRESET_ICON_ACTIVITY_ENDURANCE | 61 | | +| PRESET_ICON_CINEMATIC_ENDURANCE | 62 | | +| PRESET_ICON_SLOMO_ENDURANCE | 63 | | +| PRESET_ICON_STATIONARY_1 | 64 | | +| PRESET_ICON_STATIONARY_2 | 65 | | +| PRESET_ICON_STATIONARY_3 | 66 | | +| PRESET_ICON_STATIONARY_4 | 67 | | +| PRESET_ICON_SIMPLE_SUPER_PHOTO | 70 | | +| PRESET_ICON_SIMPLE_NIGHT_PHOTO | 71 | | +| PRESET_ICON_HIGHEST_QUALITY_VIDEO | 73 | | +| PRESET_ICON_STANDARD_QUALITY_VIDEO | 74 | | +| PRESET_ICON_BASIC_QUALITY_VIDEO | 75 | | +| PRESET_ICON_STAR_TRAIL | 76 | | +| PRESET_ICON_LIGHT_PAINTING | 77 | | +| PRESET_ICON_LIGHT_TRAIL | 78 | | +| PRESET_ICON_FULL_FRAME | 79 | | +| PRESET_ICON_TIMELAPSE_PHOTO | 1000 | | +| PRESET_ICON_NIGHTLAPSE_PHOTO | 1001 | | + +## EnumPresetTitle + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| PRESET_TITLE_ACTIVITY | 0 | | +| PRESET_TITLE_STANDARD | 1 | | +| PRESET_TITLE_CINEMATIC | 2 | | +| PRESET_TITLE_PHOTO | 3 | | +| PRESET_TITLE_LIVE_BURST | 4 | | +| PRESET_TITLE_BURST | 5 | | +| PRESET_TITLE_NIGHT | 6 | | +| PRESET_TITLE_TIME_WARP | 7 | | +| PRESET_TITLE_TIME_LAPSE | 8 | | +| PRESET_TITLE_NIGHT_LAPSE | 9 | | +| PRESET_TITLE_VIDEO | 10 | | +| PRESET_TITLE_SLOMO | 11 | | +| PRESET_TITLE_PHOTO_2 | 13 | | +| PRESET_TITLE_PANORAMA | 14 | | +| PRESET_TITLE_TIME_WARP_2 | 16 | | +| PRESET_TITLE_CUSTOM | 18 | | +| PRESET_TITLE_AIR | 19 | | +| PRESET_TITLE_BIKE | 20 | | +| PRESET_TITLE_EPIC | 21 | | +| PRESET_TITLE_INDOOR | 22 | | +| PRESET_TITLE_MOTOR | 23 | | +| PRESET_TITLE_MOUNTED | 24 | | +| PRESET_TITLE_OUTDOOR | 25 | | +| PRESET_TITLE_POV | 26 | | +| PRESET_TITLE_SELFIE | 27 | | +| PRESET_TITLE_SKATE | 28 | | +| PRESET_TITLE_SNOW | 29 | | +| PRESET_TITLE_TRAIL | 30 | | +| PRESET_TITLE_TRAVEL | 31 | | +| PRESET_TITLE_WATER | 32 | | +| PRESET_TITLE_LOOPING | 33 | | +| PRESET_TITLE_BASIC | 58 | | +| PRESET_TITLE_ULTRA_SLO_MO | 59 | | +| PRESET_TITLE_STANDARD_ENDURANCE | 60 | | +| PRESET_TITLE_ACTIVITY_ENDURANCE | 61 | | +| PRESET_TITLE_CINEMATIC_ENDURANCE | 62 | | +| PRESET_TITLE_SLOMO_ENDURANCE | 63 | | +| PRESET_TITLE_STATIONARY_1 | 64 | | +| PRESET_TITLE_STATIONARY_2 | 65 | | +| PRESET_TITLE_STATIONARY_3 | 66 | | +| PRESET_TITLE_STATIONARY_4 | 67 | | +| PRESET_TITLE_SIMPLE_VIDEO | 68 | | +| PRESET_TITLE_SIMPLE_TIME_WARP | 69 | | +| PRESET_TITLE_SIMPLE_SUPER_PHOTO | 70 | | +| PRESET_TITLE_SIMPLE_NIGHT_PHOTO | 71 | | +| PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE | 72 | | +| PRESET_TITLE_HIGHEST_QUALITY | 73 | | +| PRESET_TITLE_EXTENDED_BATTERY | 74 | | +| PRESET_TITLE_LONGEST_BATTERY | 75 | | +| PRESET_TITLE_STAR_TRAIL | 76 | | +| PRESET_TITLE_LIGHT_PAINTING | 77 | | +| PRESET_TITLE_LIGHT_TRAIL | 78 | | +| PRESET_TITLE_FULL_FRAME | 79 | | +| PRESET_TITLE_STANDARD_QUALITY_VIDEO | 82 | | +| PRESET_TITLE_BASIC_QUALITY_VIDEO | 83 | | +| PRESET_TITLE_HIGHEST_QUALITY_VIDEO | 93 | | +| PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | 94 | | + +## EnumProvisioning + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| PROVISIONING_UNKNOWN | 0 | | +| PROVISIONING_NEVER_STARTED | 1 | | +| PROVISIONING_STARTED | 2 | | +| PROVISIONING_ABORTED_BY_SYSTEM | 3 | | +| PROVISIONING_CANCELLED_BY_USER | 4 | | +| PROVISIONING_SUCCESS_NEW_AP | 5 | | +| PROVISIONING_SUCCESS_OLD_AP | 6 | | +| PROVISIONING_ERROR_FAILED_TO_ASSOCIATE | 7 | | +| PROVISIONING_ERROR_PASSWORD_AUTH | 8 | | +| PROVISIONING_ERROR_EULA_BLOCKING | 9 | | +| PROVISIONING_ERROR_NO_INTERNET | 10 | | +| PROVISIONING_ERROR_UNSUPPORTED_TYPE | 11 | | + +## EnumRegisterLiveStreamStatus + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| REGISTER_LIVE_STREAM_STATUS_STATUS | 1 | | +| REGISTER_LIVE_STREAM_STATUS_ERROR | 2 | | +| REGISTER_LIVE_STREAM_STATUS_MODE | 3 | | +| REGISTER_LIVE_STREAM_STATUS_BITRATE | 4 | | + +## EnumRegisterPresetStatus + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| REGISTER_PRESET_STATUS_PRESET | 1 | Send notification when properties of a preset change | +| REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY | 2 | Send notification when properties of a preset group change | + +## EnumResultGeneric + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| RESULT_UNKNOWN | 0 | | +| RESULT_SUCCESS | 1 | | +| RESULT_ILL_FORMED | 2 | | +| RESULT_NOT_SUPPORTED | 3 | | +| RESULT_ARGUMENT_OUT_OF_BOUNDS | 4 | | +| RESULT_ARGUMENT_INVALID | 5 | | +| RESULT_RESOURCE_NOT_AVAILABLE | 6 | | + +## EnumScanEntryFlags + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| SCAN_FLAG_OPEN | 0x00 | This network does not require authentication | +| SCAN_FLAG_AUTHENTICATED | 0x01 | This network requires authentication | +| SCAN_FLAG_CONFIGURED | 0x02 | This network has been previously provisioned | +| SCAN_FLAG_BEST_SSID | 0x04 | | +| SCAN_FLAG_ASSOCIATED | 0x08 | camera is connected to this AP | +| SCAN_FLAG_UNSUPPORTED_TYPE | 0x10 | | + +## EnumScanning + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| SCANNING_UNKNOWN | 0 | | +| SCANNING_NEVER_STARTED | 1 | | +| SCANNING_STARTED | 2 | | +| SCANNING_ABORTED_BY_SYSTEM | 3 | | +| SCANNING_CANCELLED_BY_USER | 4 | | +| SCANNING_SUCCESS | 5 | | + +## EnumWindowSize + + + + +| Name | Value | Summary | +| ---- | ----- | ------- | +| WINDOW_SIZE_480 | 4 | | +| WINDOW_SIZE_720 | 7 | | +| WINDOW_SIZE_1080 | 12 | | + +## Media + +A reusable model to represent a media file + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| folder | optional | string | 1 | Directory that the media is contained in | +| file | optional | string | 2 | Filename of media | + +## NotifProvisioningState + +Provision state notification + + TODO refernce where this is triggered + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}#enumprovisioning) | 1 | Provisioning / connection state | + +## NotifStartScanning + +Scanning state notification + + Triggered via [RequestStartScan]( {% link protos/open_gopro.md %}#requeststartscan ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| scanning_state | required | [EnumScanning]({% link protos/open_gopro.md %}#enumscanning) | 1 | Scanning state | +| scan_id | optional | int32 | 2 | ID associated with scan results (included if scan was successful) | +| total_entries | optional | int32 | 3 | Number of APs found during scan (included if scan was successful) | +| total_configured_ssid | required | int32 | 4 | Total count of camera's provisioned SSIDs | + +## NotifyCOHNStatus + +Current COHN status triggered by a RequestGetCOHNStatus + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| status | optional | [EnumCOHNStatus]({% link protos/open_gopro.md %}#enumcohnstatus) | 1 | Current COHN status | +| state | optional | [EnumCOHNNetworkState]({% link protos/open_gopro.md %}#enumcohnnetworkstate) | 2 | Current COHN network state | +| username | optional | string | 3 | Username used for http basic auth header | +| password | optional | string | 4 | Password used for http basic auth header | +| ipaddress | optional | string | 5 | Camera's IP address on the local network | +| enabled | optional | bool | 6 | Is COHN currently enabled | +| ssid | optional | string | 7 | Currently connected SSID | +| macaddress | optional | string | 8 | MAC address of the wifi adapter | + +## NotifyLiveStreamStatus + +Live Stream status + + Sent either: + - as a syncrhonous response to initial [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}#requestgetlivestreamstatus ) + - as asynchronous notifications registered for via [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}#requestgetlivestreamstatus ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| live_stream_status | optional | [EnumLiveStreamStatus]({% link protos/open_gopro.md %}#enumlivestreamstatus) | 1 | Live stream status | +| live_stream_error | optional | [EnumLiveStreamError]({% link protos/open_gopro.md %}#enumlivestreamerror) | 2 | Live stream error | +| live_stream_encode | optional | bool | 3 | Is live stream encoding? | +| live_stream_bitrate | optional | int32 | 4 | Live stream bitrate (Kbps) | +| live_stream_window_size_supported_array | repeated | [EnumWindowSize]({% link protos/open_gopro.md %}#enumwindowsize) | 5 | Set of currently supported resolutions | +| live_stream_encode_supported | optional | bool | 6 | Does the camera support encoding while live streaming? | +| live_stream_max_lens_unsupported | optional | bool | 7 | Is the Max Lens feature NOT supported? | +| live_stream_minimum_stream_bitrate | optional | int32 | 8 | Camera-defined minimum bitrate (static) (Kbps) | +| live_stream_maximum_stream_bitrate | optional | int32 | 9 | Camera-defined maximum bitrate (static) (Kbps) | +| live_stream_lens_supported | optional | bool | 10 | Does camera support setting lens for live streaming? | +| live_stream_lens_supported_array | repeated | [EnumLens]({% link protos/open_gopro.md %}#enumlens) | 11 | Set of currently supported FOV options | + +## NotifyPresetStatus + +Current Preset status + + Sent either: + - synchronously via initial response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}#requestgetpresetstatus ) + - asynchronously when Preset change if registered in @rev RequestGetPresetStatus + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| preset_group_array | repeated | [PresetGroup]({% link protos/open_gopro.md %}#presetgroup) | 1 | Array of currently available Preset Groups | + +## Preset + +An individual preset. + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| id | optional | int32 | 1 | Preset ID | +| mode | optional | [EnumFlatMode]({% link protos/open_gopro.md %}#enumflatmode) | 2 | Preset flatmode ID | +| title_id | optional | [EnumPresetTitle]({% link protos/open_gopro.md %}#enumpresettitle) | 3 | Preset Title ID | +| title_number | optional | int32 | 4 | Preset Title Number (e.g. 1/2/3 in Custom1, Custom2, Custom3) | +| user_defined | optional | bool | 5 | Is the Preset custom/user-defined? | +| icon | optional | [EnumPresetIcon]({% link protos/open_gopro.md %}#enumpreseticon) | 6 | Preset Icon ID | +| setting_array | repeated | [PresetSetting]({% link protos/open_gopro.md %}#presetsetting) | 7 | Array of settings associated with this Preset | +| is_modified | optional | bool | 8 | Has Preset been modified from factory defaults? (False for user-defined Presets) | +| is_fixed | optional | bool | 9 | Is this Preset mutable? | +| custom_name | optional | string | 10 | Custom string name given to this preset via [RequestCustomPresetUpdate]( {% link protos/open_gopro.md %}#requestcustompresetupdate ) | + +## PresetGroup + +Preset Group meta information and contained Presets + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| id | optional | [EnumPresetGroup]({% link protos/open_gopro.md %}#enumpresetgroup) | 1 | Preset Group ID | +| preset_array | repeated | [Preset]({% link protos/open_gopro.md %}#preset) | 2 | Array of Presets contained in this Preset Group | +| can_add_preset | optional | bool | 3 | Is there room in the group to add additional Presets? | +| icon | optional | [EnumPresetGroupIcon]({% link protos/open_gopro.md %}#enumpresetgroupicon) | 4 | The icon to display for this preset group | + +## PresetSetting + +Setting representation that comprises a [Preset]( {% link protos/open_gopro.md %}#preset ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| id | optional | int32 | 1 | Setting ID | +| value | optional | int32 | 2 | Setting value | +| is_caption | optional | bool | 3 | Does this setting appear on the Preset "pill" in the camera UI? | + +## RequestCOHNCert + +Get the COHN certificate. + + Returns a [ResponseCOHNCert]( {% link protos/open_gopro.md %}#responsecohncert ) + + +## RequestClearCOHNCert + +Clear the COHN certificate. + + Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) with the status of the clear + + +## RequestConnect + +Connect to (but do not authenticate with) an Access Point + + This is intended to be used to connect to a previously-connected Access Point + + Response: [ResponseConnect]( {% link protos/open_gopro.md %}#responseconnect ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| ssid | required | string | 1 | AP SSID | + +## RequestConnectNew + +Connect to and authenticate with an Access Point + + This is only intended to be used if the AP is not previously provisioned. + + Response: [ResponseConnectNew]( {% link protos/open_gopro.md %}#responseconnectnew ) sent immediately + + Notification: [NotifProvisioningState]( {% link protos/open_gopro.md %}#notifprovisioningstate ) sent periodically as provisioning state changes + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| ssid | required | string | 1 | AP SSID | +| password | required | string | 2 | AP password | +| static_ip | optional | bytes | 3 | Static IP address | +| gateway | optional | bytes | 4 | Gateway IP address | +| subnet | optional | bytes | 5 | Subnet mask | +| dns_primary | optional | bytes | 6 | Primary DNS | +| dns_secondary | optional | bytes | 7 | Secondary DNS | + +## RequestCreateCOHNCert + +Create the COHN certificate. + + Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) with the status of the creation + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| override | optional | bool | 1 | Override current provisioning and create new cert | + +## RequestCustomPresetUpdate + +Request to update the active custom preset + + This only operates on the currently active Preset and will fail if the current + Preset is not custom. + + The use cases are: + + 1. Update the Custom Preset Icon + - `icon_id` is always optional and can always be passed + + and / or + + 2. Update the Custom Preset Title to a... + - **Factory Preset Title**: Set `title_id` to a non-94 value + - **Custom Preset Name**: Set `title_id` to 94 and specify a `custom_name` + + Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) with the status of the preset update request. + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| title_id | optional | [EnumPresetTitle]({% link protos/open_gopro.md %}#enumpresettitle) | 1 | Preset Title ID The range of acceptable custom title ID's can be found in the initial [NotifyPresetStatus]( {% link protos/open_gopro.md %}#notifypresetstatus ) response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}#requestgetpresetstatus ) | +| custom_name | optional | string | 2 | utf-8 encoded target custom preset name | +| icon_id | optional | [EnumPresetIcon]({% link protos/open_gopro.md %}#enumpreseticon) | 3 | Preset Icon ID The range of acceptable custom icon ID's can be found in the initial [NotifyPresetStatus]( {% link protos/open_gopro.md %}#notifypresetstatus ) response to [RequestGetPresetStatus]( {% link protos/open_gopro.md %}#requestgetpresetstatus ) | + +## RequestGetApEntries + +Get a list of Access Points found during a [RequestStartScan]( {% link protos/open_gopro.md %}#requeststartscan ) + + Response: [ResponseGetApEntries]( {% link protos/open_gopro.md %}#responsegetapentries ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| start_index | required | int32 | 1 | Used for paging. 0 <= start_index < [ResponseGetApEntries]( {% link protos/open_gopro.md %}#responsegetapentries ) .total_entries | +| max_entries | required | int32 | 2 | Used for paging. Value must be < [ResponseGetApEntries]( {% link protos/open_gopro.md %}#responsegetapentries ) .total_entries | +| scan_id | required | int32 | 3 | ID corresponding to a set of scan results (i.e. [ResponseGetApEntries]( {% link protos/open_gopro.md %}#responsegetapentries ) .scan_id) | + +## RequestGetCOHNStatus + +Get the current COHN status. + + This always returns a [NotifyCOHNStatus]( {% link protos/open_gopro.md %}#notifycohnstatus ) + + Additionally, asynchronous updates can also be registerd to return more [NotifyCOHNStatus]( {% link protos/open_gopro.md %}#notifycohnstatus ) when a value + changes. + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| register_cohn_status | optional | bool | 1 | 1 to register, 0 to unregister | + +## RequestGetLastCapturedMedia + +Get the last captured media filename + + Returns a [ResponseLastCapturedMedia]( {% link protos/open_gopro.md %}#responselastcapturedmedia ) + + +## RequestGetLiveStreamStatus + +Get the current livestream status (and optionally register for future status changes) + + Both current status and future status changes are sent via [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}#notifylivestreamstatus ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| register_live_stream_status | repeated | [EnumRegisterLiveStreamStatus]({% link protos/open_gopro.md %}#enumregisterlivestreamstatus) | 1 | Array of live stream statuses to be notified about | +| unregister_live_stream_status | repeated | [EnumRegisterLiveStreamStatus]({% link protos/open_gopro.md %}#enumregisterlivestreamstatus) | 2 | Array of live stream statuses to stop being notified about | + +## RequestGetPresetStatus + +Get preset status (and optionally register to be notified when it changes) + + Response: [NotifyPresetStatus]( {% link protos/open_gopro.md %}#notifypresetstatus ) sent immediately + + Notification: [NotifyPresetStatus]( {% link protos/open_gopro.md %}#notifypresetstatus ) sent periodically as preset status changes, if registered. + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| register_preset_status | repeated | [EnumRegisterPresetStatus]({% link protos/open_gopro.md %}#enumregisterpresetstatus) | 1 | Array of Preset statuses to be notified about | +| unregister_preset_status | repeated | [EnumRegisterPresetStatus]({% link protos/open_gopro.md %}#enumregisterpresetstatus) | 2 | Array of Preset statuses to stop being notified about | + +## RequestReleaseNetwork + +Request to disconnect from current AP network + + Response: [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) + + +## RequestSetCOHNSetting + +Enable and disable COHN if provisioned + + Returns a [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| cohn_active | optional | bool | 1 | 1 to enable, 0 to disable | + +## RequestSetCameraControlStatus + +Set Camera Control Status (as part of Global Behaviors feature) + + Response: [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| camera_control_status | required | [EnumCameraControlStatus]({% link protos/open_gopro.md %}#enumcameracontrolstatus) | 1 | Declare who is taking control of the camera | + +## RequestSetLiveStreamMode + +Configure lives streaming + + The current livestream status can be queried via [RequestGetLiveStreamStatus]( {% link protos/open_gopro.md %}#requestgetlivestreamstatus ) + + Response: [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| url | optional | string | 1 | RTMP(S) URL used for live stream | +| encode | optional | bool | 2 | Save media to sdcard while streaming? | +| window_size | optional | [EnumWindowSize]({% link protos/open_gopro.md %}#enumwindowsize) | 3 | Resolution to use for live stream The set of supported lenses is only available from the `live_stream_window_size_supported_array` in [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}#notifylivestreamstatus )) | +| cert | optional | bytes | 6 | Certificate for servers that require it | +| minimum_bitrate | optional | int32 | 7 | Minimum desired bitrate (may or may not be honored) | +| maximum_bitrate | optional | int32 | 8 | Maximum desired bitrate (may or may not be honored) | +| starting_bitrate | optional | int32 | 9 | Starting bitrate | +| lens | optional | [EnumLens]({% link protos/open_gopro.md %}#enumlens) | 10 | Lens to use for live stream The set of supported lenses is only available from the `live_stream_lens_supported_array` in [NotifyLiveStreamStatus]( {% link protos/open_gopro.md %}#notifylivestreamstatus )) | + +## RequestSetTurboActive + +Enable/disable display of "Transferring Media" UI + + Response: [ResponseGeneric]( {% link protos/open_gopro.md %}#responsegeneric ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| active | required | bool | 1 | Enable or disable Turbo Transfer feature | + +## RequestStartScan + +Start scanning for Access Points + + > Serialization of this object is zero bytes. + + Response: [ResponseStartScanning]( {% link protos/open_gopro.md %}#responsestartscanning ) are sent immediately after the camera receives this command + + Notifications: [NotifStartScanning]( {% link protos/open_gopro.md %}#notifstartscanning ) are sent periodically as scanning state changes. Use to detect scan complete. + + +## ResponseCOHNCert + +COHN Certificate response triggered by RequestCOHNCert + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | optional | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Was request successful? | +| cert | optional | string | 2 | Root CA cert (ASCII text) | + +## ResponseConnect + +The status of an attempt to connect to an Access Point + + Sent as the initial response to [RequestConnect]( {% link protos/open_gopro.md %}#requestconnect ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Generic pass/fail/error info | +| provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}#enumprovisioning) | 2 | Provisioning/connection state | +| timeout_seconds | required | int32 | 3 | Network connection timeout (seconds) | + +## ResponseConnectNew + +The status of an attempt to connect to an Access Point + + Sent as the initial response to [RequestConnectNew]( {% link protos/open_gopro.md %}#requestconnectnew ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Status of Connect New request | +| provisioning_state | required | [EnumProvisioning]({% link protos/open_gopro.md %}#enumprovisioning) | 2 | Current provisioning state of the network | +| timeout_seconds | required | int32 | 3 | number of seconds camera will wait before declaring a network connection attempt failed. | + +## ResponseGeneric + +Generic Response used across most response / notification messages + + [EnumResultGeneric]( {% link protos/open_gopro.md %}#enumresultgeneric ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Generic pass/fail/error info | + +## ResponseGetApEntries + +A list of scan entries describing a scanned Access Point + + This is sent in response to a [RequestGetApEntries]( {% link protos/open_gopro.md %}#requestgetapentries ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Generic pass/fail/error info | +| scan_id | required | int32 | 2 | ID associated with this batch of results | +| entries | repeated | [ScanEntry]({% link protos/open_gopro.md %}#scanentry) | 3 | Array containing details about discovered APs | + +## ResponseLastCapturedMedia + +Message sent in response to a [RequestGetLastCapturedMedia]( {% link protos/open_gopro.md %}#requestgetlastcapturedmedia ) + + This contains the complete path of the last captured media. Depending on the type of media captured, it will return: + + - Single photo / video: The single media path + - Any grouped media: The path to the first captured media in the group + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | optional | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Was the request successful? | +| media | optional | [Media]({% link protos/open_gopro.md %}#media) | 2 | Last captured media if result is RESULT_SUCCESS. Invalid if result is RESULT_RESOURCE_NOT_AVAILBLE. | + +## ResponseStartScanning + +The current scanning state. + + This is the initial response to a [RequestStartScan]( {% link protos/open_gopro.md %}#requeststartscan ) + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| result | required | [EnumResultGeneric]({% link protos/open_gopro.md %}#enumresultgeneric) | 1 | Generic pass/fail/error info | +| scanning_state | required | [EnumScanning]({% link protos/open_gopro.md %}#enumscanning) | 2 | Scanning state | + +## ScanEntry + +The individual Scan Entry model + + + +| Field | Typespec | Value Type | Value | Summary | +| ----- | -------- | ---------- | ----- | ------- | +| ssid | required | string | 1 | AP SSID | +| signal_strength_bars | required | int32 | 2 | Signal strength (3 bars: >-70 dBm; 2 bars: >-85 dBm; 1 bar: <=-85 dBm) | +| signal_frequency_mhz | required | int32 | 4 | Signal frequency (MHz) | +| scan_entry_flags | required | int32 | 5 | Bitmasked value from [EnumScanEntryFlags]( {% link protos/open_gopro.md %}#enumscanentryflags ) | diff --git a/redirects.json b/redirects.json index a539c75e..81d98ef4 100644 --- a/redirects.json +++ b/redirects.json @@ -1 +1 @@ -{"/ble":"https://gopro.github.io/OpenGoPro/ble_2_0","/swift":"https://gopro.github.io/OpenGoPro/demos","/python":"https://gopro.github.io/OpenGoPro/demos","/csharp":"https://gopro.github.io/OpenGoPro/demos","/c_c++":"https://gopro.github.io/OpenGoPro/demos","/ionic":"https://gopro.github.io/OpenGoPro/demos","/bash":"https://gopro.github.io/OpenGoPro/demos","/http":"https://gopro.github.io/OpenGoPro/http_2_0"} \ No newline at end of file +{"/ble":"https://gopro.github.io/OpenGoPro/ble_2_0","/protos":"https://gopro.github.io/OpenGoPro/protos/open_gopro.html"} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 88b4dcd4..f1392d8c 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,64 +1,32 @@ -https://gopro.github.io/OpenGoPro/demos/bash/ota_update -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/c_c++/GoProC_C++Demo -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/c_c++/GoProStreamDemo -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/csharp/GoProCSharpSample -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/csharp/webcam -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/python/multi_webcam -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/python/sdk_wireless_camera_control -2023-12-11T15:38:12-08:00 - - -https://gopro.github.io/OpenGoPro/demos/swift/EnableWiFiDemo -2023-12-11T15:38:12-08:00 - - https://gopro.github.io/OpenGoPro/tutorials/connect-ble -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/send-ble-commands -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/parse-ble-responses -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/ble-queries -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/connect-wifi -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/send-wifi-commands -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/tutorials/camera-media-list -2023-12-11T15:38:12-08:00 +2023-12-21T16:22:03-08:00 https://gopro.github.io/OpenGoPro/ble_2_0 @@ -67,21 +35,29 @@ https://gopro.github.io/OpenGoPro/contribution.html -https://gopro.github.io/OpenGoPro/demos +https://gopro.github.io/OpenGoPro/faq -https://gopro.github.io/OpenGoPro/faq +https://gopro.github.io/OpenGoPro/http-legacy -https://gopro.github.io/OpenGoPro/http_2_0 +https://gopro.github.io/OpenGoPro/swagger https://gopro.github.io/OpenGoPro/ -https://gopro.github.io/OpenGoPro/protos +https://gopro.github.io/OpenGoPro/tutorials/ -https://gopro.github.io/OpenGoPro/tutorials/ +https://gopro.github.io/OpenGoPro/protos/open_gopro.html + + +https://gopro.github.io/OpenGoPro/http.html +2023-12-21T16:21:37-08:00 + + +https://gopro.github.io/OpenGoPro/http_2_0.html +2023-12-21T16:21:37-08:00 diff --git a/specs/.enums.yml b/specs/.enums.yml new file mode 100644 index 00000000..00dcb5ea --- /dev/null +++ b/specs/.enums.yml @@ -0,0 +1,391 @@ +# .enums.yml/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). +# This copyright was auto-generated on Thu Dec 21 23:28:45 UTC 2023 + + +######################################################################################################################## +# This file is automatically generated. Do not modify manually. + +# Last generated at 2023-12-22 00:09:35.243055 +######################################################################################################################## + +EnumCOHNNetworkState: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | COHN_STATE_Init | | + | 1 | COHN_STATE_Error | | + | 2 | COHN_STATE_Exit | | + | 5 | COHN_STATE_Idle | | + | 27 | COHN_STATE_NetworkConnected | | + | 28 | COHN_STATE_NetworkDisconnected | | + | 29 | COHN_STATE_ConnectingToNetwork | | + | 30 | COHN_STATE_Invalid | | + enum: [0, 1, 2, 5, 27, 28, 29, 30] + +EnumCOHNStatus: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | COHN_UNPROVISIONED | | + | 1 | COHN_PROVISIONED | | + enum: [0, 1] + +EnumCameraControlStatus: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | CAMERA_IDLE | | + | 1 | CAMERA_CONTROL | Can only be set by camera, not by app or third party | + | 2 | CAMERA_EXTERNAL_CONTROL | | + enum: [0, 1, 2] + +EnumFlatMode: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | -1 | FLAT_MODE_UNKNOWN | | + | 4 | FLAT_MODE_PLAYBACK | | + | 5 | FLAT_MODE_SETUP | | + | 12 | FLAT_MODE_VIDEO | | + | 13 | FLAT_MODE_TIME_LAPSE_VIDEO | | + | 15 | FLAT_MODE_LOOPING | | + | 16 | FLAT_MODE_PHOTO_SINGLE | | + | 17 | FLAT_MODE_PHOTO | | + | 18 | FLAT_MODE_PHOTO_NIGHT | | + | 19 | FLAT_MODE_PHOTO_BURST | | + | 20 | FLAT_MODE_TIME_LAPSE_PHOTO | | + | 21 | FLAT_MODE_NIGHT_LAPSE_PHOTO | | + | 22 | FLAT_MODE_BROADCAST_RECORD | | + | 23 | FLAT_MODE_BROADCAST_BROADCAST | | + | 24 | FLAT_MODE_TIME_WARP_VIDEO | | + | 25 | FLAT_MODE_LIVE_BURST | | + | 26 | FLAT_MODE_NIGHT_LAPSE_VIDEO | | + | 27 | FLAT_MODE_SLOMO | | + | 28 | FLAT_MODE_IDLE | | + | 29 | FLAT_MODE_VIDEO_STAR_TRAIL | | + | 30 | FLAT_MODE_VIDEO_LIGHT_PAINTING | | + | 31 | FLAT_MODE_VIDEO_LIGHT_TRAIL | | + enum: [-1, 4, 5, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31] + +EnumLens: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | LENS_WIDE | | + | 4 | LENS_LINEAR | | + | 3 | LENS_SUPERVIEW | | + enum: [0, 4, 3] + +EnumLiveStreamError: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | LIVE_STREAM_ERROR_NONE | No error (success) | + | 1 | LIVE_STREAM_ERROR_NETWORK | General network error during the stream | + | 2 | LIVE_STREAM_ERROR_CREATESTREAM | Startup error: bad URL or valid with live stream server | + | 3 | LIVE_STREAM_ERROR_OUTOFMEMORY | Not enough memory on camera to complete task | + | 4 | LIVE_STREAM_ERROR_INPUTSTREAM | Failed to get stream from low level camera system | + | 5 | LIVE_STREAM_ERROR_INTERNET | No internet access detected on startup of streamer | + | 6 | LIVE_STREAM_ERROR_OSNETWORK | Error occured in linux networking stack. usually means the server closed the connection | + | 7 | LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT | Timed out attemping to connect to the wifi network when attemping live stream | + | 8 | LIVE_STREAM_ERROR_SSL_HANDSHAKE | SSL handshake failed (commonly caused due to incorrect time / time zone) | + | 9 | LIVE_STREAM_ERROR_CAMERA_BLOCKED | Low level camera system rejected attempt to start live stream | + | 10 | LIVE_STREAM_ERROR_UNKNOWN | Unknown | + | 40 | LIVE_STREAM_ERROR_SD_CARD_FULL | Can not perform livestream because sd card is full | + | 41 | LIVE_STREAM_ERROR_SD_CARD_REMOVED | Livestream stopped because sd card was removed | + enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 40, 41] + +EnumLiveStreamStatus: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | LIVE_STREAM_STATE_IDLE | Initial status. Livestream has not yet been configured | + | 1 | LIVE_STREAM_STATE_CONFIG | Livestream is being configured | + | 2 | LIVE_STREAM_STATE_READY | Livestream has finished configuration and is ready to start streaming | + | 3 | LIVE_STREAM_STATE_STREAMING | Livestream is actively streaming | + | 4 | LIVE_STREAM_STATE_COMPLETE_STAY_ON | Live stream is exiting. No errors occured. | + | 5 | LIVE_STREAM_STATE_FAILED_STAY_ON | Live stream is exiting. An error occurred. | + | 6 | LIVE_STREAM_STATE_RECONNECTING | An error occurred during livestream and stream is attempting to reconnect. | + enum: [0, 1, 2, 3, 4, 5, 6] + +EnumPresetGroup: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 1000 | PRESET_GROUP_ID_VIDEO | | + | 1001 | PRESET_GROUP_ID_PHOTO | | + | 1002 | PRESET_GROUP_ID_TIMELAPSE | | + enum: [1000, 1001, 1002] + +EnumPresetGroupIcon: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | PRESET_GROUP_VIDEO_ICON_ID | | + | 1 | PRESET_GROUP_PHOTO_ICON_ID | | + | 2 | PRESET_GROUP_TIMELAPSE_ICON_ID | | + | 3 | PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID | | + | 4 | PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID | | + | 5 | PRESET_GROUP_MAX_VIDEO_ICON_ID | | + | 6 | PRESET_GROUP_MAX_PHOTO_ICON_ID | | + | 7 | PRESET_GROUP_MAX_TIMELAPSE_ICON_ID | | + enum: [0, 1, 2, 3, 4, 5, 6, 7] + +EnumPresetIcon: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | PRESET_ICON_VIDEO | | + | 1 | PRESET_ICON_ACTIVITY | | + | 2 | PRESET_ICON_CINEMATIC | | + | 3 | PRESET_ICON_PHOTO | | + | 4 | PRESET_ICON_LIVE_BURST | | + | 5 | PRESET_ICON_BURST | | + | 6 | PRESET_ICON_PHOTO_NIGHT | | + | 7 | PRESET_ICON_TIMEWARP | | + | 8 | PRESET_ICON_TIMELAPSE | | + | 9 | PRESET_ICON_NIGHTLAPSE | | + | 10 | PRESET_ICON_SNAIL | | + | 11 | PRESET_ICON_VIDEO_2 | | + | 13 | PRESET_ICON_PHOTO_2 | | + | 14 | PRESET_ICON_PANORAMA | | + | 15 | PRESET_ICON_BURST_2 | | + | 16 | PRESET_ICON_TIMEWARP_2 | | + | 17 | PRESET_ICON_TIMELAPSE_2 | | + | 18 | PRESET_ICON_CUSTOM | | + | 19 | PRESET_ICON_AIR | | + | 20 | PRESET_ICON_BIKE | | + | 21 | PRESET_ICON_EPIC | | + | 22 | PRESET_ICON_INDOOR | | + | 23 | PRESET_ICON_MOTOR | | + | 24 | PRESET_ICON_MOUNTED | | + | 25 | PRESET_ICON_OUTDOOR | | + | 26 | PRESET_ICON_POV | | + | 27 | PRESET_ICON_SELFIE | | + | 28 | PRESET_ICON_SKATE | | + | 29 | PRESET_ICON_SNOW | | + | 30 | PRESET_ICON_TRAIL | | + | 31 | PRESET_ICON_TRAVEL | | + | 32 | PRESET_ICON_WATER | | + | 33 | PRESET_ICON_LOOPING | | + | 58 | PRESET_ICON_BASIC | | + | 59 | PRESET_ICON_ULTRA_SLO_MO | | + | 60 | PRESET_ICON_STANDARD_ENDURANCE | | + | 61 | PRESET_ICON_ACTIVITY_ENDURANCE | | + | 62 | PRESET_ICON_CINEMATIC_ENDURANCE | | + | 63 | PRESET_ICON_SLOMO_ENDURANCE | | + | 64 | PRESET_ICON_STATIONARY_1 | | + | 65 | PRESET_ICON_STATIONARY_2 | | + | 66 | PRESET_ICON_STATIONARY_3 | | + | 67 | PRESET_ICON_STATIONARY_4 | | + | 70 | PRESET_ICON_SIMPLE_SUPER_PHOTO | | + | 71 | PRESET_ICON_SIMPLE_NIGHT_PHOTO | | + | 73 | PRESET_ICON_HIGHEST_QUALITY_VIDEO | | + | 74 | PRESET_ICON_STANDARD_QUALITY_VIDEO | | + | 75 | PRESET_ICON_BASIC_QUALITY_VIDEO | | + | 76 | PRESET_ICON_STAR_TRAIL | | + | 77 | PRESET_ICON_LIGHT_PAINTING | | + | 78 | PRESET_ICON_LIGHT_TRAIL | | + | 79 | PRESET_ICON_FULL_FRAME | | + | 1000 | PRESET_ICON_TIMELAPSE_PHOTO | | + | 1001 | PRESET_ICON_NIGHTLAPSE_PHOTO | | + enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 70, 71, 73, 74, 75, 76, 77, 78, 79, 1000, 1001] + +EnumPresetTitle: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | PRESET_TITLE_ACTIVITY | | + | 1 | PRESET_TITLE_STANDARD | | + | 2 | PRESET_TITLE_CINEMATIC | | + | 3 | PRESET_TITLE_PHOTO | | + | 4 | PRESET_TITLE_LIVE_BURST | | + | 5 | PRESET_TITLE_BURST | | + | 6 | PRESET_TITLE_NIGHT | | + | 7 | PRESET_TITLE_TIME_WARP | | + | 8 | PRESET_TITLE_TIME_LAPSE | | + | 9 | PRESET_TITLE_NIGHT_LAPSE | | + | 10 | PRESET_TITLE_VIDEO | | + | 11 | PRESET_TITLE_SLOMO | | + | 13 | PRESET_TITLE_PHOTO_2 | | + | 14 | PRESET_TITLE_PANORAMA | | + | 16 | PRESET_TITLE_TIME_WARP_2 | | + | 18 | PRESET_TITLE_CUSTOM | | + | 19 | PRESET_TITLE_AIR | | + | 20 | PRESET_TITLE_BIKE | | + | 21 | PRESET_TITLE_EPIC | | + | 22 | PRESET_TITLE_INDOOR | | + | 23 | PRESET_TITLE_MOTOR | | + | 24 | PRESET_TITLE_MOUNTED | | + | 25 | PRESET_TITLE_OUTDOOR | | + | 26 | PRESET_TITLE_POV | | + | 27 | PRESET_TITLE_SELFIE | | + | 28 | PRESET_TITLE_SKATE | | + | 29 | PRESET_TITLE_SNOW | | + | 30 | PRESET_TITLE_TRAIL | | + | 31 | PRESET_TITLE_TRAVEL | | + | 32 | PRESET_TITLE_WATER | | + | 33 | PRESET_TITLE_LOOPING | | + | 58 | PRESET_TITLE_BASIC | | + | 59 | PRESET_TITLE_ULTRA_SLO_MO | | + | 60 | PRESET_TITLE_STANDARD_ENDURANCE | | + | 61 | PRESET_TITLE_ACTIVITY_ENDURANCE | | + | 62 | PRESET_TITLE_CINEMATIC_ENDURANCE | | + | 63 | PRESET_TITLE_SLOMO_ENDURANCE | | + | 64 | PRESET_TITLE_STATIONARY_1 | | + | 65 | PRESET_TITLE_STATIONARY_2 | | + | 66 | PRESET_TITLE_STATIONARY_3 | | + | 67 | PRESET_TITLE_STATIONARY_4 | | + | 68 | PRESET_TITLE_SIMPLE_VIDEO | | + | 69 | PRESET_TITLE_SIMPLE_TIME_WARP | | + | 70 | PRESET_TITLE_SIMPLE_SUPER_PHOTO | | + | 71 | PRESET_TITLE_SIMPLE_NIGHT_PHOTO | | + | 72 | PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE | | + | 73 | PRESET_TITLE_HIGHEST_QUALITY | | + | 74 | PRESET_TITLE_EXTENDED_BATTERY | | + | 75 | PRESET_TITLE_LONGEST_BATTERY | | + | 76 | PRESET_TITLE_STAR_TRAIL | | + | 77 | PRESET_TITLE_LIGHT_PAINTING | | + | 78 | PRESET_TITLE_LIGHT_TRAIL | | + | 79 | PRESET_TITLE_FULL_FRAME | | + | 82 | PRESET_TITLE_STANDARD_QUALITY_VIDEO | | + | 83 | PRESET_TITLE_BASIC_QUALITY_VIDEO | | + | 93 | PRESET_TITLE_HIGHEST_QUALITY_VIDEO | | + | 94 | PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | | + enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 16, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 82, 83, 93, 94] + +EnumProvisioning: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | PROVISIONING_UNKNOWN | | + | 1 | PROVISIONING_NEVER_STARTED | | + | 2 | PROVISIONING_STARTED | | + | 3 | PROVISIONING_ABORTED_BY_SYSTEM | | + | 4 | PROVISIONING_CANCELLED_BY_USER | | + | 5 | PROVISIONING_SUCCESS_NEW_AP | | + | 6 | PROVISIONING_SUCCESS_OLD_AP | | + | 7 | PROVISIONING_ERROR_FAILED_TO_ASSOCIATE | | + | 8 | PROVISIONING_ERROR_PASSWORD_AUTH | | + | 9 | PROVISIONING_ERROR_EULA_BLOCKING | | + | 10 | PROVISIONING_ERROR_NO_INTERNET | | + | 11 | PROVISIONING_ERROR_UNSUPPORTED_TYPE | | + enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11] + +EnumRegisterLiveStreamStatus: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 1 | REGISTER_LIVE_STREAM_STATUS_STATUS | | + | 2 | REGISTER_LIVE_STREAM_STATUS_ERROR | | + | 3 | REGISTER_LIVE_STREAM_STATUS_MODE | | + | 4 | REGISTER_LIVE_STREAM_STATUS_BITRATE | | + enum: [1, 2, 3, 4] + +EnumRegisterPresetStatus: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 1 | REGISTER_PRESET_STATUS_PRESET | Send notification when properties of a preset change | + | 2 | REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY | Send notification when properties of a preset group change | + enum: [1, 2] + +EnumResultGeneric: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | RESULT_UNKNOWN | | + | 1 | RESULT_SUCCESS | | + | 2 | RESULT_ILL_FORMED | | + | 3 | RESULT_NOT_SUPPORTED | | + | 4 | RESULT_ARGUMENT_OUT_OF_BOUNDS | | + | 5 | RESULT_ARGUMENT_INVALID | | + | 6 | RESULT_RESOURCE_NOT_AVAILABLE | | + enum: [0, 1, 2, 3, 4, 5, 6] + +EnumScanEntryFlags: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0x00 | SCAN_FLAG_OPEN | This network does not require authentication | + | 0x01 | SCAN_FLAG_AUTHENTICATED | This network requires authentication | + | 0x02 | SCAN_FLAG_CONFIGURED | This network has been previously provisioned | + | 0x04 | SCAN_FLAG_BEST_SSID | | + | 0x08 | SCAN_FLAG_ASSOCIATED | camera is connected to this AP | + | 0x10 | SCAN_FLAG_UNSUPPORTED_TYPE | | + enum: [0x00, 0x01, 0x02, 0x04, 0x08, 0x10] + +EnumScanning: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 0 | SCANNING_UNKNOWN | | + | 1 | SCANNING_NEVER_STARTED | | + | 2 | SCANNING_STARTED | | + | 3 | SCANNING_ABORTED_BY_SYSTEM | | + | 4 | SCANNING_CANCELLED_BY_USER | | + | 5 | SCANNING_SUCCESS | | + enum: [0, 1, 2, 3, 4, 5] + +EnumWindowSize: + type: integer + description: | + + + | ID | Name | Summary | + | -- | ---- | ------- | + | 4 | WINDOW_SIZE_480 | | + | 7 | WINDOW_SIZE_720 | | + | 12 | WINDOW_SIZE_1080 | | + enum: [4, 7, 12] diff --git a/specs/.openapi.yml b/specs/.openapi.yml new file mode 100644 index 00000000..38a8ca40 --- /dev/null +++ b/specs/.openapi.yml @@ -0,0 +1,3986 @@ +# .openapi.yml/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). +# This copyright was auto-generated on Thu Dec 21 23:28:45 UTC 2023 + + +######################################################################################################################## +# This file is automatically generated. Do not modify manually. + +# Last generated at 2023-12-22 00:09:35.307572 +######################################################################################################################## +components: + responses: + 200Empty: + content: + application/json: + schema: + type: object + description: Request was successfully received by the camera + GenericEmpty: + content: + application/json: + schema: + type: object + description: This should be overwritten when it is referenced. + State: + content: + application/json: + schema: + $ref: '#/components/schemas/State' + description: Success. Lists of settings and statuses + schemas: + GroupedMediaListItem: + description: "A grouped (i.e. burst, lapse, etc.) media item\n\nNote that each property actually comes as a string but + is specified here using its functional value.\n" + properties: + b: + description: ID of first member in the group + example: 1 + type: integer + cre: + description: Creation time in seconds since epoch + example: 1696600109 + type: integer + g: + description: Group Identifier + example: 1 + type: integer + glrv: + description: Low resolution video size + example: 817767 + type: integer + id: + description: Media list session identifier + type: string + l: + description: ID of last member in the group + example: 6 + type: integer + ls: + description: Low resolution file size. -1 if there is no LRV file + example: -1 + type: integer + m: + description: File ID's that are missing or deleted + example: + - 1 + - 2 + items: + type: integer + type: array + mod: + description: Time file was last modified in seconds since epoch + example: 1696600109 + type: integer + n: + description: Media filename + example: G0010011.MP4 + type: string + s: + description: Number of files in the group + example: 5 + type: integer + t: + description: Group Type (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse) + enum: + - b + - c + - n + - t + type: string + required: + - n + - cre + - mod + - g + - s + - b + - l + - m + - t + type: object + x-tags: + - Models + MediaList: + description: list of media file systems + properties: + id: + description: media list identifier + example: '1554375628411872255' + type: string + media: + items: + properties: + d: + description: directory that the media files reside in + example: 100GOPRO + type: string + fs: + description: list of files + items: + anyOf: + - $ref: '#/components/schemas/SingleMediaListItem' + - $ref: '#/components/schemas/GroupedMediaListItem' + type: array + required: + - d + - fs + type: object + type: array + required: + - id + - media + type: object + x-tags: + - Models + OtaStatus: + description: "OTA Status\n\n| ID | Status | Description |\n| -- | ------ | ----------- |\n| 0 | OK | No errors occurred + |\n| 1 | Unknown Request | Server did not recognize the request |\n| 2 | Bad Params | Parameter values not recognized + |\n| 3 | SHA1 Send Mismatch | SHA1 for chunk did not match SHA1 of previous chunk(s) |\n| 4 | SHA1 Calculated Mismatch + | Calculated SHA1 did not match user-specified SHA1 |\n| 5 | HTTP Boundary Error | HTTP Post was malformed |\n| 6 + | HTTP Post Error | Unexpected HTTP / Post Content Type |\n| 7 | Server Busy | HTTP server is busy |\n| 8 | Offset + Mismatch | Attempt to upload chunk with offset that did not align with previous chunk |\n| 9 | Bad Post Data | Server + failed to parse POST data |\n| 10 | File Incomplete | Tried to start update before server finished validating .zip + file |\n| 11 | Update in progress | Firmware update is in progress |\n| 12 | Insufficient Space | Insufficient space + on the sdcard to hold decompressed update file |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + type: integer + PhotoMetadata: + description: "Metadata for a photo media file\n\nNote that each property actually comes as a string but is specified + here using its functional value.\n" + properties: + cre: + description: Creation time in seconds since epoch + example: 1692992748 + type: integer + ct: + description: "Media content type\n\n| ID | Mode |\n| -- | ---- |\n| Video | 0 |\n| Looping | 1 |\n| Chaptered Video + | 2 |\n| Time Lapse | 3 |\n| Single Photo | 4 |\n| Burst Photo | 5 |\n| Time Lapse Photo | 6 |\n| Night Lapse + Photo | 8 |\n| Night Photo | 9 |\n| Continuous Photo | 10 |\n| Raw Photo | 11 |\n| Live Burst | 12 |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 8 + - 9 + - 10 + - 11 + - 12 + type: integer + eis: + description: 1 if stabilized, 0 otherwise + enum: + - 0 + - 1 + type: integer + fov: + description: Field of View + type: string + gumi: + description: Globally Unique Media ID + example: '12345678998765443211234567899875' + type: string + h: + description: Height of media in pixels + example: 1080 + type: integer + hc: + description: Number of hilights in media + maximum: 99 + minimum: 0 + type: integer + hdr: + description: 1 if photo taken with high dynamic range, 0 otherwise + enum: + - 0 + - 1 + type: integer + lc: + description: Lens configuration ==> 0 for front, 1 for rear + enum: + - 0 + - 1 + type: integer + mos: + description: List of offload states + example: + - app + - pc + items: + enum: + - app + - pc + - other + type: string + type: array + mp: + description: 1 if metadata is present, 0 otherwise + enum: + - 0 + - 1 + type: integer + prjn: + description: "Lens projection\n\n| ID | Mode |\n| -- | ---- |\n| EAC | 0 |\n| ERP | 1 |\n| EAC, split horizontally + in the middle for 2 output | 2 |\n| ERP, cropped for panorama | 3 |\n| Bypass stitch algorithm, side by side circles + | 4 |\n| Stitch is disabled, stitch algorithm is enabled for offline stitch | 5 |\n| Stitch is disabled| 6 |\n + | Bypass stitch algorithm for EAC split | 7 |\n| Hemisheric | 8 |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + raw: + description: 1 if photo has raw version, 0 otherwise + enum: + - 0 + - 1 + type: integer + rot: + description: Deprecated + type: string + s: + description: File size in bytes + example: 1234567890 + type: integer + tr: + description: 1 if file is transcoded, 0 otherwise + enum: + - 0 + - 1 + type: integer + us: + description: Has the file been uploaded? 0 if no, 1 if yes + enum: + - 0 + - 1 + type: integer + w: + description: Width of media in pixels + example: 1920 + type: integer + wdr: + description: 1 if photo taken with wide dynamic range, 0 otherwise + enum: + - 0 + - 1 + type: integer + required: + - ct + - cre + - s + - gumi + - h + - w + - hc + - eis + - mp + - rot + - tr + - us + type: object + x-tags: + - Models + Preset: + description: "A logical wrapper around a specific camera mode, title, icon, and a set of settings that enhance different\n + styles of capturing media.\n" + properties: + icon: + $ref: .enums.yml#/EnumPresetIcon + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | PRESET_ICON_VIDEO | |\n| 1 | PRESET_ICON_ACTIVITY + | |\n| 2 | PRESET_ICON_CINEMATIC | |\n| 3 | PRESET_ICON_PHOTO | |\n| 4 | PRESET_ICON_LIVE_BURST | |\n| 5 | + PRESET_ICON_BURST | |\n| 6 | PRESET_ICON_PHOTO_NIGHT | |\n| 7 | PRESET_ICON_TIMEWARP | |\n| 8 | PRESET_ICON_TIMELAPSE + | |\n| 9 | PRESET_ICON_NIGHTLAPSE | |\n| 10 | PRESET_ICON_SNAIL | |\n| 11 | PRESET_ICON_VIDEO_2 | |\n| 13 + | PRESET_ICON_PHOTO_2 | |\n| 14 | PRESET_ICON_PANORAMA | |\n| 15 | PRESET_ICON_BURST_2 | |\n| 16 | PRESET_ICON_TIMEWARP_2 + | |\n| 17 | PRESET_ICON_TIMELAPSE_2 | |\n| 18 | PRESET_ICON_CUSTOM | |\n| 19 | PRESET_ICON_AIR | |\n| 20 | + PRESET_ICON_BIKE | |\n| 21 | PRESET_ICON_EPIC | |\n| 22 | PRESET_ICON_INDOOR | |\n| 23 | PRESET_ICON_MOTOR + | |\n| 24 | PRESET_ICON_MOUNTED | |\n| 25 | PRESET_ICON_OUTDOOR | |\n| 26 | PRESET_ICON_POV | |\n| 27 | PRESET_ICON_SELFIE + | |\n| 28 | PRESET_ICON_SKATE | |\n| 29 | PRESET_ICON_SNOW | |\n| 30 | PRESET_ICON_TRAIL | |\n| 31 | PRESET_ICON_TRAVEL + | |\n| 32 | PRESET_ICON_WATER | |\n| 33 | PRESET_ICON_LOOPING | |\n| 58 | PRESET_ICON_BASIC | |\n| 59 | PRESET_ICON_ULTRA_SLO_MO + | |\n| 60 | PRESET_ICON_STANDARD_ENDURANCE | |\n| 61 | PRESET_ICON_ACTIVITY_ENDURANCE | |\n| 62 | PRESET_ICON_CINEMATIC_ENDURANCE + | |\n| 63 | PRESET_ICON_SLOMO_ENDURANCE | |\n| 64 | PRESET_ICON_STATIONARY_1 | |\n| 65 | PRESET_ICON_STATIONARY_2 + | |\n| 66 | PRESET_ICON_STATIONARY_3 | |\n| 67 | PRESET_ICON_STATIONARY_4 | |\n| 70 | PRESET_ICON_SIMPLE_SUPER_PHOTO + | |\n| 71 | PRESET_ICON_SIMPLE_NIGHT_PHOTO | |\n| 73 | PRESET_ICON_HIGHEST_QUALITY_VIDEO | |\n| 74 | PRESET_ICON_STANDARD_QUALITY_VIDEO + | |\n| 75 | PRESET_ICON_BASIC_QUALITY_VIDEO | |\n| 76 | PRESET_ICON_STAR_TRAIL | |\n| 77 | PRESET_ICON_LIGHT_PAINTING + | |\n| 78 | PRESET_ICON_LIGHT_TRAIL | |\n| 79 | PRESET_ICON_FULL_FRAME | |\n| 1000 | PRESET_ICON_TIMELAPSE_PHOTO + | |\n| 1001 | PRESET_ICON_NIGHTLAPSE_PHOTO | |" + id: + description: Unique preset identifier + format: int32 + type: integer + is_fixed: + description: Is this preset mutable? + type: boolean + is_modified: + description: Has the preset been modified from the factory defaults? + type: boolean + mode: + $ref: .enums.yml#/EnumFlatMode + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| -1 | FLAT_MODE_UNKNOWN | |\n| 4 | FLAT_MODE_PLAYBACK + | |\n| 5 | FLAT_MODE_SETUP | |\n| 12 | FLAT_MODE_VIDEO | |\n| 13 | FLAT_MODE_TIME_LAPSE_VIDEO | |\n| 15 | + FLAT_MODE_LOOPING | |\n| 16 | FLAT_MODE_PHOTO_SINGLE | |\n| 17 | FLAT_MODE_PHOTO | |\n| 18 | FLAT_MODE_PHOTO_NIGHT + | |\n| 19 | FLAT_MODE_PHOTO_BURST | |\n| 20 | FLAT_MODE_TIME_LAPSE_PHOTO | |\n| 21 | FLAT_MODE_NIGHT_LAPSE_PHOTO + | |\n| 22 | FLAT_MODE_BROADCAST_RECORD | |\n| 23 | FLAT_MODE_BROADCAST_BROADCAST | |\n| 24 | FLAT_MODE_TIME_WARP_VIDEO + | |\n| 25 | FLAT_MODE_LIVE_BURST | |\n| 26 | FLAT_MODE_NIGHT_LAPSE_VIDEO | |\n| 27 | FLAT_MODE_SLOMO | |\n + | 28 | FLAT_MODE_IDLE | |\n| 29 | FLAT_MODE_VIDEO_STAR_TRAIL | |\n| 30 | FLAT_MODE_VIDEO_LIGHT_PAINTING | |\n + | 31 | FLAT_MODE_VIDEO_LIGHT_TRAIL | |" + setting_array: + items: + $ref: '#/components/schemas/PresetSetting' + type: array + title_id: + $ref: .enums.yml#/EnumPresetTitle + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | PRESET_TITLE_ACTIVITY | |\n| 1 | PRESET_TITLE_STANDARD + | |\n| 2 | PRESET_TITLE_CINEMATIC | |\n| 3 | PRESET_TITLE_PHOTO | |\n| 4 | PRESET_TITLE_LIVE_BURST | |\n| + 5 | PRESET_TITLE_BURST | |\n| 6 | PRESET_TITLE_NIGHT | |\n| 7 | PRESET_TITLE_TIME_WARP | |\n| 8 | PRESET_TITLE_TIME_LAPSE + | |\n| 9 | PRESET_TITLE_NIGHT_LAPSE | |\n| 10 | PRESET_TITLE_VIDEO | |\n| 11 | PRESET_TITLE_SLOMO | |\n| 13 + | PRESET_TITLE_PHOTO_2 | |\n| 14 | PRESET_TITLE_PANORAMA | |\n| 16 | PRESET_TITLE_TIME_WARP_2 | |\n| 18 | PRESET_TITLE_CUSTOM + | |\n| 19 | PRESET_TITLE_AIR | |\n| 20 | PRESET_TITLE_BIKE | |\n| 21 | PRESET_TITLE_EPIC | |\n| 22 | PRESET_TITLE_INDOOR + | |\n| 23 | PRESET_TITLE_MOTOR | |\n| 24 | PRESET_TITLE_MOUNTED | |\n| 25 | PRESET_TITLE_OUTDOOR | |\n| 26 + | PRESET_TITLE_POV | |\n| 27 | PRESET_TITLE_SELFIE | |\n| 28 | PRESET_TITLE_SKATE | |\n| 29 | PRESET_TITLE_SNOW + | |\n| 30 | PRESET_TITLE_TRAIL | |\n| 31 | PRESET_TITLE_TRAVEL | |\n| 32 | PRESET_TITLE_WATER | |\n| 33 | + PRESET_TITLE_LOOPING | |\n| 58 | PRESET_TITLE_BASIC | |\n| 59 | PRESET_TITLE_ULTRA_SLO_MO | |\n| 60 | PRESET_TITLE_STANDARD_ENDURANCE + | |\n| 61 | PRESET_TITLE_ACTIVITY_ENDURANCE | |\n| 62 | PRESET_TITLE_CINEMATIC_ENDURANCE | |\n| 63 | PRESET_TITLE_SLOMO_ENDURANCE + | |\n| 64 | PRESET_TITLE_STATIONARY_1 | |\n| 65 | PRESET_TITLE_STATIONARY_2 | |\n| 66 | PRESET_TITLE_STATIONARY_3 + | |\n| 67 | PRESET_TITLE_STATIONARY_4 | |\n| 68 | PRESET_TITLE_SIMPLE_VIDEO | |\n| 69 | PRESET_TITLE_SIMPLE_TIME_WARP + | |\n| 70 | PRESET_TITLE_SIMPLE_SUPER_PHOTO | |\n| 71 | PRESET_TITLE_SIMPLE_NIGHT_PHOTO | |\n| 72 | PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE + | |\n| 73 | PRESET_TITLE_HIGHEST_QUALITY | |\n| 74 | PRESET_TITLE_EXTENDED_BATTERY | |\n| 75 | PRESET_TITLE_LONGEST_BATTERY + | |\n| 76 | PRESET_TITLE_STAR_TRAIL | |\n| 77 | PRESET_TITLE_LIGHT_PAINTING | |\n| 78 | PRESET_TITLE_LIGHT_TRAIL + | |\n| 79 | PRESET_TITLE_FULL_FRAME | |\n| 82 | PRESET_TITLE_STANDARD_QUALITY_VIDEO | |\n| 83 | PRESET_TITLE_BASIC_QUALITY_VIDEO + | |\n| 93 | PRESET_TITLE_HIGHEST_QUALITY_VIDEO | |\n| 94 | PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | |" + title_number: + description: Preset title number + format: int32 + type: integer + user_defined: + description: Is this preset user defined? + type: boolean + type: object + x-tags: + - Models + PresetGroup: + description: A collection of Presets + properties: + can_add_preset: + description: Is there room in the group to add additional Presets? + type: boolean + icon: + $ref: .enums.yml#/EnumPresetGroupIcon + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | PRESET_GROUP_VIDEO_ICON_ID | |\n| 1 | PRESET_GROUP_PHOTO_ICON_ID + | |\n| 2 | PRESET_GROUP_TIMELAPSE_ICON_ID | |\n| 3 | PRESET_GROUP_LONG_BAT_VIDEO_ICON_ID | |\n| 4 | PRESET_GROUP_ENDURANCE_VIDEO_ICON_ID + | |\n| 5 | PRESET_GROUP_MAX_VIDEO_ICON_ID | |\n| 6 | PRESET_GROUP_MAX_PHOTO_ICON_ID | |\n| 7 | PRESET_GROUP_MAX_TIMELAPSE_ICON_ID + | |" + id: + $ref: .enums.yml#/EnumPresetGroup + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 1000 | PRESET_GROUP_ID_VIDEO | |\n| 1001 | PRESET_GROUP_ID_PHOTO + | |\n| 1002 | PRESET_GROUP_ID_TIMELAPSE | |" + preset_array: + description: Array of Presets contained in this Preset Group + items: + $ref: '#/components/schemas/Preset' + type: array + type: object + x-tags: + - Models + PresetSetting: + description: An individual preset setting that forms the preset's setting array + properties: + id: + description: Setting identifier + format: int32 + type: integer + is_caption: + description: Does this setting appear on the Preset "pill" in the camera UI? + type: boolean + value: + description: Setting value + format: int32 + type: integer + type: object + x-tags: + - Models + SingleMediaListItem: + description: "A single (non-grouped) media item\n\nNote that each property actually comes as a string but is specified + here using its functional value.\n" + properties: + cre: + description: Creation time in seconds since epoch + example: 1696600109 + type: integer + glrv: + description: Low resolution video size + example: 817767 + type: integer + ls: + description: Low resolution file size. -1 if there is no LRV file + example: -1 + type: integer + mod: + description: Time file was last modified in seconds since epoch + example: 1696600109 + type: integer + n: + description: Media filename + example: GOPR0001.JPG + type: string + s: + description: Size of media in bytes + example: 2806303 + type: integer + required: + - n + - cre + - mod + - s + type: object + x-tags: + - Models + State: + description: All settings and statuses + properties: + settings: + description: All currently known setting values indexed by setting ID + properties: + 2: + description: "**Video Resolution**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 1 | Video Resolution 4K | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n + | 4 | Video Resolution 2 7K | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n + | 6 | Video Resolution 2 7K 4By3 | HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 7 | Video + Resolution 1440 | HERO9 Black |\n| 9 | Video Resolution 1080 | HERO12 Black, HERO11 Black Mini, HERO11 Black, + HERO10 Black, HERO9 Black |\n| 18 | Video Resolution 4K 4By3 | HERO12 Black, HERO11 Black Mini, HERO11 Black, + HERO10 Black, HERO9 Black |\n| 24 | Video Resolution 5K | HERO9 Black |\n| 25 | Video Resolution 5K 4By3 | + HERO10 Black |\n| 26 | Video Resolution 5 3K 8By7 | HERO11 Black Mini, HERO11 Black |\n| 27 | Video Resolution + 5 3K 4By3 | HERO11 Black Mini, HERO11 Black |\n| 28 | Video Resolution 4K 8By7 | HERO11 Black Mini, HERO11 + Black |\n| 100 | Video Resolution 5 3K | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black |\n| + 107 | Video Resolution 5 3K 8By7 V2 | HERO12 Black |\n| 108 | Video Resolution 4K 8By7 V2 | HERO12 Black |\n + | 109 | Video Resolution 4K 9By16 V2 | HERO12 Black |\n| 110 | Video Resolution 1080 9By16 V2 | HERO12 Black + |\n| 111 | Video Resolution 2 7K 4By3 V2 | HERO12 Black |\n" + enum: + - 1 + - 4 + - 6 + - 7 + - 9 + - 18 + - 24 + - 25 + - 26 + - 27 + - 28 + - 100 + - 107 + - 108 + - 109 + - 110 + - 111 + type: integer + 3: + description: "**Video Fps**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 0 | Video Fps 240 | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 1 | + Video Fps 120 | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 2 | Video Fps + 100 | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 5 | Video Fps 60 | HERO12 + Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 6 | Video Fps 50 | HERO12 Black, HERO11 + Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 8 | Video Fps 30 | HERO12 Black, HERO11 Black Mini, + HERO11 Black, HERO10 Black, HERO9 Black |\n| 9 | Video Fps 25 | HERO12 Black, HERO11 Black Mini, HERO11 Black, + HERO10 Black, HERO9 Black |\n| 10 | Video Fps 24 | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, + HERO9 Black |\n| 13 | Video Fps 200 | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n" + enum: + - 0 + - 1 + - 2 + - 5 + - 6 + - 8 + - 9 + - 10 + - 13 + type: integer + 43: + description: "**Broadcast Fov**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 0 | Broadcast Fov Wide | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n + | 2 | Broadcast Fov Narrow | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n + | 3 | Broadcast Fov Superview | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n + | 4 | Broadcast Fov Linear | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n" + enum: + - 0 + - 2 + - 3 + - 4 + type: integer + 59: + description: "**Setup Auto Power Down**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 0 | Setup Auto Power Down Never | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 + Black |\n| 1 | Setup Auto Power Down 1 Min | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 4 | Setup + Auto Power Down 5 Min | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 6 | + Setup Auto Power Down 15 Min | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 7 | Setup Auto Power + Down 30 Min | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 11 | Setup Auto Power Down 8 Seconds + | HERO11 Black Mini |\n| 12 | Setup Auto Power Down 30 Seconds | HERO11 Black Mini |\n" + enum: + - 0 + - 1 + - 4 + - 6 + - 7 + - 11 + - 12 + type: integer + 108: + description: "**Video Aspect Ratio**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Aspect Ratio 4By3 | HERO12 Black |\n| 1 | + Video Aspect Ratio 16By9 | HERO12 Black |\n| 3 | Video Aspect Ratio 8By7 | HERO12 Black |\n| 4 | Video Aspect + Ratio 9By16 | HERO12 Black |\n" + enum: + - 0 + - 1 + - 3 + - 4 + type: integer + 121: + description: "**Video Digital Lenses**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 0 | Video Digital Lenses Wide | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n| 2 | Video Digital Lenses Narrow | HERO10 Black, HERO9 Black |\n| 3 | Video Digital Lenses Superview | + HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 4 | Video Digital Lenses Linear + | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 7 | Video Digital Lenses Max + Superview | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black |\n| 8 | Video Digital + Lenses Linear Plus Horizon Leveling | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n| 9 | Video Digital Lenses Hyperview | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 10 | Video Digital + Lenses Linear Plus Horizon Lock | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 11 | Video Digital Lenses + Max Hyperview | HERO12 Black |\n" + enum: + - 0 + - 2 + - 3 + - 4 + - 7 + - 8 + - 9 + - 10 + - 11 + type: integer + 122: + description: "**Photo Digital Lenses**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 19 + | Photo Digital Lenses Narrow | HERO10 Black, HERO9 Black |\n| 100 | Photo Digital Lenses Max Superview | + HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 101 | Photo Digital Lenses Wide | HERO12 Black, + HERO11 Black, HERO10 Black, HERO9 Black |\n| 102 | Photo Digital Lenses Linear | HERO12 Black, HERO11 Black, + HERO10 Black, HERO9 Black |\n" + enum: + - 19 + - 100 + - 101 + - 102 + type: integer + 123: + description: "**Multi Shot Digital Lenses**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 + Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 19 | Multi Shot Digital Lenses Narrow | HERO10 Black, HERO9 Black |\n| 100 | Multi Shot Digital Lenses + Max Superview | HERO10 Black |\n| 101 | Multi Shot Digital Lenses Wide | HERO12 Black, HERO11 Black, HERO10 + Black, HERO9 Black |\n| 102 | Multi Shot Digital Lenses Linear | HERO12 Black, HERO11 Black, HERO10 Black, + HERO9 Black |\n" + enum: + - 19 + - 100 + - 101 + - 102 + type: integer + 128: + description: "**General Format**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 13 + | General Format Time Lapse Video | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 20 | General + Format Time Lapse Photo | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 21 | General Format Night + Lapse Photo | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 26 | General Format Night Lapse Video + | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n" + enum: + - 13 + - 20 + - 21 + - 26 + type: integer + 134: + description: "**Setup Anti Flicker**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 2 | Setup Anti Flicker 60 Hz | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n| 3 | Setup Anti Flicker 50 Hz | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n" + enum: + - 2 + - 3 + type: integer + 135: + description: "**Video Hypersmooth**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 0 | Video Hypersmooth Off | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO10 Black, HERO9 Black + |\n| 1 | Video Hypersmooth On | HERO12 Black, HERO11 Black Mini, HERO11 Black, HERO9 Black |\n| 2 | Video + Hypersmooth High | HERO10 Black, HERO9 Black |\n| 3 | Video Hypersmooth Boost | HERO11 Black Mini, HERO11 + Black, HERO10 Black, HERO9 Black |\n| 4 | Video Hypersmooth Auto Boost | HERO12 Black, HERO11 Black Mini, + HERO11 Black |\n| 100 | Video Hypersmooth Standard | HERO10 Black |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 100 + type: integer + 150: + description: "**Video Horizon Levelling**\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n\n| Value | Meaning |\ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Horizon Levelling Off | HERO11 + Black |\n| 2 | Video Horizon Levelling Locked | HERO11 Black |\n" + enum: + - 0 + - 2 + type: integer + 151: + description: "**Photo Horizon Levelling**\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n\n| Value | Meaning |\ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Photo Horizon Levelling Off | HERO11 + Black |\n| 2 | Photo Horizon Levelling Locked | HERO11 Black |\n" + enum: + - 0 + - 2 + type: integer + 162: + description: "**Mods Max Lens Enable**\n\nSupported Cameras:\n\n\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n + \n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Mods Max Lens + Enable Off | HERO11 Black, HERO10 Black, HERO9 Black |\n| 1 | Mods Max Lens Enable On | HERO11 Black, HERO10 + Black, HERO9 Black |\n" + enum: + - 0 + - 1 + type: integer + 167: + description: "**Video Hindsight Length**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 + Black\n- HERO9 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- + |\n| 2 | Video Hindsight Length 15 Seconds | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 3 + | Video Hindsight Length 30 Seconds | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n| 4 | Video + Hindsight Length Off | HERO12 Black, HERO11 Black, HERO10 Black, HERO9 Black |\n" + enum: + - 2 + - 3 + - 4 + type: integer + 171: + description: "**Photo Single Interval**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | \ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Photo Single Interval Off | HERO12 + Black |\n| 2 | Photo Single Interval 0 5 Seconds | HERO12 Black |\n| 3 | Photo Single Interval 1 Second | + HERO12 Black |\n| 4 | Photo Single Interval 2 Seconds | HERO12 Black |\n| 5 | Photo Single Interval 5 Seconds + | HERO12 Black |\n| 6 | Photo Single Interval 10 Seconds | HERO12 Black |\n| 7 | Photo Single Interval 30 + Seconds | HERO12 Black |\n| 8 | Photo Single Interval 60 Seconds | HERO12 Black |\n| 9 | Photo Single Interval + 120 Seconds | HERO12 Black |\n| 10 | Photo Single Interval 3 Seconds | HERO12 Black |\n" + enum: + - 0 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + type: integer + 172: + description: "**Photo Interval Duration**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning |\ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Photo Interval Duration Off | HERO12 + Black |\n| 1 | Photo Interval Duration 15 Seconds | HERO12 Black |\n| 2 | Photo Interval Duration 30 Seconds + | HERO12 Black |\n| 3 | Photo Interval Duration 1 Minute | HERO12 Black |\n| 4 | Photo Interval Duration 5 + Minutes | HERO12 Black |\n| 5 | Photo Interval Duration 15 Minutes | HERO12 Black |\n| 6 | Photo Interval + Duration 30 Minutes | HERO12 Black |\n| 7 | Photo Interval Duration 1 Hour | HERO12 Black |\n| 8 | Photo Interval + Duration 2 Hours | HERO12 Black |\n| 9 | Photo Interval Duration 3 Hours | HERO12 Black |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + type: integer + 173: + description: "**System Power Profile**\n\nSupported Cameras:\n\n\n- HERO10 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Power Profile Maximum Video Performance + | HERO10 Black |\n| 1 | System Power Profile Extended Battery | HERO10 Black |\n| 2 | System Power Profile + Tripod Stationary Video | HERO10 Black |\n" + enum: + - 0 + - 1 + - 2 + type: integer + 175: + description: "**Setup Camera Ux Mode**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n\n\n| Value + | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Setup Camera Ux Mode Easy + | HERO12 Black, HERO11 Black |\n| 1 | Setup Camera Ux Mode Pro | HERO12 Black, HERO11 Black |\n" + enum: + - 0 + - 1 + type: integer + 176: + description: "**Video Easy Mode Speed**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n\n\n| Value + | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Easy Mode Speed 8X + Ultra Slo Mo | HERO11 Black |\n| 1 | Video Easy Mode Speed 4X Super Slo Mo | HERO11 Black |\n| 2 | Video Easy + Mode Speed 2X Slo Mo | HERO11 Black |\n| 3 | Video Easy Mode Speed 1X Speed Low Light | HERO11 Black |\n| + 4 | Video Easy Mode Speed Eb 4X Super Slo Mo | HERO11 Black |\n| 5 | Video Easy Mode Speed Eb 2X Slo Mo | + HERO11 Black |\n| 6 | Video Easy Mode Speed Eb 1X Speed Low Light | HERO11 Black |\n| 7 | Video Easy Mode + Speed 8X Ultra Slo Mo 50Hz | HERO11 Black |\n| 8 | Video Easy Mode Speed 4X Super Slo Mo 50Hz | HERO11 Black + |\n| 9 | Video Easy Mode Speed 2X Slo Mo 50Hz | HERO11 Black |\n| 10 | Video Easy Mode Speed 1X Speed Low + Light 50Hz | HERO11 Black |\n| 11 | Video Easy Mode Speed Eb 4X Super Slo Mo 50Hz | HERO11 Black |\n| 12 | + Video Easy Mode Speed Eb 2X Slo Mo 50Hz | HERO11 Black |\n| 13 | Video Easy Mode Speed Eb 1X Speed Low Light + 50Hz | HERO11 Black |\n| 14 | Video Easy Mode Speed Eb 8X Ultra Slo Mo | HERO11 Black |\n| 15 | Video Easy + Mode Speed Eb 8X Ultra Slo Mo 50Hz | HERO11 Black |\n| 16 | Video Easy Mode Speed Lb 8X Ultra Slo Mo | HERO11 + Black |\n| 17 | Video Easy Mode Speed Lb 4X Super Slo Mo | HERO11 Black |\n| 18 | Video Easy Mode Speed Lb + 2X Slo Mo | HERO11 Black |\n| 19 | Video Easy Mode Speed Lb 1X Speed Low Light | HERO11 Black |\n| 20 | Video + Easy Mode Speed Lb 8X Ultra Slo Mo 50Hz | HERO11 Black |\n| 21 | Video Easy Mode Speed Lb 4X Super Slo Mo + 50Hz | HERO11 Black |\n| 22 | Video Easy Mode Speed Lb 2X Slo Mo 50Hz | HERO11 Black |\n| 23 | Video Easy + Mode Speed Lb 1X Speed Low Light 50Hz | HERO11 Black |\n| 24 | Video Easy Mode Speed 2X Slo Mo 4K | HERO11 + Black |\n| 25 | Video Easy Mode Speed 4X Super Slo Mo 2 7K | HERO11 Black |\n| 26 | Video Easy Mode Speed + 2X Slo Mo 4K 50Hz | HERO11 Black |\n| 27 | Video Easy Mode Speed 4X Super Slo Mo 2 7K 50Hz | HERO11 Black + |\n| 100 | Video Easy Mode Speed 8X Ultra Slo Mo V2 | HERO12 Black |\n| 101 | Video Easy Mode Speed 4X Super + Slo Mo V2 | HERO12 Black |\n| 102 | Video Easy Mode Speed 2X Slo Mo V2 | HERO12 Black |\n| 103 | Video Easy + Mode Speed 1X Speed Low Light V2 | HERO12 Black |\n| 104 | Video Easy Mode Speed 8X Ultra Slo Mo 50Hz V2 | + HERO12 Black |\n| 105 | Video Easy Mode Speed 4X Super Slo Mo 50Hz V2 | HERO12 Black |\n| 106 | Video Easy + Mode Speed 2X Slo Mo 50Hz V2 | HERO12 Black |\n| 107 | Video Easy Mode Speed 1X Speed Low Light 50Hz V2 | + HERO12 Black |\n| 108 | Video Easy Mode Speed Lb 8X Ultra Slo Mo V2 | HERO12 Black |\n| 109 | Video Easy Mode + Speed Lb 4X Super Slo Mo V2 | HERO12 Black |\n| 110 | Video Easy Mode Speed Lb 2X Slo Mo V2 | HERO12 Black + |\n| 111 | Video Easy Mode Speed Lb 1X Speed Low Light V2 | HERO12 Black |\n| 112 | Video Easy Mode Speed + Lb 8X Ultra Slo Mo 50Hz V2 | HERO12 Black |\n| 113 | Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz V2 | HERO12 + Black |\n| 114 | Video Easy Mode Speed Lb 2X Slo Mo 50Hz V2 | HERO12 Black |\n| 115 | Video Easy Mode Speed + Lb 1X Speed Low Light 50Hz V2 | HERO12 Black |\n| 116 | Video Easy Mode Speed 2X Slo Mo 4K V2 | HERO12 Black + |\n| 117 | Video Easy Mode Speed 2X Slo Mo 4K 50Hz V2 | HERO12 Black |\n| 118 | Video Easy Mode Speed Mobile + 1X Speed Low Light V2 | HERO12 Black |\n| 119 | Video Easy Mode Speed Mobile 1X Speed Low Light 50Hz V2 | + HERO12 Black |\n| 120 | Video Easy Mode Speed Mobile 2X Slo Mo V2 | HERO12 Black |\n| 121 | Video Easy Mode + Speed Mobile 2X Slo Mo 50Hz V2 | HERO12 Black |\n| 122 | Video Easy Mode Speed Universal 1X Speed Low Light + V2 | HERO12 Black |\n| 123 | Video Easy Mode Speed Universal 1X Speed Low Light 50Hz V2 | HERO12 Black |\n + | 124 | Video Easy Mode Speed Universal 2X Slo Mo V2 | HERO12 Black |\n| 125 | Video Easy Mode Speed Universal + 2X Slo Mo 50Hz V2 | HERO12 Black |\n| 126 | Video Easy Mode Speed 1X Speed Low Light 4K V2 | HERO12 Black + |\n| 127 | Video Easy Mode Speed 1X Speed Low Light 4K 50Hz V2 | HERO12 Black |\n| 128 | Video Easy Mode Speed + 1X Speed Low Light 2 7K V2 | HERO12 Black |\n| 129 | Video Easy Mode Speed 1X Speed Low Light 2 7K 50Hz V2 + | HERO12 Black |\n| 130 | Video Easy Mode Speed 2X Slo Mo 2 7K V2 | HERO12 Black |\n| 131 | Video Easy Mode + Speed 2X Slo Mo 2 7K 50Hz V2 | HERO12 Black |\n| 132 | Video Easy Mode Speed Mobile Lb 2X Slo Mo V2 | HERO12 + Black |\n| 133 | Video Easy Mode Speed Mobile Lb 2X Slo Mo 50Hz V2 | HERO12 Black |\n| 134 | Video Easy Mode + Speed Mobile Lb 1X Speed Low Light V2 | HERO12 Black |\n| 135 | Video Easy Mode Speed Mobile Lb 1X Speed Low + Light 50Hz V2 | HERO12 Black |\n| 136 | Video Easy Mode Speed Universal 1X Speed Low Light 4K V2 | HERO12 + Black |\n| 137 | Video Easy Mode Speed Universal 1X Speed Low Light 4K 50Hz V2 | HERO12 Black |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 100 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 118 + - 119 + - 120 + - 121 + - 122 + - 123 + - 124 + - 125 + - 126 + - 127 + - 128 + - 129 + - 130 + - 131 + - 132 + - 133 + - 134 + - 135 + - 136 + - 137 + type: integer + 177: + description: "**Photo Easy Mode Night Photo**\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n\n| Value | Meaning + | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Photo Easy Mode Night Photo Off | + HERO11 Black |\n| 1 | Photo Easy Mode Night Photo On | HERO11 Black |\n" + enum: + - 0 + - 1 + type: integer + 178: + description: "**Wireless Wireless Band**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Wireless + Wireless Band 2 4 Ghz | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 1 | Wireless Wireless Band 5 Ghz + | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n" + enum: + - 0 + - 1 + type: integer + 179: + description: "**Multi Shot Trail Length**\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- + HERO11 Black\n\n\n| Value | Meaning | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 1 + | Multi Shot Trail Length Short | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 2 | Multi Shot Trail + Length Long | HERO12 Black, HERO11 Black Mini, HERO11 Black |\n| 3 | Multi Shot Trail Length Max | HERO12 + Black, HERO11 Black Mini, HERO11 Black |\n" + enum: + - 1 + - 2 + - 3 + type: integer + 180: + description: "**System Video Mode**\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Video Mode Highest Quality | HERO11 Black + |\n| 101 | System Video Mode Extended Battery Green | HERO11 Black |\n| 102 | System Video Mode Longest Battery + Green | HERO11 Black |\n" + enum: + - 0 + - 101 + - 102 + type: integer + 182: + description: "**System Video Bit Rate**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | \ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Video Bit Rate Standard | HERO12 + Black |\n| 1 | System Video Bit Rate High | HERO12 Black |\n" + enum: + - 0 + - 1 + type: integer + 183: + description: "**System Video Bit Depth**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning |\ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Video Bit Depth 8Bit | HERO12 + Black |\n| 2 | System Video Bit Depth 10Bit | HERO12 Black |\n" + enum: + - 0 + - 2 + type: integer + 184: + description: "**Video Profile**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Profile Standard | HERO12 Black |\n| 1 | + Video Profile Hdr | HERO12 Black |\n| 2 | Video Profile 10 Bit Log | HERO12 Black |\n" + enum: + - 0 + - 1 + - 2 + type: integer + 186: + description: "**Video Easy Presets**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Easy Presets Highest Quality | HERO12 Black + |\n| 1 | Video Easy Presets Standard Quality | HERO12 Black |\n| 2 | Video Easy Presets Basic Quality | HERO12 + Black |\n" + enum: + - 0 + - 1 + - 2 + type: integer + 187: + description: "**Multi Shot Easy Presets**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning |\ + \ Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Multi Shot Easy Presets Lapse Mode + Time Warp | HERO12 Black |\n| 1 | Multi Shot Easy Presets Lapse Mode Star Trails | HERO12 Black |\n| 2 | Multi + Shot Easy Presets Lapse Mode Light Painting | HERO12 Black |\n| 3 | Multi Shot Easy Presets Lapse Mode Vehicle + Lights | HERO12 Black |\n| 4 | Multi Shot Easy Presets Max Lapse Mode Time Warp | HERO12 Black |\n| 5 | Multi + Shot Easy Presets Max Lapse Mode Star Trails | HERO12 Black |\n| 6 | Multi Shot Easy Presets Max Lapse Mode + Light Painting | HERO12 Black |\n| 7 | Multi Shot Easy Presets Max Lapse Mode Vehicle Lights | HERO12 Black + |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + type: integer + 189: + description: "**System Addon Lens Active**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning + | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Addon Lens Active None | HERO12 + Black |\n| 1 | System Addon Lens Active Max Lens 1 0 | HERO12 Black |\n| 2 | System Addon Lens Active Max + Lens 2 0 | HERO12 Black |\n" + enum: + - 0 + - 1 + - 2 + type: integer + 190: + description: "**System Addon Lens Status**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning + | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | System Addon Lens Status Off | HERO12 + Black |\n| 1 | System Addon Lens Status On | HERO12 Black |\n" + enum: + - 0 + - 1 + type: integer + 191: + description: "**Photo Easy Presets**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Photo Easy Presets Super Photo | HERO12 Black |\n + | 1 | Photo Easy Presets Night Photo | HERO12 Black |\n" + enum: + - 0 + - 1 + type: integer + 192: + description: "**Multi Shot Nlv Aspect Ratio**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning + | Supported Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Multi Shot Nlv Aspect Ratio 4By3 | + HERO12 Black |\n| 1 | Multi Shot Nlv Aspect Ratio 16By9 | HERO12 Black |\n| 3 | Multi Shot Nlv Aspect Ratio + 8By7 | HERO12 Black |\n" + enum: + - 0 + - 1 + - 3 + type: integer + 193: + description: "**Video Easy Framing**\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n| Value | Meaning | Supported + Cameras |\n| ----- | ------- | ----------------- |\n| 0 | Video Easy Framing Widescreen | HERO12 Black |\n + | 1 | Video Easy Framing Vertical | HERO12 Black |\n| 2 | Video Easy Framing Full Frame | HERO12 Black |\n" + enum: + - 0 + - 1 + - 2 + type: integer + type: object + status: + description: All currently known status values indexed by status ID + properties: + 1: + description: "**Is the system's internal battery present?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 2: + description: "**Rough approximation of internal battery level in bars**\n\n\n| Value | Meaning |\n| ----- | + ------- |\n| 0 | Zero |\n| 1 | One |\n| 2 | Two |\n| 3 | Three |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + type: integer + 6: + description: "**Is the system currently overheating?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 8: + description: "**Is the camera busy?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- + HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 9: + description: "**Is Quick Capture feature enabled?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 10: + description: "**Is the system encoding right now?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 11: + description: "**Is LCD lock active?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- + HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 13: + description: "**When encoding video, this is the duration (seconds) of the video so far; 0 otherwise**\n\n\n + \nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 17: + description: "**Are Wireless Connections enabled?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 19: + description: "**The pairing state of the camera**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Never + Started |\n| 1 | Started |\n| 2 | Aborted |\n| 3 | Cancelled |\n| 4 | Completed |\n\n\nSupported Cameras:\n + \n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + type: integer + 20: + description: "**The last type of pairing that the camera was engaged in**\n\n\n| Value | Meaning |\n| ----- + | ------- |\n| 0 | Not Pairing |\n| 1 | Pairing App |\n| 2 | Pairing Remote Control |\n| 3 | Pairing Bluetooth + Device |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + type: integer + 21: + description: "**Time (milliseconds) since boot of last successful pairing complete action**\n\n\n\nSupported + Cameras:\n\n\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 22: + description: "**State of current scan for WiFi Access Points. Appears to only change for CAH-related scans**\n + \n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Never started |\n| 1 | Started |\n| 2 | Aborted |\n| 3 + | Canceled |\n| 4 | Completed |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + type: integer + 23: + description: "**The time, in milliseconds since boot that the WiFi Access Point scan completed**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 24: + description: "**WiFi AP provisioning state**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Never started + |\n| 1 | Started |\n| 2 | Aborted |\n| 3 | Canceled |\n| 4 | Completed |\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + type: integer + 26: + description: "**Wireless remote control version**\n\n\n\nSupported Cameras:\n\n\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 27: + description: "**Is a wireless remote control connected?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 28: + description: "**Wireless Pairing State. Each bit contains state information (see WirelessPairingStateFlags)**\n + \n\n\nSupported Cameras:\n\n\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 29: + description: "**Provisioned WIFI AP SSID. On BLE connection, value is big-endian byte-encoded int**\n\n\n\n + Supported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: string + 30: + description: "**Camera's WIFI SSID. On BLE connection, value is big-endian byte-encoded int**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: string + 31: + description: "**The number of wireless devices connected to the camera**\n\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 32: + description: "**Is Preview Stream enabled?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 33: + description: "**Primary Storage Status**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| -1 | Unknown |\n| + 0 | OK |\n| 1 | SD Card Full |\n| 2 | SD Card Removed |\n| 3 | SD Card Format Error |\n| 4 | SD Card Busy + |\n| 8 | SD Card Swapped |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black" + enum: + - -1 + - 0 + - 1 + - 2 + - 3 + - 4 + - 8 + type: integer + 34: + description: "**How many photos can be taken before sdcard is full**\n\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 35: + description: "**How many minutes of video can be captured with current settings before sdcard is full**\n\n\n + \nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 38: + description: "**Total number of photos on sdcard**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 39: + description: "**Total number of videos on sdcard**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 41: + description: "**The current status of Over The Air (OTA) update**\n\n\n| Value | Meaning |\n| ----- | ------- + |\n| 0 | Idle |\n| 1 | Downloading |\n| 2 | Verifying |\n| 3 | Download Failed |\n| 4 | Verify Failed |\n + | 5 | Ready |\n| 6 | GoPro App: Downloading |\n| 7 | GoPro App: Verifying |\n| 8 | GoPro App: Download Failed + |\n| 9 | GoPro App: Verify Failed |\n| 10 | GoPro App: Ready |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + type: integer + 42: + description: "**Is there a pending request to cancel a firmware update download?**\n\n\n\nSupported Cameras:\n + \n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 45: + description: "**Is locate camera feature active?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 49: + description: "**The current timelapse interval countdown value (e.g. 5...4...3...2...1...)**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 54: + description: "**Remaining space on the sdcard in Kilobytes**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 55: + description: "**Is preview stream supported in current recording/mode/secondary-stream?**\n\n\n\nSupported Cameras:\n + \n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 56: + description: "**WiFi signal strength in bars**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 58: + description: "**The number of hilights in encoding video (set to 0 when encoding stops)**\n\n\n\nSupported Cameras:\n + \n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 59: + description: "**Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops)**\n + \n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + type: integer + 60: + description: "**The min time between camera status updates (msec). Do not poll for status more often than this**\n + \n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + type: integer + 64: + description: "**How many min of Timelapse video can be captured with current settings before sdcard is full**\n + \n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + type: integer + 65: + description: "**Liveview Exposure Select Mode**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Disabled + |\n| 1 | Auto |\n| 2 | ISO Lock |\n| 3 | Hemisphere |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + type: integer + 66: + description: "**Liveview Exposure Select: y-coordinate (percent)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + maximum: 100 + minimum: 0 + type: integer + 67: + description: "**Liveview Exposure Select: y-coordinate (percent)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + maximum: 100 + minimum: 0 + type: integer + 68: + description: "**Does the camera currently have a GPS lock?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 69: + description: "**Is the camera in AP Mode?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 70: + description: "**Internal battery level (percent)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + maximum: 100 + minimum: 0 + type: integer + 74: + description: "**Microphone Accesstory (Garter) status**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | + Garter not connected |\n| 1 | Garter connected |\n| 2 | Garter connected and microphone plugged into Garter + |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + enum: + - 0 + - 1 + - 2 + type: integer + 75: + description: "**Digital Zoom level (percent)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + maximum: 100 + minimum: 0 + type: integer + 76: + description: "**Wireless Band**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | 2.4 GHz |\n| 1 | 5 GHz + |\n| 2 | Max |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 + Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + type: integer + 77: + description: "**Is Digital Zoom feature available?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 78: + description: "**Are current video settings mobile friendly? (related to video compression and frame rate)**\n + \n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + enum: + - 0 + - 1 + type: integer + 79: + description: "**Is the camera currently in First Time Use (FTU) UI flow?**\n\n\n\nSupported Cameras:\n\n\n- + HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 81: + description: "**Is 5GHz wireless band available?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 82: + description: "**Is the system ready to accept commands?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 83: + description: "**Is the internal battery charged sufficiently to start Over The Air (OTA) update?**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 85: + description: "**Is the camera getting too cold to continue recording?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 86: + description: "**The rotational orientation of the camera**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| + 0 | 0 degrees (upright) |\n| 1 | 180 degrees (upside down) |\n| 2 | 90 degrees (laying on right side) |\n + | 3 | 270 degrees (laying on left side) |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + type: integer + 88: + description: "**Is this camera capable of zooming while encoding (static value based on model, not settings)**\n + \n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 + Black" + enum: + - 0 + - 1 + type: integer + 89: + description: "**Current flatmode ID**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- + HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 93: + description: "**Current Video Preset (ID)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 94: + description: "**Current Photo Preset (ID)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black" + type: integer + 95: + description: "**Current Timelapse Preset (ID)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 96: + description: "**Current Preset Group (ID) (corresponds to ui_mode_groups in settings.json)**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 97: + description: "**Current Preset (ID)**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- + HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 98: + description: "**Preset Modified Status, which contains an event ID and a preset (group) ID**\n\n\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 99: + description: "**How many Live Bursts can be captured before sdcard is full**\n\n\n\nSupported Cameras:\n\n\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + type: integer + 100: + description: "**Total number of Live Bursts on sdcard**\n\n\n\nSupported Cameras:\n\n\n- HERO11 Black\n- HERO10 + Black\n- HERO9 Black" + type: integer + 101: + description: "**Is Capture Delay currently active (i.e. counting down)?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 102: + description: "**Borg State**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Borg microphone removed |\n + | 2 | Borg microphone only |\n| 3 | Borg microphone with external microphone |\n\n\nSupported Cameras:\n\n + \n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 2 + - 3 + type: integer + 103: + description: "**Time Warp Speed**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | 15x |\n| 1 | 30x |\n + | 2 | 60x |\n| 3 | 150x |\n| 4 | 300x |\n| 5 | 900x |\n| 6 | 1800x |\n| 7 | 2x |\n| 8 | 5x |\n| 9 | 10x |\n + | 10 | Auto |\n| 11 | 1x (realtime) |\n| 12 | 1/2x (slow-motion) |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + type: integer + 104: + description: "**Is the system's Linux core active?**\n\n\n\nSupported Cameras:\n\n\n- HERO10 Black\n- HERO9 + Black" + enum: + - 0 + - 1 + type: integer + 105: + description: "**Camera lens type (reflects changes to setting 162 or setting 189)**\n\n\n| Value | Meaning |\n + | ----- | ------- |\n| 0 | Default |\n| 1 | Max Lens |\n| 2 | Max Lens 2.0 |\n\n\nSupported Cameras:\n\n\n + - HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + type: integer + 106: + description: "**Is Video Hindsight Capture Active?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 107: + description: "**Scheduled Capture Preset ID**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black" + type: integer + 108: + description: "**Is Scheduled Capture set?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n + - HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 110: + description: "**Media Mode Status (bitmasked)**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | 000 = Headroom: + 0, HDMI: 0, Media Mod Connected: False |\n| 1 | 001 = Headroom: 0, HDMI: 0, Media Mod Connected: True |\n + | 2 | 010 = Headroom: 0, HDMI: 1, Media Mod Connected: False |\n| 3 | 011 = Headroom: 0, HDMI: 1, Media Mod + Connected: True |\n| 4 | 100 = Headroom: 1, HDMI: 0, Media Mod Connected: False |\n| 5 | 101 = Headroom: 1, + HDMI: 0, Media Mod Connected: True |\n| 6 | 110 = Headroom: 1, HDMI: 1, Media Mod Connected: False |\n| 7 + | 111 = Headroom: 1, HDMI: 1, Media Mod Connected: True |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + type: integer + 111: + description: "**Does sdcard meet specified minimum write speed?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black" + enum: + - 0 + - 1 + type: integer + 112: + description: "**Number of sdcard write speed errors since device booted**\n\n\n\nSupported Cameras:\n\n\n- HERO12 + Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black" + type: integer + 113: + description: "**Is Turbo Transfer active?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black" + enum: + - 0 + - 1 + type: integer + 114: + description: "**Camera control status ID**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Camera Idle: + No one is attempting to change camera settings |\n| 1 | Camera Control: Camera is in a menu or changing settings. + To intervene, app must request control |\n| 2 | Camera External Control: An outside entity (app) has control + and is in a menu or modifying settings |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black" + enum: + - 0 + - 1 + - 2 + type: integer + 115: + description: "**Is the camera connected to a PC via USB?**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- + HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black" + enum: + - 0 + - 1 + type: integer + 116: + description: "**Camera control over USB state**\n\n\n| Value | Meaning |\n| ----- | ------- |\n| 0 | Disabled + |\n| 1 | Enabled |\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 + Black" + enum: + - 0 + - 1 + type: integer + 117: + description: "**Total SD card capacity in Kilobytes**\n\n\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 + Black Mini\n- HERO11 Black" + type: integer + type: object + type: object + x-tags: + - Models + VideoMetadata: + description: "Metadata for a video media file\n\nNote that each property actually comes as a string but is specified + here using its functional value.\n" + properties: + ao: + description: Audio option + enum: + - auto + - wind + - stereo + - off + example: auto + type: string + avc_profile: + description: Advanced Video Code Profile + example: 0 + maximum: 255 + minimum: 0 + type: integer + cl: + description: 1 if clipped, 0 otherwise + enum: + - 0 + - 1 + type: integer + cre: + description: Creation time in seconds since epoch + example: 1692992748 + type: integer + ct: + description: "Media content type\n\n| ID | Mode |\n| -- | ---- |\n| Video | 0 |\n| Looping | 1 |\n| Chaptered Video + | 2 |\n| Time Lapse | 3 |\n| Single Photo | 4 |\n| Burst Photo | 5 |\n| Time Lapse Photo | 6 |\n| Night Lapse + Photo | 8 |\n| Night Photo | 9 |\n| Continuous Photo | 10 |\n| Raw Photo | 11 |\n| Live Burst | 12 |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 8 + - 9 + - 10 + - 11 + - 12 + type: integer + dur: + description: Video duration in seconds + example: 42 + type: integer + eis: + description: 1 if stabilized, 0 otherwise + enum: + - 0 + - 1 + type: integer + fov: + description: Field of View + type: string + fps: + description: Video frame rate numerator + example: 1001 + type: integer + fps_denom: + description: Video frame rate denominator + example: 30000 + type: integer + gumi: + description: Globally Unique Media ID + example: '12345678998765443211234567899875' + type: string + h: + description: Height of media in pixels + example: 1080 + type: integer + hc: + description: Number of hilights in media + maximum: 99 + minimum: 0 + type: integer + hi: + description: List of hilights in ms offset from start of video + example: + - 1500 + - 4700 + items: + type: integer + type: array + lc: + description: Lens configuration ==> 0 for front, 1 for rear + enum: + - 0 + - 1 + type: integer + ls: + description: Low Resolution Video file size in bytes. -1 if there is no LRV file + maximum: 1234567890 + minimum: -1 + type: integer + mos: + description: List of offload states + example: + - app + - pc + items: + enum: + - app + - pc + - other + type: string + type: array + mp: + description: 1 if metadata is present, 0 otherwise + enum: + - 0 + - 1 + type: integer + prjn: + description: "Lens projection\n\n| ID | Mode |\n| -- | ---- |\n| EAC | 0 |\n| ERP | 1 |\n| EAC, split horizontally + in the middle for 2 output | 2 |\n| ERP, cropped for panorama | 3 |\n| Bypass stitch algorithm, side by side circles + | 4 |\n| Stitch is disabled, stitch algorithm is enabled for offline stitch | 5 |\n| Stitch is disabled| 6 |\n + | Bypass stitch algorithm for EAC split | 7 |\n| Hemisheric | 8 |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + profile: + description: Advanced Video Codec Level + maximum: 255 + minimum: 0 + type: integer + progr: + description: Is video progressive? 1 if progressive, 0 if interlaced + enum: + - 0 + - 1 + type: integer + pta: + description: 1 if protune audio is present, 0 otherwise + enum: + - 0 + - 1 + type: integer + rot: + description: Deprecated + type: string + s: + description: File size in bytes + example: 1234567890 + type: integer + subsample: + description: 1 if subsampled from other video, 0 otherwise + enum: + - 0 + - 1 + type: integer + tr: + description: 1 if file is transcoded, 0 otherwise + enum: + - 0 + - 1 + type: integer + us: + description: Has the file been uploaded? 0 if no, 1 if yes + enum: + - 0 + - 1 + type: integer + w: + description: Width of media in pixels + example: 1920 + type: integer + required: + - ct + - cre + - s + - gumi + - h + - w + - hc + - eis + - mp + - rot + - tr + - us + - ao + - profile + - avc_profile + - cl + - dur + - fps + - fps_denom + - ls + - pta + - subsample + type: object + x-tags: + - Models +info: + contact: + url: https://github.com/gopro/OpenGoPro/issues + description: + $ref: ./snippets/info.md + summary: The GoPro API allows developers to create apps and utilities that interact with and control a GoPro camera. + title: OpenGoPro HTTP API + version: '2.0' +openapi: 3.1.0 +paths: + /GoProRootCA.crt: + post: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_GET_HOME_NETWORK_CERT + responses: + '200': + content: + text/plain: + example: "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n-----END CERTIFICATE----\n" + schema: + type: string + description: SSL COHN Certificate + summary: Get COHN Certificate + tags: + - COHN + x-gopro: + - external + /gopro/camera/analytics/set_client_info: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_SET_ANALYTICS + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Set Client as Third Party + tags: + - Analytics + x-gopro: + - external + /gopro/camera/control/set_ui_controller: + get: + description: "This command is used to tell the camera that a client (i.e. External Control) wishes to claim control + of the camera.\nThis causes the camera to immediately exit any contextual menus and return to the idle screen. Any + interaction with the\ncamera's physical buttons will cause the camera to reclaim control and update control status + accordingly. If the user\nreturns the camera UI to the idle screen, the camera updates control status to Idle.\n\n + Note:\n\n- The entity currently claiming control of the camera is advertised in camera status 114\n- Information about + whether the camera is in a contextual menu or not is advertised in camera status 63.\n\nSee the below diagram for + a state diagram of Camera Control:\n\n![global behaviors state diagram](/assets/images/openapi/global_behaviors.png)\n + \n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\n + Supported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_SET_CAMERA_CONTROL_STATUS + parameters: + - description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | CAMERA_IDLE | |\n| 1 | CAMERA_CONTROL | Can + only be set by camera, not by app or third party |\n| 2 | CAMERA_EXTERNAL_CONTROL | |" + example: 0 + in: query + name: p + schema: + $ref: .enums.yml#/EnumCameraControlStatus + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Set Camera Control Status + tags: + - Control + x-gopro: + - external + /gopro/camera/control/wired_usb: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + \n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_SET_WIRED_USB_CONTROL + parameters: + - description: If 1, enable wired usb control; If 0, disable usb control + in: query + name: p + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Enable Wired camera control over USB + tags: + - Control + x-gopro: + - external + /gopro/camera/digital_zoom: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_DIGITAL_ZOOM_SET + parameters: + - description: Zoom Level (0-100) + example: 50 + in: query + name: percent + schema: + maximum: 100 + minimum: 0 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Set Digital Zoom + tags: + - Control + x-gopro: + - external + /gopro/camera/get_date_time: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_GET_DATE_TIME + responses: + '200': + content: + application/json: + schema: + properties: + date: + description: current date in format YYYY_MM_DD + example: '2023_12_31' + type: string + dst: + description: Is daylight savings time active? + enum: + - 0 + - 1 + type: integer + time: + description: current time in format HH_MM_SS + example: '11_05_45' + type: string + tzone: + description: Timezone offset in minutes + example: -480 + type: integer + required: + - date + - time + type: object + description: Success. Current date/time. + summary: Get Date / Time + tags: + - Query + x-gopro: + - external + /gopro/camera/info: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_CAMERA_INFO + responses: + '200': + content: + application/json: + schema: + properties: + info: + properties: + ap_mac_addr: + description: Camera's Access Point MAC address + example: 065747046ceb + type: string + ap_ssid: + description: Camera's ACcess Point SSID name + example: GP24645504 + type: string + firmware_version: + description: Camera Firmware version + example: H23.01.01.10.00 + format: version + type: string + model_name: + description: Camera Model Name + example: Hero12 Black + type: string + model_number: + description: Camera Model integer (as string) + example: '62' + type: string + serial_number: + description: Camera serial number + example: C3501324645504 + type: string + type: object + type: object + description: Hardware Info Response + summary: Get Hardware Info + tags: + - Query + x-gopro: + - external + /gopro/camera/keep_alive: + get: + description: "In order to maximize battery life, GoPro cameras automatically go to sleep after some time.\nThis logic + is handled by a combination of the **Auto Power Down** setting which most (but not all) cameras support\nand a **Keep + Alive** message that the user can regularly send to the camera.\n\nThe camera will automatically go to sleep if both + timers reach zero.\n\nThe Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the + camera,\nprogrammatically (un)sets the shutter, sets a setting, or loads a Preset.\n\nThe Keep Alive timer is reset + when the user sends a keep alive message.\n\nThe best practice to prevent the camera from inadvertently going to sleep + is to start sending Keep Alive messages\nevery **3.0** seconds after a connection is established.\n\n\n---\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported + Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_KEEP_ALIVE + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Keep Alive + tags: + - Control + x-gopro: + - external + /gopro/camera/presets/get: + get: + description: "Get the currently available Preset Groups and Presets, the set of which\n[depends](#tag/Presets/Presets) + on the current camera settings.\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_PRESETS_GET + responses: + '200': + content: + application/json: + schema: + properties: + presetGroupArray: + description: Array of Preset Groups + items: + $ref: '#/components/schemas/PresetGroup' + type: array + type: object + description: Currently available presets organized into preset groups + summary: Get Available Presets + tags: + - Presets + x-gopro: + - external + /gopro/camera/presets/load: + get: + description: "Preset ID's are not constant and must be retrieved via [Get Preset Status](#operation/OGP_PRESETS_GET)\n + \n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n + \n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_PRESET_LOAD + parameters: + - description: Preset to load + example: 0 + in: query + name: id + schema: + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Load Preset by ID + tags: + - Presets + x-gopro: + - external + /gopro/camera/presets/set_group: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_PRESET_SET_GROUP + parameters: + - description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 1000 | PRESET_GROUP_ID_VIDEO | |\n| 1001 | PRESET_GROUP_ID_PHOTO + | |\n| 1002 | PRESET_GROUP_ID_TIMELAPSE | |" + in: query + name: id + schema: + $ref: .enums.yml#/EnumPresetGroup + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Load Preset Group by ID + tags: + - Presets + x-gopro: + - external + /gopro/camera/presets/update_custom: + put: + description: "This only operates on the currently active Preset and will fail if the current\nPreset is not custom.\n + \nThe use cases are:\n\n1. Update the Custom Preset Icon\n\n - `icon_id` is always optional and can always be passed\n + \nand / or\n\n2. Update the Custom Preset Title to a...\n\n - **Factory Preset Title**: Set `title_id` to a non-94 + value\n - **Custom Preset Name**: Set `title_id` to 94 and specify a `custom_name`\n\n\n---\n\nSupported Cameras:\n + \n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_CUSTOM_PRESET_UPDATE + requestBody: + content: + application/json: + schema: + properties: + custom_name: + description: "utf-8 encoded target custom preset name which obeys the following:\n\n- must be between 1 + and 16 characters (inclusive)\n- No special characters outside of the following languages: English, French,\n\ + \ Italian, German, Spanish, Portuguese, Swedish, Russian\n" + type: string + icon_id: + $ref: .enums.yml#/EnumPresetIcon + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | PRESET_ICON_VIDEO | |\n| 1 | PRESET_ICON_ACTIVITY + | |\n| 2 | PRESET_ICON_CINEMATIC | |\n| 3 | PRESET_ICON_PHOTO | |\n| 4 | PRESET_ICON_LIVE_BURST | \ + \ |\n| 5 | PRESET_ICON_BURST | |\n| 6 | PRESET_ICON_PHOTO_NIGHT | |\n| 7 | PRESET_ICON_TIMEWARP | |\n + | 8 | PRESET_ICON_TIMELAPSE | |\n| 9 | PRESET_ICON_NIGHTLAPSE | |\n| 10 | PRESET_ICON_SNAIL | |\n| + 11 | PRESET_ICON_VIDEO_2 | |\n| 13 | PRESET_ICON_PHOTO_2 | |\n| 14 | PRESET_ICON_PANORAMA | |\n| 15 + | PRESET_ICON_BURST_2 | |\n| 16 | PRESET_ICON_TIMEWARP_2 | |\n| 17 | PRESET_ICON_TIMELAPSE_2 | |\n + | 18 | PRESET_ICON_CUSTOM | |\n| 19 | PRESET_ICON_AIR | |\n| 20 | PRESET_ICON_BIKE | |\n| 21 | PRESET_ICON_EPIC + | |\n| 22 | PRESET_ICON_INDOOR | |\n| 23 | PRESET_ICON_MOTOR | |\n| 24 | PRESET_ICON_MOUNTED | |\n + | 25 | PRESET_ICON_OUTDOOR | |\n| 26 | PRESET_ICON_POV | |\n| 27 | PRESET_ICON_SELFIE | |\n| 28 | PRESET_ICON_SKATE + | |\n| 29 | PRESET_ICON_SNOW | |\n| 30 | PRESET_ICON_TRAIL | |\n| 31 | PRESET_ICON_TRAVEL | |\n| 32 + | PRESET_ICON_WATER | |\n| 33 | PRESET_ICON_LOOPING | |\n| 58 | PRESET_ICON_BASIC | |\n| 59 | PRESET_ICON_ULTRA_SLO_MO + | |\n| 60 | PRESET_ICON_STANDARD_ENDURANCE | |\n| 61 | PRESET_ICON_ACTIVITY_ENDURANCE | |\n| 62 | PRESET_ICON_CINEMATIC_ENDURANCE + | |\n| 63 | PRESET_ICON_SLOMO_ENDURANCE | |\n| 64 | PRESET_ICON_STATIONARY_1 | |\n| 65 | PRESET_ICON_STATIONARY_2 + | |\n| 66 | PRESET_ICON_STATIONARY_3 | |\n| 67 | PRESET_ICON_STATIONARY_4 | |\n| 70 | PRESET_ICON_SIMPLE_SUPER_PHOTO + | |\n| 71 | PRESET_ICON_SIMPLE_NIGHT_PHOTO | |\n| 73 | PRESET_ICON_HIGHEST_QUALITY_VIDEO | |\n| 74 + | PRESET_ICON_STANDARD_QUALITY_VIDEO | |\n| 75 | PRESET_ICON_BASIC_QUALITY_VIDEO | |\n| 76 | PRESET_ICON_STAR_TRAIL + | |\n| 77 | PRESET_ICON_LIGHT_PAINTING | |\n| 78 | PRESET_ICON_LIGHT_TRAIL | |\n| 79 | PRESET_ICON_FULL_FRAME + | |\n| 1000 | PRESET_ICON_TIMELAPSE_PHOTO | |\n| 1001 | PRESET_ICON_NIGHTLAPSE_PHOTO | |" + title_id: + $ref: .enums.yml#/EnumPresetTitle + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | PRESET_TITLE_ACTIVITY | |\n| 1 | + PRESET_TITLE_STANDARD | |\n| 2 | PRESET_TITLE_CINEMATIC | |\n| 3 | PRESET_TITLE_PHOTO | |\n| 4 | PRESET_TITLE_LIVE_BURST + | |\n| 5 | PRESET_TITLE_BURST | |\n| 6 | PRESET_TITLE_NIGHT | |\n| 7 | PRESET_TITLE_TIME_WARP | |\n + | 8 | PRESET_TITLE_TIME_LAPSE | |\n| 9 | PRESET_TITLE_NIGHT_LAPSE | |\n| 10 | PRESET_TITLE_VIDEO | \ + \ |\n| 11 | PRESET_TITLE_SLOMO | |\n| 13 | PRESET_TITLE_PHOTO_2 | |\n| 14 | PRESET_TITLE_PANORAMA |\ + \ |\n| 16 | PRESET_TITLE_TIME_WARP_2 | |\n| 18 | PRESET_TITLE_CUSTOM | |\n| 19 | PRESET_TITLE_AIR |\ + \ |\n| 20 | PRESET_TITLE_BIKE | |\n| 21 | PRESET_TITLE_EPIC | |\n| 22 | PRESET_TITLE_INDOOR | |\n + | 23 | PRESET_TITLE_MOTOR | |\n| 24 | PRESET_TITLE_MOUNTED | |\n| 25 | PRESET_TITLE_OUTDOOR | |\n| + 26 | PRESET_TITLE_POV | |\n| 27 | PRESET_TITLE_SELFIE | |\n| 28 | PRESET_TITLE_SKATE | |\n| 29 | PRESET_TITLE_SNOW + | |\n| 30 | PRESET_TITLE_TRAIL | |\n| 31 | PRESET_TITLE_TRAVEL | |\n| 32 | PRESET_TITLE_WATER | |\n + | 33 | PRESET_TITLE_LOOPING | |\n| 58 | PRESET_TITLE_BASIC | |\n| 59 | PRESET_TITLE_ULTRA_SLO_MO | \ + \ |\n| 60 | PRESET_TITLE_STANDARD_ENDURANCE | |\n| 61 | PRESET_TITLE_ACTIVITY_ENDURANCE | |\n| 62 | + PRESET_TITLE_CINEMATIC_ENDURANCE | |\n| 63 | PRESET_TITLE_SLOMO_ENDURANCE | |\n| 64 | PRESET_TITLE_STATIONARY_1 + | |\n| 65 | PRESET_TITLE_STATIONARY_2 | |\n| 66 | PRESET_TITLE_STATIONARY_3 | |\n| 67 | PRESET_TITLE_STATIONARY_4 + | |\n| 68 | PRESET_TITLE_SIMPLE_VIDEO | |\n| 69 | PRESET_TITLE_SIMPLE_TIME_WARP | |\n| 70 | PRESET_TITLE_SIMPLE_SUPER_PHOTO + | |\n| 71 | PRESET_TITLE_SIMPLE_NIGHT_PHOTO | |\n| 72 | PRESET_TITLE_SIMPLE_VIDEO_ENDURANCE | |\n| + 73 | PRESET_TITLE_HIGHEST_QUALITY | |\n| 74 | PRESET_TITLE_EXTENDED_BATTERY | |\n| 75 | PRESET_TITLE_LONGEST_BATTERY + | |\n| 76 | PRESET_TITLE_STAR_TRAIL | |\n| 77 | PRESET_TITLE_LIGHT_PAINTING | |\n| 78 | PRESET_TITLE_LIGHT_TRAIL + | |\n| 79 | PRESET_TITLE_FULL_FRAME | |\n| 82 | PRESET_TITLE_STANDARD_QUALITY_VIDEO | |\n| 83 | PRESET_TITLE_BASIC_QUALITY_VIDEO + | |\n| 93 | PRESET_TITLE_HIGHEST_QUALITY_VIDEO | |\n| 94 | PRESET_TITLE_USER_DEFINED_CUSTOM_NAME | \ + \ |" + type: object + required: true + responses: + '200': + $ref: '#/components/responses/200Empty' + '400': + $ref: '#/components/responses/GenericEmpty' + description: Attempted to update custom preset but the currently active preset is not custom. + summary: Update Custom Preset + tags: + - Presets + x-gopro: + - external + /gopro/camera/set_date_time: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_SET_DATE_AND_TIME_DST_ID + parameters: + - description: current date in format YYYY_MM_DD + example: '2023_12_31' + in: query + name: date + schema: + type: string + - description: current time in format HH_MM_SS in 24 hour format + example: '21_12_13' + in: query + name: time + schema: + type: string + - description: "Timezone offset in minutes. See [here](https://en.wikipedia.org/wiki/List_of_UTC_offsets) for a\nlisting + of all UTC offsets.\n\nNot supported on:\n- Hero 10 Black\n- Hero 9 Black\n" + example: -480 + in: query + name: tzone + schema: + type: integer + - description: "Is daylight savings time active?\n\nNot supported on:\n- Hero 10 Black\n- Hero 9 Black\n" + in: query + name: dst + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Set Date / Time + tags: + - Control + x-gopro: + - external + /gopro/camera/setting/108/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::108 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Aspect Ratio 4By3 | HERO12 Black\n + | 1 | Video Aspect Ratio 16By9 | HERO12 Black\n| 3 | Video Aspect Ratio 8By7 | HERO12 Black\n| 4 | Video Aspect + Ratio 9By16 | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 3 + - 4 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Aspect Ratio (108) + tags: + - settings + /gopro/camera/setting/121/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::121 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Digital Lenses Wide | HERO11 Black + Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 2 | Video Digital Lenses Narrow | HERO9 Black, HERO10 + Black\n| 3 | Video Digital Lenses Superview | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 + Black\n| 4 | Video Digital Lenses Linear | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n + | 7 | Video Digital Lenses Max Superview | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n + | 8 | Video Digital Lenses Linear Plus Horizon Leveling | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, + HERO11 Black\n| 9 | Video Digital Lenses Hyperview | HERO11 Black Mini, HERO12 Black, HERO11 Black\n| 10 | Video + Digital Lenses Linear Plus Horizon Lock | HERO11 Black Mini, HERO12 Black, HERO11 Black\n| 11 | Video Digital Lenses + Max Hyperview | HERO12 Black" + example: 7 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + - 3 + - 4 + - 7 + - 8 + - 9 + - 10 + - 11 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Digital Lenses (121) + tags: + - settings + /gopro/camera/setting/122/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::122 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 19 | Photo Digital Lenses Narrow | HERO9 Black, + HERO10 Black\n| 100 | Photo Digital Lenses Max Superview | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n + | 101 | Photo Digital Lenses Wide | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 102 | Photo Digital + Lenses Linear | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 100 + in: path + name: option + required: true + schema: + enum: + - 19 + - 100 + - 101 + - 102 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Digital Lenses (122) + tags: + - settings + /gopro/camera/setting/123/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::123 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 19 | Multi Shot Digital Lenses Narrow | HERO9 + Black, HERO10 Black\n| 100 | Multi Shot Digital Lenses Max Superview | HERO10 Black\n| 101 | Multi Shot Digital + Lenses Wide | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 102 | Multi Shot Digital Lenses Linear | + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 101 + in: path + name: option + required: true + schema: + enum: + - 19 + - 100 + - 101 + - 102 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Multi Shot Digital Lenses (123) + tags: + - settings + /gopro/camera/setting/128/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::128 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 13 | General Format Time Lapse Video | HERO9 + Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 20 | General Format Time Lapse Photo | HERO9 Black, HERO10 Black, + HERO12 Black, HERO11 Black\n| 21 | General Format Night Lapse Photo | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 + Black\n| 26 | General Format Night Lapse Video | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 13 + in: path + name: option + required: true + schema: + enum: + - 13 + - 20 + - 21 + - 26 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: General Format (128) + tags: + - settings + /gopro/camera/setting/134/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::134 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 2 | Setup Anti Flicker 60 Hz | HERO11 Black + Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 3 | Setup Anti Flicker 50 Hz | HERO11 Black Mini, + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 2 + in: path + name: option + required: true + schema: + enum: + - 2 + - 3 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Setup Anti Flicker (134) + tags: + - settings + /gopro/camera/setting/135/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::135 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Hypersmooth Off | HERO11 Black Mini, + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 1 | Video Hypersmooth On | HERO11 Black Mini, HERO9 Black, + HERO12 Black, HERO11 Black\n| 2 | Video Hypersmooth High | HERO9 Black, HERO10 Black\n| 3 | Video Hypersmooth Boost + | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO11 Black\n| 4 | Video Hypersmooth Auto Boost | HERO11 Black + Mini, HERO12 Black, HERO11 Black\n| 100 | Video Hypersmooth Standard | HERO10 Black" + example: 3 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 100 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Hypersmooth (135) + tags: + - settings + /gopro/camera/setting/150/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::150 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Horizon Levelling Off | HERO11 Black\n + | 2 | Video Horizon Levelling Locked | HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Horizon Levelling (150) + tags: + - settings + /gopro/camera/setting/151/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::151 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Photo Horizon Levelling Off | HERO11 Black\n + | 2 | Photo Horizon Levelling Locked | HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Horizon Levelling (151) + tags: + - settings + /gopro/camera/setting/162/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::162 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Mods Max Lens Enable Off | HERO9 Black, + HERO10 Black, HERO11 Black\n| 1 | Mods Max Lens Enable On | HERO9 Black, HERO10 Black, HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Mods Max Lens Enable (162) + tags: + - settings + /gopro/camera/setting/167/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::167 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 2 | Video Hindsight Length 15 Seconds | HERO9 + Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 3 | Video Hindsight Length 30 Seconds | HERO9 Black, HERO10 Black, + HERO12 Black, HERO11 Black\n| 4 | Video Hindsight Length Off | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 2 + in: path + name: option + required: true + schema: + enum: + - 2 + - 3 + - 4 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Hindsight Length (167) + tags: + - settings + /gopro/camera/setting/171/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::171 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Photo Single Interval Off | HERO12 Black\n + | 2 | Photo Single Interval 0 5 Seconds | HERO12 Black\n| 3 | Photo Single Interval 1 Second | HERO12 Black\n| 4 + | Photo Single Interval 2 Seconds | HERO12 Black\n| 5 | Photo Single Interval 5 Seconds | HERO12 Black\n| 6 | Photo + Single Interval 10 Seconds | HERO12 Black\n| 7 | Photo Single Interval 30 Seconds | HERO12 Black\n| 8 | Photo Single + Interval 60 Seconds | HERO12 Black\n| 9 | Photo Single Interval 120 Seconds | HERO12 Black\n| 10 | Photo Single + Interval 3 Seconds | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Single Interval (171) + tags: + - settings + /gopro/camera/setting/172/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::172 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Photo Interval Duration Off | HERO12 Black\n + | 1 | Photo Interval Duration 15 Seconds | HERO12 Black\n| 2 | Photo Interval Duration 30 Seconds | HERO12 Black\n + | 3 | Photo Interval Duration 1 Minute | HERO12 Black\n| 4 | Photo Interval Duration 5 Minutes | HERO12 Black\n + | 5 | Photo Interval Duration 15 Minutes | HERO12 Black\n| 6 | Photo Interval Duration 30 Minutes | HERO12 Black\n + | 7 | Photo Interval Duration 1 Hour | HERO12 Black\n| 8 | Photo Interval Duration 2 Hours | HERO12 Black\n| 9 | + Photo Interval Duration 3 Hours | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Interval Duration (172) + tags: + - settings + /gopro/camera/setting/173/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO10 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::173 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Power Profile Maximum Video Performance + | HERO10 Black\n| 1 | System Power Profile Extended Battery | HERO10 Black\n| 2 | System Power Profile Tripod Stationary + Video | HERO10 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Power Profile (173) + tags: + - settings + /gopro/camera/setting/175/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::175 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Setup Camera Ux Mode Easy | HERO12 Black, + HERO11 Black\n| 1 | Setup Camera Ux Mode Pro | HERO12 Black, HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Setup Camera Ux Mode (175) + tags: + - settings + /gopro/camera/setting/176/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::176 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Easy Mode Speed 8X Ultra Slo Mo + | HERO11 Black\n| 1 | Video Easy Mode Speed 4X Super Slo Mo | HERO11 Black\n| 2 | Video Easy Mode Speed 2X Slo Mo + | HERO11 Black\n| 3 | Video Easy Mode Speed 1X Speed Low Light | HERO11 Black\n| 4 | Video Easy Mode Speed Eb 4X + Super Slo Mo | HERO11 Black\n| 5 | Video Easy Mode Speed Eb 2X Slo Mo | HERO11 Black\n| 6 | Video Easy Mode Speed + Eb 1X Speed Low Light | HERO11 Black\n| 7 | Video Easy Mode Speed 8X Ultra Slo Mo 50Hz | HERO11 Black\n| 8 | Video + Easy Mode Speed 4X Super Slo Mo 50Hz | HERO11 Black\n| 9 | Video Easy Mode Speed 2X Slo Mo 50Hz | HERO11 Black\n + | 10 | Video Easy Mode Speed 1X Speed Low Light 50Hz | HERO11 Black\n| 11 | Video Easy Mode Speed Eb 4X Super Slo + Mo 50Hz | HERO11 Black\n| 12 | Video Easy Mode Speed Eb 2X Slo Mo 50Hz | HERO11 Black\n| 13 | Video Easy Mode Speed + Eb 1X Speed Low Light 50Hz | HERO11 Black\n| 14 | Video Easy Mode Speed Eb 8X Ultra Slo Mo | HERO11 Black\n| 15 + | Video Easy Mode Speed Eb 8X Ultra Slo Mo 50Hz | HERO11 Black\n| 16 | Video Easy Mode Speed Lb 8X Ultra Slo Mo + | HERO11 Black\n| 17 | Video Easy Mode Speed Lb 4X Super Slo Mo | HERO11 Black\n| 18 | Video Easy Mode Speed Lb + 2X Slo Mo | HERO11 Black\n| 19 | Video Easy Mode Speed Lb 1X Speed Low Light | HERO11 Black\n| 20 | Video Easy Mode + Speed Lb 8X Ultra Slo Mo 50Hz | HERO11 Black\n| 21 | Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz | HERO11 Black\n + | 22 | Video Easy Mode Speed Lb 2X Slo Mo 50Hz | HERO11 Black\n| 23 | Video Easy Mode Speed Lb 1X Speed Low Light + 50Hz | HERO11 Black\n| 24 | Video Easy Mode Speed 2X Slo Mo 4K | HERO11 Black\n| 25 | Video Easy Mode Speed 4X Super + Slo Mo 2 7K | HERO11 Black\n| 26 | Video Easy Mode Speed 2X Slo Mo 4K 50Hz | HERO11 Black\n| 27 | Video Easy Mode + Speed 4X Super Slo Mo 2 7K 50Hz | HERO11 Black\n| 100 | Video Easy Mode Speed 8X Ultra Slo Mo V2 | HERO12 Black\n + | 101 | Video Easy Mode Speed 4X Super Slo Mo V2 | HERO12 Black\n| 102 | Video Easy Mode Speed 2X Slo Mo V2 | HERO12 + Black\n| 103 | Video Easy Mode Speed 1X Speed Low Light V2 | HERO12 Black\n| 104 | Video Easy Mode Speed 8X Ultra + Slo Mo 50Hz V2 | HERO12 Black\n| 105 | Video Easy Mode Speed 4X Super Slo Mo 50Hz V2 | HERO12 Black\n| 106 | Video + Easy Mode Speed 2X Slo Mo 50Hz V2 | HERO12 Black\n| 107 | Video Easy Mode Speed 1X Speed Low Light 50Hz V2 | HERO12 + Black\n| 108 | Video Easy Mode Speed Lb 8X Ultra Slo Mo V2 | HERO12 Black\n| 109 | Video Easy Mode Speed Lb 4X Super + Slo Mo V2 | HERO12 Black\n| 110 | Video Easy Mode Speed Lb 2X Slo Mo V2 | HERO12 Black\n| 111 | Video Easy Mode + Speed Lb 1X Speed Low Light V2 | HERO12 Black\n| 112 | Video Easy Mode Speed Lb 8X Ultra Slo Mo 50Hz V2 | HERO12 + Black\n| 113 | Video Easy Mode Speed Lb 4X Super Slo Mo 50Hz V2 | HERO12 Black\n| 114 | Video Easy Mode Speed Lb + 2X Slo Mo 50Hz V2 | HERO12 Black\n| 115 | Video Easy Mode Speed Lb 1X Speed Low Light 50Hz V2 | HERO12 Black\n| + 116 | Video Easy Mode Speed 2X Slo Mo 4K V2 | HERO12 Black\n| 117 | Video Easy Mode Speed 2X Slo Mo 4K 50Hz V2 | + HERO12 Black\n| 118 | Video Easy Mode Speed Mobile 1X Speed Low Light V2 | HERO12 Black\n| 119 | Video Easy Mode + Speed Mobile 1X Speed Low Light 50Hz V2 | HERO12 Black\n| 120 | Video Easy Mode Speed Mobile 2X Slo Mo V2 | HERO12 + Black\n| 121 | Video Easy Mode Speed Mobile 2X Slo Mo 50Hz V2 | HERO12 Black\n| 122 | Video Easy Mode Speed Universal + 1X Speed Low Light V2 | HERO12 Black\n| 123 | Video Easy Mode Speed Universal 1X Speed Low Light 50Hz V2 | HERO12 + Black\n| 124 | Video Easy Mode Speed Universal 2X Slo Mo V2 | HERO12 Black\n| 125 | Video Easy Mode Speed Universal + 2X Slo Mo 50Hz V2 | HERO12 Black\n| 126 | Video Easy Mode Speed 1X Speed Low Light 4K V2 | HERO12 Black\n| 127 | + Video Easy Mode Speed 1X Speed Low Light 4K 50Hz V2 | HERO12 Black\n| 128 | Video Easy Mode Speed 1X Speed Low Light + 2 7K V2 | HERO12 Black\n| 129 | Video Easy Mode Speed 1X Speed Low Light 2 7K 50Hz V2 | HERO12 Black\n| 130 | Video + Easy Mode Speed 2X Slo Mo 2 7K V2 | HERO12 Black\n| 131 | Video Easy Mode Speed 2X Slo Mo 2 7K 50Hz V2 | HERO12 + Black\n| 132 | Video Easy Mode Speed Mobile Lb 2X Slo Mo V2 | HERO12 Black\n| 133 | Video Easy Mode Speed Mobile + Lb 2X Slo Mo 50Hz V2 | HERO12 Black\n| 134 | Video Easy Mode Speed Mobile Lb 1X Speed Low Light V2 | HERO12 Black\n + | 135 | Video Easy Mode Speed Mobile Lb 1X Speed Low Light 50Hz V2 | HERO12 Black\n| 136 | Video Easy Mode Speed + Universal 1X Speed Low Light 4K V2 | HERO12 Black\n| 137 | Video Easy Mode Speed Universal 1X Speed Low Light 4K + 50Hz V2 | HERO12 Black" + example: 103 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 100 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 118 + - 119 + - 120 + - 121 + - 122 + - 123 + - 124 + - 125 + - 126 + - 127 + - 128 + - 129 + - 130 + - 131 + - 132 + - 133 + - 134 + - 135 + - 136 + - 137 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Easy Mode Speed (176) + tags: + - settings + /gopro/camera/setting/177/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::177 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Photo Easy Mode Night Photo Off | HERO11 + Black\n| 1 | Photo Easy Mode Night Photo On | HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Easy Mode Night Photo (177) + tags: + - settings + /gopro/camera/setting/178/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::178 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Wireless Wireless Band 2 4 Ghz | HERO11 + Black Mini, HERO12 Black, HERO11 Black\n| 1 | Wireless Wireless Band 5 Ghz | HERO11 Black Mini, HERO12 Black, HERO11 + Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Wireless Wireless Band (178) + tags: + - settings + /gopro/camera/setting/179/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::179 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 1 | Multi Shot Trail Length Short | HERO11 + Black Mini, HERO12 Black, HERO11 Black\n| 2 | Multi Shot Trail Length Long | HERO11 Black Mini, HERO12 Black, HERO11 + Black\n| 3 | Multi Shot Trail Length Max | HERO11 Black Mini, HERO12 Black, HERO11 Black" + example: 3 + in: path + name: option + required: true + schema: + enum: + - 1 + - 2 + - 3 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Multi Shot Trail Length (179) + tags: + - settings + /gopro/camera/setting/180/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::180 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Video Mode Highest Quality | HERO11 + Black\n| 101 | System Video Mode Extended Battery Green | HERO11 Black\n| 102 | System Video Mode Longest Battery + Green | HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 101 + - 102 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Video Mode (180) + tags: + - settings + /gopro/camera/setting/182/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::182 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Video Bit Rate Standard | HERO12 + Black\n| 1 | System Video Bit Rate High | HERO12 Black" + example: 1 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Video Bit Rate (182) + tags: + - settings + /gopro/camera/setting/183/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::183 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Video Bit Depth 8Bit | HERO12 Black\n + | 2 | System Video Bit Depth 10Bit | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Video Bit Depth (183) + tags: + - settings + /gopro/camera/setting/184/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::184 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Profile Standard | HERO12 Black\n + | 1 | Video Profile Hdr | HERO12 Black\n| 2 | Video Profile 10 Bit Log | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Profile (184) + tags: + - settings + /gopro/camera/setting/186/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::186 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Easy Presets Highest Quality | HERO12 + Black\n| 1 | Video Easy Presets Standard Quality | HERO12 Black\n| 2 | Video Easy Presets Basic Quality | HERO12 + Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Easy Presets (186) + tags: + - settings + /gopro/camera/setting/187/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::187 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Multi Shot Easy Presets Lapse Mode Time + Warp | HERO12 Black\n| 1 | Multi Shot Easy Presets Lapse Mode Star Trails | HERO12 Black\n| 2 | Multi Shot Easy + Presets Lapse Mode Light Painting | HERO12 Black\n| 3 | Multi Shot Easy Presets Lapse Mode Vehicle Lights | HERO12 + Black\n| 4 | Multi Shot Easy Presets Max Lapse Mode Time Warp | HERO12 Black\n| 5 | Multi Shot Easy Presets Max + Lapse Mode Star Trails | HERO12 Black\n| 6 | Multi Shot Easy Presets Max Lapse Mode Light Painting | HERO12 Black\n + | 7 | Multi Shot Easy Presets Max Lapse Mode Vehicle Lights | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Multi Shot Easy Presets (187) + tags: + - settings + /gopro/camera/setting/189/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::189 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Addon Lens Active None | HERO12 + Black\n| 1 | System Addon Lens Active Max Lens 1 0 | HERO12 Black\n| 2 | System Addon Lens Active Max Lens 2 0 | + HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Addon Lens Active (189) + tags: + - settings + /gopro/camera/setting/190/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::190 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | System Addon Lens Status Off | HERO12 + Black\n| 1 | System Addon Lens Status On | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: System Addon Lens Status (190) + tags: + - settings + /gopro/camera/setting/191/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::191 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Photo Easy Presets Super Photo | HERO12 + Black\n| 1 | Photo Easy Presets Night Photo | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Photo Easy Presets (191) + tags: + - settings + /gopro/camera/setting/192/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::192 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Multi Shot Nlv Aspect Ratio 4By3 | HERO12 + Black\n| 1 | Multi Shot Nlv Aspect Ratio 16By9 | HERO12 Black\n| 3 | Multi Shot Nlv Aspect Ratio 8By7 | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 3 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Multi Shot Nlv Aspect Ratio (192) + tags: + - settings + /gopro/camera/setting/193/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::193 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Easy Framing Widescreen | HERO12 + Black\n| 1 | Video Easy Framing Vertical | HERO12 Black\n| 2 | Video Easy Framing Full Frame | HERO12 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Easy Framing (193) + tags: + - settings + /gopro/camera/setting/2/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::2 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 1 | Video Resolution 4K | HERO11 Black Mini, + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 4 | Video Resolution 2 7K | HERO11 Black Mini, HERO9 Black, + HERO10 Black, HERO12 Black, HERO11 Black\n| 6 | Video Resolution 2 7K 4By3 | HERO11 Black Mini, HERO9 Black, HERO10 + Black, HERO11 Black\n| 7 | Video Resolution 1440 | HERO9 Black\n| 9 | Video Resolution 1080 | HERO11 Black Mini, + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 18 | Video Resolution 4K 4By3 | HERO11 Black Mini, HERO9 + Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 24 | Video Resolution 5K | HERO9 Black\n| 25 | Video Resolution + 5K 4By3 | HERO10 Black\n| 26 | Video Resolution 5 3K 8By7 | HERO11 Black Mini, HERO11 Black\n| 27 | Video Resolution + 5 3K 4By3 | HERO11 Black Mini, HERO11 Black\n| 28 | Video Resolution 4K 8By7 | HERO11 Black Mini, HERO11 Black\n + | 100 | Video Resolution 5 3K | HERO11 Black Mini, HERO10 Black, HERO12 Black, HERO11 Black\n| 107 | Video Resolution + 5 3K 8By7 V2 | HERO12 Black\n| 108 | Video Resolution 4K 8By7 V2 | HERO12 Black\n| 109 | Video Resolution 4K 9By16 + V2 | HERO12 Black\n| 110 | Video Resolution 1080 9By16 V2 | HERO12 Black\n| 111 | Video Resolution 2 7K 4By3 V2 + | HERO12 Black" + example: 24 + in: path + name: option + required: true + schema: + enum: + - 1 + - 4 + - 6 + - 7 + - 9 + - 18 + - 24 + - 25 + - 26 + - 27 + - 28 + - 100 + - 107 + - 108 + - 109 + - 110 + - 111 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Resolution (2) + tags: + - settings + /gopro/camera/setting/3/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::3 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Video Fps 240 | HERO11 Black Mini, HERO9 + Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 1 | Video Fps 120 | HERO11 Black Mini, HERO9 Black, HERO10 Black, + HERO12 Black, HERO11 Black\n| 2 | Video Fps 100 | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 + Black\n| 5 | Video Fps 60 | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 6 | Video + Fps 50 | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 8 | Video Fps 30 | HERO11 Black + Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 9 | Video Fps 25 | HERO11 Black Mini, HERO9 Black, + HERO10 Black, HERO12 Black, HERO11 Black\n| 10 | Video Fps 24 | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 + Black, HERO11 Black\n| 13 | Video Fps 200 | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black" + example: 0 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 2 + - 5 + - 6 + - 8 + - 9 + - 10 + - 13 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Video Fps (3) + tags: + - settings + /gopro/camera/setting/43/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::43 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Broadcast Fov Wide | HERO11 Black Mini, + HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 2 | Broadcast Fov Narrow | HERO11 Black Mini, HERO9 Black, + HERO10 Black, HERO12 Black, HERO11 Black\n| 3 | Broadcast Fov Superview | HERO11 Black Mini, HERO9 Black, HERO10 + Black, HERO12 Black, HERO11 Black\n| 4 | Broadcast Fov Linear | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 + Black, HERO11 Black" + example: 3 + in: path + name: option + required: true + schema: + enum: + - 0 + - 2 + - 3 + - 4 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Broadcast Fov (43) + tags: + - settings + /gopro/camera/setting/59/{option}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n" + operationId: GPCAMERA_CHANGE_SETTING::59 + parameters: + - description: "| ID | Meaning | Cameras |\n| -- | ------- | ------- |\n| 0 | Setup Auto Power Down Never | HERO11 Black + Mini, HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 1 | Setup Auto Power Down 1 Min | HERO11 Black Mini, + HERO12 Black, HERO11 Black\n| 4 | Setup Auto Power Down 5 Min | HERO11 Black Mini, HERO9 Black, HERO10 Black, HERO12 + Black, HERO11 Black\n| 6 | Setup Auto Power Down 15 Min | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n + | 7 | Setup Auto Power Down 30 Min | HERO9 Black, HERO10 Black, HERO12 Black, HERO11 Black\n| 11 | Setup Auto Power + Down 8 Seconds | HERO11 Black Mini\n| 12 | Setup Auto Power Down 30 Seconds | HERO11 Black Mini" + example: 4 + in: path + name: option + required: true + schema: + enum: + - 0 + - 1 + - 4 + - 6 + - 7 + - 11 + - 12 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Setup Auto Power Down (59) + tags: + - settings + /gopro/camera/shutter/{mode}: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + \n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_SHUTTER + parameters: + - description: Start / stop encoding. + in: path + name: mode + schema: + enum: + - start + - stop + type: string + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Set Shutter + tags: + - Control + x-gopro: + - external + /gopro/camera/state: + get: + description: "Get all camera settings and statuses.\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_GET_STATE + responses: + '200': + $ref: '#/components/responses/State' + summary: Get Camera State + tags: + - Query + x-gopro: + - external + /gopro/camera/stream/start: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_PREVIEW_STREAM_START + parameters: + - description: "Port to use for Preview Stream. Defaults to 8554 if not set\n\nNot supported on:\n - Hero 11 Black + Mini\n - Hero 11 Black\n - Hero 10 Black\n - Hero 9 Black\n" + example: 8556 + in: query + name: port + schema: + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Start the Preview Stream + tags: + - Preview Stream + x-gopro: + - external + /gopro/camera/stream/stop: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_PREVIEW_STREAM_STOP + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Stop the Preview Stream + tags: + - Preview Stream + x-gopro: + - external + /gopro/cohn/cert/clear: + post: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_CLEAR_HOME_NETWORK_CERT + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Delete COHN Certificates + tags: + - COHN + x-gopro: + - external + /gopro/cohn/cert/create: + post: + description: "This creates the Camera On the Home Network SSL/TLS certs certs.\nThe created certificate(s) can be obtained + via [Get COHN Certificate](#operation/GPCAMERA_GET_HOME_NETWORK_CERT) and\nused for SSL/TLS communications\n\n\n---\n + \nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_CREATE_HOME_NETWORK_CERT + requestBody: + content: + application/json: + schema: + properties: + override: + description: If 1, replace existing Root CA cert with a newly-generated one. + enum: + - 0 + - 1 + type: integer + type: object + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Create the COHN Certificates + tags: + - COHN + x-gopro: + - external + /gopro/cohn/setting: + post: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_SET_HOME_NETWORK_SETTING + requestBody: + content: + application/json: + schema: + properties: + cohn_active: + description: "1 to enable, 0 to disable\n\nWhen `cohn_active` == 1, STA Mode connection will be dropped + and camera will not\nautomatically re-connect for COHN.\n" + enum: + - 0 + - 1 + type: integer + type: object + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Configure COHN Settings + tags: + - COHN + x-gopro: + - external + /gopro/cohn/status: + post: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_GET_HOME_NETWORK_STATUS + responses: + '200': + content: + application/json: + schema: + properties: + enabled: + description: Is COHN currently enabled? + enum: + - 0 + - 1 + type: integer + ipaddress: + description: Camera's IP address on the local network + example: 123.45.67.890 + type: string + macaddress: + description: MAC address of the wifi adapter + type: string + password: + description: Password used for http basic auth header + type: string + ssid: + description: Currently connected SSID + type: string + state: + $ref: .enums.yml#/EnumCOHNNetworkState + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | COHN_STATE_Init | |\n| 1 | COHN_STATE_Error + | |\n| 2 | COHN_STATE_Exit | |\n| 5 | COHN_STATE_Idle | |\n| 27 | COHN_STATE_NetworkConnected | \ + \ |\n| 28 | COHN_STATE_NetworkDisconnected | |\n| 29 | COHN_STATE_ConnectingToNetwork | |\n| 30 | + COHN_STATE_Invalid | |" + status: + $ref: .enums.yml#/EnumCOHNStatus + description: "| ID | Name | Summary |\n| -- | ---- | ------- |\n| 0 | COHN_UNPROVISIONED | |\n| 1 | COHN_PROVISIONED + | |" + username: + description: Username used for http basic auth header + type: string + type: object + description: Current COHN Status + summary: Get COHN Status + tags: + - COHN + x-gopro: + - external + /gopro/media/gpmf: + get: + description: "None\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_MEDIA_GPMF + parameters: + - description: media file name + example: 100GOPRO/GOPR0002.JPG + in: query + name: path + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + format: binary + type: string + description: "Binary GPMF data\n\nSee the [GPMF documentation](https://gopro.github.io/gpmf-parser/) for more information + on how\nto handle this data.\n" + summary: Get Media File GPMF + tags: + - Media + x-gopro: + - external + /gopro/media/hilight/file: + get: + description: "Add a hilight / tag to an existing photo or media file.\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- + WIFI\n" + operationId: OGP_ADD_HILIGHT + parameters: + - description: The path to a file on the camera to HiLight + example: 100GOPRO/GOPR0002.MP4 + in: query + name: path + required: true + schema: + type: string + - description: The offset from the beginning of a video file, in milliseconds + example: 1 + in: query + name: ms + schema: + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Hilight a Media File + tags: + - Hilights + x-gopro: + - external + /gopro/media/hilight/moment: + get: + description: "Add hilight at current time while recording video\n\nThis can only be used during recording.\n\n\n---\n + \nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\nSupported + Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_TAG_MOMENT + responses: + '200': + $ref: '#/components/responses/200Empty' + '500': + $ref: '#/components/responses/GenericEmpty' + description: Camera is not currently recording + summary: Hilight While Recording + tags: + - Hilights + x-gopro: + - external + /gopro/media/hilight/remove: + get: + description: "Remove an existing hilight from a photo or video file.\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- + WIFI\n" + operationId: OGP_REMOVE_HILIGHT + parameters: + - description: The path to a file on the camera to remove a HiLight from + example: 100GOPRO/GOPR0002.MP4 + in: query + name: path + required: true + schema: + type: string + - description: The offset from the beginning of a video file, in milliseconds + example: 1 + in: query + name: ms + schema: + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + '500': + $ref: '#/components/responses/GenericEmpty' + description: Requested hilight does not exist + summary: Remove Hilight + tags: + - Hilights + x-gopro: + - external + /gopro/media/info: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_MEDIA_INFO + parameters: + - description: media file name + example: 100GOPRO/GOPR0002.JPG + in: query + name: path + schema: + type: string + responses: + '200': + content: + application/json: + schema: + anyOf: + - $ref: '#/components/schemas/VideoMetadata' + - $ref: '#/components/schemas/PhotoMetadata' + type: object + description: Photo or Video Metadata + summary: Get Media File Info + tags: + - Media + x-gopro: + - external + /gopro/media/last_captured: + get: + description: "This will return the complete path of the last captured media. Depending on the type of media captured, + it will return:\n\n- single photo / video: The single media path\n- any grouped media: The path to the first captured + media in the group\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n + - USB\n" + operationId: OGP_GET_LAST_MEDIA + responses: + '200': + content: + application/json: + schema: + properties: + file: + description: Filename of media + example: GOPR0002.JPG + type: string + folder: + description: Directory that the media is contained in + example: 100GOPRO + type: string + type: object + description: Successful last captured media response + '204': + content: + application/json: + schema: + type: object + description: There is no last captured media for the camera to report + summary: Get Last Captured Media + tags: + - Media + - Query + x-gopro: + - external + /gopro/media/list: + get: + description: "To minimize the size of the JSON transmitted by the camera, grouped media items such as Burst Photos,\n + Time Lapse Photos, Night Lapse Photos, etc are represented with a single item in the media list with additional keys\n + that allow the user to extrapolate individual filenames for each member of the group.\n\nFilenames for group media + items have the form \"GXXXYYYY.ZZZ\"\nwhere XXX is the group ID, YYY is the group member ID and ZZZ is the file extension.\n + \nFor example, take the media list below, which contains a Time Lapse Photo group media item:\n\n```json\n{\n \"\ + id\": \"2530266050123724003\",\n \"media\": [\n {\n \"d\": \"100GOPRO\",\n \"fs\" + : [\n {\n \"b\": \"8\",\n \"cre\": \"1613669353\",\n \ + \ \"g\": \"1\",\n \"l\": \"396\",\n \"m\": [\"75\", \"139\"],\n \ + \ \"mod\": \"1613669353\",\n \"n\": \"G0010008.JPG\",\n \"\ + s\": \"773977407\",\n \"t\": \"t\"\n }\n ]\n }\n ]\n}\n```\n + \nThe first filename in the group is `G0010008.JP` (key: `n`).\n\nThe ID of the first group member in this case is + `008` (key: `b`).\n\nThe ID of the last group member in this case is `396` (key: `l`).\n\nThe IDs of deleted members + in this case are `75` and `139` (key: `m`)\n\nGiven this information, the user can extrapolate that the group currently + contains\n\n```\nG0010008.JPG, G0010009.JPG, G0010010.JPG,\n...,\nG0010074.JPG, G0010076.JPG,\n...,\nG0010138.JPG, + G0010140.JPG,\n...,\nG0010394.JPG, G0010395.JPG. G0010396.JPG\n```\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n + - HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- + WIFI\n" + operationId: OGP_MEDIA_LIST + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MediaList' + description: Structured media list response + summary: Get Media List + tags: + - Media + x-gopro: + - external + /gopro/media/screennail: + get: + description: "A screennail is a low-res preview image that is higher resolution than a thumbnail.\n\n---\n\nSupported + Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported + Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_MEDIA_SCREENNAIL + parameters: + - description: media file name + example: 100GOPRO/GOPR0002.JPG + in: query + name: path + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + format: binary + type: string + description: Screennail image data + summary: Get Media File Screennail + tags: + - Media + x-gopro: + - external + /gopro/media/telemetry: + get: + description: "Get Media File Telemetry track data\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n + - HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_MEDIA_TELEMETRY + parameters: + - description: media file name + example: 100GOPRO/GOPR0002.JPG + in: query + name: path + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + format: binary + type: string + description: "Binary telemetry data\n\nSee the [GPMF documentation](https://gopro.github.io/gpmf-parser/) for more + information on how\nto handle this data.\n" + summary: Get Media File Telemetry + tags: + - Media + x-gopro: + - external + /gopro/media/thumbnail: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_MEDIA_THUMBNAIL + parameters: + - description: media file name + example: 100GOPRO/GOPR0002.JPG + in: query + name: path + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + format: binary + type: string + description: Thumbnail image data + summary: Get Media File Thumbnail + tags: + - Media + x-gopro: + - external + /gopro/media/turbo_transfer: + get: + description: "Some cameras support Turbo Transfer mode, which allows media to be downloaded over WiFi more rapidly.\n + \nThis special mode should only be used during media offload.\n\nIt is recommended that the user check for and, if + necessary, disable Turbo Transfer on connection.\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black + Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_TURBO_MODE_ENABLE + parameters: + - description: 0 to disable, 1 to enable + in: query + name: p + schema: + enum: + - 0 + - 1 + type: integer + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Configure Turbo Transfer + tags: + - Control + x-gopro: + - external + /gopro/version: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n + - HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- WIFI\n- USB\n" + operationId: GPCAMERA_OPENGOPRO_VERSION + responses: + '200': + content: + application/json: + schema: + properties: + version: + description: Open GoPro version + example: '2.0' + format: version + type: string + type: object + description: GoPro Version. + summary: Get Open GoPro Version + tags: + - Query + x-gopro: + - external + /gopro/webcam/exit: + get: + description: "Not supported on **WiFi** for:\n - Hero 11 Black Mini\n - Hero 11 Black\n - Hero 10 Black\n \ + \ - Hero 9 Black\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\n + Supported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_EXIT + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Exit Webcam Mode + tags: + - Webcam + x-gopro: + - external + /gopro/webcam/preview: + get: + description: "Not supported on **WiFi** for:\n - Hero 11 Black Mini\n - Hero 11 Black\n - Hero 10 Black\n \ + \ - Hero 9 Black\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\n + Supported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_PREVIEW + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Enter Webcam Preview + tags: + - Webcam + x-gopro: + - external + /gopro/webcam/start: + get: + description: "Not supported on **WiFi** for:\n - Hero 11 Black Mini\n - Hero 11 Black\n - Hero 10 Black\n \ + \ - Hero 9 Black\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\n + Supported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_START + parameters: + - description: + $ref: ./snippets/webcam_res.md + in: query + name: res + schema: + type: integer + - description: + $ref: ./snippets/webcam_fov.md + in: query + name: fov + schema: + type: integer + - description: "Port to use for Webcam Stream. Defaults to 8554 if not set\n\nNot supported on:\n - Hero 11 Black Mini\n\ + \ - Hero 10 Black\n - Hero 9 Black\n" + example: 8556 + in: query + name: port + schema: + type: integer + - description: "Streaming protocol to use.\n\nNot supported on:\n - Hero 11 Black Mini\n - Hero 11 Black\n - Hero + 10 Black\n - Hero 9 Black\n" + in: query + name: protocol + schema: + enum: + - RTSP + - TS + type: string + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Start Webcam + tags: + - Webcam + x-gopro: + - external + /gopro/webcam/status: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\nSupported + Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_STATUS + responses: + '200': + content: + application/json: + schema: + properties: + error: + description: "Current webcam error (if status was not successful)\n\n| Code | Status |\n| ---- | ------ + |\n| 0 | None |\n| 1 | Set Preset |\n| 2 | Set Window Size |\n| 3 | Exec Stream |\n| 4 | Shutter |\n + | 5 | Com timeout |\n| 6 | Invalid param |\n| 7 | Unavailable |\n| 8 | Exit |\n" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + status: + description: "Current webcam status\n\n| Code | Status |\n| ---- | ------ |\n| 0 | Off |\n| 1 | Idle + |\n| 2 | High Power Preview |\n| 3 | Low Power Preview |\n" + enum: + - 0 + - 1 + - 2 + - 3 + type: integer + type: object + description: Current webcam status and error + summary: Get Webcam Status + tags: + - Webcam + x-gopro: + - external + /gopro/webcam/stop: + get: + description: "Not supported on **WiFi** for:\n - Hero 11 Black Mini\n - Hero 11 Black\n - Hero 10 Black\n \ + \ - Hero 9 Black\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\n + Supported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_STOP + responses: + '200': + $ref: '#/components/responses/200Empty' + summary: Stop Webcam + tags: + - Webcam + x-gopro: + - external + /gopro/webcam/version: + get: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black\n- HERO10 Black\n\n\n---\n\nSupported + Protocols:\n\n\n- USB\n- WIFI\n" + operationId: OGP_WEBCAM_VERSION + responses: + '200': + content: + application/json: + schema: + properties: + max_lens_support: + description: Does the webcam support Max Lens Mod? + type: boolean + usb_3_1_compatible: + description: Is the webcam USB 3.1 compatible? + type: boolean + version: + description: Current webcam version + type: integer + type: object + description: Current webcam version and metadata + summary: Get Webcam Version + tags: + - Webcam + x-gopro: + - external + /gp/gpSoftUpdate: + post: + description: "Perform Resumable OTA Update\n\nTo send a portion of the OTA image as per the requestBody specification, + do not use the `request` parameter.\n\n\n---\n\nSupported Cameras:\n\n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 + Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: GPCAMERA_FIRMWARE_UPDATE_V2 + parameters: + - description: "Optional request parameter to control / query OTA functionality.\n\n| Parameter | Behavior |\n| --------- + | -------- |\n| delete | Delete any old / cached OTA data |\n| showui | Display the update OSD on the camera UI + |\n| start | Start updating firmware with received OTA image |\n| progress | Get the current firmware update progress + |\n| cancelled | show canceled/failed ui on the camera |\n" + in: query + name: request + schema: + enum: + - delete + - showui + - start + - progress + - cancelled + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: Binary file + format: binary + type: string + offset: + description: Offset (in bytes) into the file data to start reading from + type: integer + sha1: + description: SHA of the complete firmware upload zip file + type: string + type: object + description: OTA image chunk used when executed with no `request` parameter + responses: + '200': + content: + application/json: + schema: + properties: + bytes_complete: + type: integer + complete: + type: boolean + message: + type: string + sha1: + type: string + status: + $ref: '#/components/schemas/OtaStatus' + type: object + description: Current OTA progress + summary: Resumable OTA Update + tags: + - OTA + x-gopro: + - external + /gp/gpUpdate: + post: + description: "\n\n---\n\nSupported Cameras:\n\n\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n + \n\n---\n\nSupported Protocols:\n\n\n- USB\n- WIFI\n" + operationId: GPCAMERA_FWUPDATE_DOWNLOAD_FILE + requestBody: + content: + multipart/form-data: + schema: + properties: + DirectToSD: + description: Always set to 1 + type: integer + file: + description: Binary file + format: binary + type: string + sha1: + description: SHA of the complete firmware upload zip file + type: string + update: + description: Always set to 1 + type: integer + type: object + responses: + '200': + content: + application/json: + schema: + properties: + status: + $ref: '#/components/schemas/OtaStatus' + type: object + description: Current OTA progress + summary: Simple OTA Update + tags: + - OTA + x-gopro: + - external + /videos/DCIM/{directory}/{filename}: + get: + description: "Note that this is the same endpoint for all media (photos, video, etc.).\n\n\n---\n\nSupported Cameras:\n + \n\n- HERO12 Black\n- HERO11 Black Mini\n- HERO11 Black\n- HERO10 Black\n- HERO9 Black\n\n\n---\n\nSupported Protocols:\n + \n\n- USB\n- WIFI\n" + operationId: OGP_DOWNLOAD_MEDIA + parameters: + - description: Case sensitive directory that media resides in + example: 100GOPRO + in: path + name: directory + required: true + schema: + type: string + - description: Case sensitive media filename + examples: + photo: + summary: Sample photo file + value: GOPR0001.JPG + video: + summary: Sample video file + value: GH010397.MP4 + in: path + name: filename + required: true + schema: + type: string + summary: Download a Media File + tags: + - Media + x-gopro: + - external +servers: +- description: default camera + url: http://10.5.5.9:8080 +tags: +- description: Command and control of the camera + name: Control +- description: Get information about the camera + name: Query +- description: + $ref: ./snippets/media.md + name: Media +- description: + $ref: ./snippets/webcam.md + name: Webcam +- description: + $ref: ./snippets/preview_stream.md + name: Preview Stream +- description: + $ref: ./snippets/ota.md + name: OTA +- description: + $ref: ./snippets/cohn.md + name: COHN +- description: Query / Configure Analytics + name: Analytics +- description: + $ref: ./snippets/presets.md + name: Presets +- description: + $ref: ./snippets/settings.md + name: settings +- description: + $ref: ./snippets/hilights.md + name: Hilights +- description: Common data models used across operations + name: Models diff --git a/specs/capabilities.json b/specs/capabilities.json index bad466a2..7afba704 100644 --- a/specs/capabilities.json +++ b/specs/capabilities.json @@ -1,5 +1,3721 @@ { "HERO12 Black": { + "v02.00.00": { + "states": [ + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "30", + "option_id": 8 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "60", + "option_id": 5 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "120", + "option_id": 1 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "1080", + "option_id": 9 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "240", + "option_id": 0 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "2.7K", + "option_id": 4 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "2.7K", + "option_id": 4 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "2.7K", + "option_id": 4 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "2.7K", + "option_id": 4 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "200", + "option_id": 13 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "2.7K", + "option_id": 4 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "240", + "option_id": 0 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "30", + "option_id": 8 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "60", + "option_id": 5 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "100", + "option_id": 2 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "4K", + "option_id": 1 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "120", + "option_id": 1 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Superview", + "option_id": 3 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Linear", + "option_id": 4 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "24", + "option_id": 10 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "HyperView", + "option_id": 9 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "25", + "option_id": 9 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "30", + "option_id": 8 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Low", + "option_id": 1 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Auto Boost", + "option_id": 4 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "50", + "option_id": 6 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "60Hz", + "option_id": 2 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ], + [ + { + "setting_name": "Resolution", + "setting_id": 2, + "option_name": "5.3K", + "option_id": 100 + }, + { + "setting_name": "Frames Per Second", + "setting_id": 3, + "option_name": "60", + "option_id": 5 + }, + { + "setting_name": "Video Digital Lenses", + "setting_id": 121, + "option_name": "Wide", + "option_id": 0 + }, + { + "setting_name": "Anti-Flicker", + "setting_id": 134, + "option_name": "50Hz", + "option_id": 3 + }, + { + "setting_name": "Hypersmooth", + "setting_id": 135, + "option_name": "Off", + "option_id": 0 + } + ] + ] + }, "v01.30.00": { "states": [ [ diff --git a/specs/capabilities.xlsx b/specs/capabilities.xlsx index d0950a1c..be49192d 100644 --- a/specs/capabilities.xlsx +++ b/specs/capabilities.xlsx @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:946c4a5d3d1809cfe5371f634747d111840e20a628c2cca2a45751a6fc9772b3 -size 108929 +oid sha256:546ce0b1b877b16510b6b97983b00d245ad12628ade7615a1ebe28bd5bbb8416 +size 111890 diff --git a/swagger.html b/swagger.html new file mode 100644 index 00000000..88897f10 --- /dev/null +++ b/swagger.html @@ -0,0 +1,301 @@ + + + + + + +Open GoPro + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + + +
    +
    +
    +
    +
    + + + + + + + Internal BOSS API + + +
    + + + + + + +
    +
    +
    +
    + +
    + + +
    +
    +
    + + +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + diff --git a/tutorials/ble-queries.html b/tutorials/ble-queries.html index 869b8b37..cf6d8065 100644 --- a/tutorials/ble-queries.html +++ b/tutorials/ble-queries.html @@ -34,7 +34,7 @@ - + @@ -142,7 +142,7 @@ Tutorials
  • - Demos + Demos
  • FAQ @@ -410,7 +410,7 @@

    GoPro

    - +
    @@ -500,7 +500,7 @@

    Requirements

    Just Show me the Demo(s)!!

    -
      +
      • python @@ -511,7 +511,7 @@

        Just Show me the Demo(s)!!

      -
        +
        • Each of the scripts for this tutorial can be found in the Tutorial 2 @@ -634,7 +634,7 @@

          Setup

          characteristic. Throughout this tutorial, the query information that we will be reading is the Resolution Setting (ID 0x02).

          -
            + -
              +
              • Therefore, we have slightly changed the notification handler to update a global resolution variable as it @@ -773,7 +773,7 @@

                Individual Query Poll

                First we send the query command:

                -
                  +
                  • python @@ -784,7 +784,7 @@

                    Individual Query Poll

                  -
                    +
                    • The sample code can be found in in ble_query_poll_resolution_value.py. @@ -814,7 +814,7 @@

                      Individual Query Poll

                      When the response is received in / from the notification handler, we update the global resolution variable:

                      -
                        +
                        • python @@ -825,7 +825,7 @@

                          Individual Query Poll

                        -
                          +
                          • def notification_handler(characteristic: BleakGATTCharacteristic, data: bytes) -> None:
                            @@ -878,7 +878,7 @@ 

                            Individual Query Poll

                            has changed:

                            -
                              +
                              • python @@ -889,7 +889,7 @@

                                Individual Query Poll

                              -
                                +
                                • INFO:root:Changing the resolution to Resolution.RES_2_7K...
                                  @@ -945,7 +945,7 @@ 

                                  Multiple Simultaneous Query Polls

                                  The query command now includes 3 settings: Resolution, FPS, and FOV.

                                  -
                                    +
                                    • python @@ -956,7 +956,7 @@

                                      Multiple Simultaneous Query Polls

                                    -
                                      +
                                      • RESOLUTION_ID = 2
                                        @@ -981,7 +981,7 @@ 

                                        Multiple Simultaneous Query Polls

                                        We are also parsing the response to get all 3 values:

                                        -
                                          +
                                          • python @@ -992,7 +992,7 @@

                                            Multiple Simultaneous Query Polls

                                          -
                                            +
                                            • def notification_handler(characteristic: BleakGATTCharacteristic, data: bytes) -> None:
                                              @@ -1024,7 +1024,7 @@ 

                                              Multiple Simultaneous Query Polls

                                              They are then printed to the log which will look like the following:

                                              -
                                                +
                                                • python @@ -1035,7 +1035,7 @@

                                                  Multiple Simultaneous Query Polls

                                                -
                                                  +
                                                  • INFO:root:Received response at handle=62: b'0b:12:00:02:01:07:03:01:01:79:01:00'
                                                    @@ -1085,10 +1085,10 @@ 

                                                    Query All

                                                    Quiz time! 📚 ✏️

                                                    -
                                                    +
                                                    -
                                                    How can we poll the encoding status and the resolution setting using one command?
                                                    -
                                                    +
                                                    How can we poll the encoding status and the resolution setting using one command?
                                                    +

                                                    @@ -1101,10 +1101,10 @@

                                                    Query All

                                                    - -