.. role:: ts-api-decorator

.. _StreamingMode:

#############
StreamingMode
#############

.. container:: ts-api-section

   Enumerates the mode the viewer will use when streaming data to the client.



.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`StreamingMode.All`
   * :ref:`StreamingMode.Default`
   * :ref:`StreamingMode.Interactive`
   * :ref:`StreamingMode.OnDemand`





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

Enumeration Members
===================

.. rst-class:: ts-api-section

.. _StreamingMode.All:

All
---

All data will be streamed to the client.
Priority will be given to data visible based on the view frustum.
The supporting server process will remain active.

.. rst-class:: ts-api-section

.. _StreamingMode.Default:

Default
-------

The default streaming mode.

.. rst-class:: ts-api-section

.. _StreamingMode.Interactive:

Interactive
-----------

This is the default setting for the viewer.
Data will be streamed as it becomes visible based on the viewing frustum.
Keyed data that was encoded with priority 0 will not be streamed unless explicitly requested.
The supporting server process will remain active while the user views the model.

.. rst-class:: ts-api-section

.. _StreamingMode.OnDemand:

OnDemand
--------

No data is streamed to the client unless it has been explicitly requested.
The supporting server process will remain active while the user views the model.

