Class AudioInClient

constructor

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

  Parameters

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

  Returns AudioInClient

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

getAudio

• getAudio(
      codec: string,
      durationSeconds: number,
      previousTimestamp?: bigint,
      extra?: {},
      callOptions?: CallOptions,
  ): AsyncIterable<AudioChunk>

  Stream audio from the device.

  Parameters

  • codec: string
  • durationSeconds: number
  • previousTimestamp: bigint = 0n
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns AsyncIterable<AudioChunk>

  Example

  const audioIn = new VIAM.AudioInClient(machine, 'my_audio_in');
  const stream = audioIn.getAudio(VIAM.AudioCodec.PCM16, 3, 0n, {});
  Copy

getProperties

• getProperties(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<
      { numChannels: number; sampleRateHz: number; supportedCodecs: string[] },
  >

  Return the audio input properties.

  Parameters

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

  Returns Promise<
      { numChannels: number; sampleRateHz: number; supportedCodecs: string[] },
  >

  Example

  const audioIn = new VIAM.AudioInClient(machine, 'my_audio_in');
  const properties = await audioIn.getProperties();
  Copy

getStatus

• getStatus(callOptions?: CallOptions): Promise<JsonValue>

  Get the status of the resource.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>