cee.vs

The vs sub-module provides a streaming model designed to work in pair with the Visualization Streamer Service (VizService) to which it requires a live connection. It handles fast and efficient streaming of 3D data to web while being specifically tailored towards showing CAE visualizations.

For any visualization to be streamed to the client, VizService must be running on the server side an data must be pushed towards it from an application or other service running on the server side. That is done via gRPC or a C++ interface. For more information, please see the Visualization Streamer documentation page.

Assuming that the EnvisionWeb client component has been imported into the variable cee, the members of the vs module may be referenced using the cee.vs prefix, e.g.:

const serverSession = await cee.vs.ServerSession.createInstance_async("http://localhost:8091");

We provide a complete minimal example of how to use this module in the Examples/MinimalVsClient folder inside the distribution package.

Classes

Interfaces

Type Aliases

  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A
  • N/A

Type Aliases

Properties

CallbackOptions.matchPublishTag
Type:string optional
CallbackOptions.oneShot
Type:boolean optional

Properties

StreamResError.error
Type:Error
StreamResError.status
Type:unknown
StreamResError.streamRevision
Type:number

Properties

StreamResOk.publishTag
Type:string | unknown
StreamResOk.status
Type:unknown
StreamResOk.streamRevision
Type:number

Properties

StreamResRevisionObsolete.status
Type:unknown
StreamResRevisionObsolete.supersededByStreamRevision
Type:number