AppStreamer#
- Package:
@nvidia/omniverse-webrtc-streaming-library v4.4.2
- Defined in:
AppStreamer.ts:36
Class AppStreamer can be used connect to, pause, un-pause, and terminate a streaming Omniverse kit application session. It can also be used to send/receive custom messages to/from the streaming kit application.
Constructors#
new AppStreamer()#
new AppStreamer()
- Returns:
Methods#
connect()#
- static connect(props)#
- Parameters:
props (StreamProps) – The StreamProps that contain the initialization data for the stream.
- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:45
Connects to the streaming kit app specified by the input props.
resize()#
- static resize(width, height)#
- Parameters:
width (number) – The requested width
height (number) – The requested height
- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:202
Makes a request to update the resolution of the steaming application.
sendMessage()#
- static sendMessage(message)#
- Parameters:
message (any) – A custom message to send to the streaming application.
- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:89
Sends the provided custom message to the streaming kit application.
start()#
- static start()#
- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:127
Starts/restarts the stream.
stop()#
- static stop()#
- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:144
Stops (pauses) the stream.
terminate()#
- static terminate(terminateApp, force)#
- Parameters:
terminateApp (boolean) – Whether or not to terminate the kit app instance. Default:
falseforce (boolean) – Default:
false- Returns:
Promise<StreamEvent>
- Defined in:
AppStreamer.ts:168
Terminates the stream. The stream reference will be reset and will no longer be accessible. Setup will need to be called to connect to a new session. If terminateApp is true, then the kit app instance will also be terminated (currently only applies to OVC v1 stream API).