camera.getImage
Returns a full-size or scaled image given its URI. Input parameters include
resolution. This is the only command that should return, Content-Type: image/jpeg
.
All other commands return Content-Type: application/json;charset=utf-8
.
This command was deprecated in API level 2.
Parameters
- fileUri: URI of the target file. Manufacturers decide whether to use
absolute or relative URIs. Clients may treat this as an opaque identifier.
- maxSize: (Optional) Maximum size of the requested image;
max(scaledimage_width, scaledimage_height). If
maxSize
is omitted or larger
than the full-size image, the full-size image is returned.
Results
- content: Image binary data, including corresponding (for example, scaled)
metadata in image header.
Errors
- missingParameter: The required
fileUri
is not specified.
- invalidParameterName: An input parameter name is unrecognized.
- invalidParameterValue: The input parameter name is recognized, but its value
is invalid; for example, the
fileUri
value doesn't exist, its data type is incorrect,
or maxSize
has the wrong data type.
Command I/O |
Command Input |
{
"parameters": {
"fileUri": "file URI",
"maxSize": 400
}
} |
Command Output |
Image binary data |
Command Output (Error) |
{
"error": {
"code": "invalidParameterValue",
"message": "Parameter fileUri doesn't exist."
}
} |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["Returns a full-size or scaled image based on its URI, with optional resizing using the `maxSize` parameter."],["This command is deprecated and was replaced in API level 2, primarily used for retrieving image data in JPEG format."],["Input requires a `fileUri` parameter, while `maxSize` is optional for scaling the output image."],["Output provides the image as binary data, including relevant metadata, or an error message in JSON format."],["Potential errors involve missing or invalid parameters, such as an incorrect `fileUri` or `maxSize` value."]]],["The command retrieves an image (full-size or scaled) via its URI, with `fileUri` being mandatory and `maxSize` (maximum dimension) being optional. If `maxSize` is omitted or exceeds the image's full size, the full-size image is provided. Output is image binary data, with `Content-Type: image/jpeg`. Errors include missing/invalid parameter or invalid value. It was deprecated in API level 2. Example input involves `fileUri` and `maxSize`. Example error is related to an invalid `fileUri`.\n"]]