StreamEvent

Package:

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

Type:

object

Defined in:

StreamStatus.ts:119

StreamEvent

This structure is used to pass steaming event information to the client. All event messages will be in this format.

Type declaration

action

Type:

eAction

The type of action that the event describes.

eta

Type:

number

Optional:

Yes

info

Type:

string | TypeError

Additional information about the action.

queuePosition

Type:

number

Optional:

Yes

The position of the event in the event queue.

sessionId

Type:

string

Optional:

Yes

The id of the session that sent the event.

stats

Type:

StreamStats

Optional:

Yes

Performance stats information about the running stream.

status

Type:

eStatus

The status of the event action.

subSessionId

Type:

string

Optional:

Yes

The id of the sub-session that sent the event.