Class VideoStream

Readonlylocked

[asyncIterator]

• "[asyncIterator]"(): ReadableStreamAsyncIterator<VideoFrameEvent>

  Returns ReadableStreamAsyncIterator<VideoFrameEvent>

cancel

• cancel(reason?: any): Promise<void>

  Parameters

  • Optionalreason: any

  Returns Promise<void>

getReader

• getReader(options: { mode: "byob" }): ReadableStreamBYOBReader

  Parameters

  • options: { mode: "byob" }

  Returns ReadableStreamBYOBReader

• getReader(): ReadableStreamDefaultReader<VideoFrameEvent>

  Returns ReadableStreamDefaultReader<VideoFrameEvent>

• getReader(
      options?: ReadableStreamGetReaderOptions,
  ): ReadableStreamReader<VideoFrameEvent>

  Parameters

  • Optionaloptions: ReadableStreamGetReaderOptions

  Returns ReadableStreamReader<VideoFrameEvent>

pipeThrough

• pipeThrough<T>(
      transform: ReadableWritablePair<T, VideoFrameEvent>,
      options?: StreamPipeOptions,
  ): ReadableStream<T>

  Type Parameters

  • T

  Parameters

  • transform: ReadableWritablePair<T, VideoFrameEvent>
  • Optionaloptions: StreamPipeOptions

  Returns ReadableStream<T>

pipeTo

• pipeTo(
      destination: WritableStream<VideoFrameEvent>,
      options?: StreamPipeOptions,
  ): Promise<void>

  Parameters

  • destination: WritableStream<VideoFrameEvent>
  • Optionaloptions: StreamPipeOptions

  Returns Promise<void>

tee

• tee(): [ReadableStream<VideoFrameEvent>, ReadableStream<VideoFrameEvent>]

  Returns [ReadableStream<VideoFrameEvent>, ReadableStream<VideoFrameEvent>]

values

• values(
      options?: { preventCancel?: boolean },
  ): ReadableStreamAsyncIterator<VideoFrameEvent>

  Parameters

  • Optionaloptions: { preventCancel?: boolean }

  Returns ReadableStreamAsyncIterator<VideoFrameEvent>

Staticfrom

• from<T>(
      iterable: Iterable<T, any, any> | AsyncIterable<T, any, any>,
  ): ReadableStream<T>

  Type Parameters

  • T

  Parameters

  • iterable: Iterable<T, any, any> | AsyncIterable<T, any, any>

  Returns ReadableStream<T>