Changeset 414

Timestamp:

Apr 27, 2006 11:48:08 PM (19 years ago)

Author:

bennylp

Message:

Fixed obsolete comments in stream.h and session.h about stream transmitting media immediately

Location:

pjproject/trunk/pjmedia/include/pjmedia

Files:

• session.h (modified) (4 diffs)
• stream.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia/session.h

@@ -89 +89 @@
 
 /**
- * Create media session based on the local and remote SDP.
- * The session will start immediately.
- *
+ * Create media session based on the local and remote SDP. After the session
+ * has been created, application normally would want to get the media port 
+ * interface of each streams, by calling #pjmedia_session_get_port(). The 
+ * media port interface exports put_frame() and get_frame() function, used
+ * to transmit and receive media frames from the stream.
+ *
+ * Without application calling put_frame() and get_frame(), there will be 
+ * no media frames transmitted or received by the session.
+ * 
  * @param endpt         The PJMEDIA endpoint instance.
  * @param stream_cnt    Maximum number of streams to be created. This
@@ -119 +125 @@
 
 /**
- * Get session info.
+ * Get media session info of the session.
  *
  * @param session       The session which info is being queried.
@@ -132 +138 @@
 /**
  * Activate all streams in media session for the specified direction.
+ * Application only needs to call this function if it previously paused
+ * the session.
  *
  * @param session       The media session.
@@ -199 +207 @@
 
 /**
- * Get the port interface for the specified stream.
+ * Get the media port interface of the specified stream. The media port
+ * interface declares put_frame() and get_frame() function, which is the 
+ * only  way for application to transmit and receive media frames from the
+ * stream.
+ *
+ * @param session       The media session.
+ * @param index         Stream index.
+ * @param p_port        Pointer to receive the media port interface for
+ *                      the specified stream.
+ *
+ * @return              PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjmedia_session_get_port( pjmedia_session *session,

pjproject/trunk/pjmedia/include/pjmedia/stream.h

@@ -84 +84 @@
 
 /**
- * Create a media stream based on the specified stream parameter.
- * All channels in the stream initially will be inactive.
+ * Create a media stream based on the specified parameter. After the stream
+ * has been created, application normally would want to get the media port 
+ * interface of the streams, by calling pjmedia_stream_get_port(). The 
+ * media port interface exports put_frame() and get_frame() function, used
+ * to transmit and receive media frames from the stream.
+ *
+ * Without application calling put_frame() and get_frame(), there will be 
+ * no media frames transmitted or received by the stream.
  *
  * @param endpt         Media endpoint.
@@ -112 +118 @@
 PJ_DECL(pj_status_t) pjmedia_stream_destroy(pjmedia_stream *stream);
 
-/**
- * Get the port interface of the stream.
+
+/**
+ * Get the media port interface of the stream. The media port interface
+ * declares put_frame() and get_frame() function, which is the only 
+ * way for application to transmit and receive media frames from the
+ * stream.
  *
  * @param stream        The media stream.