Changeset 895 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Jan 21, 2007 11:12:40 PM (17 years ago)

Author:

bennylp

Message:

Implement ticket #67: added WAV playlist feature to PJMEDIA

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (5 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -2894 +2894 @@
 
 /*****************************************************************************
- * File player.
- */
-
-/**
- * Create a file player, and automatically connect this player to
+ * File player and playlist.
+ */
+
+/**
+ * Create a file player, and automatically add this player to
  * the conference bridge.
  *
@@ -2916 +2916 @@
 
 /**
- * Get conference port ID associated with player.
+ * Create a file playlist media port, and automatically add the port
+ * to the conference bridge.
+ *
+ * @param file_names    Array of file names to be added to the play list.
+ *                      Note that the files must have the same clock rate,
+ *                      number of channels, and number of bits per sample.
+ * @param file_count    Number of files in the array.
+ * @param label         Optional label to be set for the media port.
+ * @param options       Optional option flag. Application may specify
+ *                      PJMEDIA_FILE_NO_LOOP to prevent looping.
+ * @param p_id          Optional pointer to receive player ID.
+ *
+ * @return              PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pjsua_playlist_create(const pj_str_t file_names[],
+                                           unsigned file_count,
+                                           const pj_str_t *label,
+                                           unsigned options,
+                                           pjsua_player_id *p_id);
+
+/**
+ * Get conference port ID associated with player or playlist.
  *
  * @param id            The file player ID.
@@ -2926 +2947 @@
 
 /**
- * Get the media port for the player.
+ * Get the media port for the player or playlist.
  *
  * @param id            The player ID.
@@ -2937 +2958 @@
 
 /**
- * Set playback position.
+ * Set playback position. This operation is not valid for playlist.
  *
  * @param id            The file player ID.
@@ -2950 +2971 @@
 
 /**
- * Close the file, remove the player from the bridge, and free
- * resources associated with the file player.
+ * Close the file of playlist, remove the player from the bridge, and free
+ * resources associated with the file player or playlist.
  *
  * @param id            The file player ID.