mmmw_plat/telephony_multimedia_service_api/inc/tmsfactory.h
branchRCL_3
changeset 7 709f89d8c047
parent 0 71ca22bcf22a
child 45 095bea5f582e
equal deleted inserted replaced
3:4f62049db6ac 7:709f89d8c047
    30 class TMSSource;
    30 class TMSSource;
    31 class TMSSink;
    31 class TMSSink;
    32 class TMSFactoryImpl;
    32 class TMSFactoryImpl;
    33 class TMSVer;
    33 class TMSVer;
    34 class TMSGlobalRouting;
    34 class TMSGlobalRouting;
    35 class TMSDTMF;
       
    36 class TMSRTPSession;
       
    37 class TMSRingTone;
       
    38 
    35 
    39 /**
    36 /**
    40  * TMSFactory class
    37  * TMSFactory class
    41  *
    38  *
    42  * This class serves as a factory crating all necessary TMS components.
    39  * This class serves as a factory crating all necessary TMS components.
   352      *      TMS_RESULT_SUCCESS if global routing object is deleted successfully.
   349      *      TMS_RESULT_SUCCESS if global routing object is deleted successfully.
   353      *      TMS_RESULT_INVALID_ARGUMENT if the global routing object is invalid.
   350      *      TMS_RESULT_INVALID_ARGUMENT if the global routing object is invalid.
   354      */
   351      */
   355     IMPORT_C gint DeleteGlobalRouting(TMSGlobalRouting*& globrouting);
   352     IMPORT_C gint DeleteGlobalRouting(TMSGlobalRouting*& globrouting);
   356 
   353 
   357     /**
       
   358      * Create DTMF player object.
       
   359      *
       
   360      * @param  streamtype
       
   361      *     Stream ID to be used to create the DTMF player.
       
   362      *     TMS_STREAM_UPLINK
       
   363      *     TMS_STREAM_DOWNLINK
       
   364      *
       
   365      * @param  dtmf
       
   366      *      Created DTMF player.
       
   367      *
       
   368      * @return
       
   369      *      TMS_RESULT_SUCCESS if the operation was successful.
       
   370      *      TMS_RESULT_INSUFFICIENT_MEMORY if DTMF player creation failed due
       
   371      *      to insufficient memory.
       
   372      *      TMS_RESULT_FATAL_ERROR if an error occured.
       
   373      *      TMS_REASON_EMERGENCY_CALL_ONGOING if emergency call is active.
       
   374      *      TMS_REASON_PERMISSION_DENIED if permission is denied.
       
   375      *
       
   376      */
       
   377     IMPORT_C gint CreateDTMF(TMSStreamType streamtype, TMSDTMF*& dtmf);
       
   378 
       
   379     /**
       
   380      * Delete DTMF player object.
       
   381      *
       
   382      * @param  dtmf
       
   383      *      DTMF player to be deleted.
       
   384      *
       
   385      * @return
       
   386      *      TMS_RESULT_SUCCESS if the operation was successful.
       
   387      *      TMS_RESULT_INVALID_ARGUMENT if the DTMF player is not valid.
       
   388      *
       
   389      */
       
   390     IMPORT_C gint DeleteDTMF(TMSDTMF*& dtmf);
       
   391 
       
   392     /**
       
   393      * Creates TMSRTPSession object.
       
   394      *
       
   395      * @param  rtpsession
       
   396      *      RTP Session object to be created.
       
   397      *
       
   398      * @param  sdp
       
   399      *      Session description protocol message.
       
   400      *
       
   401      * @param  mode
       
   402      *      Buffer processing mode: either PULL or PUSH.
       
   403      *
       
   404      * @return
       
   405      *      TMS_RESULT_SUCCESS when object is created successfully.
       
   406      *      TMS_RESULT_INSUFFICIENT_MEMORY when object creation failed due to
       
   407      *      insufficient memory.
       
   408      */
       
   409     IMPORT_C gint CreateRTPSession(TMSRTPSession*& rtpsession, guint8* sdp,
       
   410             guint mode);
       
   411 
       
   412     /**
       
   413      * Deletes TMSRTPSession object.
       
   414      *
       
   415      * @param  rtpsession
       
   416      *      RTP Session object to be deleted.
       
   417      *
       
   418      * @return
       
   419      *      TMS_RESULT_SUCCESS when object is deleted successfully.
       
   420      *      TMS_RESULT_INVALID_ARGUMENT if RTP session object is invalid.
       
   421      */
       
   422     IMPORT_C gint DeleteRTPSession(TMSRTPSession*& rtpsession);
       
   423 
       
   424     /**
       
   425      * Creates TMSRingTone player object.
       
   426      *
       
   427      * @param  rt
       
   428      *      RingTone player object to be created.
       
   429      *
       
   430      * @return
       
   431      *      TMS_RESULT_SUCCESS when object is created successfully.
       
   432      *      TMS_RESULT_INSUFFICIENT_MEMORY when object creation failed due to
       
   433      *      insufficient memory.
       
   434      */
       
   435     IMPORT_C gint CreateRingTonePlayer(TMSRingTone*& rt);
       
   436 
       
   437     /**
       
   438      * Deletes TMSRingTone object.
       
   439      *
       
   440      * @param  rt
       
   441      *      RingTone player object to be deleted.
       
   442      *
       
   443      * @return
       
   444      *      TMS_RESULT_SUCCESS when object is deleted successfully.
       
   445      *      TMS_RESULT_INVALID_ARGUMENT if RingTone player object is invalid.
       
   446      */
       
   447     IMPORT_C gint DeleteRingTonePlayer(TMSRingTone*& rt);
       
   448 
   354 
   449 private:
   355 private:
   450     /**
   356     /**
   451      * Constructor
   357      * Constructor
   452      */
   358      */