Interface Config

Main configuration interface for the API.

Hierarchy

Config

Index

Properties

auth? ingestUrl? inputCfg? metrics? previewVideoElId? reconnect? serverUrl? streamName?

Properties

`Optional` auth

auth?: Nullable<AuthConfig>

Authorization config. Note: Disabled for now.

`Optional` ingestUrl

ingestUrl?: string

URL of the stream.

`Optional` inputCfg

inputCfg?: Nullable<InputConfig>

Configuration for input media streams and broadcast.

`Optional` metrics

metrics?: Nullable<MetricsCredentialsConfig>

Metrics credentials

`Optional` previewVideoElId

previewVideoElId?: Nullable<string>

Identifier for the video preview element in the DOM.

`Optional` reconnect

reconnect?: boolean | Nullable<ReconnectConfig>

Reconnection config.

`Optional` serverUrl

serverUrl?: string

URL of the server.

`Optional` streamName

streamName?: Nullable<string>

Name of the stream.

Generated using TypeDoc