DirectQueryProps

Package:

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

Type:

object

Defined in:

DirectQueryParams.ts:14

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

Type declaration

accessToken

Type:

string

Optional:

Yes

The client JWT.

autoLaunch

Type:

boolean

Optional:

Yes

Whether to play the stream automatically on connection.

cursor

Type:

"free" | "hardware" | "software"

Optional:

Yes

Default:

"free"

fps

Type:

number

Optional:

Yes

Default:

60

Requested frames per second for stream render.

height

Type:

number

Optional:

Yes

Default:

1080

The stream resolution height of the rendering application.

mediaPort

Type:

number

Optional:

Yes

Default:

14109

The port number for the media server.

mediaServer

Type:

string

Optional:

Yes

Default:

''

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

mic

Type:

boolean

Optional:

Yes

Default:

false

Whether to enable a mic.

nucleus

Type:

string

Optional:

Yes

Default:

''

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

server

Type:

string

Optional:

Yes

Default:

''

URL of the streaming service server to connect to.

sessionId

Type:

string

Optional:

Yes

Default:

''

Unique ID for the kit app streaming session.

signalingPath

Type:

string

Optional:

Yes

Path for resolving custom NVCF functions.

signalingPort

Type:

number

Optional:

Yes

Default:

48322

The port number for the signaling server.

signalingQuery

Type:

URLSearchParams

Optional:

Yes

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

Type:

string

Optional:

Yes

Default:

''

URL of the signaling server to connect to.

width

Type:

number

Optional:

Yes

Default:

1920

The stream resolution width of the rendering application.