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

Timestamp:

Feb 21, 2006 12:11:18 AM (18 years ago)

Author:

bennylp

Message:

Initial conference implementation

File:

• pjproject/trunk/pjmedia/include/pjmedia/conference.h (moved) (moved from pjproject/trunk/pjmedia/include/pjmedia/audio_conf.h) (3 diffs)

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

@@ -22 +22 @@
 
 /**
- * @file conf.h
+ * @file conference.h
  * @brief Conference bridge.
  */
-#include <pjmedia/types.h>
+#include <pjmedia/port.h>
+
+
+PJ_BEGIN_DECL
+
 
 /**
@@ -32 +36 @@
 typedef struct pjmedia_conf pjmedia_conf;
 
+/**
+ * Conference port info.
+ */
+typedef struct pjmedia_conf_port_info
+{
+    pj_str_t            name;
+    pjmedia_port_op     tx_setting;
+    pjmedia_port_op     rx_setting;
+    pj_bool_t          *listener;
+} pjmedia_conf_port_info;
+
 
 /**
@@ -37 +52 @@
  */
 PJ_DECL(pj_status_t) pjmedia_conf_create( pj_pool_t *pool,
-                                          unsigned max_ports,
+                                          unsigned max_slots,
+                                          unsigned sampling_rate,
+                                          unsigned samples_per_frame,
+                                          unsigned bits_per_sample,
                                           pjmedia_conf **p_conf );
 
 
 /**
- * Add stream port to the conference bridge.
+ * Destroy conference bridge.
+ */
+PJ_DECL(pj_status_t) pjmedia_conf_destroy( pjmedia_conf *conf );
+
+
+/**
+ * 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.
+ *
+ * @param conf          The conference bridge.
+ * @param pool          Pool to allocate buffers for this port.
+ * @param strm_port     Stream port interface.
+ * @param name          Port name.
+ * @param p_slot        Pointer to receive the slot index of the port in
+ *                      the conference bridge.
+ *
+ * @return              PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjmedia_conf_add_port( pjmedia_conf *conf,
                                             pj_pool_t *pool,
-                                            pjmedia_stream_port *strm_port,
-                                            const pj_str_t *port_name,
-                                            unsigned *p_port );
+                                            pjmedia_port *strm_port,
+                                            const pj_str_t *name,
+                                            unsigned *p_slot );
+
 
 
 /**
- * Mute or unmute port.
+ * Change TX and RX settings for the port.
+ *
+ * @param conf          The conference bridge.
+ * @param slot          Port number/slot in the conference bridge.
+ * @param tx            Settings for the transmission TO this port.
+ * @param rx            Settings for the receipt FROM this port.
+ *
+ * @return              PJ_SUCCESS on success.
  */
-PJ_DECL(pj_status_t) pjmedia_conf_set_mute( pjmedia_conf *conf,
-                                            unsigned port,
-                                            pj_bool_t mute );
+PJ_DECL(pj_status_t) pjmedia_conf_configure_port( pjmedia_conf *conf,
+                                                  unsigned slot,
+                                                  pjmedia_port_op tx,
+                                                  pjmedia_port_op rx);
 
 
 /**
- * Set the specified port to be member of conference bridge.
+ * Enable unidirectional audio from the specified source slot to the
+ * specified sink slot.
+ *
+ * @param conf          The conference bridge.
+ * @param src_slot      Source slot.
+ * @param sink_slot     Sink slot.
+ *
+ * @return              PJ_SUCCES on success.
  */
-PJ_DECL(pj_status_t) pjmedia_conf_set_membership( pjmedia_conf *conf,
-                                                  unsigned port,
-                                                  pj_bool_t enabled );
+PJ_DECL(pj_status_t) pjmedia_conf_connect_port( pjmedia_conf *conf,
+                                                unsigned src_slot,
+                                                unsigned sink_slot );
 
 
 /**
- * Remove the specified port.
+ * Disconnect unidirectional audio from the specified source to the specified
+ * sink slot.
+ *
+ * @param conf          The conference bridge.
+ * @param src_slot      Source slot.
+ * @param sink_slot     Sink slot.
+ *
+ * @reutrn              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_conf_disconnect_port( pjmedia_conf *conf,
+                                                   unsigned src_slot,
+                                                   unsigned sink_slot );
+
+
+/**
+ * Remove the specified port from the conference bridge.
+ *
+ * @param conf          The conference bridge.
+ * @param slot          The port index to be removed.
+ *
+ * @return              PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjmedia_conf_remove_port( pjmedia_conf *conf,
-                                               unsigned port );
+                                               unsigned slot );
 
+
+
+/**
+ * Get port info.
+ */
+PJ_DECL(pj_status_t) pjmedia_conf_get_port_info( pjmedia_conf *conf,
+                                                 unsigned slot,
+                                                 pjmedia_conf_port_info *info);
+
+
+PJ_END_DECL