.. role:: ts-api-decorator

######
cee.vs
######

.. container:: ts-api-section

   .. js:module:: 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.:


   .. code-block:: javascript

      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.




.. toctree::
   :titlesonly:
   :hidden:

   /c3_reference/interfaces/cee.vs.HitItem
   /c3_reference/classes/cee.vs.ServerSession
   /c3_reference/interfaces/cee.vs.StreamInfo
   /c3_reference/classes/cee.vs.StreamModel

.. container:: api-index-section

   .. rubric:: Classes

   .. rst-class:: api-index-list-item api-kind-class api-parent-kind-module

   * :js:class:`~cee.vs.ServerSession`
   * :js:class:`~cee.vs.StreamModel`



.. container:: api-index-section

   .. rubric:: Interfaces

   .. rst-class:: api-index-list-item api-kind-interface api-parent-kind-module

   * :js:class:`~cee.vs.HitItem`
   * :js:class:`~cee.vs.StreamInfo`



.. container:: api-index-section

   .. rubric:: Type Aliases

   .. rst-class:: api-index-list-item api-kind-objectliteral api-parent-kind-module

   * 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
============

.. todo:: Implement None cee.vs.CallbackOptions ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')



------------

Properties
----------

.. container:: ts-api-section

   .. js:attribute:: CallbackOptions.matchPublishTag

      :type: string :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: CallbackOptions.oneShot

      :type: boolean :ts-api-decorator:`optional`





.. todo:: Implement None cee.vs.ConfigReadyCallback ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.ConfigReadyResult ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.RevisionBoundConfigReadyCallback ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.RevisionBoundConfigReadyResult ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.RevisionBoundStreamingCompleteCallback ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.RevisionBoundStreamingCompleteResult ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.StreamingCompleteCallback ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.StreamingCompleteResult ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')

.. todo:: Implement None cee.vs.StreamResError ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')



------------

Properties
----------

.. container:: ts-api-section

   .. js:attribute:: StreamResError.error

      :type: Error





.. container:: ts-api-section

   .. js:attribute:: StreamResError.status

      :type: unknown





.. container:: ts-api-section

   .. js:attribute:: StreamResError.streamRevision

      :type: number





.. todo:: Implement None cee.vs.StreamResOk ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')



------------

Properties
----------

.. container:: ts-api-section

   .. js:attribute:: StreamResOk.publishTag

      :type: string | unknown





.. container:: ts-api-section

   .. js:attribute:: StreamResOk.status

      :type: unknown





.. container:: ts-api-section

   .. js:attribute:: StreamResOk.streamRevision

      :type: number





.. todo:: Implement None cee.vs.StreamResRevisionObsolete ('RSTGenerator' object has no attribute 'write_OBJECTLITERAL')



------------

Properties
----------

.. container:: ts-api-section

   .. js:attribute:: StreamResRevisionObsolete.status

      :type: unknown





.. container:: ts-api-section

   .. js:attribute:: StreamResRevisionObsolete.supersededByStreamRevision

      :type: number





