Changeset 4793 for pjproject/trunk/pjmedia/include/pjmedia/wav_port.h

Timestamp:

Mar 14, 2014 4:09:50 AM (10 years ago)

Author:

bennylp

Message:

Closed #1748: enhancements to WAV player API

File:

• pjproject/trunk/pjmedia/include/pjmedia/wav_port.h (modified) (4 diffs)

pjproject/trunk/pjmedia/include/pjmedia/wav_port.h

@@ -50 +50 @@
     PJMEDIA_FILE_NO_LOOP = 1
 };
+
+
+/**
+ * Additional information about the WAV player.
+ */
+typedef struct pjmedia_wav_player_info
+{
+    /**
+     * Format ID of the payload.
+     */
+    pjmedia_format_id   fmt_id;
+
+    /**
+     * The number of bits per sample of the file payload. For example,
+     * the value is 16 for PCM WAV and 8 for Alaw/Ulas WAV files.
+     */
+    unsigned            payload_bits_per_sample;
+
+    /**
+     * The WAV payload size in bytes.
+     */
+    pj_uint32_t         size_bytes;
+
+    /**
+     * The WAV payload size in samples.
+     */
+    pj_uint32_t         size_samples;
+
+} pjmedia_wav_player_info;
 
 
@@ -77 +106 @@
                                                      pjmedia_port **p_port );
 
+/**
+ * Get additional info about the file player.
+ *
+ * @param port          The file port.
+ * @param i             The info.
+ *
+ * @return              PJ_SUCCESS on success or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pjmedia_wav_player_get_info(pjmedia_port *port,
+                                                 pjmedia_wav_player_info *i);
 
 /**
@@ -83 +122 @@
  * @param port          The file player port.
  *
- * @return              The length of the data, in bytes. Upon error it will
- *                      return negative value.
+ * @return              The length of the data, in bytes. On error, the
+ *                      error code is given as negative value.
  */
 PJ_DECL(pj_ssize_t) pjmedia_wav_player_get_len(pjmedia_port *port);
@@ -103 +142 @@
 
 /**
- * Get the file play position of WAV player.
- *
- * @param port          The file player port.
- *
- * @return              PJ_SUCCESS on success.
+ * Get the file play position of WAV player, in bytes.
+ *
+ * @param port          The file player port.
+ *
+ * @return              The current play position, in bytes. On error, the
+ *                      error code is given as negative value.
  */
 PJ_DECL(pj_ssize_t) pjmedia_wav_player_port_get_pos( pjmedia_port *port );