Is this page helpful?

Type Alias: GFNConfig#

GFNConfig: type

GFNConfig

Configuration parameters specific to starting a GFN stream.

Type declaration#

catalogClientId#

catalogClientId: string

The ID of the catalog client.

clientId#

clientId: string

The ID of the client application.

cmsId#

cmsId: number

The CMS ID of the client application.

GFN#

GFN: 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?#

optional muteAudio: boolean

Whether or not to start the stream with audio muted.

Default Value#

true

nonce?#

optional nonce: string

The nonce value used for logging in with nonce.

onCustomEvent()?#

optional onCustomEvent: (message) => void

A function that will be called on custom events.

Parameters#

message#

ApplicationMessage | StreamMessage

Returns#

void

onStart()#

onStart: (message) => void

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

Parameters#

message#

StreamEvent

Returns#

void

onStop()?#

optional onStop: (message) => void

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

Parameters#

message#

StreamEvent

Returns#

void

onTerminate()?#

optional onTerminate: (message) => void

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

Parameters#

message#

StreamEvent

Returns#

void

onUpdate()#

onUpdate: (message) => void

A function that will be called on update events.

Parameters#

message#

StreamEvent

Returns#

void

partnerId?#

optional partnerId: string

The partner id. Required if logging in with nonce