Class CameraClient

constructor

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

  Parameters

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

  Returns CameraClient

callOptions

Readonlyname

doCommand

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

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  const result = await resource.doCommand({
    name: 'myCommand',
    args: { 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[]>

getImage

• getImage(
      mimeType?: MimeType,
      extra?: {},
      callOptions?: CallOptions,
  ): 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.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<Uint8Array>

  Example

  const camera = new VIAM.CameraClient(machine, 'my_camera');
  const image = await camera.getImage();
  
  // Convert Uint8Array to base64
  const base64Image = btoa(
    Array.from(image)
      .map((byte) => String.fromCharCode(byte))
      .join('')
  );
  
  // Convert image to base64 and display it
  const imageElement = document.createElement('img');
  imageElement.src = `data:image/jpeg;base64,${base64Image}`;
  const imageContainer = document.getElementById('#imageContainer');
  if (imageContainer) {
    imageContainer.innerHTML = '';
    imageContainer.appendChild(imageElement);
  }
  Copy

  For more information, see Camera API.

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.

renderFrame

• renderFrame(
      mimeType?: MimeType,
      extra?: {},
      callOptions?: CallOptions,
  ): 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.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<Blob>

  Example

  const camera = new VIAM.CameraClient(machine, 'my_camera');
  const mimeType = 'image/jpeg';
  const image = await camera.renderFrame(mimeType);
  Copy

  For more information, see Camera API.