camera.getOptions

Page Summary

outlined_flag

• This command returns current camera settings for the requested properties, specified in optionNames .

• API level 2 removed the requirement for a sessionId , obtained from camera.startSession .

• Results are provided in JSON format as <key, value> pairs within the options field.

• Possible errors include missingParameter if required parameters are absent and invalidParameterName for unsupported option names.

• invalidParameterValue error was deprecated in API level 2 and replaced with invalidParameterName for invalid option names.

Returns current settings for requested properties. This command was modified in API level 2.

Parameters

• sessionId:Unique session identifier of type string obtained using the camera.startSession command. This field was deprecated in API level 2.
• optionNames:A String Array of property names to return.

Results

• options:JSON <key, value> pairs of the requested properties. The value can be any of the following types: String , String Array , Number , Number Array , Boolean , Object , Object Array . See Options .

Errors

• missingParameter:One or more required parameters is missing; for example, optionNames is not specified.
• invalidParameterName:One or more input parameter name or option name is unrecognized or unsupported, e.g. this code should be returned if an option (e.g. captureInterval ) from API level 2 is used when clientVersion in Options is 1.
• invalidParameterValue:Input parameter names are recognized, but one or more values are invalid; for example, the sessionId doesn't exist, is inactive, or its data type is incorrect. This error code was deprecated in API level 2since when any option name is invalid, invalidParameterName should be returned.

{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}

{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}

{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}

{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}

{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}

{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}