Type Alias: DirectConfig#

DirectConfig = DirectQueryProps & object

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

Type declaration#

audioElementId?#

optional audioElementId: string

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

Default Value#

'remote-audio'

authenticate?#

optional authenticate: boolean

Whether the stream reverse proxy requires a JWT token.

Default Value#

false

backendUrl?#

optional backendUrl: string

AKA Stream API URL. Endpoint for the OVC Stream API. Used to interact with the stream service rather than the stream application. For example, request a new session, terminate a session, etc.

codecList?#

optional codecList: string[]

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

connectivityTimeout?#

optional connectivityTimeout: number

Defines the stream connection timeout interval, in milliseconds.

Default Value#

enableAV1Support?#

optional enableAV1Support: boolean

Enables Av1 support for streaming.

localizeTextInput?#

optional localizeTextInput: boolean

Whether the client wants localized unicode text input sent directly to the server, if supported (requires server built with Kit 108 or above).

Default Value#

true

maxReconnects?#

optional maxReconnects: number

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

Default Value#

nativeTouchEvents?#

optional nativeTouchEvents: boolean

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

Default Value#

false

newSession?#

optional newSession: boolean

Whether to request a new session from the backend URL.

Default Value#

false

onCustomEvent()?#

optional onCustomEvent: (message) => void

A function that will be called for custom events.

Parameters#

message#

any

Returns#

void

onStart()?#

optional 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

onStreamStats()?#

optional onStreamStats: (message) => void

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

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()?#

optional onUpdate: (message) => void

A function that will be called on update events.

Parameters#

message#

StreamEvent

Returns#

void

videoElementId?#

optional videoElementId: string

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

Default Value#

'remote-video'