
<refentry id="OfxTimeLineSuiteV1">
  <refmeta>
    <refentrytitle><type>OfxTimeLineSuiteV1</type></refentrytitle>
  </refmeta>
  <refnamediv>
    <refname><function>OfxTimeLineSuiteV1</function></refname>
    <refpurpose>Suite to control timelines </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
     <blockquote><programlisting>
#include "ofxTimeLine.h"
typedef struct OfxTimeLineSuiteV1 {
  OfxStatus (*getTime)(void *instance, double *time);
  OfxStatus (*gotoTime)(void *instance, double time);
  OfxStatus (*getTimeBounds)(void *instance, double *firstTime, double *lastTime);
} OfxTimeLineSuiteV1;

</programlisting></blockquote>
     </refsynopsisdiv>
    <refsect1>
      <title>Description</title><para>
This suite is used to enquire and control a timeline associated with a plug-in
instance.
</para>
<para>
This is an optional suite in the Image Effect API.
</para>
    </refsect1>
</refentry>

<refentry id="OfxTimeLineSuiteV1_getTime">
  <refmeta>
    <refentrytitle><function>OfxTimeLineSuiteV1::getTime</function></refentrytitle>
  </refmeta>
  <refnamediv>
    <refname><function>OfxTimeLineSuiteV1::getTime</function></refname>
       <refpurpose>Get the time value of the timeline that is controlling to the indicated effect.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include "ofxTimeLine.h" </funcsynopsisinfo>
      <funcprototype>
        <funcdef><typename>OfxStatus</typename><function>(*getTime)</function></funcdef>
              <paramdef>void *<parameter>instance</parameter></paramdef>
              <paramdef>double *<parameter>time</parameter></paramdef>
        </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect2>
   <title>Arguments</title>
   <itemizedlist>

<listitem>instance - is the instance of the effect changing the timeline, cast to a void 
</listitem>
<listitem>time - a pointer through which the timeline value should be returned
</listitem>
    </itemizedlist>
  </refsect2>
  <refsect2>
    <title>Description</title>
      <para>
This function returns the current time value of the timeline associated with the effect instance.
</para>

  </refsect2>

  <refsect2>
    <title>Returns</title>
      <para>

<itemizedlist>
  <listitem><link linkend="kOfxStatOK"><code>kOfxStatOK</code></link> - the time enquiry was sucessful</listitem>
  <listitem><link linkend="kOfxStatFailed"><code>kOfxStatFailed</code></link> - the enquiry failed for some host specific reason</listitem>
  <listitem><link linkend="kOfxStatErrBadHandle"><code>kOfxStatErrBadHandle</code></link> - the effect handle was invalid</listitem>
</itemizedlist>
</para>

  </refsect2>
</refentry>

<refentry id="OfxTimeLineSuiteV1_gotoTime">
  <refmeta>
    <refentrytitle><function>OfxTimeLineSuiteV1::gotoTime</function></refentrytitle>
  </refmeta>
  <refnamediv>
    <refname><function>OfxTimeLineSuiteV1::gotoTime</function></refname>
       <refpurpose>Move the timeline control to the indicated time.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include "ofxTimeLine.h" </funcsynopsisinfo>
      <funcprototype>
        <funcdef><typename>OfxStatus</typename><function>(*gotoTime)</function></funcdef>
              <paramdef>void *<parameter>instance</parameter></paramdef>
              <paramdef>double<parameter>time</parameter></paramdef>
        </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect2>
   <title>Arguments</title>
   <itemizedlist>

<listitem>instance - is the instance of the effect changing the timeline, cast to a void 
</listitem>
<listitem>time - is the time to change the timeline to. This is in the temporal coordinate system of the effect.
</listitem>
    </itemizedlist>
  </refsect2>
  <refsect2>
    <title>Description</title>
      <para>
This function moves the timeline to the indicated frame and returns. Any side effects of the timeline
change are also triggered and completed before this returns (for example instance changed actions and renders
if the output of the effect is being viewed).
</para>

  </refsect2>

  <refsect2>
    <title>Returns</title>
      <para>

<itemizedlist>
  <listitem><link linkend="kOfxStatOK"><code>kOfxStatOK</code></link> - the time was changed sucessfully, will all side effects if the change completed</listitem>
  <listitem><link linkend="kOfxStatFailed"><code>kOfxStatFailed</code></link> - the change failed for some host specific reason</listitem>
  <listitem><link linkend="kOfxStatErrBadHandle"><code>kOfxStatErrBadHandle</code></link> - the effect handle was invalid</listitem>
  <listitem><link linkend="kOfxStatErrValue"><code>kOfxStatErrValue</code></link> - the time was an illegal value       </listitem>
</itemizedlist>
</para>

  </refsect2>
</refentry>

<refentry id="OfxTimeLineSuiteV1_getTimeBounds">
  <refmeta>
    <refentrytitle><function>OfxTimeLineSuiteV1::getTimeBounds</function></refentrytitle>
  </refmeta>
  <refnamediv>
    <refname><function>OfxTimeLineSuiteV1::getTimeBounds</function></refname>
       <refpurpose>Get the current bounds on a timeline</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include "ofxTimeLine.h" </funcsynopsisinfo>
      <funcprototype>
        <funcdef><typename>OfxStatus</typename><function>(*getTimeBounds)</function></funcdef>
              <paramdef>void *<parameter>instance</parameter></paramdef>
              <paramdef>double *<parameter>firstTime</parameter></paramdef>
              <paramdef>double *<parameter>lastTime</parameter></paramdef>
        </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect2>
   <title>Arguments</title>
   <itemizedlist>

<listitem>instance - is the instance of the effect changing the timeline, cast to a void 
</listitem>
<listitem>firstTime - is the first time on the timeline. This is in the temporal coordinate system of the effect.
</listitem>
<listitem>lastTime - is last time on the timeline. This is in the temporal coordinate system of the effect.
</listitem>
    </itemizedlist>
  </refsect2>
  <refsect2>
    <title>Description</title>
      <para>
This function
</para>

  </refsect2>

  <refsect2>
    <title>Returns</title>
      <para>

<itemizedlist>
  <listitem><link linkend="kOfxStatOK"><code>kOfxStatOK</code></link> - the time enquiry was sucessful</listitem>
  <listitem><link linkend="kOfxStatFailed"><code>kOfxStatFailed</code></link> - the enquiry failed for some host specific reason</listitem>
  <listitem><link linkend="kOfxStatErrBadHandle"><code>kOfxStatErrBadHandle</code></link> - the effect handle was invalid</listitem>
</itemizedlist>
</para>

  </refsect2>
</refentry>
