Changeset 631 for pjproject/trunk/pjmedia/include/pjmedia/port.h

Timestamp:

Jul 27, 2006 10:03:51 PM (18 years ago)

Author:

bennylp

Message:

• Added splitter/combiner port (splitcomb.c)
• Added function to initialize pjmedia_port_info (still unused though)

File:

• pjproject/trunk/pjmedia/include/pjmedia/port.h (modified) (3 diffs)

pjproject/trunk/pjmedia/include/pjmedia/port.h

@@ -357 +357 @@
 
 /**
+ * This is an auxiliary function to initialize port info for
+ * ports which deal with PCM audio.
+ *
+ * @param info              The port info to be initialized.
+ * @param name              Port name.
+ * @param signature         Port signature.
+ * @param channel_count     Number of channels.
+ * @param bits_per_sample   Bits per sample.
+ * @param samples_per_frame Number of samples per frame.
+ *
+ * @return                  PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_port_info_init( pjmedia_port_info *info,
+                                             const pj_str_t *name,
+                                             unsigned signature,
+                                             unsigned clock_rate,
+                                             unsigned channel_count,
+                                             unsigned bits_per_sample,
+                                             unsigned samples_per_frame);
+
+
+/**
  * Get a frame from the port (and subsequent downstream ports).
+ *
+ * @param port      The media port.
+ * @param frame     Frame to store samples.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_get_frame( pjmedia_port *port,
@@ -364 +391 @@
 /**
  * Put a frame to the port (and subsequent downstream ports).
+ *
+ * @param port      The media port.
+ * @param frame     Frame to the put to the port.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_put_frame( pjmedia_port *port,
@@ -371 +403 @@
 /**
  * Destroy port (and subsequent downstream ports)
+ *
+ * @param port      The media port.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_destroy( pjmedia_port *port );