Stay organized with collections
Save and categorize content based on your preferences.
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 2 since when any option name is invalid, invalidParameterName
should be returned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis command returns current camera settings for the requested properties, specified in \u003ccode\u003eoptionNames\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAPI level 2 removed the requirement for a \u003ccode\u003esessionId\u003c/code\u003e, obtained from \u003ccode\u003ecamera.startSession\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eResults are provided in JSON format as \u003ccode\u003e<key, value>\u003c/code\u003e pairs within the \u003ccode\u003eoptions\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003ePossible errors include \u003ccode\u003emissingParameter\u003c/code\u003e if required parameters are absent and \u003ccode\u003einvalidParameterName\u003c/code\u003e for unsupported option names.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003einvalidParameterValue\u003c/code\u003e error was deprecated in API level 2 and replaced with \u003ccode\u003einvalidParameterName\u003c/code\u003e for invalid option names.\u003c/p\u003e\n"]]],["This command retrieves current settings for specified properties. It requires an array of `optionNames` to be provided. It returns a JSON object containing `\u003ckey, value\u003e` pairs of the requested properties within the `options` field. API level 1 required a `sessionId` obtained from `camera.startSession`, but this is deprecated in API level 2. Errors include `missingParameter`, `invalidParameterName` for unrecognized parameters, and `invalidParameterValue` for incorrect values in API 1.\n"],null,[]]