mmmw_plat/telephony_multimedia_service_api/inc/tmsstream.h
branchRCL_3
changeset 19 095bea5f582e
parent 13 bea5e7625e42
child 20 0ac9a5310753
--- a/mmmw_plat/telephony_multimedia_service_api/inc/tmsstream.h	Thu Aug 19 10:26:11 2010 +0300
+++ b/mmmw_plat/telephony_multimedia_service_api/inc/tmsstream.h	Tue Aug 31 15:43:02 2010 +0300
@@ -429,6 +429,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:
      *      TMS_RESULT_SUCCESS if stream transitioned to the initialized state.
@@ -440,7 +449,7 @@
      *      element attached to it.
      *
      */
-    IMPORT_C gint Init();
+    IMPORT_C gint Init(gint retrytime = 0);
 
     /**
      * Trigger stream to transition to the paused state.
@@ -482,6 +491,15 @@
      * Upon stream's successful transition to the started state, the stream will
      * be in the TMS_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
+     *      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:
      *      TMS_RESULT_SUCCESS if stream successfully transitioned to the
@@ -490,7 +508,7 @@
      *      TMS_STREAM_INITIALIZED or TMS_STREAM_STARTED state.
      *
      */
-    IMPORT_C gint Start();
+    IMPORT_C gint Start(gint retrytime = 0);
 
     /**
      * Trigger stream to transition to the initialized state.