mmappfw_plat/qt_telephony_multimedia_service_api/inc/qtmsstream.h
changeset 38 959ca709b049
parent 35 2ee890d2f7e7
child 50 762d760dcfdf
--- a/mmappfw_plat/qt_telephony_multimedia_service_api/inc/qtmsstream.h	Fri Jun 11 14:04:53 2010 +0300
+++ b/mmappfw_plat/qt_telephony_multimedia_service_api/inc/qtmsstream.h	Fri Jun 11 19:35:01 2010 -0500
@@ -388,6 +388,15 @@
      *      IP call: UPL: mic source, codec format and client sink
      *      IP call: DNL: client source, codec format and speaker sink
      *
+     * @param  retrytime
+     *      Indicates (in seconds) for how long TMS should retry stream
+     *      initialization in case of an error. When stream initialization
+     *      fails within specified retry time, TMS will return
+     *      TMS_EVENT_STREAM_STATE_CHANGE_ERROR. If set to 0, TMS will return
+     *      TMS_EVENT_STREAM_STATE_CHANGE_ERROR immediately without retrying.
+     *      If set to -1, TMS will keep retrying until user cancels by calling
+     *      either Stop() or Deinit().
+     *
      * @return
      *      Common return codes:
      *      QTMS_RESULT_SUCCESS if stream transitioned to the initialized state.
@@ -399,7 +408,7 @@
      *      element attached to it.
      *
      */
-    gint Init();
+    gint Init(gint retrytime = 0);
 
     /**
      * Trigger stream to transition to the paused state.
@@ -441,6 +450,15 @@
      * Upon stream's successful transition to the started state, the stream will
      * be in the QTMS_STREAM_STARTED state.
      *
+     * @param  retrytime
+     *      Indicates (in seconds) for how long TMS should attempt to start
+     *      a stream in case of an error. When stream starting fails within
+     *      specified retry time, TMS will return
+     *      QTMS_EVENT_STREAM_STATE_CHANGE_ERROR. If set to 0, TMS will return
+     *      QTMS_EVENT_STREAM_STATE_CHANGE_ERROR immediately without retrying.
+     *      If set to -1, TMS will keep retrying until user cancels by calling
+     *      either Stop() or Deinit().
+     *
      * @return
      *      Common return codes:
      *      QTMS_RESULT_SUCCESS if stream successfully transitioned to the
@@ -449,7 +467,7 @@
      *      QTMS_STREAM_INITIALIZED or QTMS_STREAM_STARTED state.
      *
      */
-    gint Start();
+    gint Start(gint retrytime = 0);
 
     /**
      * Trigger stream to transition to the initialized state.