mmappfw_plat/qt_telephony_multimedia_service_api/inc/qtmsstream.h
changeset 38 959ca709b049
parent 35 2ee890d2f7e7
child 50 762d760dcfdf
equal deleted inserted replaced
35:2ee890d2f7e7 38:959ca709b049
   386      *      CS call: UPL: mic source and modem sink
   386      *      CS call: UPL: mic source and modem sink
   387      *      CS call: DNL: modem source and speaker sink
   387      *      CS call: DNL: modem source and speaker sink
   388      *      IP call: UPL: mic source, codec format and client sink
   388      *      IP call: UPL: mic source, codec format and client sink
   389      *      IP call: DNL: client source, codec format and speaker sink
   389      *      IP call: DNL: client source, codec format and speaker sink
   390      *
   390      *
       
   391      * @param  retrytime
       
   392      *      Indicates (in seconds) for how long TMS should retry stream
       
   393      *      initialization in case of an error. When stream initialization
       
   394      *      fails within specified retry time, TMS will return
       
   395      *      TMS_EVENT_STREAM_STATE_CHANGE_ERROR. If set to 0, TMS will return
       
   396      *      TMS_EVENT_STREAM_STATE_CHANGE_ERROR immediately without retrying.
       
   397      *      If set to -1, TMS will keep retrying until user cancels by calling
       
   398      *      either Stop() or Deinit().
       
   399      *
   391      * @return
   400      * @return
   392      *      Common return codes:
   401      *      Common return codes:
   393      *      QTMS_RESULT_SUCCESS if stream transitioned to the initialized state.
   402      *      QTMS_RESULT_SUCCESS if stream transitioned to the initialized state.
   394      *      QTMS_RESULT_INVALID_STATE if stream has not transitioned to the
   403      *      QTMS_RESULT_INVALID_STATE if stream has not transitioned to the
   395      *      QTMS_STREAM_INITIALIZED state.
   404      *      QTMS_STREAM_INITIALIZED state.
   397      *      has no format attached to it.
   406      *      has no format attached to it.
   398      *      QTMS_RESULT_UNINITIALIZED_OBJECT when stream has no sink or source
   407      *      QTMS_RESULT_UNINITIALIZED_OBJECT when stream has no sink or source
   399      *      element attached to it.
   408      *      element attached to it.
   400      *
   409      *
   401      */
   410      */
   402     gint Init();
   411     gint Init(gint retrytime = 0);
   403 
   412 
   404     /**
   413     /**
   405      * Trigger stream to transition to the paused state.
   414      * Trigger stream to transition to the paused state.
   406      *
   415      *
   407      * This function can be called only when stream is in the
   416      * This function can be called only when stream is in the
   439      * state change callback.
   448      * state change callback.
   440      *
   449      *
   441      * Upon stream's successful transition to the started state, the stream will
   450      * Upon stream's successful transition to the started state, the stream will
   442      * be in the QTMS_STREAM_STARTED state.
   451      * be in the QTMS_STREAM_STARTED state.
   443      *
   452      *
       
   453      * @param  retrytime
       
   454      *      Indicates (in seconds) for how long TMS should attempt to start
       
   455      *      a stream in case of an error. When stream starting fails within
       
   456      *      specified retry time, TMS will return
       
   457      *      QTMS_EVENT_STREAM_STATE_CHANGE_ERROR. If set to 0, TMS will return
       
   458      *      QTMS_EVENT_STREAM_STATE_CHANGE_ERROR immediately without retrying.
       
   459      *      If set to -1, TMS will keep retrying until user cancels by calling
       
   460      *      either Stop() or Deinit().
       
   461      *
   444      * @return
   462      * @return
   445      *      Common return codes:
   463      *      Common return codes:
   446      *      QTMS_RESULT_SUCCESS if stream successfully transitioned to the
   464      *      QTMS_RESULT_SUCCESS if stream successfully transitioned to the
   447      *      started state.
   465      *      started state.
   448      *      QTMS_RESULT_INVALID_STATE if stream is not in the
   466      *      QTMS_RESULT_INVALID_STATE if stream is not in the
   449      *      QTMS_STREAM_INITIALIZED or QTMS_STREAM_STARTED state.
   467      *      QTMS_STREAM_INITIALIZED or QTMS_STREAM_STARTED state.
   450      *
   468      *
   451      */
   469      */
   452     gint Start();
   470     gint Start(gint retrytime = 0);
   453 
   471 
   454     /**
   472     /**
   455      * Trigger stream to transition to the initialized state.
   473      * Trigger stream to transition to the initialized state.
   456      *
   474      *
   457      * This function can be called only when stream is in the
   475      * This function can be called only when stream is in the