camera.setOptions

AI-generated Key Takeaways

outlined_flag

• Sets camera properties like GPS, date/time, ISO, and shutter speed.

• This command was modified in API level 2, removing the need for a session identifier.

• options parameter accepts JSON key-value pairs to configure camera settings.

• Possible errors include missing parameters, invalid parameter names or values.

Sets values for specified properties; for example, GPS on/off, date & time, ISO, white balance, shutter speed, sleep/power-off delay, and so on. 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.
• options: JSON <key, value> pairs of the properties to set. The value can be any of the following types: String, String Array, Number, Number Array, Boolean, Object, Object Array. See Options.

Results

• This command returns no result.

Errors

• missingParameter: One or more required parameters is missing; for example, options is not specified.
• invalidParameterName: One or more input parameter option 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: One or more input parameter or option name is recognized, but its value is invalid; for example, a data type is incorrect.

{
    "parameters": {
        "sessionId": "12ABC3",
        "options": {
            "isoBalance": 200
        }
    }
}

none

{
    "error": {
        "code": "invalidParameterName",
        "message": "Parameter options contains unsupported option isoBalance."
    }
}

{
    "parameters": {
        "options": {
            "iso": 200,
            "captureInterval": 20
        }
    }
}

none

{
    "error": {
        "code": "invalidParameterName",
        "message": "Parameter options contains unsupported option captureInterval."
    }
}