comparison include/BeagleRT.h @ 174:1e629f126322

AuxiliaryTask can now be scheduled from setup(). Closes #1373

  * \brief Stop processing audio and sensor data.
  *
  * This function will stop the BeagleRT audio/sensor system. After this function returns, no further
  * calls to render() will be issued.
  */
+int BeagleRT_startAuxiliaryTask(AuxiliaryTask it);
 void BeagleRT_stopAudio();
 
 /**
  * \brief Clean up resources from audio and sensor processing.
  *

  * \param name Name for this task, which should be unique system-wide (no other running program should use this name).
  */
 AuxiliaryTask BeagleRT_createAuxiliaryTask(void (*functionToCall)(void), int priority, const char *name);
 
 /**
+ * \brief Start an auxiliary task so that it can be run.
+ *
+ * This function will start an auxiliary task but will NOT schedule it.
+ * It will also set a flag in the associate InternalAuxiliaryTask to flag the
+ * task as "started", so that successive calls to the same function for a given AuxiliaryTask
+ * have no effect.
+ * The user should never be required to call this function directly, as it is called
+ * by BeagleRT_scheduleAuxiliaryTask if needed (e.g.: if a task is scheduled in setup() )
+ * or immediately after starting the audio thread.
+ *
+* \param task Task to start.
+ */
+
+int BeagleRT_startAuxiliaryTask(AuxiliaryTask task);
+/**
  * \brief Run an auxiliary task which has previously been created.
  *
  * This function will schedule an auxiliary task to run. When the task runs, the function in the first
  * argument of createAuxiliaryTaskLoop() will be called.
  *