.. _omni_graph_nodes_GetTimeline_1:

.. _omni_graph_nodes_GetTimeline:

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

:orphan:

.. meta::
    :title: Get main timeline
    :keywords: lang-en omnigraph node time compute-on-request nodes get-timeline


Get main timeline
=================

.. <description>

Get the main timeline properties

.. </description>


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

To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.


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

    "End Frame (*outputs:endFrame*)", "``double``", "The end frame of the main timeline's play range.", "None"
    "End Time (*outputs:endTime*)", "``double``", "The end time (in seconds) of the main timeline's play range.", "None"
    "Current Frame (*outputs:frame*)", "``double``", "The current frame number of the main timeline's playhead.", "None"
    "Frames Per Second (*outputs:framesPerSecond*)", "``double``", "The number of frames per second of the main timeline.", "None"
    "Is Looping (*outputs:isLooping*)", "``bool``", "Is the main timeline currently looping?", "None"
    "Is Playing (*outputs:isPlaying*)", "``bool``", "Is the main timeline currently playing?", "None"
    "Start Frame (*outputs:startFrame*)", "``double``", "The start frame of the main timeline's play range.", "None"
    "Start Time (*outputs:startTime*)", "``double``", "The start time (in seconds) of the main timeline's play range.", "None"
    "Current Time (*outputs:time*)", "``double``", "The current time (in seconds) of the main timeline's playhead.", "None"


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

    "Unique ID", "omni.graph.nodes.GetTimeline"
    "Version", "1"
    "Extension", "omni.graph.nodes"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "Get main timeline"
    "Categories", "time"
    "Generated Class Name", "OgnTimelineGetDatabase"
    "Python Module", "omni.graph.nodes"

