Skip to content
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.

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

DOCS-3466: Remove stream from hello world module guide #3935

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions docs/operate/get-started/other-hardware/hello-world-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,6 @@ First, implement the camera API methods by editing the camera class definition:
1. Delete the `SubscribeRTP` and `Unsubscribe` methods, since they are not applicable to this camera.

1. You can leave the rest of the functions not implemented, because this module is not meant to return a point cloud (`NextPointCloud`), and does not need to return multiple images simultaneously (`Images`).
If this camera returned a camera stream instead of a single static file, we would have implemented `Stream` instead of `Read`.

However, you do need to edit the return statements to return empty structs that match the API.
Edit these methods so they look like this:
Expand All @@ -587,10 +586,6 @@ First, implement the camera API methods by editing the camera class definition:
return nil, errors.New("not implemented")
}

func (s *helloWorldHelloCamera) Stream(ctx context.Context, errHandlers ...gostream.ErrorHandler) (gostream.VideoStream, error) {
return nil, errors.New("not implemented")
}

func (s *helloWorldHelloCamera) Images(ctx context.Context) ([]camera.NamedImage, resource.ResponseMetadata, error) {
return []camera.NamedImage{}, resource.ResponseMetadata{}, errors.New("not implemented")
}
Expand Down
Loading