DOCS-3196: Update Camera interface for Go Image function and remove Stream/Next #3854
Conversation
sguequierre
commented
Jan 15, 2025
sguequierre
commented
- tested and confirmed with rand that decoded function is what we want to use for the vision service samples
viambot
added
the
safe to build
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ``` | ||
|
|
||
| If you use this method, be sure to import `"go.viam.com/rdk/utils"` at the beginning of your file. |
There was a problem hiding this comment.
this tripped me up when testing-- imported wrong utils-- so wanted to specify
There was a problem hiding this comment.
Nice. Does this need to be added to an override in order to stay here in the future?
| **Parameters:** | ||
|
|
||
| - `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. | ||
| - `errHandlers` [(...gostream.ErrorHandler)](https://pkg.go.dev/go.viam.com/rdk/gostream#ErrorHandler): A handler for errors allowing for logic based on consecutively retrieved errors. | ||
| - `mimeType` [(string)](https://pkg.go.dev/builtin#string): The desired mime type of the image. This does not guarantee output type. |
There was a problem hiding this comment.
[nit/oopt] if you care to, update "MIME" upstream to be capitalized, here and elsewhere
| ``` | ||
|
|
||
| If you use this method, be sure to import `"go.viam.com/rdk/utils"` at the beginning of your file. |
There was a problem hiding this comment.
Nice. Does this need to be added to an override in order to stay here in the future?
static/include/components/apis/overrides/methods/go.camera.Image.after.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,8 @@ | |||
| You can also directly decode as an `Image.Image` with the camera's `DecodeImageFromCamera` function: | |||
There was a problem hiding this comment.
I just looked at the linked Go SDK doc to see if there was more about why someone would do one versus the other and noticed it says "Or try to directly decode as an image.Image:" The word "try" makes me wonder if there's a reason the DecodeImageFromCamera method would be more likely to fail than the other method. Is there?
There was a problem hiding this comment.
@randhid is there any reason we should update the wording here to account for the method failing?
There was a problem hiding this comment.
checked in with rand -- try is appropriate bc you could pass in bytes that aren't an image and it will decode it into garbage
Co-authored-by: JessamyT <[email protected]>
static/include/components/apis/overrides/methods/go.camera.Image.after.md
Outdated
Show resolved
Hide resolved
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3854 |
