Class StreamClient

A gRPC-web client for a Stream.

Hierarchy

EventDispatcher<{ track: RTCTrackEvent }>
- StreamClient

Implements

Stream

Index

Constructors

Properties

Methods

add emit getOptions getStream has off on once remove resetOptions setOptions

Constructors

constructor

new StreamClient(client: Client, options?: Options): StreamClient
Parameters
- client: Client
- options: Options = {}
Returns StreamClient
Overrides EventDispatcher<{ track: RTCTrackEvent }>.constructor

Properties

listeners

listeners: Partial<{ [K in keyof Events]: Set<Callback<Events[K]>> }> = {}

Methods

add

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

emit

emit<K extends "track">(type: K, args: { track: RTCTrackEvent }[K]): void
Type Parameters
- K extends "track"
Parameters
- type: K
- args: { track: RTCTrackEvent }[K]
Returns void
Inherited from EventDispatcher.emit

getOptions

getOptions(resourceName: string): Promise<Resolution[]>
Get the available livestream resolutions for a camera component. If the stream client cannot find any available resolutions, an empty list will be returned.
Parameters
- resourceName: string
  The name of a camera component.
Returns Promise<Resolution[]>
A list of available resolutions for livestreaming.

Implementation of Stream.getOptions

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<K extends "track">(
type: K,
listener: Callback<{ track: RTCTrackEvent }[K]>,
): boolean | undefined
Type Parameters
- K extends "track"
Parameters
- type: K
- listener: Callback<{ track: RTCTrackEvent }[K]>
Returns boolean | undefined
Inherited from EventDispatcher.has

off

off<K extends "track">(
type: K,
listener: Callback<{ track: RTCTrackEvent }[K]>,
): void
Type Parameters
- K extends "track"
Parameters
- type: K
- listener: Callback<{ track: RTCTrackEvent }[K]>
Returns void
Inherited from EventDispatcher.off

on

on<K extends "track">(
type: K,
listener: Callback<{ track: RTCTrackEvent }[K]>,
): void
Type Parameters
- K extends "track"
Parameters
- type: K
- listener: Callback<{ track: RTCTrackEvent }[K]>
Returns void
Inherited from EventDispatcher.on

once

once<K extends "track">(
type: K,
listener: Callback<{ track: RTCTrackEvent }[K]>,
): void
Type Parameters
- K extends "track"
Parameters
- type: K
- listener: Callback<{ track: RTCTrackEvent }[K]>
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

resetOptions

resetOptions(name: string): Promise<void>
Reset the livestream options for a camera component. This will reset the resolution to the default component attributes.
Parameters
- name: string
  The name of a camera component.
Returns Promise<void>
Implementation of Stream.resetOptions

setOptions

setOptions(name: string, width: number, height: number): Promise<void>
Set the livestream options for a camera component. This will change the resolution of the stream to the specified width and height.
Parameters
- name: string
  The name of a camera component.
- width: number
  The width of the resolution.
- height: number
  The height of the resolution.
Returns Promise<void>
Implementation of Stream.setOptions