DirectConfig

Package:

@nvidia/omniverse-webrtc-streaming-library v4.4.2

Type:

DirectQueryProps & object

Defined in:

DirectStreamer.ts:23

Configuration parameters specific to starting a local or remote non-GFN stream.

Type declaration

audioElementId

Type:

string

Optional:

Yes

Default:

'remote-audio'

The id of the audio element created by the caller for the stream.

authenticate

Type:

boolean

Optional:

Yes

Default:

false

Whether the stream reverse proxy requires a JWT token.

backendUrl

Type:

string

Optional:

Yes

AKA Stream API URL. Endpoint for the OVC Stream API. Used to terminate instances.

codecList

Type:

string[]

Optional:

Yes

A optional list of explicitly supported codecs, in descending order, according to priority

connectivityTimeout

Type:

number

Optional:

Yes

Default:

2000

Defines the stream connection timeout interval, in milliseconds.

enableAV1Support

Type:

boolean

Optional:

Yes

Enables Av1 support for streaming.

maxReconnects

Type:

number

Optional:

Yes

Default:

5

Maximum number of reconnects to the stream the client should attempt. Range[0, max_integer].

nativeTouchEvents

Type:

boolean

Optional:

Yes

Default:

false

Whether the client should send native touch events or emulate mouse events.

onCustomEvent

Type:

(message: any) => void

Optional:

Yes

A function that will be called for custom events.

onStart

Type:

(message: StreamEvent) => void

Optional:

Yes

A function that will be called when the stream is started.

onStop

Type:

(message: StreamEvent) => void

Optional:

Yes

A function that will be called when the stream is stopped.

onStreamStats

Type:

(message: StreamEvent) => void

Optional:

Yes

A function that will be called by the service to pass stream StreamStats information.

onTerminate

Type:

(message: StreamEvent) => void

Optional:

Yes

A function that will be called when the stream is terminated.

onUpdate

Type:

(message: StreamEvent) => void

Optional:

Yes

A function that will be called on update events.

videoElementId

Type:

string

Optional:

Yes

Default:

'remote-video'

The id of the video element created by the caller for the stream.