Type Alias: DirectQueryProps#

DirectQueryProps = object

DirectQueryProps defines all possible parameters that are passed down to Direct as URLSearchParams.

Properties#

accessToken?#

optional accessToken: string

The client JWT.

autoLaunch?#

optional autoLaunch: boolean

Whether to play the stream automatically on connection.

Default Value#

true

cursor?#

optional cursor: "free" | "hardware" | "software"

Default Value#

free

fps?#

optional fps: number

Requested frames per second for stream render.

Default Value#

height?#

optional height: number

The stream resolution height of the rendering application.

Default Value#

mediaPort?#

optional mediaPort: number

The port number for the media server.

mediaServer?#

optional mediaServer: string

URL of the media server to connect the streaming kit app to.

mic?#

optional mic: boolean

Whether to enable a mic.

Default Value#

false

nucleus?#

optional nucleus: string

URL of a Nucleus data server to connect the streaming kit app to.

server?#

optional server: string

URL of the streaming service server to connect to.

sessionId?#

optional sessionId: string

Unique ID for the kit app streaming session. If no value is specified, a new session will be requested.

signalingPath?#

optional signalingPath: string

Path for resolving custom NVCF functions.

signalingPort?#

optional signalingPort: number

The port number for the signaling server.

Default Value#

signalingQuery?#

optional signalingQuery: URLSearchParams

Search params for the signaling server. NOTE that we cannot type this as individual parameters because they will need to be re-definable by library users.

signalingServer?#

optional signalingServer: string

URL of the signaling server to connect to.

width?#

optional width: number

The stream resolution width of the rendering application.