GFNConfig

Package:

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

Type:

object

Defined in:

GFNStreamer.ts:17

Configuration parameters specific to starting a GFN stream.

Type declaration

catalogClientId

Type:

string

The ID of the catalog client.

clientId

Type:

string

The ID of the client application.

cmsId

Type:

number

The CMS ID of the client application.

GFN

Type:

any

The GFN instance, which is imported in the calling application’s index.html script block from https://sdk.nvidia.com/gfn/client-sdk/1.x/gfn-client-sdk.js

muteAudio

Type:

boolean

Optional:

Yes

Default:

true

Whether or not to start the stream with audio muted.

nonce

Type:

string

Optional:

Yes

The nonce value used for logging in with nonce.

onCustomEvent

Type:

(message: unknown) => void

Optional:

Yes

A function that will be called when for custom events.

onStart

Type:

(message: StreamEvent) => void

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

onUpdate

Type:

(message: StreamEvent) => void

A function that will be called on update events.

partnerId

Type:

string

Optional:

Yes

The partner id. Required if logging in with nonce.