Changeset 633 for pjproject/trunk/pjmedia/include/pjmedia/conference.h

Timestamp:

Jul 29, 2006 11:14:47 AM (18 years ago)

Author:

bennylp

Message:

Added pjmedia_port_info_init() to fill in pjmedia_port_info structure, avoiding manual initialization and thus improves consistency (and probably reduces size by a tiny bit). This involves modification in quite few places.

File:

• pjproject/trunk/pjmedia/include/pjmedia/conference.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia/conference.h

@@ -173 +173 @@
 
 /**
- * Add stream port to the conference bridge. By default, the new conference
- * port will have both TX and RX enabled, but it is not connected to any
- * other ports.
- *
- * Application SHOULD call #pjmedia_conf_connect_port() to enable audio
- * transmission and receipt to/from this port.
+ * Add media port to the conference bridge.
+ *
+ * By default, the new conference port will have both TX and RX enabled, 
+ * but it is not connected to any other ports. Application SHOULD call 
+ * #pjmedia_conf_connect_port() to  enable audio transmission and receipt 
+ * to/from this port.
+ *
+ * Once the media port is connected to other port(s) in the bridge,
+ * the bridge will continuosly call get_frame() and put_frame() to the
+ * port, allowing media to flow to/from the port.
  *
  * @param conf          The conference bridge.
@@ -198 +202 @@
 
 
+/**
+ * Create and add a passive media port to the conference bridge. Unlike
+ * "normal" media port that is added with #pjmedia_conf_add_port(), media
+ * port created with this function will not have its get_frame() and
+ * put_frame() called by the bridge; instead, application MUST continuosly
+ * call these functions to the port, to allow media to flow from/to the
+ * port.
+ *
+ * Upon return of this function, application will be given two objects:
+ * the slot number of the port in the bridge, and pointer to the media
+ * port where application MUST start calling get_frame() and put_frame()
+ * to the port.
+ *
+ * @param conf              The conference bridge.
+ * @param pool              Pool to allocate buffers etc for this port.
+ * @param name              Name to be assigned to the port.
+ * @param clock_rate        Clock rate/sampling rate.
+ * @param channel_count     Number of channels.
+ * @param samples_per_frame Number of samples per frame.
+ * @param bits_per_sample   Number of bits per sample.
+ * @param options           Options (should be zero at the moment).
+ * @param p_slot            Pointer to receive the slot index of the port in
+ *                          the conference bridge.
+ * @param p_port            Pointer to receive the port instance.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate error 
+ *                          code.
+ */
+PJ_DECL(pj_status_t) pjmedia_conf_add_passive_port( pjmedia_conf *conf,
+                                                    pj_pool_t *pool,
+                                                    const pj_str_t *name,
+                                                    unsigned clock_rate,
+                                                    unsigned channel_count,
+                                                    unsigned samples_per_frame,
+                                                    unsigned bits_per_sample,
+                                                    unsigned options,
+                                                    unsigned *p_slot,
+                                                    pjmedia_port **p_port );
+
 
 /**