Class StreamClient

A gRPC-web client for a Stream.

Hierarchy

EventDispatcher
- StreamClient

Implements

Stream

Index

Constructors

Properties

STREAM_TIMEOUT client listeners options streams

Accessors

Methods

add emit getStream has off on once remove

Constructors

constructor

new StreamClient(client: RobotClient, options?: Options): StreamClient
Parameters
- client: RobotClient
- options: Options = {}
Returns StreamClient

Overrides EventDispatcher.constructor

Properties

`Private` STREAM_TIMEOUT

STREAM_TIMEOUT: number = 5000

`Private` client

client: StreamServiceClient

listeners

listeners: Record<string, Set<Callback>> = {}

`Private` `Readonly` options

options: Options

`Private` streams

streams: Set<string>

Accessors

`Private` streamService

get streamService(): StreamServiceClient
Returns StreamServiceClient

Methods

add

add(name: string): Promise<void>
Add a stream by name.
Parameters
- name: string
Returns Promise<void>

Implementation of Stream.add

emit

emit(type: string, args: unknown): void
Parameters
- type: string
- args: unknown
Returns void

Inherited from EventDispatcher.emit

getStream

getStream(name: string): Promise<MediaStream>
Get a stream by name from a StreamClient. Will time out if stream is not received within 5 seconds.
Parameters
- name: string
  
  The name of a camera component.
Returns Promise<MediaStream>

has

has(type: string, listener: Callback): undefined | boolean
Parameters
- type: string
- listener: Callback
Returns undefined | boolean

Inherited from EventDispatcher.has

off

off(type: string, listener: Callback): void
Parameters
- type: string
- listener: Callback
Returns void

Inherited from EventDispatcher.off

on

on(type: string, listener: Callback): void
Parameters
- type: string
- listener: Callback
Returns void

Inherited from EventDispatcher.on

once

once(type: string, listener: Callback): void
Parameters
- type: string
- listener: Callback
Returns void

Inherited from EventDispatcher.once

remove

remove(name: string): Promise<void>
Remove a stream by name.
Parameters
- name: string
Returns Promise<void>

Implementation of Stream.remove

Generated using TypeDoc