OpenGoPro HTTP API (2.0)

Download OpenAPI specification:Download

URL: https://github.com/gopro/OpenGoPro/issues

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

See the supported cameras from the BLE Specification

The documentation assumes that the GoPro is always updated to the most recent version. This is relevant in cases where functionality changes between versions.

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:

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 BLE Services and Characteristics 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 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

General

The camera will reject requests to change settings while encoding; for example, if Hindsight feature is active, the user can not change settings
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 a video-based Preset.

Analytics

Query / Configure Analytics

Set Client as Third Party

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/analytics/set_client_info

Response samples

200

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.

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 Protocols:

usb
wifi

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

200

Content type

application/json

{ }

Create the COHN SSL/TLS certificates

Supported Protocols:

usb
wifi

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

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

200

Content type

application/json

{ }

Delete COHN Certificates

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request POST \
  --url http://10.5.5.9:8080/gopro/cohn/cert/clear

Response samples

200

Content type

application/json

{ }

Get COHN Certificate

Supported Protocols:

usb
wifi

Responses

Response Schema: text/plain

string

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request POST \
  --url http://10.5.5.9:8080/GoProRootCA.crt

Response samples

200

Content type

text/plain

Get COHN Status

Supported Protocols:

usb
wifi

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

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

status

integer (EnumCOHNStatus)

Enum: 0 1

ID	Name	Summary
0	COHN_UNPROVISIONED
1	COHN_PROVISIONED

username

string

Username used for http basic auth header

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request POST \
  --url http://10.5.5.9:8080/gopro/cohn/status

Response samples

200

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

Supported Protocols:

usb
wifi

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.

Note that Disabling / enabling turbo mode will also enable / disable the transferring media camera UI.

query Parameters

p<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

0 to disable, 1 to enable

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/turbo_transfer?p=0'

Response samples

200

Content type

application/json

{ }

Enable Wired camera control over USB

Supported Protocols:

usb
wifi

query Parameters

p<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

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

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/control/wired_usb?p=0'

Response samples

200

Content type

application/json

{ }

Keep Alive

Supported Protocols:

usb
wifi

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.

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/keep_alive

Response samples

200

Content type

application/json

{ }

Set Camera Control Status

Supported Protocols:

usb
wifi

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 most 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

query Parameters

p<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1 2 3

camera control status

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
3	CAMERA_COF_SETUP	Set by the camera when it is on the CAH (Camera As a Hub) / COF (Cloud Offload) setup screen

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/control/set_ui_controller?p=0'

Response samples

200

Content type

application/json

{ }

Set Date / Time

Supported Protocols:

usb
wifi

query Parameters

date<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: date=2023_12_31 current date in format YYYY_MM_DD
time<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: time=21_12_13 current time in format HH_MM_SS in 24 hour format
tzone<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: tzone=-480Timezone offset in minutes. See here for a listing of all UTC offsets. Not supported on Hero 10 Black Hero 9 Black
dst<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Enum: 0 1 Is daylight savings time active? Not supported on Hero 10 Black Hero 9 Black

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/set_date_time?date=2023_12_31&time=21_12_13&tzone=-480&dst=0'

Response samples

200

Content type

application/json

{ }

Set Digital Zoom

Supported Protocols:

usb
wifi

query Parameters

percent<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 100 ]

Example: percent=50

Zoom Level (0-100)

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/digital_zoom?percent=50'

Response samples

200

Content type

application/json

{ }

Set Shutter

Supported Protocols:

usb
wifi

path Parameters

mode<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Enum: "start" "stop"

Example: start

Start / stop encoding.

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/shutter/start

Response samples

200

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

Supported Protocols:

usb
wifi

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

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	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

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/hilight/file?path=100GOPRO/GOPR0002.MP4&ms=1'

Response samples

200

Content type

application/json

{ }

Hilight While Recording

Supported Protocols:

usb
wifi

Add hilight at current time while recording video

This can only be used during recording.

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/media/hilight/moment

Response samples

200
500

Content type

application/json

{ }

Remove Hilight

Supported Protocols:

usb
wifi

Remove an existing hilight from a photo or video file.

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	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

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/hilight/remove?path=100GOPRO/GOPR0002.MP4&ms=1'

Response samples

200
500

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

Delete All Files

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gp/gpControl/command/storage/delete/all

Response samples

200

Content type

application/json

{ }

Delete Grouped Media Item

Supported Protocols:

usb
wifi

Delete an entire group of media files such as in a burst, timelapse, or chaptered video. This API should not be used to delete single files. Instead use Delete Single File

query Parameters

p<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: p=105GOPRO/G0016880.JPG

The path to the group on the camera to delete. This path must be the first file in the group.

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gp/gpControl/command/storage/delete/group?p=105GOPRO/G0016880.JPG'

Response samples

200
400

Content type

application/json

{ }

Delete Single Media File

Supported Protocols:

usb
wifi

When operating on a file that is part of a group, only the individual file will be deleted. To delete the entire group, use Delete Grouped Media Item

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=105GOPRO/GOPR6879.JPG

path to media file to delete

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/delete/file?path=105GOPRO/GOPR6879.JPG'

Response samples

200
400

Content type

application/json

{ }

Download a Media File

Supported Protocols:

usb
wifi

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

path Parameters

directory<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: 100GOPRO Case sensitive directory that media resides in
filename<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Examples: GOPR0001.JPG - Sample photo file GH010397.MP4 - Sample video file Case sensitive media filename

Responses

Response Schema: application/octet-stream

string <binary>

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/videos/DCIM/100GOPRO/%7Bfilename%7D

Get Last Captured Media

Supported Protocols:

usb
wifi

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

Responses

Response Schema: application/json

file	string Example: "GOPR0002.JPG" Filename of media
folder	string Example: "100GOPRO" Directory in which the media is contained in

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/media/last_captured

Response samples

200
204

Content type

application/json

{

"file": "GOPR0002.JPG",


"folder": "100GOPRO"


}

Get Media File GPMF

Supported Protocols:

usb
wifi

None

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=100GOPRO/GOPR0002.JPG

media file name

Responses

Response Schema: application/octet-stream

string <binary>

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/gpmf?path=100GOPRO/GOPR0002.JPG'

Get Media File Info

Supported Protocols:

usb
wifi

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=100GOPRO/GOPR0002.JPG

media file name

Responses

Response Schema: application/json

Any of

ct<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1 2 3 4 5 6 8 9 10 11 12

Media content type

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

cre<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1692992748"

Creation time in seconds since epoch

s<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1234567890"

File size in bytes

gumi<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: "12345678998765443211234567899875"

Globally Unique Media ID

h<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1080"

Height of media in pixels

w<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1920"

Width of media in pixels

hc<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 99 ]

Number of hilights in media

eis<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if stabilized, 0 otherwise

mp<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if metadata is present, 0 otherwise

rot<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Deprecated

tr<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if file is transcoded, 0 otherwise

us<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

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

ao<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Enum: "auto" "wind" "stereo" "off"

Example: "auto"

Audio option

profile<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 255 ]

Advanced Video Codec Level

avc_profile<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 255 ]

Example: "0"

Advanced Video Code Profile

cl<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if clipped, 0 otherwise

dur<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "42"

Video duration in seconds

fps<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1001"

Video frame rate numerator

fps_denom<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "30000"

Video frame rate denominator

ls<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ -1 .. 1234567890 ]

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

pta<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if protune audio is present, 0 otherwise

subsample<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if subsampled from other video, 0 otherwise

fov

string

Field of View

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

mos

Array of strings

Items Enum: "app" "pc" "other"

Example: "app,pc"

List of offload states

prjn

integer

Enum: 0 1 2 3 4 5 6 7 8

Lens projection

ID	Mode
EAC	0
ERP	1
EAC, split horizontally in the middle for 2 output	2
ERP, cropped for panorama	3
Bypass stitch algorithm, side by side circles	4
Stitch is disabled, stitch algorithm is enabled for offline stitch	5
Stitch is disabled	6
Bypass stitch algorithm for EAC split	7
Hemisheric	8

progr

integer

Enum: 0 1

Is video progressive? 1 if progressive, 0 if interlaced

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/info?path=100GOPRO/GOPR0002.JPG'

Response samples

200

Content type

application/json

Example

VideoMetadata

{

"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": [

1500,
4700

],


"lc": 0,


"ls": -1,


"mos": [

"app",
"pc"

],


"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

Supported Protocols:

usb
wifi

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

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=100GOPRO/GOPR0002.JPG

media file name

Responses

Response Schema: application/octet-stream

string <binary>

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/screennail?path=100GOPRO/GOPR0002.JPG'

Get Media File Telemetry

Supported Protocols:

usb
wifi

Get Media File Telemetry track data

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=100GOPRO/GOPR0002.JPG

media file name

Responses

Response Schema: application/octet-stream

string <binary>

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/telemetry?path=100GOPRO/GOPR0002.JPG'

Get Media File Thumbnail

Supported Protocols:

usb
wifi

query Parameters

path<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: path=100GOPRO/GOPR0002.JPG

media file name

Responses

Response Schema: application/octet-stream

string <binary>

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/media/thumbnail?path=100GOPRO/GOPR0002.JPG'

Get Media List

Supported Protocols:

usb
wifi

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

Responses

Response Schema: application/json

id<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: "1554375628411872255"

media list identifier

<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

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

n required	string Example: "GOPR0001.JPG" Media filename
cre required	integer Example: "1696600109" Creation time in seconds since epoch
mod required	integer Example: "1696600109" Time file was last modified in seconds since epoch
s required	integer Example: "2806303" Size of media in bytes
glrv	integer Example: "817767" Low resolution video size
ls	integer Example: "-1" Low resolution file size. -1 if there is no LRV file
raw	integer Example: "1" Is set to 1 if this is a raw file

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/media/list

Response samples

200

Content type

application/json

{

"id": "1554375628411872255",


"media": [
{

"d": "100GOPRO",


"fs": [
{

"cre": 1696600109,


"glrv": 817767,


"ls": -1,


"mod": 1696600109,


"n": "GOPR0001.JPG",


"raw": 1,


"s": 2806303


}

]


}

]


}

Models

Common data models used across operations

GroupedMediaListItem

n<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: "G0010011.MP4" Media filename
cre<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1696600109" Creation time in seconds since epoch
mod<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1696600109" Time file was last modified in seconds since epoch
g<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1" Group Identifier
s<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "5" Number of files in the group
b<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1" ID of first member in the group
l<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "6" ID of last member in the group
m<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	Array of integers Example: "1,2" File ID's that are missing or deleted
t<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Enum: "b" "c" "n" "t" Group Type (b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse)
glrv	integer Example: "817767" Low resolution video size
id	string Media list session identifier
ls	integer Example: "-1" Low resolution file size. -1 if there is no LRV file

{

"b": 1,


"cre": 1696600109,


"g": 1,


"glrv": 817767,


"id": "string",


"l": 6,


"ls": -1,


"m": [

1,
2

],


"mod": 1696600109,


"n": "G0010011.MP4",


"s": 5,


"t": "b"


}

MediaList

id<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: "1554375628411872255"

media list identifier

<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

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

n required	string Example: "GOPR0001.JPG" Media filename
cre required	integer Example: "1696600109" Creation time in seconds since epoch
mod required	integer Example: "1696600109" Time file was last modified in seconds since epoch
s required	integer Example: "2806303" Size of media in bytes
glrv	integer Example: "817767" Low resolution video size
ls	integer Example: "-1" Low resolution file size. -1 if there is no LRV file
raw	integer Example: "1" Is set to 1 if this is a raw file

{

"id": "1554375628411872255",


"media": [
{

"d": "100GOPRO",


"fs": [
{

"cre": 1696600109,


"glrv": 817767,


"ls": -1,


"mod": 1696600109,


"n": "GOPR0001.JPG",


"raw": 1,


"s": 2806303


}

]


}

]


}

PhotoMetadata

ct<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1 2 3 4 5 6 8 9 10 11 12

Media content type

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

cre<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1692992748"

Creation time in seconds since epoch

s<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1234567890"

File size in bytes

gumi<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: "12345678998765443211234567899875"

Globally Unique Media ID

h<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1080"

Height of media in pixels

w<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1920"

Width of media in pixels

hc<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 99 ]

Number of hilights in media

eis<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if stabilized, 0 otherwise

mp<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if metadata is present, 0 otherwise

rot<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Deprecated

tr<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if file is transcoded, 0 otherwise

us<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

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

fov

string

Field of View

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

prjn

integer

Enum: 0 1 2 3 4 5 6 7 8

Lens projection

ID	Mode
EAC	0
ERP	1
EAC, split horizontally in the middle for 2 output	2
ERP, cropped for panorama	3
Bypass stitch algorithm, side by side circles	4
Stitch is disabled, stitch algorithm is enabled for offline stitch	5
Stitch is disabled	6
Bypass stitch algorithm for EAC split	7
Hemisheric	8

raw

integer

Enum: 0 1

1 if photo has raw version, 0 otherwise

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": [

"app",
"pc"

],


"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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 55 56 57 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 80 81 82 83 84 85 89 90 91 100 101 102 1000 1001

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
34	PRESET_ICON_STARS
35	PRESET_ICON_ACTION
36	PRESET_ICON_FOLLOW_CAM
37	PRESET_ICON_SURF
38	PRESET_ICON_CITY
39	PRESET_ICON_SHAKY
40	PRESET_ICON_CHESTY
41	PRESET_ICON_HELMET
42	PRESET_ICON_BITE
43	PRESET_ICON_CUSTOM_CINEMATIC
44	PRESET_ICON_VLOG
45	PRESET_ICON_FPV
46	PRESET_ICON_HDR
47	PRESET_ICON_LANDSCAPE
48	PRESET_ICON_LOG
49	PRESET_ICON_CUSTOM_SLOMO
50	PRESET_ICON_TRIPOD
55	PRESET_ICON_MAX_VIDEO
56	PRESET_ICON_MAX_PHOTO
57	PRESET_ICON_MAX_TIMEWARP
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
80	PRESET_ICON_EASY_MAX_VIDEO
81	PRESET_ICON_EASY_MAX_PHOTO
82	PRESET_ICON_EASY_MAX_TIMEWARP
83	PRESET_ICON_EASY_MAX_STAR_TRAIL
84	PRESET_ICON_EASY_MAX_LIGHT_PAINTING
85	PRESET_ICON_EASY_MAX_LIGHT_TRAIL
89	PRESET_ICON_MAX_STAR_TRAIL
90	PRESET_ICON_MAX_LIGHT_PAINTING
91	PRESET_ICON_MAX_LIGHT_TRAIL
100	PRESET_ICON_EASY_STANDARD_PROFILE
101	PRESET_ICON_EASY_HDR_PROFILE
102	PRESET_ICON_BURST_SLOMO
1000	PRESET_ICON_TIMELAPSE_PHOTO
1001	PRESET_ICON_NIGHTLAPSE_PHOTO

id

integer <int32>

Unique preset identifier

isFixed

boolean

Is this preset mutable?

isModified

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 32

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
32	FLAT_MODE_VIDEO_BURST_SLOMO

Array of objects (PresetSetting)

Array

id	integer <int32> Setting identifier
isCaption	boolean Does this setting appear on the Preset "pill" in the camera UI?
value	integer <int32> Setting value

titleId

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 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 99 100 106

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
34	PRESET_TITLE_STARS
35	PRESET_TITLE_ACTION
36	PRESET_TITLE_FOLLOW_CAM
37	PRESET_TITLE_SURF
38	PRESET_TITLE_CITY
39	PRESET_TITLE_SHAKY
40	PRESET_TITLE_CHESTY
41	PRESET_TITLE_HELMET
42	PRESET_TITLE_BITE
43	PRESET_TITLE_CUSTOM_CINEMATIC
44	PRESET_TITLE_VLOG
45	PRESET_TITLE_FPV
46	PRESET_TITLE_HDR
47	PRESET_TITLE_LANDSCAPE
48	PRESET_TITLE_LOG
49	PRESET_TITLE_CUSTOM_SLOMO
50	PRESET_TITLE_TRIPOD
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
99	PRESET_TITLE_EASY_STANDARD_PROFILE
100	PRESET_TITLE_EASY_HDR_PROFILE
106	PRESET_TITLE_BURST_SLOMO

titleNumber

integer <int32>

Preset title number

userDefined

boolean

Is this preset user defined?

{

"icon": 0,


"id": 0,


"isFixed": true,


"isModified": true,


"mode": -1,


"settingArray": [
{

"id": 0,


"isCaption": true,


"value": 0


}

],


"titleId": 0,


"titleNumber": 0,


"userDefined": true


}

PresetGroup

canAddPreset

boolean

Is there room in the group to add additional Presets?

icon

integer (EnumPresetGroupIcon)

Enum: 0 1 2 3 4 5 6 7 8 9 10

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
8	PRESET_GROUP_ND_MOD_VIDEO_ICON_ID
9	PRESET_GROUP_ND_MOD_PHOTO_ICON_ID
10	PRESET_GROUP_ND_MOD_TIMELAPSE_ICON_ID

id

integer (EnumPresetGroup)

Enum: 1000 1001 1002

ID	Name	Summary
1000	PRESET_GROUP_ID_VIDEO
1001	PRESET_GROUP_ID_PHOTO
1002	PRESET_GROUP_ID_TIMELAPSE

modeArray

Array of integers (EnumFlatMode)

Items Enum: -1 4 5 12 13 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Array of Flatmodes available for this preset group

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
32	FLAT_MODE_VIDEO_BURST_SLOMO

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 55 56 57 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 80 81 82 83 84 85 89 90 91 100 101 102 1000 1001

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
34	PRESET_ICON_STARS
35	PRESET_ICON_ACTION
36	PRESET_ICON_FOLLOW_CAM
37	PRESET_ICON_SURF
38	PRESET_ICON_CITY
39	PRESET_ICON_SHAKY
40	PRESET_ICON_CHESTY
41	PRESET_ICON_HELMET
42	PRESET_ICON_BITE
43	PRESET_ICON_CUSTOM_CINEMATIC
44	PRESET_ICON_VLOG
45	PRESET_ICON_FPV
46	PRESET_ICON_HDR
47	PRESET_ICON_LANDSCAPE
48	PRESET_ICON_LOG
49	PRESET_ICON_CUSTOM_SLOMO
50	PRESET_ICON_TRIPOD
55	PRESET_ICON_MAX_VIDEO
56	PRESET_ICON_MAX_PHOTO
57	PRESET_ICON_MAX_TIMEWARP
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
80	PRESET_ICON_EASY_MAX_VIDEO
81	PRESET_ICON_EASY_MAX_PHOTO
82	PRESET_ICON_EASY_MAX_TIMEWARP
83	PRESET_ICON_EASY_MAX_STAR_TRAIL
84	PRESET_ICON_EASY_MAX_LIGHT_PAINTING
85	PRESET_ICON_EASY_MAX_LIGHT_TRAIL
89	PRESET_ICON_MAX_STAR_TRAIL
90	PRESET_ICON_MAX_LIGHT_PAINTING
91	PRESET_ICON_MAX_LIGHT_TRAIL
100	PRESET_ICON_EASY_STANDARD_PROFILE
101	PRESET_ICON_EASY_HDR_PROFILE
102	PRESET_ICON_BURST_SLOMO
1000	PRESET_ICON_TIMELAPSE_PHOTO
1001	PRESET_ICON_NIGHTLAPSE_PHOTO

id

integer <int32>

Unique preset identifier

isFixed

boolean

Is this preset mutable?

isModified

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 32

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
32	FLAT_MODE_VIDEO_BURST_SLOMO

Array of objects (PresetSetting)

Array

id	integer <int32> Setting identifier
isCaption	boolean Does this setting appear on the Preset "pill" in the camera UI?
value	integer <int32> Setting value

titleId

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 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 99 100 106

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
34	PRESET_TITLE_STARS
35	PRESET_TITLE_ACTION
36	PRESET_TITLE_FOLLOW_CAM
37	PRESET_TITLE_SURF
38	PRESET_TITLE_CITY
39	PRESET_TITLE_SHAKY
40	PRESET_TITLE_CHESTY
41	PRESET_TITLE_HELMET
42	PRESET_TITLE_BITE
43	PRESET_TITLE_CUSTOM_CINEMATIC
44	PRESET_TITLE_VLOG
45	PRESET_TITLE_FPV
46	PRESET_TITLE_HDR
47	PRESET_TITLE_LANDSCAPE
48	PRESET_TITLE_LOG
49	PRESET_TITLE_CUSTOM_SLOMO
50	PRESET_TITLE_TRIPOD
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
99	PRESET_TITLE_EASY_STANDARD_PROFILE
100	PRESET_TITLE_EASY_HDR_PROFILE
106	PRESET_TITLE_BURST_SLOMO

titleNumber

integer <int32>

Preset title number

userDefined

boolean

Is this preset user defined?

{

"canAddPreset": true,


"icon": 0,


"id": 1000,


"modeArray": [-1
],


"presetArray": [
{

"icon": 0,


"id": 0,


"isFixed": true,


"isModified": true,


"mode": -1,


"settingArray": [
{

"id": 0,


"isCaption": true,


"value": 0


}

],


"titleId": 0,


"titleNumber": 0,


"userDefined": true


}

]


}

PresetSetting

id	integer <int32> Setting identifier
isCaption	boolean Does this setting appear on the Preset "pill" in the camera UI?
value	integer <int32> Setting value

{

"id": 0,


"isCaption": true,


"value": 0


}

SettingCapabilities

Array

display_name	string Human readable option name.
id	integer Option identifier.

[
{

"display_name": "string",


"id": 0


}

]

SingleMediaListItem

n<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: "GOPR0001.JPG" Media filename
cre<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1696600109" Creation time in seconds since epoch
mod<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "1696600109" Time file was last modified in seconds since epoch
s<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	integer Example: "2806303" Size of media in bytes
glrv	integer Example: "817767" Low resolution video size
ls	integer Example: "-1" Low resolution file size. -1 if there is no LRV file
raw	integer Example: "1" Is set to 1 if this is a raw file

{

"cre": 1696600109,


"glrv": 817767,


"ls": -1,


"mod": 1696600109,


"n": "GOPR0001.JPG",


"raw": 1,


"s": 2806303


}

State

object

All currently known setting values indexed by setting ID

2

integer

Enum: 1 4 6 7 9 12 18 24 25 26 27 28 37 38 100 107 108 109 110 111

Video Resolution

Value	Meaning	Supported Cameras
1	4K
4	2.7K
6	2.7K 4:3
7	1440
9	1080
12	720
18	4K 4:3
24	5K
25	5K 4:3
26	5.3K 8:7
27	5.3K 4:3
28	4K 8:7
37	4K 1:1
38	900
100	5.3K
107	5.3K 8:7 V2
108	4K 8:7 V2
109	4K 9:16 V2
110	1080 9:16 V2
111	2.7K 4:3 V2

3

integer

Enum: 0 1 2 5 6 8 9 10 13

Frames Per Second

Value	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0

5

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11

Video Timelapse Rate

Value	Meaning	Supported Cameras
0	0.5 Seconds
1	1 Second
2	2 Seconds
3	5 Seconds
4	10 Seconds
5	30 Seconds
6	60 Seconds
7	2 Minutes
8	5 Minutes
9	30 Minutes
10	60 Minutes
11	3 Seconds

How frequently to take a video when performing a Video Timelapse

30

integer

Enum: 11 100 101 102 103 104 105 106 107 108 109 110

Photo Timelapse Rate

Value	Meaning	Supported Cameras
11	3 Seconds
100	60 Minutes
101	30 Minutes
102	5 Minutes
103	2 Minutes
104	60 Seconds
105	30 Seconds
106	10 Seconds
107	5 Seconds
108	2 Seconds
109	1 Second
110	0.5 Seconds

How frequently to take a photo when performing a Photo Timelapse.

32

integer

Enum: 4 5 10 15 20 30 100 120 300 1800 3600 3601

Nightlapse Rate

Value	Meaning	Supported Cameras
4	4 Seconds
5	5 Seconds
10	10 Seconds
15	15 Seconds
20	20 Seconds
30	30 Seconds
100	60 Seconds
120	2 Minutes
300	5 Minutes
1800	30 Minutes
3600	60 Minutes
3601	Auto

How frequently to take a video or photo when performing a Nightlapse.

This controls the Video or Photo Nightlapse rate if Setting 128 is set to 21 or 26 respectively.

43

integer

Enum: 0 2 3 4

Webcam Digital Lenses

Value	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear

59

integer

Enum: 0 1 4 6 7 11 12

Auto Power Down

Value	Meaning	Supported Cameras
0	Never
1	1 Min
4	5 Min
6	15 Min
7	30 Min
11	8 Seconds
12	30 Seconds

83

integer

Enum: 0 1

GPS

Value	Meaning	Supported Cameras
0	Off
1	On

108

integer

Enum: 0 1 3 4

Video Aspect Ratio

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

121

integer

Enum: 0 2 3 4 7 8 9 10 11 12 13 104

Video Lens

Value	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear
7	Max SuperView
8	Linear + Horizon Leveling
9	HyperView
10	Linear + Horizon Lock
11	Max HyperView
12	Ultra SuperView
13	Ultra Wide
104	Ultra HyperView

122

integer

Enum: 0 10 19 27 28 31 32 41 100 101 102

Photo Lens

Value	Meaning	Supported Cameras
0	Wide 12 MP
10	Linear 12 MP
19	Narrow
27	Wide 23 MP
28	Linear 13 MP
31	Wide 27 MP
32	Linear 27 MP
41	Ultra Wide 12 MP
100	Max SuperView
101	Wide
102	Linear

123

integer

Enum: 19 31 32 100 101 102

Time Lapse Digital Lenses

Value	Meaning	Supported Cameras
19	Narrow
31	Wide 27 MP
32	Linear 27 MP
100	Max SuperView
101	Wide
102	Linear

125

integer

Enum: 0 1 2 3

Photo Output

Value	Meaning	Supported Cameras
0	Standard
1	Raw
2	HDR
3	SuperPhoto

128

integer

Enum: 13 20 21 26

Media Format

Value	Meaning	Supported Cameras
13	Time Lapse Video
20	Time Lapse Photo
21	Night Lapse Photo
26	Night Lapse Video

134

integer

Enum: 0 1 2 3

Anti-Flicker

Value	Meaning	Supported Cameras
0	NTSC
1	PAL
2	60Hz
3	50Hz

135

integer

Enum: 0 1 2 3 4 100

Hypersmooth

Value	Meaning	Supported Cameras
0	Off
1	Low
2	High
3	Boost
4	Auto Boost
100	Standard

150

integer

Enum: 0 2

Video Horizon Leveling

Value	Meaning	Supported Cameras
0	Off
2	Locked

151

integer

Enum: 0 2

Photo Horizon Leveling

Value	Meaning	Supported Cameras
0	Off
2	Locked

162

integer

Enum: 0 1

Max Lens

Value	Meaning	Supported Cameras
0	Off
1	On

167

integer

Enum: 2 3 4

HindSight

Value	Meaning	Supported Cameras
2	15 Seconds
3	30 Seconds
4	Off

171

integer

Enum: 0 2 3 4 5 6 7 8 9 10

Photo Single Interval

Value	Meaning	Supported Cameras
0	Off
2	0.5s
3	1s
4	2s
5	5s
6	10s
7	30s
8	60s
9	120s
10	3s

172

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Photo Interval Duration

Value	Meaning	Supported Cameras
0	Off
1	15 Seconds
2	30 Seconds
3	1 Minute
4	5 Minutes
5	15 Minutes
6	30 Minutes
7	1 Hour
8	2 Hours
9	3 Hours

173

integer

Enum: 0 1 2

Video Performance Mode

Value	Meaning	Supported Cameras
0	Maximum Video Performance
1	Extended Battery
2	Tripod / Stationary Video

175

integer

Enum: 0 1

Controls

Value	Meaning	Supported Cameras
0	Easy
1	Pro

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 138 139 140 141 152 153 154 155 156 157 158 159

Easy Mode Speed

Value	Meaning	Supported Cameras
0	8X Ultra Slo-Mo
1	4X Super Slo-Mo
2	2X Slo-Mo
3	1X Speed (Low Light)
4	4X Super Slo-Mo (Ext. Batt.)
5	2X Slo-Mo (Ext. Batt.)
6	1X Speed (Ext. Batt.) (Low Light)
7	8X Ultra Slo-Mo (50Hz)
8	4X Super Slo-Mo (50Hz)
9	2X Slo-Mo (50Hz)
10	1X Speed (50Hz) (Low Light)
11	4X Super Slo-Mo (50Hz) (Ext. Batt.)
12	2X Slo-Mo (50Hz) (Ext. Batt.)
13	1X Speed (50Hz) (Ext. Batt.) (Low Light)
14	8X Ultra Slo-Mo (Ext. Batt.)
15	8X Ultra Slo-Mo (50Hz) (Ext. Batt.)
16	8X Ultra Slo-Mo (Long. Batt.)
17	4X Super Slo-Mo (Long. Batt.)
18	2X Slo-Mo (Long. Batt.)
19	1X Speed (Long. Batt.) (Low Light)
20	8X Ultra Slo-Mo (50Hz) (Long. Batt.)
21	4X Super Slo-Mo (50Hz) (Long. Batt.)
22	2X Slo-Mo (50Hz) (Long. Batt.)
23	1X Speed (50Hz) (Long. Batt.) (Low Light)
24	2X Slo-Mo (4K)
25	4X Super Slo-Mo (2.7K)
26	2X Slo-Mo (4K) (50Hz)
27	4X Super Slo-Mo (2.7K) (50Hz)
100	8X Ultra Slo-Mo (V2)
101	4X Super Slo-Mo (V2)
102	2X Slo-Mo (V2)
103	1X Speed (Low Light) (V2)
104	8X Ultra Slo-Mo (50Hz) (V2)
105	4X Super Slo-Mo (50Hz) (V2)
106	2X Slo-Mo (50Hz) (V2)
107	1X Speed (50Hz) (Low Light) (V2)
108	8X Ultra Slo-Mo (Long. Batt.) (V2)
109	4X Super Slo-Mo (Long. Batt.) (V2)
110	2X Slo-Mo (Long. Batt.) (V2)
111	1X Speed (Long. Batt.) (Low Light) (V2)
112	8X Ultra Slo-Mo (50Hz) (Long. Batt.) (V2)
113	4X Super Slo-Mo (50Hz) (Long. Batt.) (V2)
114	2X Slo-Mo (50Hz) (Long. Batt.) (V2)
115	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2)
116	2X Slo-Mo (4K) (V2)
117	2X Slo-Mo (4K) (50Hz) (V2)
118	1X Speed (Low Light) (V2) (Vertical)
119	1X Speed (50Hz) (Low Light) (V2) (Vertical)
120	2X Slo-Mo (V2) (Vertical)
121	2X Slo-Mo (50Hz) (V2) (Vertical)
122	1X Speed (Full Frame) (Low Light) (V2)
123	1X Speed (50Hz) (Full Frame) (Low Light) (V2)
124	2X Slo-Mo (Full Frame) (V2)
125	2X Slo-Mo (50Hz) (Full Frame) (V2)
126	1X Speed (4K) (Low Light) (V2)
127	1X Speed (4K) (50Hz) (Low Light) (V2)
128	1X Speed (2.7K) (Low Light) (V2)
129	1X Speed (2.7K) (50Hz) (Low Light) (V2)
130	2X Slo-Mo (2.7K) (V2)
131	2X Slo-Mo (2.7K) (50Hz) (V2)
132	2X Slo-Mo (Long. Batt.) (V2) (Vertical)
133	2X Slo-Mo (50Hz) (Long. Batt.) (V2) (Vertical)
134	1X Speed (Long. Batt.) (Low Light) (V2) (Vertical)
135	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2) (Vertical)
136	1X Speed (4K) (Full Frame) (Low Light) (V2)
137	1X Speed (4K) (50Hz) (Full Frame) (Low Light) (V2)
138	1X Normal Speed (1:1) (30 Fps) (4K) (V2)
139	1X Normal Speed (1:1) (25 Fps) (4K) (V2)
140	2X Slo-Mo Speed (1:1) (4K) (60 Fps) (V2)
141	2X Slo-Mo Speed (1:1) (4K) (50 Fps) (V2)
152	1X Normal Speed (30 Fps) (4:3) (5.3K) (V2)
153	1X Normal Speed (25 Fps) (4:3) (5.3K) (V2)
154	1X Normal Speed (30 Fps) (4:3) (4K) (V2)
155	1X Normal Speed (25 Fps) (4:3) (4K) (V2)
156	2X Slo-Mo Speed (4:3) (4K) (60 Fps) (V2)
157	2X Slo-Mo Speed (4:3) (4K) (50 Fps) (V2)
158	120 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)
159	100 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)

177

integer

Enum: 0 1

Enable Night Photo

Value	Meaning	Supported Cameras
0	Off
1	On

178

integer

Enum: 0 1

Wireless Band

Value	Meaning	Supported Cameras
0	2.4GHz
1	5GHz

179

integer

Enum: 1 2 3

Star Trails Length

Value	Meaning	Supported Cameras
1	Short
2	Long
3	Max

180

integer

Enum: 0 101 102 111 112

System Video Mode

Value	Meaning	Supported Cameras
0	Highest Quality
101	Extended Battery
102	Longest Battery
111	Standard Quality
112	Basic Quality

182

integer

Enum: 0 1

Video Bit Rate

Value	Meaning	Supported Cameras
0	Standard
1	High

183

integer

Enum: 0 2

Bit Depth

Value	Meaning	Supported Cameras
0	8-Bit
2	10-Bit

184

integer

Enum: 0 1 2 101

Profiles

Value	Meaning	Supported Cameras
0	Standard
1	HDR
2	Log
101	HLG HDR

186

integer

Enum: 0 1 2 3 4

Video Easy Mode

Value	Meaning	Supported Cameras
0	Highest Quality
1	Standard Quality
2	Basic Quality
3	Standard Video
4	HDR Video

187

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Lapse Mode

Value	Meaning	Supported Cameras
0	TimeWarp
1	Star Trails
2	Light Painting
3	Vehicle Lights
4	Max TimeWarp
5	Max Star Trails
6	Max Light Painting
7	Max Vehicle Lights
8	Time Lapse Video
9	Night Lapse Video

189

integer

Enum: 0 1 2 3 4 6 7 8 9 10 100

Max Lens Mod

Value	Meaning	Supported Cameras
0	None
1	Max Lens 1.0
2	Max Lens 2.0
3	Max Lens 2.5
4	Macro
6	ND 4
7	ND 8
8	ND 16
9	ND 32
10	Standard Lens
100	Auto Detect

190

integer

Enum: 0 1

Max Lens Mod Enable

Value	Meaning	Supported Cameras
0	Off
1	On

191

integer

Enum: 0 1

Easy Night Photo

Value	Meaning	Supported Cameras
0	Super Photo
1	Night Photo

192

integer

Enum: 0 1 3

Multi Shot Aspect Ratio

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7

193

integer

Enum: 0 1 2 100 101 103 104 106

Framing

Value	Meaning	Supported Cameras
0	Widescreen
1	Vertical
2	Full Frame
100	Traditional 4:3 v2
101	Widescreen 16:9 v2
103	Full Frame 8:7 v2
104	Vertical 9:16 v2
106	Full Frame 1:1 v2

216

integer

Enum: 70 85 100

Camera Volume

Value	Meaning	Supported Cameras
70	Low
85	Medium
100	High

219

integer

Enum: 1 2 3 4

Setup Screen Saver

Value	Meaning	Supported Cameras
1	1 Min
2	2 Min
3	3 Min
4	5 Min

223

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14

Setup Language

Value	Meaning	Supported Cameras
0	English - US
1	English - UK
2	English - AUS
3	German
4	French
5	Italian
6	Spanish
7	Spanish - NA
8	Chinese
9	Japanese
10	Korean
11	Portuguese
12	Russian
13	English - IND
14	Swedish

227

integer

Enum: 0 1 2

Photo Mode

Value	Meaning	Supported Cameras
0	SuperPhoto
1	Night Photo
2	Burst

232

integer

Enum: 0 1 3 4 6

Video Framing

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16
6	1:1

233

integer

Enum: 0 1 3 4

Multi Shot Framing

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

234

integer

Enum: 0 1 2 5 6 8 9 10 13 15 16 17

Frame Rate

Value	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0
15	400.0
16	360.0
17	300.0

object

All currently known status values indexed by status ID

1

integer

Enum: 0 1

Battery Present

2

integer

Enum: 0 1 2 3 4

Internal Battery Bars

Value	Meaning
0	Zero
1	One
2	Two
3	Three
4	Charging

Rough approximation of internal battery level in bars (or charging)

6

integer

Enum: 0 1

Overheating

8

integer

Enum: 0 1

Busy

9

integer

Enum: 0 1

Quick Capture

10

integer

Enum: 0 1

Encoding

11

integer

Enum: 0 1

LCD Lock

13

integer <int32ub>

Video Encoding Duration

17

integer

Enum: 0 1

Wireless Connections Enabled

19

integer

Enum: 0 1 2 3 4

Pairing State

Value	Meaning
0	Never Started
1	Started
2	Aborted
3	Cancelled
4	Completed

20

integer

Enum: 0 1 2 3

Last Pairing Type

Value	Meaning
0	Not Pairing
1	Pairing App
2	Pairing Remote Control
3	Pairing Bluetooth Device

The last type of pairing in which the camera was engaged

21

integer <int32ub>

Last Pairing Success

22

integer

Enum: 0 1 2 3 4

Wifi Scan State

Value	Meaning
0	Never started
1	Started
2	Aborted
3	Canceled
4	Completed

State of current scan for WiFi Access Points

23

integer <int8ub>

Last Wifi Scan Success

24

integer

Enum: 0 1 2 3 4

Wifi Provisioning State

Value	Meaning
0	Never started
1	Started
2	Aborted
3	Canceled
4	Completed

WiFi AP provisioning state

26

integer <int8ub>

Remote Version

27

integer

Enum: 0 1

Remote Connected

28

integer <unspecified>

Pairing State (Legacy)

29

string

AP SSID

30

string

WiFi SSID

31

integer <int8ub>

Connected Devices

32

integer

Enum: 0 1

Preview Stream

33

integer

Enum: -1 0 1 2 3 4 8

Primary Storage

Value	Meaning
-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

integer <int32ub>

Remaining Photos

35

integer <int32ub>

Remaining Video Time

38

integer <int32ub>

Photos

39

integer <int32ub>

Videos

41

integer

Enum: 0 1 10 2 3 4 5 6 7 8 9

OTA

Value	Meaning
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

The current status of Over The Air (OTA) update

42

integer

Enum: 0 1

Pending FW Update Cancel

45

integer

Enum: 0 1

Locate

49

integer <int32ub>

Timelapse Interval Countdown

54

integer <int64ub>

SD Card Remaining

55

integer

Enum: 0 1

Preview Stream Available

56

integer <int8ub>

Wifi Bars

58

integer <int8ub>

Active Hilights

59

integer <int32ub>

Time Since Last Hilight

60

integer <int32ub>

Minimum Status Poll Period

65

integer

Enum: 0 1 2 3

Liveview Exposure Select Mode

Value	Meaning
0	Disabled
1	Auto
2	ISO Lock
3	Hemisphere

66

integer <int8ub>

Liveview Y

67

integer <int8ub>

Liveview X

68

integer

Enum: 0 1

GPS Lock

69

integer

Enum: 0 1

AP Mode

70

integer <int8ub>

Internal Battery Percentage

74

integer

Enum: 0 1 2

Microphone Accessory

Value	Meaning
0	Accessory not connected
1	Accessory connected
2	Accessory connected and a microphone is plugged into the accessory

75

integer <int8ub>

Zoom Level

76

integer

Enum: 0 1

Wireless Band

Value	Meaning
0	2.4 GHz
1	5 GHz

77

integer

Enum: 0 1

Zoom Available

78

integer

Enum: 0 1

Mobile Friendly

79

integer

Enum: 0 1

FTU

81

integer

Enum: 0 1

5GHZ Available

82

integer

Enum: 0 1

Ready

83

integer

Enum: 0 1

OTA Charged

85

integer

Enum: 0 1

Cold

86

integer

Enum: 0 1 2 3

Rotation

Value	Meaning
0	0 degrees (upright)
1	180 degrees (upside down)
2	90 degrees (laying on right side)
3	270 degrees (laying on left side)

Rotational orientation of the camera

88

integer

Enum: 0 1

Zoom while Encoding

89

integer <unspecified>

Flatmode

93

integer <int32ub>

Video Preset

94

integer <int32ub>

Photo Preset

95

integer <int32ub>

Timelapse Preset

96

integer <int32ub>

Preset Group

97

integer <int32ub>

Preset

98

integer <int32ub>

Preset Modified

99

integer <int32ub>

Remaining Live Bursts

100

integer <int32ub>

Live Bursts

101

integer

Enum: 0 1

Capture Delay Active

102

integer

Enum: 0 2 3

Media Mod State

Value	Meaning
0	Microphone removed
2	Microphone only
3	Microphone with external microphone

103

integer

Enum: 0 1 10 11 12 2 3 4 5 6 7 8 9

Time Warp Speed

Value	Meaning
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

integer

Enum: 0 1

Linux Core

105

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Lens Type

Value	Meaning
0	Default
1	Max Lens
2	Max Lens 2.0
3	Max Lens 2.5
4	Macro Lens
5	Anamorphic Lens
6	Neutral Density 4
7	Neutral Density 8
8	Neutral Density 16
9	Neutral Density 32

Camera lens type (reflects changes to lens settings such as 162, 189, 194, ...)

106

integer

Enum: 0 1

Hindsight

107

integer <int32ub>

Scheduled Capture Preset ID

108

integer

Enum: 0 1

Scheduled Capture

110

integer

Enum: 0 1 2 3 4 5 6 7

Display Mod Status

Value	Meaning
0	000 = Display Mod: 0, HDMI: 0, Display Mod Connected: False
1	001 = Display Mod: 0, HDMI: 0, Display Mod Connected: True
2	010 = Display Mod: 0, HDMI: 1, Display Mod Connected: False
3	011 = Display Mod: 0, HDMI: 1, Display Mod Connected: True
4	100 = Display Mod: 1, HDMI: 0, Display Mod Connected: False
5	101 = Display Mod: 1, HDMI: 0, Display Mod Connected: True
6	110 = Display Mod: 1, HDMI: 1, Display Mod Connected: False
7	111 = Display Mod: 1, HDMI: 1, Display Mod Connected: True

Note that this is a bitmasked value.

111

integer

Enum: 0 1

SD Card Write Speed Error

112

integer <int8ub>

SD Card Errors

113

integer

Enum: 0 1

Turbo Transfer

114

integer

Enum: 0 1 2

Camera Control ID

Value	Meaning
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

Camera control status ID

115

integer

Enum: 0 1

USB Connected

116

integer

Enum: 0 1

USB Controlled

Value	Meaning
0	Disabled
1	Enabled

Camera control over USB state

117

integer <int32ub>

SD Card Capacity

118

integer <unspecified>

Photo Interval Capture Count

{

"settings": {

"2": 1,


"3": 0,


"5": 0,


"30": 11,


"32": 4,


"43": 0,


"59": 0,


"83": 0,


"108": 0,


"121": 0,


"122": 0,


"123": 19,


"125": 0,


"128": 13,


"134": 0,


"135": 0,


"150": 0,


"151": 0,


"162": 0,


"167": 2,


"171": 0,


"172": 0,


"173": 0,


"175": 0,


"176": 0,


"177": 0,


"178": 0,


"179": 1,


"180": 0,


"182": 0,


"183": 0,


"184": 0,


"186": 0,


"187": 0,


"189": 0,


"190": 0,


"191": 0,


"192": 0,


"193": 0,


"216": 70,


"219": 1,


"223": 0,


"227": 0,


"232": 0,


"233": 0,


"234": 0


},


"status": {

"1": 0,


"2": 0,


"6": 0,


"8": 0,


"9": 0,


"10": 0,


"11": 0,


"13": 0,


"17": 0,


"19": 0,


"20": 0,


"21": 0,


"22": 0,


"23": 0,


"24": 0,


"26": 0,


"27": 0,


"28": 0,


"29": "string",


"30": "string",


"31": 0,


"32": 0,


"33": -1,


"34": 0,


"35": 0,


"38": 0,


"39": 0,


"41": 0,


"42": 0,


"45": 0,


"49": 0,


"54": 0,


"55": 0,


"56": 0,


"58": 0,


"59": 0,


"60": 0,


"65": 0,


"66": 0,


"67": 0,


"68": 0,


"69": 0,


"70": 0,


"74": 0,


"75": 0,


"76": 0,


"77": 0,


"78": 0,


"79": 0,


"81": 0,


"82": 0,


"83": 0,


"85": 0,


"86": 0,


"88": 0,


"89": 0,


"93": 0,


"94": 0,


"95": 0,


"96": 0,


"97": 0,


"98": 0,


"99": 0,


"100": 0,


"101": 0,


"102": 0,


"103": 0,


"104": 0,


"105": 0,


"106": 0,


"107": 0,


"108": 0,


"110": 0,


"111": 0,


"112": 0,


"113": 0,


"114": 0,


"115": 0,


"116": 0,


"117": 0,


"118": 0


}


}

VideoMetadata

ct<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1 2 3 4 5 6 8 9 10 11 12

Media content type

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

cre<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1692992748"

Creation time in seconds since epoch

s<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1234567890"

File size in bytes

gumi<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Example: "12345678998765443211234567899875"

Globally Unique Media ID

h<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1080"

Height of media in pixels

w<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1920"

Width of media in pixels

hc<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 99 ]

Number of hilights in media

eis<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if stabilized, 0 otherwise

mp<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if metadata is present, 0 otherwise

rot<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Deprecated

tr<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if file is transcoded, 0 otherwise

us<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

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

ao<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

string

Enum: "auto" "wind" "stereo" "off"

Example: "auto"

Audio option

profile<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 255 ]

Advanced Video Codec Level

avc_profile<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ 0 .. 255 ]

Example: "0"

Advanced Video Code Profile

cl<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if clipped, 0 otherwise

dur<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "42"

Video duration in seconds

fps<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "1001"

Video frame rate numerator

fps_denom<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Example: "30000"

Video frame rate denominator

ls<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer [ -1 .. 1234567890 ]

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

pta<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if protune audio is present, 0 otherwise

subsample<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 0 1

1 if subsampled from other video, 0 otherwise

fov

string

Field of View

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

mos

Array of strings

Items Enum: "app" "pc" "other"

Example: "app,pc"

List of offload states

prjn

integer

Enum: 0 1 2 3 4 5 6 7 8

Lens projection

ID	Mode
EAC	0
ERP	1
EAC, split horizontally in the middle for 2 output	2
ERP, cropped for panorama	3
Bypass stitch algorithm, side by side circles	4
Stitch is disabled, stitch algorithm is enabled for offline stitch	5
Stitch is disabled	6
Bypass stitch algorithm for EAC split	7
Hemisheric	8

progr

integer

Enum: 0 1

Is video progressive? 1 if progressive, 0 if interlaced

{

"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": [

1500,
4700

],


"lc": 0,


"ls": -1,


"mos": [

"app",
"pc"

],


"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

Supported Protocols:

usb
wifi

Perform Resumable OTA Update

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

query Parameters

request

string

Enum: "delete" "showui" "start" "progress" "cancelled"

Example: request=progress

Optional request parameter to control / query OTA functionality.

Parameter	Behavior
delete	Delete any old / cached OTA data
showui	Display the update OSD on the camera UI
start	Start updating firmware with received OTA image
progress	Get the current firmware update progress
cancelled	show 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

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 Calculated Mismatch	Calculated SHA1 did not match user-specified SHA1
5	HTTP Boundary Error	HTTP Post was malformed
6	HTTP Post Error	Unexpected HTTP / Post Content Type
7	Server Busy	HTTP server is busy
8	Offset Mismatch	Attempt 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 is in progress
12	Insufficient Space	Insufficient space on the sdcard to hold decompressed update file

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request POST \
  --url 'http://10.5.5.9:8080/gp/gpSoftUpdate?request=progress' \
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{

"bytes_complete": 0,


"complete": true,


"message": "string",


"sha1": "string",


"status": 0


}

Simple OTA Update

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

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 Calculated Mismatch	Calculated SHA1 did not match user-specified SHA1
5	HTTP Boundary Error	HTTP Post was malformed
6	HTTP Post Error	Unexpected HTTP / Post Content Type
7	Server Busy	HTTP server is busy
8	Offset Mismatch	Attempt 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 is in progress
12	Insufficient Space	Insufficient space on the sdcard to hold decompressed update file

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request POST \
  --url http://10.5.5.9:8080/gp/gpUpdate \
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{
"status": 0

}

Presets

The camera organizes modes of operation into Presets.

Depending on the camera's state, different collections of presets will be available for immediate loading and use.

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

Preset Groups

Presets are organized into Preset Groups.

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

Get Available Presets

Supported Protocols:

usb
wifi

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

Responses

Response Schema: application/json

Array of objects

A list of ranges of icon ID's available for custom presets.

Array

length	integer Example: "10" number of items in the range
start	integer Example: "0" start index of range

Array of objects

A list of ranges of title ID's available for custom presets.

Array

length	integer Example: "25" number of items in the range
start	integer Example: "18" start index of range

Array of objects (PresetGroup)

Array of Preset Groups

Array

canAddPreset

boolean

Is there room in the group to add additional Presets?

icon

integer (EnumPresetGroupIcon)

Enum: 0 1 2 3 4 5 6 7 8 9 10

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
8	PRESET_GROUP_ND_MOD_VIDEO_ICON_ID
9	PRESET_GROUP_ND_MOD_PHOTO_ICON_ID
10	PRESET_GROUP_ND_MOD_TIMELAPSE_ICON_ID

id

integer (EnumPresetGroup)

Enum: 1000 1001 1002

ID	Name	Summary
1000	PRESET_GROUP_ID_VIDEO
1001	PRESET_GROUP_ID_PHOTO
1002	PRESET_GROUP_ID_TIMELAPSE

modeArray

Array of integers (EnumFlatMode)

Items Enum: -1 4 5 12 13 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Array of Flatmodes available for this preset group

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
32	FLAT_MODE_VIDEO_BURST_SLOMO

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 55 56 57 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 80 81 82 83 84 85 89 90 91 100 101 102 1000 1001

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
34	PRESET_ICON_STARS
35	PRESET_ICON_ACTION
36	PRESET_ICON_FOLLOW_CAM
37	PRESET_ICON_SURF
38	PRESET_ICON_CITY
39	PRESET_ICON_SHAKY
40	PRESET_ICON_CHESTY
41	PRESET_ICON_HELMET
42	PRESET_ICON_BITE
43	PRESET_ICON_CUSTOM_CINEMATIC
44	PRESET_ICON_VLOG
45	PRESET_ICON_FPV
46	PRESET_ICON_HDR
47	PRESET_ICON_LANDSCAPE
48	PRESET_ICON_LOG
49	PRESET_ICON_CUSTOM_SLOMO
50	PRESET_ICON_TRIPOD
55	PRESET_ICON_MAX_VIDEO
56	PRESET_ICON_MAX_PHOTO
57	PRESET_ICON_MAX_TIMEWARP
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
80	PRESET_ICON_EASY_MAX_VIDEO
81	PRESET_ICON_EASY_MAX_PHOTO
82	PRESET_ICON_EASY_MAX_TIMEWARP
83	PRESET_ICON_EASY_MAX_STAR_TRAIL
84	PRESET_ICON_EASY_MAX_LIGHT_PAINTING
85	PRESET_ICON_EASY_MAX_LIGHT_TRAIL
89	PRESET_ICON_MAX_STAR_TRAIL
90	PRESET_ICON_MAX_LIGHT_PAINTING
91	PRESET_ICON_MAX_LIGHT_TRAIL
100	PRESET_ICON_EASY_STANDARD_PROFILE
101	PRESET_ICON_EASY_HDR_PROFILE
102	PRESET_ICON_BURST_SLOMO
1000	PRESET_ICON_TIMELAPSE_PHOTO
1001	PRESET_ICON_NIGHTLAPSE_PHOTO

id

integer <int32>

Unique preset identifier

isFixed

boolean

Is this preset mutable?

isModified

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 32

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
32	FLAT_MODE_VIDEO_BURST_SLOMO

Array of objects (PresetSetting)

Array

id	integer <int32> Setting identifier
isCaption	boolean Does this setting appear on the Preset "pill" in the camera UI?
value	integer <int32> Setting value

titleId

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 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 99 100 106

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
34	PRESET_TITLE_STARS
35	PRESET_TITLE_ACTION
36	PRESET_TITLE_FOLLOW_CAM
37	PRESET_TITLE_SURF
38	PRESET_TITLE_CITY
39	PRESET_TITLE_SHAKY
40	PRESET_TITLE_CHESTY
41	PRESET_TITLE_HELMET
42	PRESET_TITLE_BITE
43	PRESET_TITLE_CUSTOM_CINEMATIC
44	PRESET_TITLE_VLOG
45	PRESET_TITLE_FPV
46	PRESET_TITLE_HDR
47	PRESET_TITLE_LANDSCAPE
48	PRESET_TITLE_LOG
49	PRESET_TITLE_CUSTOM_SLOMO
50	PRESET_TITLE_TRIPOD
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
99	PRESET_TITLE_EASY_STANDARD_PROFILE
100	PRESET_TITLE_EASY_HDR_PROFILE
106	PRESET_TITLE_BURST_SLOMO

titleNumber

integer <int32>

Preset title number

userDefined

boolean

Is this preset user defined?

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/presets/get

Response samples

200

Content type

application/json

{

"customIconIds": [
{

"length": 10,


"start": 0


}

],


"customTitleIds": [
{

"length": 25,


"start": 18


}

],


"presetGroupArray": [
{

"canAddPreset": true,


"icon": 0,


"id": 1000,


"modeArray": [-1
],


"presetArray": [
{

"icon": 0,


"id": 0,


"isFixed": true,


"isModified": true,


"mode": -1,


"settingArray": [
{

"id": 0,


"isCaption": true,


"value": 0


}

],


"titleId": 0,


"titleNumber": 0,


"userDefined": true


}

]


}

]


}

Load Preset by ID

Supported Protocols:

usb
wifi

A preset can only be loaded if it is currently available where available preset IDs can be found from Get Preset Status

query Parameters

id<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Preset to load

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/presets/load?id=0'

Response samples

200

Content type

application/json

{ }

Load Preset Group by ID

Supported Protocols:

usb
wifi

query Parameters

id<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>

integer

Enum: 1000 1001 1002

Example: id=1000

Preset group to load

ID	Name	Summary
1000	PRESET_GROUP_ID_VIDEO
1001	PRESET_GROUP_ID_PHOTO
1002	PRESET_GROUP_ID_TIMELAPSE

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/presets/set_group?id=1000'

Response samples

200

Content type

application/json

{ }

Update Custom Preset

Supported Protocols:

usb
wifi

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

The use cases are:

Update the Custom Preset Icon
- icon_id is always optional and can always be passed

and / or

Update the Custom Preset Title to a...
- Factory Preset Title: Set title_id to a non-PRESET_TITLE_USER_DEFINED_CUSTOM_NAME (94) value
- Custom Preset Name: Set title_id to PRESET_TITLE_USER_DEFINED_CUSTOM_NAME (94) and specify a custom_name

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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 55 56 57 58 59 60 61 62 63 64 65 66 67 70 71 73 74 75 76 77 78 79 80 81 82 83 84 85 89 90 91 100 101 102 1000 1001

Desired Icon ID

The range of acceptable custom Icon ID's can be found in the Get Preset Status response

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
34	PRESET_ICON_STARS
35	PRESET_ICON_ACTION
36	PRESET_ICON_FOLLOW_CAM
37	PRESET_ICON_SURF
38	PRESET_ICON_CITY
39	PRESET_ICON_SHAKY
40	PRESET_ICON_CHESTY
41	PRESET_ICON_HELMET
42	PRESET_ICON_BITE
43	PRESET_ICON_CUSTOM_CINEMATIC
44	PRESET_ICON_VLOG
45	PRESET_ICON_FPV
46	PRESET_ICON_HDR
47	PRESET_ICON_LANDSCAPE
48	PRESET_ICON_LOG
49	PRESET_ICON_CUSTOM_SLOMO
50	PRESET_ICON_TRIPOD
55	PRESET_ICON_MAX_VIDEO
56	PRESET_ICON_MAX_PHOTO
57	PRESET_ICON_MAX_TIMEWARP
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
80	PRESET_ICON_EASY_MAX_VIDEO
81	PRESET_ICON_EASY_MAX_PHOTO
82	PRESET_ICON_EASY_MAX_TIMEWARP
83	PRESET_ICON_EASY_MAX_STAR_TRAIL
84	PRESET_ICON_EASY_MAX_LIGHT_PAINTING
85	PRESET_ICON_EASY_MAX_LIGHT_TRAIL
89	PRESET_ICON_MAX_STAR_TRAIL
90	PRESET_ICON_MAX_LIGHT_PAINTING
91	PRESET_ICON_MAX_LIGHT_TRAIL
100	PRESET_ICON_EASY_STANDARD_PROFILE
101	PRESET_ICON_EASY_HDR_PROFILE
102	PRESET_ICON_BURST_SLOMO
1000	PRESET_ICON_TIMELAPSE_PHOTO
1001	PRESET_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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 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 99 100 106

Desired Title ID

The range of acceptable custom Title ID's can be found in the Get Preset Status response

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
34	PRESET_TITLE_STARS
35	PRESET_TITLE_ACTION
36	PRESET_TITLE_FOLLOW_CAM
37	PRESET_TITLE_SURF
38	PRESET_TITLE_CITY
39	PRESET_TITLE_SHAKY
40	PRESET_TITLE_CHESTY
41	PRESET_TITLE_HELMET
42	PRESET_TITLE_BITE
43	PRESET_TITLE_CUSTOM_CINEMATIC
44	PRESET_TITLE_VLOG
45	PRESET_TITLE_FPV
46	PRESET_TITLE_HDR
47	PRESET_TITLE_LANDSCAPE
48	PRESET_TITLE_LOG
49	PRESET_TITLE_CUSTOM_SLOMO
50	PRESET_TITLE_TRIPOD
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
99	PRESET_TITLE_EASY_STANDARD_PROFILE
100	PRESET_TITLE_EASY_HDR_PROFILE
106	PRESET_TITLE_BURST_SLOMO

Responses

Response Schema: application/json

object

Request samples

Content type

application/json

{

"custom_name": "string",


"icon_id": 0,


"title_id": 0


}

Response samples

200
400

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 Preview Stream

Supported Protocols:

usb
wifi

query Parameters

port	integer Example: port=8556Port to use for Preview Stream. Not supported on Hero 11 Black Mini Hero 11 Black Hero 10 Black Hero 9 Black

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/stream/start?port=8556'

Response samples

200

Content type

application/json

{ }

Stop Preview Stream

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/stream/stop

Response samples

200

Content type

application/json

{ }

Query

Get information about the camera

Get Camera State

Supported Protocols:

usb
wifi

Get all camera settings and statuses.

Responses

Response Schema: application/json

object

All currently known setting values indexed by setting ID

2

integer

Enum: 1 4 6 7 9 12 18 24 25 26 27 28 37 38 100 107 108 109 110 111

Video Resolution

Value	Meaning	Supported Cameras
1	4K
4	2.7K
6	2.7K 4:3
7	1440
9	1080
12	720
18	4K 4:3
24	5K
25	5K 4:3
26	5.3K 8:7
27	5.3K 4:3
28	4K 8:7
37	4K 1:1
38	900
100	5.3K
107	5.3K 8:7 V2
108	4K 8:7 V2
109	4K 9:16 V2
110	1080 9:16 V2
111	2.7K 4:3 V2

3

integer

Enum: 0 1 2 5 6 8 9 10 13

Frames Per Second

Value	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0

5

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11

Video Timelapse Rate

Value	Meaning	Supported Cameras
0	0.5 Seconds
1	1 Second
2	2 Seconds
3	5 Seconds
4	10 Seconds
5	30 Seconds
6	60 Seconds
7	2 Minutes
8	5 Minutes
9	30 Minutes
10	60 Minutes
11	3 Seconds

How frequently to take a video when performing a Video Timelapse

30

integer

Enum: 11 100 101 102 103 104 105 106 107 108 109 110

Photo Timelapse Rate

Value	Meaning	Supported Cameras
11	3 Seconds
100	60 Minutes
101	30 Minutes
102	5 Minutes
103	2 Minutes
104	60 Seconds
105	30 Seconds
106	10 Seconds
107	5 Seconds
108	2 Seconds
109	1 Second
110	0.5 Seconds

How frequently to take a photo when performing a Photo Timelapse.

32

integer

Enum: 4 5 10 15 20 30 100 120 300 1800 3600 3601

Nightlapse Rate

Value	Meaning	Supported Cameras
4	4 Seconds
5	5 Seconds
10	10 Seconds
15	15 Seconds
20	20 Seconds
30	30 Seconds
100	60 Seconds
120	2 Minutes
300	5 Minutes
1800	30 Minutes
3600	60 Minutes
3601	Auto

How frequently to take a video or photo when performing a Nightlapse.

This controls the Video or Photo Nightlapse rate if Setting 128 is set to 21 or 26 respectively.

43

integer

Enum: 0 2 3 4

Webcam Digital Lenses

Value	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear

59

integer

Enum: 0 1 4 6 7 11 12

Auto Power Down

Value	Meaning	Supported Cameras
0	Never
1	1 Min
4	5 Min
6	15 Min
7	30 Min
11	8 Seconds
12	30 Seconds

83

integer

Enum: 0 1

GPS

Value	Meaning	Supported Cameras
0	Off
1	On

108

integer

Enum: 0 1 3 4

Video Aspect Ratio

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

121

integer

Enum: 0 2 3 4 7 8 9 10 11 12 13 104

Video Lens

Value	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear
7	Max SuperView
8	Linear + Horizon Leveling
9	HyperView
10	Linear + Horizon Lock
11	Max HyperView
12	Ultra SuperView
13	Ultra Wide
104	Ultra HyperView

122

integer

Enum: 0 10 19 27 28 31 32 41 100 101 102

Photo Lens

Value	Meaning	Supported Cameras
0	Wide 12 MP
10	Linear 12 MP
19	Narrow
27	Wide 23 MP
28	Linear 13 MP
31	Wide 27 MP
32	Linear 27 MP
41	Ultra Wide 12 MP
100	Max SuperView
101	Wide
102	Linear

123

integer

Enum: 19 31 32 100 101 102

Time Lapse Digital Lenses

Value	Meaning	Supported Cameras
19	Narrow
31	Wide 27 MP
32	Linear 27 MP
100	Max SuperView
101	Wide
102	Linear

125

integer

Enum: 0 1 2 3

Photo Output

Value	Meaning	Supported Cameras
0	Standard
1	Raw
2	HDR
3	SuperPhoto

128

integer

Enum: 13 20 21 26

Media Format

Value	Meaning	Supported Cameras
13	Time Lapse Video
20	Time Lapse Photo
21	Night Lapse Photo
26	Night Lapse Video

134

integer

Enum: 0 1 2 3

Anti-Flicker

Value	Meaning	Supported Cameras
0	NTSC
1	PAL
2	60Hz
3	50Hz

135

integer

Enum: 0 1 2 3 4 100

Hypersmooth

Value	Meaning	Supported Cameras
0	Off
1	Low
2	High
3	Boost
4	Auto Boost
100	Standard

150

integer

Enum: 0 2

Video Horizon Leveling

Value	Meaning	Supported Cameras
0	Off
2	Locked

151

integer

Enum: 0 2

Photo Horizon Leveling

Value	Meaning	Supported Cameras
0	Off
2	Locked

162

integer

Enum: 0 1

Max Lens

Value	Meaning	Supported Cameras
0	Off
1	On

167

integer

Enum: 2 3 4

HindSight

Value	Meaning	Supported Cameras
2	15 Seconds
3	30 Seconds
4	Off

171

integer

Enum: 0 2 3 4 5 6 7 8 9 10

Photo Single Interval

Value	Meaning	Supported Cameras
0	Off
2	0.5s
3	1s
4	2s
5	5s
6	10s
7	30s
8	60s
9	120s
10	3s

172

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Photo Interval Duration

Value	Meaning	Supported Cameras
0	Off
1	15 Seconds
2	30 Seconds
3	1 Minute
4	5 Minutes
5	15 Minutes
6	30 Minutes
7	1 Hour
8	2 Hours
9	3 Hours

173

integer

Enum: 0 1 2

Video Performance Mode

Value	Meaning	Supported Cameras
0	Maximum Video Performance
1	Extended Battery
2	Tripod / Stationary Video

175

integer

Enum: 0 1

Controls

Value	Meaning	Supported Cameras
0	Easy
1	Pro

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 138 139 140 141 152 153 154 155 156 157 158 159

Easy Mode Speed

Value	Meaning	Supported Cameras
0	8X Ultra Slo-Mo
1	4X Super Slo-Mo
2	2X Slo-Mo
3	1X Speed (Low Light)
4	4X Super Slo-Mo (Ext. Batt.)
5	2X Slo-Mo (Ext. Batt.)
6	1X Speed (Ext. Batt.) (Low Light)
7	8X Ultra Slo-Mo (50Hz)
8	4X Super Slo-Mo (50Hz)
9	2X Slo-Mo (50Hz)
10	1X Speed (50Hz) (Low Light)
11	4X Super Slo-Mo (50Hz) (Ext. Batt.)
12	2X Slo-Mo (50Hz) (Ext. Batt.)
13	1X Speed (50Hz) (Ext. Batt.) (Low Light)
14	8X Ultra Slo-Mo (Ext. Batt.)
15	8X Ultra Slo-Mo (50Hz) (Ext. Batt.)
16	8X Ultra Slo-Mo (Long. Batt.)
17	4X Super Slo-Mo (Long. Batt.)
18	2X Slo-Mo (Long. Batt.)
19	1X Speed (Long. Batt.) (Low Light)
20	8X Ultra Slo-Mo (50Hz) (Long. Batt.)
21	4X Super Slo-Mo (50Hz) (Long. Batt.)
22	2X Slo-Mo (50Hz) (Long. Batt.)
23	1X Speed (50Hz) (Long. Batt.) (Low Light)
24	2X Slo-Mo (4K)
25	4X Super Slo-Mo (2.7K)
26	2X Slo-Mo (4K) (50Hz)
27	4X Super Slo-Mo (2.7K) (50Hz)
100	8X Ultra Slo-Mo (V2)
101	4X Super Slo-Mo (V2)
102	2X Slo-Mo (V2)
103	1X Speed (Low Light) (V2)
104	8X Ultra Slo-Mo (50Hz) (V2)
105	4X Super Slo-Mo (50Hz) (V2)
106	2X Slo-Mo (50Hz) (V2)
107	1X Speed (50Hz) (Low Light) (V2)
108	8X Ultra Slo-Mo (Long. Batt.) (V2)
109	4X Super Slo-Mo (Long. Batt.) (V2)
110	2X Slo-Mo (Long. Batt.) (V2)
111	1X Speed (Long. Batt.) (Low Light) (V2)
112	8X Ultra Slo-Mo (50Hz) (Long. Batt.) (V2)
113	4X Super Slo-Mo (50Hz) (Long. Batt.) (V2)
114	2X Slo-Mo (50Hz) (Long. Batt.) (V2)
115	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2)
116	2X Slo-Mo (4K) (V2)
117	2X Slo-Mo (4K) (50Hz) (V2)
118	1X Speed (Low Light) (V2) (Vertical)
119	1X Speed (50Hz) (Low Light) (V2) (Vertical)
120	2X Slo-Mo (V2) (Vertical)
121	2X Slo-Mo (50Hz) (V2) (Vertical)
122	1X Speed (Full Frame) (Low Light) (V2)
123	1X Speed (50Hz) (Full Frame) (Low Light) (V2)
124	2X Slo-Mo (Full Frame) (V2)
125	2X Slo-Mo (50Hz) (Full Frame) (V2)
126	1X Speed (4K) (Low Light) (V2)
127	1X Speed (4K) (50Hz) (Low Light) (V2)
128	1X Speed (2.7K) (Low Light) (V2)
129	1X Speed (2.7K) (50Hz) (Low Light) (V2)
130	2X Slo-Mo (2.7K) (V2)
131	2X Slo-Mo (2.7K) (50Hz) (V2)
132	2X Slo-Mo (Long. Batt.) (V2) (Vertical)
133	2X Slo-Mo (50Hz) (Long. Batt.) (V2) (Vertical)
134	1X Speed (Long. Batt.) (Low Light) (V2) (Vertical)
135	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2) (Vertical)
136	1X Speed (4K) (Full Frame) (Low Light) (V2)
137	1X Speed (4K) (50Hz) (Full Frame) (Low Light) (V2)
138	1X Normal Speed (1:1) (30 Fps) (4K) (V2)
139	1X Normal Speed (1:1) (25 Fps) (4K) (V2)
140	2X Slo-Mo Speed (1:1) (4K) (60 Fps) (V2)
141	2X Slo-Mo Speed (1:1) (4K) (50 Fps) (V2)
152	1X Normal Speed (30 Fps) (4:3) (5.3K) (V2)
153	1X Normal Speed (25 Fps) (4:3) (5.3K) (V2)
154	1X Normal Speed (30 Fps) (4:3) (4K) (V2)
155	1X Normal Speed (25 Fps) (4:3) (4K) (V2)
156	2X Slo-Mo Speed (4:3) (4K) (60 Fps) (V2)
157	2X Slo-Mo Speed (4:3) (4K) (50 Fps) (V2)
158	120 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)
159	100 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)

177

integer

Enum: 0 1

Enable Night Photo

Value	Meaning	Supported Cameras
0	Off
1	On

178

integer

Enum: 0 1

Wireless Band

Value	Meaning	Supported Cameras
0	2.4GHz
1	5GHz

179

integer

Enum: 1 2 3

Star Trails Length

Value	Meaning	Supported Cameras
1	Short
2	Long
3	Max

180

integer

Enum: 0 101 102 111 112

System Video Mode

Value	Meaning	Supported Cameras
0	Highest Quality
101	Extended Battery
102	Longest Battery
111	Standard Quality
112	Basic Quality

182

integer

Enum: 0 1

Video Bit Rate

Value	Meaning	Supported Cameras
0	Standard
1	High

183

integer

Enum: 0 2

Bit Depth

Value	Meaning	Supported Cameras
0	8-Bit
2	10-Bit

184

integer

Enum: 0 1 2 101

Profiles

Value	Meaning	Supported Cameras
0	Standard
1	HDR
2	Log
101	HLG HDR

186

integer

Enum: 0 1 2 3 4

Video Easy Mode

Value	Meaning	Supported Cameras
0	Highest Quality
1	Standard Quality
2	Basic Quality
3	Standard Video
4	HDR Video

187

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Lapse Mode

Value	Meaning	Supported Cameras
0	TimeWarp
1	Star Trails
2	Light Painting
3	Vehicle Lights
4	Max TimeWarp
5	Max Star Trails
6	Max Light Painting
7	Max Vehicle Lights
8	Time Lapse Video
9	Night Lapse Video

189

integer

Enum: 0 1 2 3 4 6 7 8 9 10 100

Max Lens Mod

Value	Meaning	Supported Cameras
0	None
1	Max Lens 1.0
2	Max Lens 2.0
3	Max Lens 2.5
4	Macro
6	ND 4
7	ND 8
8	ND 16
9	ND 32
10	Standard Lens
100	Auto Detect

190

integer

Enum: 0 1

Max Lens Mod Enable

Value	Meaning	Supported Cameras
0	Off
1	On

191

integer

Enum: 0 1

Easy Night Photo

Value	Meaning	Supported Cameras
0	Super Photo
1	Night Photo

192

integer

Enum: 0 1 3

Multi Shot Aspect Ratio

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7

193

integer

Enum: 0 1 2 100 101 103 104 106

Framing

Value	Meaning	Supported Cameras
0	Widescreen
1	Vertical
2	Full Frame
100	Traditional 4:3 v2
101	Widescreen 16:9 v2
103	Full Frame 8:7 v2
104	Vertical 9:16 v2
106	Full Frame 1:1 v2

216

integer

Enum: 70 85 100

Camera Volume

Value	Meaning	Supported Cameras
70	Low
85	Medium
100	High

219

integer

Enum: 1 2 3 4

Setup Screen Saver

Value	Meaning	Supported Cameras
1	1 Min
2	2 Min
3	3 Min
4	5 Min

223

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14

Setup Language

Value	Meaning	Supported Cameras
0	English - US
1	English - UK
2	English - AUS
3	German
4	French
5	Italian
6	Spanish
7	Spanish - NA
8	Chinese
9	Japanese
10	Korean
11	Portuguese
12	Russian
13	English - IND
14	Swedish

227

integer

Enum: 0 1 2

Photo Mode

Value	Meaning	Supported Cameras
0	SuperPhoto
1	Night Photo
2	Burst

232

integer

Enum: 0 1 3 4 6

Video Framing

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16
6	1:1

233

integer

Enum: 0 1 3 4

Multi Shot Framing

Value	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

234

integer

Enum: 0 1 2 5 6 8 9 10 13 15 16 17

Frame Rate

Value	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0
15	400.0
16	360.0
17	300.0

object

All currently known status values indexed by status ID

1

integer

Enum: 0 1

Battery Present

2

integer

Enum: 0 1 2 3 4

Internal Battery Bars

Value	Meaning
0	Zero
1	One
2	Two
3	Three
4	Charging

Rough approximation of internal battery level in bars (or charging)

6

integer

Enum: 0 1

Overheating

8

integer

Enum: 0 1

Busy

9

integer

Enum: 0 1

Quick Capture

10

integer

Enum: 0 1

Encoding

11

integer

Enum: 0 1

LCD Lock

13

integer <int32ub>

Video Encoding Duration

17

integer

Enum: 0 1

Wireless Connections Enabled

19

integer

Enum: 0 1 2 3 4

Pairing State

Value	Meaning
0	Never Started
1	Started
2	Aborted
3	Cancelled
4	Completed

20

integer

Enum: 0 1 2 3

Last Pairing Type

Value	Meaning
0	Not Pairing
1	Pairing App
2	Pairing Remote Control
3	Pairing Bluetooth Device

The last type of pairing in which the camera was engaged

21

integer <int32ub>

Last Pairing Success

22

integer

Enum: 0 1 2 3 4

Wifi Scan State

Value	Meaning
0	Never started
1	Started
2	Aborted
3	Canceled
4	Completed

State of current scan for WiFi Access Points

23

integer <int8ub>

Last Wifi Scan Success

24

integer

Enum: 0 1 2 3 4

Wifi Provisioning State

Value	Meaning
0	Never started
1	Started
2	Aborted
3	Canceled
4	Completed

WiFi AP provisioning state

26

integer <int8ub>

Remote Version

27

integer

Enum: 0 1

Remote Connected

28

integer <unspecified>

Pairing State (Legacy)

29

string

AP SSID

30

string

WiFi SSID

31

integer <int8ub>

Connected Devices

32

integer

Enum: 0 1

Preview Stream

33

integer

Enum: -1 0 1 2 3 4 8

Primary Storage

Value	Meaning
-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

integer <int32ub>

Remaining Photos

35

integer <int32ub>

Remaining Video Time

38

integer <int32ub>

Photos

39

integer <int32ub>

Videos

41

integer

Enum: 0 1 10 2 3 4 5 6 7 8 9

OTA

Value	Meaning
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

The current status of Over The Air (OTA) update

42

integer

Enum: 0 1

Pending FW Update Cancel

45

integer

Enum: 0 1

Locate

49

integer <int32ub>

Timelapse Interval Countdown

54

integer <int64ub>

SD Card Remaining

55

integer

Enum: 0 1

Preview Stream Available

56

integer <int8ub>

Wifi Bars

58

integer <int8ub>

Active Hilights

59

integer <int32ub>

Time Since Last Hilight

60

integer <int32ub>

Minimum Status Poll Period

65

integer

Enum: 0 1 2 3

Liveview Exposure Select Mode

Value	Meaning
0	Disabled
1	Auto
2	ISO Lock
3	Hemisphere

66

integer <int8ub>

Liveview Y

67

integer <int8ub>

Liveview X

68

integer

Enum: 0 1

GPS Lock

69

integer

Enum: 0 1

AP Mode

70

integer <int8ub>

Internal Battery Percentage

74

integer

Enum: 0 1 2

Microphone Accessory

Value	Meaning
0	Accessory not connected
1	Accessory connected
2	Accessory connected and a microphone is plugged into the accessory

75

integer <int8ub>

Zoom Level

76

integer

Enum: 0 1

Wireless Band

Value	Meaning
0	2.4 GHz
1	5 GHz

77

integer

Enum: 0 1

Zoom Available

78

integer

Enum: 0 1

Mobile Friendly

79

integer

Enum: 0 1

FTU

81

integer

Enum: 0 1

5GHZ Available

82

integer

Enum: 0 1

Ready

83

integer

Enum: 0 1

OTA Charged

85

integer

Enum: 0 1

Cold

86

integer

Enum: 0 1 2 3

Rotation

Value	Meaning
0	0 degrees (upright)
1	180 degrees (upside down)
2	90 degrees (laying on right side)
3	270 degrees (laying on left side)

Rotational orientation of the camera

88

integer

Enum: 0 1

Zoom while Encoding

89

integer <unspecified>

Flatmode

93

integer <int32ub>

Video Preset

94

integer <int32ub>

Photo Preset

95

integer <int32ub>

Timelapse Preset

96

integer <int32ub>

Preset Group

97

integer <int32ub>

Preset

98

integer <int32ub>

Preset Modified

99

integer <int32ub>

Remaining Live Bursts

100

integer <int32ub>

Live Bursts

101

integer

Enum: 0 1

Capture Delay Active

102

integer

Enum: 0 2 3

Media Mod State

Value	Meaning
0	Microphone removed
2	Microphone only
3	Microphone with external microphone

103

integer

Enum: 0 1 10 11 12 2 3 4 5 6 7 8 9

Time Warp Speed

Value	Meaning
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

integer

Enum: 0 1

Linux Core

105

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Lens Type

Value	Meaning
0	Default
1	Max Lens
2	Max Lens 2.0
3	Max Lens 2.5
4	Macro Lens
5	Anamorphic Lens
6	Neutral Density 4
7	Neutral Density 8
8	Neutral Density 16
9	Neutral Density 32

Camera lens type (reflects changes to lens settings such as 162, 189, 194, ...)

106

integer

Enum: 0 1

Hindsight

107

integer <int32ub>

Scheduled Capture Preset ID

108

integer

Enum: 0 1

Scheduled Capture

110

integer

Enum: 0 1 2 3 4 5 6 7

Display Mod Status

Value	Meaning
0	000 = Display Mod: 0, HDMI: 0, Display Mod Connected: False
1	001 = Display Mod: 0, HDMI: 0, Display Mod Connected: True
2	010 = Display Mod: 0, HDMI: 1, Display Mod Connected: False
3	011 = Display Mod: 0, HDMI: 1, Display Mod Connected: True
4	100 = Display Mod: 1, HDMI: 0, Display Mod Connected: False
5	101 = Display Mod: 1, HDMI: 0, Display Mod Connected: True
6	110 = Display Mod: 1, HDMI: 1, Display Mod Connected: False
7	111 = Display Mod: 1, HDMI: 1, Display Mod Connected: True

Note that this is a bitmasked value.

111

integer

Enum: 0 1

SD Card Write Speed Error

112

integer <int8ub>

SD Card Errors

113

integer

Enum: 0 1

Turbo Transfer

114

integer

Enum: 0 1 2

Camera Control ID

Value	Meaning
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

Camera control status ID

115

integer

Enum: 0 1

USB Connected

116

integer

Enum: 0 1

USB Controlled

Value	Meaning
0	Disabled
1	Enabled

Camera control over USB state

117

integer <int32ub>

SD Card Capacity

118

integer <unspecified>

Photo Interval Capture Count

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/state

Response samples

200

Content type

application/json

{

"settings": {

"2": 1,


"3": 0,


"5": 0,


"30": 11,


"32": 4,


"43": 0,


"59": 0,


"83": 0,


"108": 0,


"121": 0,


"122": 0,


"123": 19,


"125": 0,


"128": 13,


"134": 0,


"135": 0,


"150": 0,


"151": 0,


"162": 0,


"167": 2,


"171": 0,


"172": 0,


"173": 0,


"175": 0,


"176": 0,


"177": 0,


"178": 0,


"179": 1,


"180": 0,


"182": 0,


"183": 0,


"184": 0,


"186": 0,


"187": 0,


"189": 0,


"190": 0,


"191": 0,


"192": 0,


"193": 0,


"216": 70,


"219": 1,


"223": 0,


"227": 0,


"232": 0,


"233": 0,


"234": 0


},


"status": {

"1": 0,


"2": 0,


"6": 0,


"8": 0,


"9": 0,


"10": 0,


"11": 0,


"13": 0,


"17": 0,


"19": 0,


"20": 0,


"21": 0,


"22": 0,


"23": 0,


"24": 0,


"26": 0,


"27": 0,


"28": 0,


"29": "string",


"30": "string",


"31": 0,


"32": 0,


"33": -1,


"34": 0,


"35": 0,


"38": 0,


"39": 0,


"41": 0,


"42": 0,


"45": 0,


"49": 0,


"54": 0,


"55": 0,


"56": 0,


"58": 0,


"59": 0,


"60": 0,


"65": 0,


"66": 0,


"67": 0,


"68": 0,


"69": 0,


"70": 0,


"74": 0,


"75": 0,


"76": 0,


"77": 0,


"78": 0,


"79": 0,


"81": 0,


"82": 0,


"83": 0,


"85": 0,


"86": 0,


"88": 0,


"89": 0,


"93": 0,


"94": 0,


"95": 0,


"96": 0,


"97": 0,


"98": 0,


"99": 0,


"100": 0,


"101": 0,


"102": 0,


"103": 0,


"104": 0,


"105": 0,


"106": 0,


"107": 0,


"108": 0,


"110": 0,


"111": 0,


"112": 0,


"113": 0,


"114": 0,


"115": 0,


"116": 0,


"117": 0,


"118": 0


}


}

Get Date / Time

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

date<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: "2023_12_31" current date in format YYYY_MM_DD
time<div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div>	string Example: "11_05_45" current time in format HH_MM_SS
dst	integer Enum: 0 1 Is daylight savings time active?
tzone	integer Example: "-480" Timezone offset in minutes

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/get_date_time

Response samples

200

Content type

application/json

{

"date": "2023_12_31",


"dst": 0,


"time": "11_05_45",


"tzone": -480


}

Get Hardware Info

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

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

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/camera/info

Response samples

200

Content type

application/json

{

"ap_mac_addr": "065747046ceb",


"ap_ssid": "GP24645504",


"firmware_version": "H23.01.01.10.00",


"model_name": "Hero12 Black",


"model_number": "62",


"serial_number": "C3501324645504"


}

Get Last Captured Media

Supported Protocols:

usb
wifi

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

Responses

Response Schema: application/json

file	string Example: "GOPR0002.JPG" Filename of media
folder	string Example: "100GOPRO" Directory in which the media is contained in

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/media/last_captured

Response samples

200
204

Content type

application/json

{

"file": "GOPR0002.JPG",


"folder": "100GOPRO"


}

Get Open GoPro Version

Supported Protocols:

usb
wifi

Responses

Response Schema: application/json

version

string <version>

Example: "2.0"

Open GoPro version

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/version

Response samples

200

Content type

application/json

{
"version": "2.0"

}

settings

GoPro cameras have hundreds of setting options to choose from. Since these options have a complex tree of dependencies on camera state, current Preset, etc, there is no mechanism to set a desired setting option from any camera state.

To find the currently available options for a given setting, attempt to set it to an invalid option using its relevant operation below and view the currently available options returned in the 403 error response.

Anti-Flicker (134)

query Parameters

option

integer

Enum: 0 1 2 3

Example: option=2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	NTSC
1	PAL
2	60Hz
3	50Hz

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=2&setting=134'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Auto Power Down (59)

query Parameters

option

integer

Enum: 0 1 4 6 7 11 12

Example: option=1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Never
1	1 Min
4	5 Min
6	15 Min
7	30 Min
11	8 Seconds
12	30 Seconds

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=1&setting=59'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Bit Depth (183)

query Parameters

option

integer

Enum: 0 2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	8-Bit
2	10-Bit

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=183'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Camera Volume (216)

query Parameters

option

integer

Enum: 70 85 100

Example: option=100

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
70	Low
85	Medium
100	High

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=100&setting=216'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Controls (175)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Easy
1	Pro

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=175'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Easy Mode Speed (176)

query Parameters

option

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 138 139 140 141 152 153 154 155 156 157 158 159

Example: option=103

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	8X Ultra Slo-Mo
1	4X Super Slo-Mo
2	2X Slo-Mo
3	1X Speed (Low Light)
4	4X Super Slo-Mo (Ext. Batt.)
5	2X Slo-Mo (Ext. Batt.)
6	1X Speed (Ext. Batt.) (Low Light)
7	8X Ultra Slo-Mo (50Hz)
8	4X Super Slo-Mo (50Hz)
9	2X Slo-Mo (50Hz)
10	1X Speed (50Hz) (Low Light)
11	4X Super Slo-Mo (50Hz) (Ext. Batt.)
12	2X Slo-Mo (50Hz) (Ext. Batt.)
13	1X Speed (50Hz) (Ext. Batt.) (Low Light)
14	8X Ultra Slo-Mo (Ext. Batt.)
15	8X Ultra Slo-Mo (50Hz) (Ext. Batt.)
16	8X Ultra Slo-Mo (Long. Batt.)
17	4X Super Slo-Mo (Long. Batt.)
18	2X Slo-Mo (Long. Batt.)
19	1X Speed (Long. Batt.) (Low Light)
20	8X Ultra Slo-Mo (50Hz) (Long. Batt.)
21	4X Super Slo-Mo (50Hz) (Long. Batt.)
22	2X Slo-Mo (50Hz) (Long. Batt.)
23	1X Speed (50Hz) (Long. Batt.) (Low Light)
24	2X Slo-Mo (4K)
25	4X Super Slo-Mo (2.7K)
26	2X Slo-Mo (4K) (50Hz)
27	4X Super Slo-Mo (2.7K) (50Hz)
100	8X Ultra Slo-Mo (V2)
101	4X Super Slo-Mo (V2)
102	2X Slo-Mo (V2)
103	1X Speed (Low Light) (V2)
104	8X Ultra Slo-Mo (50Hz) (V2)
105	4X Super Slo-Mo (50Hz) (V2)
106	2X Slo-Mo (50Hz) (V2)
107	1X Speed (50Hz) (Low Light) (V2)
108	8X Ultra Slo-Mo (Long. Batt.) (V2)
109	4X Super Slo-Mo (Long. Batt.) (V2)
110	2X Slo-Mo (Long. Batt.) (V2)
111	1X Speed (Long. Batt.) (Low Light) (V2)
112	8X Ultra Slo-Mo (50Hz) (Long. Batt.) (V2)
113	4X Super Slo-Mo (50Hz) (Long. Batt.) (V2)
114	2X Slo-Mo (50Hz) (Long. Batt.) (V2)
115	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2)
116	2X Slo-Mo (4K) (V2)
117	2X Slo-Mo (4K) (50Hz) (V2)
118	1X Speed (Low Light) (V2) (Vertical)
119	1X Speed (50Hz) (Low Light) (V2) (Vertical)
120	2X Slo-Mo (V2) (Vertical)
121	2X Slo-Mo (50Hz) (V2) (Vertical)
122	1X Speed (Full Frame) (Low Light) (V2)
123	1X Speed (50Hz) (Full Frame) (Low Light) (V2)
124	2X Slo-Mo (Full Frame) (V2)
125	2X Slo-Mo (50Hz) (Full Frame) (V2)
126	1X Speed (4K) (Low Light) (V2)
127	1X Speed (4K) (50Hz) (Low Light) (V2)
128	1X Speed (2.7K) (Low Light) (V2)
129	1X Speed (2.7K) (50Hz) (Low Light) (V2)
130	2X Slo-Mo (2.7K) (V2)
131	2X Slo-Mo (2.7K) (50Hz) (V2)
132	2X Slo-Mo (Long. Batt.) (V2) (Vertical)
133	2X Slo-Mo (50Hz) (Long. Batt.) (V2) (Vertical)
134	1X Speed (Long. Batt.) (Low Light) (V2) (Vertical)
135	1X Speed (50Hz) (Long. Batt.) (Low Light) (V2) (Vertical)
136	1X Speed (4K) (Full Frame) (Low Light) (V2)
137	1X Speed (4K) (50Hz) (Full Frame) (Low Light) (V2)
138	1X Normal Speed (1:1) (30 Fps) (4K) (V2)
139	1X Normal Speed (1:1) (25 Fps) (4K) (V2)
140	2X Slo-Mo Speed (1:1) (4K) (60 Fps) (V2)
141	2X Slo-Mo Speed (1:1) (4K) (50 Fps) (V2)
152	1X Normal Speed (30 Fps) (4:3) (5.3K) (V2)
153	1X Normal Speed (25 Fps) (4:3) (5.3K) (V2)
154	1X Normal Speed (30 Fps) (4:3) (4K) (V2)
155	1X Normal Speed (25 Fps) (4:3) (4K) (V2)
156	2X Slo-Mo Speed (4:3) (4K) (60 Fps) (V2)
157	2X Slo-Mo Speed (4:3) (4K) (50 Fps) (V2)
158	120 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)
159	100 4X Super Slo-Mo Speed (2.7K) (4:3) (V2)

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=103&setting=176'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Easy Night Photo (191)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Super Photo
1	Night Photo

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=191'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Enable Night Photo (177)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	On

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=177'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Frame Rate (234)

query Parameters

option

integer

Enum: 0 1 2 5 6 8 9 10 13 15 16 17

Example: option=15

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0
15	400.0
16	360.0
17	300.0

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=15&setting=234'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Frames Per Second (3)

query Parameters

option

integer

Enum: 0 1 2 5 6 8 9 10 13

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	240.0
1	120.0
2	100.0
5	60.0
6	50.0
8	30.0
9	25.0
10	24.0
13	200.0

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=3'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Framing (193)

query Parameters

option

integer

Enum: 0 1 2 100 101 103 104 106

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Widescreen
1	Vertical
2	Full Frame
100	Traditional 4:3 v2
101	Widescreen 16:9 v2
103	Full Frame 8:7 v2
104	Vertical 9:16 v2
106	Full Frame 1:1 v2

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=193'

Response samples

200
403

Content type

application/json

{
"option": 0

}

GPS (83)

query Parameters

option

integer

Enum: 0 1

Example: option=1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	On

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=1&setting=83'

Response samples

200
403

Content type

application/json

{
"option": 0

}

HindSight (167)

query Parameters

option

integer

Enum: 2 3 4

Example: option=2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
2	15 Seconds
3	30 Seconds
4	Off

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=2&setting=167'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Hypersmooth (135)

query Parameters

option

integer

Enum: 0 1 2 3 4 100

Example: option=4

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	Low
2	High
3	Boost
4	Auto Boost
100	Standard

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=4&setting=135'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Lapse Mode (187)

query Parameters

option

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	TimeWarp
1	Star Trails
2	Light Painting
3	Vehicle Lights
4	Max TimeWarp
5	Max Star Trails
6	Max Light Painting
7	Max Vehicle Lights
8	Time Lapse Video
9	Night Lapse Video

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=187'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Max Lens (162)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	On

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=162'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Max Lens Mod (189)

query Parameters

option

integer

Enum: 0 1 2 3 4 6 7 8 9 10 100

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	None
1	Max Lens 1.0
2	Max Lens 2.0
3	Max Lens 2.5
4	Macro
6	ND 4
7	ND 8
8	ND 16
9	ND 32
10	Standard Lens
100	Auto Detect

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=189'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Max Lens Mod Enable (190)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	On

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=190'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Media Format (128)

query Parameters

option

integer

Enum: 13 20 21 26

Example: option=13

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
13	Time Lapse Video
20	Time Lapse Photo
21	Night Lapse Photo
26	Night Lapse Video

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=13&setting=128'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Multi Shot Aspect Ratio (192)

query Parameters

option

integer

Enum: 0 1 3

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=192'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Multi Shot Framing (233)

query Parameters

option

integer

Enum: 0 1 3 4

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=233'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Nightlapse Rate (32)

How frequently to take a video or photo when performing a Nightlapse.

This controls the Video or Photo Nightlapse rate if Setting 128 is set to 21 or 26 respectively.

query Parameters

option

integer

Enum: 4 5 10 15 20 30 100 120 300 1800 3600 3601

Example: option=3600

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
4	4 Seconds
5	5 Seconds
10	10 Seconds
15	15 Seconds
20	20 Seconds
30	30 Seconds
100	60 Seconds
120	2 Minutes
300	5 Minutes
1800	30 Minutes
3600	60 Minutes
3601	Auto

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=3600&setting=32'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Horizon Leveling (151)

query Parameters

option

integer

Enum: 0 2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
2	Locked

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=151'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Interval Duration (172)

query Parameters

option

integer

Enum: 0 1 2 3 4 5 6 7 8 9

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
1	15 Seconds
2	30 Seconds
3	1 Minute
4	5 Minutes
5	15 Minutes
6	30 Minutes
7	1 Hour
8	2 Hours
9	3 Hours

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=172'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Lens (122)

query Parameters

option

integer

Enum: 0 10 19 27 28 31 32 41 100 101 102

Example: option=100

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Wide 12 MP
10	Linear 12 MP
19	Narrow
27	Wide 23 MP
28	Linear 13 MP
31	Wide 27 MP
32	Linear 27 MP
41	Ultra Wide 12 MP
100	Max SuperView
101	Wide
102	Linear

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=100&setting=122'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Mode (227)

query Parameters

option

integer

Enum: 0 1 2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	SuperPhoto
1	Night Photo
2	Burst

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=227'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Output (125)

query Parameters

option

integer

Enum: 0 1 2 3

Example: option=3

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Standard
1	Raw
2	HDR
3	SuperPhoto

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=3&setting=125'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Single Interval (171)

query Parameters

option

integer

Enum: 0 2 3 4 5 6 7 8 9 10

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
2	0.5s
3	1s
4	2s
5	5s
6	10s
7	30s
8	60s
9	120s
10	3s

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=171'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Photo Timelapse Rate (30)

How frequently to take a photo when performing a Photo Timelapse.

query Parameters

option

integer

Enum: 11 100 101 102 103 104 105 106 107 108 109 110

Example: option=100

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
11	3 Seconds
100	60 Minutes
101	30 Minutes
102	5 Minutes
103	2 Minutes
104	60 Seconds
105	30 Seconds
106	10 Seconds
107	5 Seconds
108	2 Seconds
109	1 Second
110	0.5 Seconds

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=100&setting=30'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Profiles (184)

query Parameters

option

integer

Enum: 0 1 2 101

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Standard
1	HDR
2	Log
101	HLG HDR

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=184'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Setup Language (223)

query Parameters

option

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14

Example: option=8

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	English - US
1	English - UK
2	English - AUS
3	German
4	French
5	Italian
6	Spanish
7	Spanish - NA
8	Chinese
9	Japanese
10	Korean
11	Portuguese
12	Russian
13	English - IND
14	Swedish

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=8&setting=223'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Setup Screen Saver (219)

query Parameters

option

integer

Enum: 1 2 3 4

Example: option=1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
1	1 Min
2	2 Min
3	3 Min
4	5 Min

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=1&setting=219'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Star Trails Length (179)

query Parameters

option

integer

Enum: 1 2 3

Example: option=3

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
1	Short
2	Long
3	Max

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=3&setting=179'

Response samples

200
403

Content type

application/json

{
"option": 0

}

System Video Mode (180)

query Parameters

option

integer

Enum: 0 101 102 111 112

Example: option=112

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Highest Quality
101	Extended Battery
102	Longest Battery
111	Standard Quality
112	Basic Quality

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=112&setting=180'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Time Lapse Digital Lenses (123)

query Parameters

option

integer

Enum: 19 31 32 100 101 102

Example: option=101

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
19	Narrow
31	Wide 27 MP
32	Linear 27 MP
100	Max SuperView
101	Wide
102	Linear

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=101&setting=123'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Aspect Ratio (108)

query Parameters

option

integer

Enum: 0 1 3 4

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=108'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Bit Rate (182)

query Parameters

option

integer

Enum: 0 1

Example: option=1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Standard
1	High

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=1&setting=182'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Easy Mode (186)

query Parameters

option

integer

Enum: 0 1 2 3 4

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Highest Quality
1	Standard Quality
2	Basic Quality
3	Standard Video
4	HDR Video

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=186'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Framing (232)

query Parameters

option

integer

Enum: 0 1 3 4 6

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	4:3
1	16:9
3	8:7
4	9:16
6	1:1

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=232'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Horizon Leveling (150)

query Parameters

option

integer

Enum: 0 2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Off
2	Locked

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=150'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Lens (121)

query Parameters

option

integer

Enum: 0 2 3 4 7 8 9 10 11 12 13 104

Example: option=10

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear
7	Max SuperView
8	Linear + Horizon Leveling
9	HyperView
10	Linear + Horizon Lock
11	Max HyperView
12	Ultra SuperView
13	Ultra Wide
104	Ultra HyperView

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=10&setting=121'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Performance Mode (173)

query Parameters

option

integer

Enum: 0 1 2

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Maximum Video Performance
1	Extended Battery
2	Tripod / Stationary Video

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=173'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Resolution (2)

query Parameters

option

integer

Enum: 1 4 6 7 9 12 18 24 25 26 27 28 37 38 100 107 108 109 110 111

Example: option=100

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
1	4K
4	2.7K
6	2.7K 4:3
7	1440
9	1080
12	720
18	4K 4:3
24	5K
25	5K 4:3
26	5.3K 8:7
27	5.3K 4:3
28	4K 8:7
37	4K 1:1
38	900
100	5.3K
107	5.3K 8:7 V2
108	4K 8:7 V2
109	4K 9:16 V2
110	1080 9:16 V2
111	2.7K 4:3 V2

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=100&setting=2'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Video Timelapse Rate (5)

How frequently to take a video when performing a Video Timelapse

query Parameters

option

integer

Enum: 0 1 2 3 4 5 6 7 8 9 10 11

Example: option=10

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	0.5 Seconds
1	1 Second
2	2 Seconds
3	5 Seconds
4	10 Seconds
5	30 Seconds
6	60 Seconds
7	2 Minutes
8	5 Minutes
9	30 Minutes
10	60 Minutes
11	3 Seconds

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=10&setting=5'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Webcam Digital Lenses (43)

query Parameters

option

integer

Enum: 0 2 3 4

Example: option=3

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	Wide
2	Narrow
3	Superview
4	Linear

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=3&setting=43'

Response samples

200
403

Content type

application/json

{
"option": 0

}

Wireless Band (178)

query Parameters

option

integer

Enum: 0 1

Set the setting to a desired option. If this parameter is not used, instead the current setting's option will be queried.

ID	Meaning	Supported Cameras
0	2.4GHz
1	5GHz

Responses

Response Schema: application/json

option

integer

The current setting's option.

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/camera/setting?option=0&setting=178'

Response samples

200
403

Content type

application/json

{
"option": 0

}

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	Port
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 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

Supported Protocols:

usb
wifi

Not supported on WiFi for:

Hero 11 Black Mini
Hero 11 Black
Hero 10 Black
Hero 9 Black

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/webcam/preview

Response samples

200

Content type

application/json

{ }

Exit Webcam Mode

Supported Protocols:

usb
wifi

Not supported on WiFi for:

Hero 11 Black Mini
Hero 11 Black
Hero 10 Black
Hero 9 Black

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/webcam/exit

Response samples

200

Content type

application/json

{ }

Get Webcam Status

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)

Code	Status
0	None
1	Set Preset
2	Set Window Size
3	Exec Stream
4	Shutter
5	Com timeout
6	Invalid param
7	Unavailable
8	Exit

status

integer

Enum: 0 1 2 3

Current webcam status

Code	Status
0	Off
1	Idle
2	High Power Preview
3	Low Power Preview
4	Status is unavailable

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/webcam/status

Response samples

200

Content type

application/json

{

"error": 0,


"status": 0


}

Get Webcam Version

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

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/webcam/version

Response samples

200

Content type

application/json

{

"max_lens_support": true,


"usb_3_1_compatible": true,


"version": 0


}

Start Webcam

Supported Protocols:

usb
wifi

Not supported on WiFi for:

Hero 11 Black Mini
Hero 11 Black
Hero 10 Black
Hero 9 Black

query Parameters

res

integer

Example: res=12

Webcam Resolution

ID	Resolution	Supported Cameras
4	480p	Hero 10 Black, Hero 9 Black
7	720p	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black
12	1080p	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black

fov

integer

Webcam Field-of-View

ID	FOV	Supported Cameras
0	Wide	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black
2	Narrow	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black
3	Superview	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black
4	Linear	Hero 12 Black, Hero 9 Black, Hero 10 Black, Hero 11 Black

port

integer Default: 8554 Example: port=8556Port 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” Example: protocol=RTSPStreaming 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

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url 'http://10.5.5.9:8080/gopro/webcam/start?res=12&fov=0&port=8556&protocol=RTSP'

Response samples

200

Content type

application/json

{ }

Stop Webcam

Supported Protocols:

usb
wifi

Not supported on WiFi for:

Hero 11 Black Mini
Hero 11 Black
Hero 10 Black
Hero 9 Black

Responses

Response Schema: application/json

object

Request samples

Shell + Curl
Python + Requests
Java + Okhttp
C + Libcurl
Node + Request

curl --request GET \
  --url http://10.5.5.9:8080/gopro/webcam/stop

Response samples

200

Content type

application/json

{ }