.. _isaacsim_streaming_rtsp_RTSPCameraHelper_1:

.. _isaacsim_streaming_rtsp_RTSPCameraHelper:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: RTSP Camera Helper
    :keywords: lang-en omnigraph node isaacRtsp rtsp r-t-s-p-camera-helper


RTSP Camera Helper
==================

.. <description>

Sets up RTSP streaming for a camera render product. Attaches a Replicator writer that captures LdrColor frames and pushes them to an RTSP server via kit-livestream.

.. </description>


Installation
------------

To use this node enable :ref:`isaacsim.streaming.rtsp<ext_isaacsim_streaming_rtsp>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Enabled (*inputs:enabled*)", "``bool``", "True to enable the RTSP stream, False to disable", "True"
    "Exec In (*inputs:execIn*)", "``execution``", "Triggering this causes the RTSP streaming pipeline to be set up", "None"
    "Mount Path (*inputs:mountPath*)", "``string``", "RTSP mount path appended to the server URL (e.g. /stream)", "/stream"
    "Port (*inputs:port*)", "``int``", "RTSP server port. Each simultaneous stream needs a unique port.", "8554"
    "Render Product Path (*inputs:renderProductPath*)", "``token``", "Path of the render product used for capturing data", ""
    "Use Raw Encoding (*inputs:useRawEncoding*)", "``bool``", "When true, streams uncompressed CUDA frames and lets the RTSP server handle encoding internally. When false (default), the render pipeline pre-encodes frames as H.264 before passing them to the RTSP server, which is more efficient and supports SEI metadata injection.", "False"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "isaacsim.streaming.rtsp.RTSPCameraHelper"
    "Version", "1"
    "Extension", "isaacsim.streaming.rtsp"
    "Icon", "ogn/icons/isaacsim.streaming.rtsp.RTSPCameraHelper.svg"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "RTSP Camera Helper"
    "Categories", "isaacRtsp"
    "Generated Class Name", "OgnRTSPCameraHelperDatabase"
    "Python Module", "isaacsim.streaming.rtsp"

