Class AudioOutClient

constructor

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

  Parameters

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

  Returns AudioOutClient

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

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

getProperties

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

  Return the audio output properties.

  Parameters

  • callOptions: CallOptions = ...

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

  Example

  const audioOut = new VIAM.AudioOutClient(machine, 'my_audio_out');
  const properties = await audioOut.getProperties();
  Copy

play

• play(
      audioData: Uint8Array,
      audioInfo?: AudioInfo,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Play audio on the device.

  Parameters

  • audioData: Uint8Array

    The audio data to play
  • OptionalaudioInfo: AudioInfo

    Information about the audio format (optional, required for raw pcm data)
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

  Example

  const audioOut = new VIAM.AudioOutClient(machine, 'my_audio_out');
  const audioData = new Uint8Array([...]); // Your audio data
  const audioInfo = { codec: 'pcm16', sampleRateHz: 48000, numChannels: 2 };
  await audioOut.play(audioData, audioInfo);
  Copy