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 whenclientVersion
inOptions
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.
Command I/O | |
---|---|
Command Input (API level 1) | { "parameters": { "sessionId": "12ABC3", "optionNames": [ "iso", "isoSupport" ] } } |
Command Output (API level 1) | { "results": { "options": { "iso": 200, "isoSupport": [100, 200, 400, 800, 1600] } } } |
Command Output (Error) (API level 1) | { "error": { "code": "invalidParameterName", "message": "Parameter optionNames contains unrecognized option XYZ." } } |
Command Input (API level 2) | { "parameters": { "optionNames": [ "iso", "isoSupport" ] } } |
Command Output (API level 2) | { "results": { "options": { "iso": 200, "isoSupport": [100, 200, 400, 800, 1600] } } } |
Command Output (Error) (API level 2) | { "error": { "code": "invalidParameterName", "message": "Parameter optionNames contains unrecognized option XYZ." } } |