Class VideoClient

constructor

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

  Parameters

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

  Returns VideoClient

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.

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  The result of the command.

getStatus

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

  Get the status of the resource.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

getVideo

• getVideo(
      startTimestamp?: Date,
      endTimestamp?: Date,
      videoCodec?: string,
      videoContainer?: string,
      extra?: {},
      callOptions?: CallOptions,
  ): AsyncIterable<VideoChunk>

  Retrieve video data for a given time range.

  Parameters

  • OptionalstartTimestamp: Date

    Start time for the video retrieval.

  • OptionalendTimestamp: Date

    End time for the video retrieval.

  • videoCodec: string = ''

    Codec for the video (e.g., "h264", "h265").

  • videoContainer: string = ''

    Container format (e.g., "mp4", "fmp4").

  • extra: {} = {}

    Additional arguments.

  • callOptions: CallOptions = ...

  Returns AsyncIterable<VideoChunk>

  An async iterable of video chunks.

  Example

  const video = new VIAM.VideoClient(machine, 'my_video');
  const videoStream = video.getVideo(
    new Date('2025-01-01T00:00:00Z'),
    new Date('2025-01-01T00:10:00Z'),
    'h264',
    'mp4',
  );
  
  for await (const chunk of videoStream) {
    console.log('Received video chunk:', chunk.videoData.length, 'bytes');
  }
  Copy