Update protobuf documentation

gopro · Jul 5, 2023 · 5baddd0 · 5baddd0
1 parent ddf3e34
commit 5baddd0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 25 deletions.
diff --git a/protobuf/live_streaming.proto b/protobuf/live_streaming.proto
@@ -1,5 +1,5 @@
 /* live_streaming.proto/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). */
-/* This copyright was auto-generated on Fri Jun  9 22:49:37 UTC 2023 */
+/* This copyright was auto-generated on Wed Jul  5 19:32:05 UTC 2023 */
 
 /*
 Defines the structure of protobuf messages for working with Live Streams
@@ -16,29 +16,30 @@ enum EnumLens {
 }
 
 enum EnumLiveStreamError {
-    LIVE_STREAM_ERROR_NONE                   = 0;
-    LIVE_STREAM_ERROR_NETWORK                = 1;
-    LIVE_STREAM_ERROR_CREATESTREAM           = 2;
-    LIVE_STREAM_ERROR_OUTOFMEMORY            = 3;
-    LIVE_STREAM_ERROR_INPUTSTREAM            = 4;
-    LIVE_STREAM_ERROR_INTERNET               = 5;
-    LIVE_STREAM_ERROR_OSNETWORK              = 6;
-    LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT = 7;
-    LIVE_STREAM_ERROR_SSL_HANDSHAKE          = 8;
-    LIVE_STREAM_ERROR_CAMERA_BLOCKED         = 9;
-    LIVE_STREAM_ERROR_UNKNOWN                = 10;
-    LIVE_STREAM_ERROR_SD_CARD_FULL           = 40;
-    LIVE_STREAM_ERROR_SD_CARD_REMOVED        = 41;
+    LIVE_STREAM_ERROR_NONE                   = 0;   // No error (success)
+    LIVE_STREAM_ERROR_NETWORK                = 1;   // General network error during the stream
+    LIVE_STREAM_ERROR_CREATESTREAM           = 2;   // Startup error: bad URL or valid with live stream server
+    LIVE_STREAM_ERROR_OUTOFMEMORY            = 3;   // Not enough memory on camera to complete task
+    LIVE_STREAM_ERROR_INPUTSTREAM            = 4;   // Failed to get stream from low level camera system
+    LIVE_STREAM_ERROR_INTERNET               = 5;   // No internet access detected on startup of streamer
+    LIVE_STREAM_ERROR_OSNETWORK              = 6;   // Error occured in linux networking stack. usually means the server closed the connection
+    LIVE_STREAM_ERROR_SELECTEDNETWORKTIMEOUT = 7;   // Timed out attemping to connect to the wifi network when attemping live stream
+    LIVE_STREAM_ERROR_SSL_HANDSHAKE          = 8;   // SSL handshake failed (commonly caused due to incorrect time / time zone)
+    LIVE_STREAM_ERROR_CAMERA_BLOCKED         = 9;   // Low level camera system rejected attempt to start live stream
+    LIVE_STREAM_ERROR_UNKNOWN                = 10; // Unknown
+    LIVE_STREAM_ERROR_SD_CARD_FULL           = 40; // Can not perform livestream because sd card is full
+    LIVE_STREAM_ERROR_SD_CARD_REMOVED        = 41; // Livestream stopped because sd card was removed
 }
 
 enum EnumLiveStreamStatus {
-    LIVE_STREAM_STATE_IDLE             = 0;
-    LIVE_STREAM_STATE_CONFIG           = 1;
+    LIVE_STREAM_STATE_IDLE             = 0; // Initial status. Livestream has not yet been configured
+    LIVE_STREAM_STATE_CONFIG           = 1; // Livestream is being configured
+    /* Livestream has finished configuration and is ready to start streaming */
     LIVE_STREAM_STATE_READY            = 2;
-    LIVE_STREAM_STATE_STREAMING        = 3;
-    LIVE_STREAM_STATE_COMPLETE_STAY_ON = 4;
-    LIVE_STREAM_STATE_FAILED_STAY_ON   = 5;
-    LIVE_STREAM_STATE_RECONNECTING     = 6;
+    LIVE_STREAM_STATE_STREAMING        = 3; // Livestream is actively streaming
+    LIVE_STREAM_STATE_COMPLETE_STAY_ON = 4; // Live stream is exiting. No errors occured.
+    LIVE_STREAM_STATE_FAILED_STAY_ON   = 5; // Live stream is exiting. An error occurred.
+    LIVE_STREAM_STATE_RECONNECTING     = 6; // An error occurred during livestream and stream is attempting to reconnect.
 }
 
 enum EnumRegisterLiveStreamStatus {

diff --git a/protobuf/network_management.proto b/protobuf/network_management.proto
@@ -1,5 +1,5 @@
 /* network_management.proto/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). */
-/* This copyright was auto-generated on Fri Jun  9 22:49:36 UTC 2023 */
+/* This copyright was auto-generated on Wed Jul  5 19:32:05 UTC 2023 */
 
 /*
 Defines the structure of protobuf messages for network management
@@ -84,7 +84,7 @@ message RequestConnectNew {
 message RequestGetApEntries {
     required int32 start_index = 1; // Used for paging. 0 <= start_index < NotifStartScanning.total_entries
     required int32 max_entries = 2; // Used for paging. Value must be < NotifStartScanning.total_entries
-    required int32 scan_id     = 3; // ID corresponding to a set of scan results (i.e.
+    required int32 scan_id     = 3; // ID corresponding to a set of scan results (i.e. NotifStartScanning.scan_id)
 }
 
 message RequestReleaseNetwork {

diff --git a/protobuf/request_get_preset_status.proto b/protobuf/request_get_preset_status.proto
@@ -1,5 +1,5 @@
 /* request_get_preset_status.proto/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). */
-/* This copyright was auto-generated on Fri Jun  9 22:49:36 UTC 2023 */
+/* This copyright was auto-generated on Wed Jul  5 19:32:05 UTC 2023 */
 
 /*
 Defines the structure of protobuf messages for obtaining preset status
@@ -10,8 +10,8 @@ package open_gopro;
 
 
 enum EnumRegisterPresetStatus {
-    REGISTER_PRESET_STATUS_PRESET             = 1;
-    REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY = 2;
+    REGISTER_PRESET_STATUS_PRESET             = 1; // Send notification when properties of a preset change
+    REGISTER_PRESET_STATUS_PRESET_GROUP_ARRAY = 2; // Send notification when properties of a preset group change
 }
 
 message RequestGetPresetStatus {