Class CameraClient

constructor

• new CameraClient(client: Client, name: string, options?: Options): CameraClient

  Parameters

  • client: Client
  • name: string
  • options: Options = {}

  Returns CameraClient

callOptions

Readonlyname

doCommand

• doCommand(
      command: Struct | Record<string, JsonValue>,
      callOptions?: CallOptions,
  ): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct | Record<string, JsonValue>

    The command to execute. Accepts either a Struct or a plain object, which will be converted automatically.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  // Plain object (recommended)
  const result = await resource.doCommand({
    myCommand: { key: 'value' },
  });
  
  // Struct (still supported)
  import { Struct } from '@viamrobotics/sdk';
  
  const result = await resource.doCommand(
    Struct.fromJson({ myCommand: { key: 'value' } })
  );
  Copy

getGeometries

• getGeometries(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Geometry[]>

  Get the geometries of the component in their current configuration

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<commonApi.Geometry[]>

getImages

• getImages(
      filterSourceNames?: string[],
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<
      {
          images: { image: Uint8Array; mimeType: string; sourceName: string }[];
          metadata: ResponseMetadata;
      },
  >

  Return a frame from a camera.

  Parameters

  • filterSourceNames: string[] = []

    A list of source names to filter the images by. If empty or undefined, all images will be returned.
  • extra: {} = {}

    Extra parameters to pass to the camera.
  • callOptions: CallOptions = ...

  Returns Promise<
      {
          images: { image: Uint8Array; mimeType: string; sourceName: string }[];
          metadata: ResponseMetadata;
      },
  >

  Example

  const camera = new VIAM.CameraClient(machine, 'my_camera');
  const images = await camera.getImages();
  Copy

  TODO(docs): include docs link for get images TS example

getPointCloud

• getPointCloud(extra?: {}, callOptions?: CallOptions): Promise<Uint8Array>

  Return a point cloud from a camera.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<Uint8Array>

  Example

  const camera = new VIAM.CameraClient(machine, 'my_camera');
  const pointCloud = await camera.getPointCloud();
  Copy

  For more information, see Camera API.

getProperties

• getProperties(
      callOptions?: CallOptions,
  ): Promise<cameraApi.GetPropertiesResponse>

  Return the camera properties.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<cameraApi.GetPropertiesResponse>

  Example

  const camera = new VIAM.CameraClient(machine, 'my_camera');
  const properties = await camera.getProperties();
  Copy

  For more information, see Camera API.