Skip to content

Commit 58f1709

Browse files
authored
Remove RenderFrame (#4810)
1 parent 89000e5 commit 58f1709

File tree

2 files changed

+0
-33
lines changed

2 files changed

+0
-33
lines changed

static/include/components/apis/generated/camera-table.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
| ----------- | ----------- |
44
| [`GetImage`](/dev/reference/apis/components/camera/#getimage) | _Deprecated_. |
55
| [`GetImages`](/dev/reference/apis/components/camera/#getimages) | Get simultaneous images from different imagers, along with associated metadata. |
6-
| [`RenderFrame`](/dev/reference/apis/components/camera/#renderframe) | Render a frame from a camera of the underlying robot to an HTTP response. |
76
| [`GetPointCloud`](/dev/reference/apis/components/camera/#getpointcloud) | Get a point cloud from the camera as bytes with a MIME type describing the structure of the data. |
87
| [`GetProperties`](/dev/reference/apis/components/camera/#getproperties) | Get the camera intrinsic parameters and camera distortion, as well as whether the camera supports returning point clouds. |
98
| [`DoCommand`](/dev/reference/apis/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

static/include/components/apis/generated/camera.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -289,38 +289,6 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s
289289
{{% /tab %}}
290290
{{< /tabs >}}
291291

292-
### RenderFrame
293-
294-
Render a frame from a camera of the underlying robot to an HTTP response.
295-
A specific MIME type can be requested but may not necessarily be the same one returned.
296-
297-
{{< tabs >}}
298-
{{% tab name="TypeScript" %}}
299-
300-
**Parameters:**
301-
302-
- `mimeType` ([MimeType](https://ts.viam.dev/types/MimeType.html)) (optional): A specific MIME type to request. This is not necessarily
303-
the same type that will be returned.
304-
- `extra` (None) (optional)
305-
- `callOptions` (CallOptions) (optional)
306-
307-
**Returns:**
308-
309-
- (Promise<Blob>)
310-
311-
**Example:**
312-
313-
```ts {class="line-numbers linkable-line-numbers"}
314-
const camera = new VIAM.CameraClient(machine, 'my_camera');
315-
const mimeType = 'image/jpeg';
316-
const image = await camera.renderFrame(mimeType);
317-
```
318-
319-
For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/CameraClient.html#renderframe).
320-
321-
{{% /tab %}}
322-
{{< /tabs >}}
323-
324292
### GetPointCloud
325293

326294
Get a point cloud from the camera as bytes with a MIME type describing the structure of the data.

0 commit comments

Comments
 (0)