Class CameraClient

A gRPC-web client for the Camera component.

Hierarchy

CameraClient

Implements

Camera

Index

Constructors

Properties

client name options

Accessors

Methods

doCommand getImage getPointCloud getProperties renderFrame

Constructors

constructor

new CameraClient(client: RobotClient, name: string, options?: Options): CameraClient
Parameters
- client: RobotClient
- name: string
- options: Options = {}
Returns CameraClient

Properties

`Private` client

client: CameraServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` cameraService

get cameraService(): CameraServiceClient
Returns CameraServiceClient

Methods

doCommand

doCommand(command: StructType): Promise<StructType>
Send/Receive arbitrary commands to the resource.
Parameters
- command: StructType
  
  The command to execute.
Returns Promise<StructType>

Implementation of Camera.doCommand

getImage

getImage(mimeType?: MimeType): Promise<Uint8Array>
Return a frame from a camera.
Parameters
- mimeType: MimeType = ''
  
  A specific MIME type to request. This is not necessarily the same type that will be returned.
Returns Promise<Uint8Array>

Implementation of Camera.getImage

getPointCloud

getPointCloud(): Promise<Uint8Array>
Return a point cloud from a camera.

Returns Promise<Uint8Array>

Implementation of Camera.getPointCloud

getProperties

getProperties(): Promise<cameraApi.GetPropertiesResponse.AsObject>
Return the camera properties.

Returns Promise<cameraApi.GetPropertiesResponse.AsObject>

Implementation of Camera.getProperties

renderFrame

renderFrame(mimeType?: MimeType): Promise<Blob>
Render a frame from a camera to an HTTP response.
Parameters
- mimeType: MimeType = ''
  
  A specific MIME type to request. This is not necessarily the same type that will be returned.
Returns Promise<Blob>

Implementation of Camera.renderFrame

Generated using TypeDoc