Skip to content

RSDK-13341: Document get_images source names #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hexbabe merged 2 commits into from
Feb 6, 2026
Merged

RSDK-13341: Document get_images source names #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc8d4ee
RSDK-13341: Document get_images source names in README
hexbabe Feb 6, 2026
770584c
Fix
hexbabe Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,17 @@ The following attributes are available for the Gemini 335Le model:
| `640X480` | `640X480` |


## `get_images` Source Names

`get_images` supports two source names for use with `filter_source_names`:

| Source Name | MIME Type | Description |
|-------------|-----------|-------------|
| `color` | `image/jpeg` or `image/png` | Color image from the RGB sensor |
| `depth` | `image/vnd.viam.dep` | Depth map from the depth sensor |

If `filter_source_names` is empty, both `color` and `depth` images are returned. If populated, only the matching source names are returned. Unrecognized names are ignored.

## Attributes
A call to get_attributes will return the camera attributes in [this struct](https://github.com/viamrobotics/viam-cpp-sdk/blob/43deea420f572e6b61b6fbd519e09b2520f05676/src/viam/sdk/components/camera.hpp#L58)

Expand Down