OpenGoPro/protobuf/set_camera_control_status.proto

/* set_camera_control_status.proto/Open GoPro, Version 2.0 (C) Copyright 2021 GoPro, Inc. (http://gopro.com/OpenGoPro). */
/* This copyright was auto-generated on Mon Nov  4 18:00:55 UTC 2024 */

/***********************************************************************************************************************
 *
 * This file is automatically generated!!! Do not modify manually.
 *
 **********************************************************************************************************************/

/**
 * Defines the structure of protobuf messages for setting camera control status
 */

syntax = "proto2";
package open_gopro;

enum EnumCameraControlStatus {
    CAMERA_IDLE             = 0;
    CAMERA_CONTROL          = 1; // Can only be set by camera, not by app or third party
    CAMERA_EXTERNAL_CONTROL = 2;
    CAMERA_COF_SETUP        = 3; // Set by the camera when it is on the CAH (Camera As a Hub) / COF (Cloud Offload) setup screen
}

/**
 * Set Camera Control Status (as part of Global Behaviors feature)
 *
 * This command is used to tell the camera that the app (i.e. External Control) wishes to claim control of the camera.
 * This causes the camera to immediately exit 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.
 *
 * 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.
 *
 * Response: @ref ResponseGeneric
 */
message RequestSetCameraControlStatus {
    required EnumCameraControlStatus camera_control_status = 1; // Declare who is taking control of the camera
}