Changeset 4740

Timestamp:

Feb 12, 2014 4:54:12 AM (11 years ago)

Author:

bennylp

Message:

More pjsua2 API (re #1519): changed default options value in createPlayer(), createRecorder(), and createPlaylist() to use 0 which is more natural

File:

• pjproject/trunk/pjsip/include/pjsua2/media.hpp (modified) (3 diffs)

pjproject/trunk/pjsip/include/pjsua2/media.hpp

@@ -340 +340 @@
      */
     void createPlayer(const string &file_name,
-                      unsigned options=PJMEDIA_FILE_NO_LOOP) throw(Error);
+                      unsigned options=0) throw(Error);
 
     /**
@@ -355 +355 @@
     void createPlaylist(const StringVector &file_names,
                         const string &label="",
-                        unsigned options=PJMEDIA_FILE_NO_LOOP) throw(Error);
+                        unsigned options=0) throw(Error);
 
     /**
      * Set playback position. This operation is not valid for playlist.
+     *
+     * @param samples      The desired playback position, in samples.
      */
     void setPos(pj_uint32_t samples) throw(Error);
@@ -410 +412 @@
      * @param max_size   Maximum file size. Specify zero or -1 to remove size
      *                   limitation. This value must be zero or -1 for now.
-     * @param options    Optional options.
+     * @param options    Optional options, which can be used to specify the
+     *                   recording file format. Supported options are
+     *                   PJMEDIA_FILE_WRITE_PCM, PJMEDIA_FILE_WRITE_ALAW,
+     *                   and PJMEDIA_FILE_WRITE_ULAW. Default is zero or
+     *                   PJMEDIA_FILE_WRITE_PCM.
      */
     void createRecorder(const string &file_name,
                         unsigned enc_type=0,
                         pj_ssize_t max_size=0,
-                        unsigned options=PJMEDIA_FILE_WRITE_PCM) throw(Error);
+                        unsigned options=0) throw(Error);
 
     /**