Changeset 6097 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Oct 25, 2019 1:42:02 AM (5 years ago)

Author:

ming

Message:

Re #2210 (misc): Clarify in the doc that on_stream_created()/destroyed() callback is for audio stream

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (6 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -511 +511 @@
 {
     /**
-     * The media stream, read-only.
+     * The audio media stream, read-only.
      */
     pjmedia_stream      *stream;
 
     /**
-     * Stream index in the media session, read-only.
+     * Stream index in the audio media session, read-only.
      */
     unsigned             stream_idx;
@@ -531 +531 @@
 
     /**
-     * On input, it specifies the media port of the stream. Application
+     * On input, it specifies the audio media port of the stream. Application
      * may modify this pointer to point to different media port to be
      * registered to the conference bridge.
@@ -961 +961 @@
 
     /**
-     * Notify application when media session is created and before it is
+     * Notify application when audio media session is created and before it is
      * registered to the conference bridge. Application may return different
-     * media port if it has added media processing port to the stream. This
-     * media port then will be added to the conference bridge instead.
+     * audio media port if it has added media processing port to the stream.
+     * This media port then will be added to the conference bridge instead.
      *
      * Note: if implemented, #on_stream_created2() callback will be called
@@ -970 +970 @@
      *
      * @param call_id       Call identification.
-     * @param strm          Media stream.
-     * @param stream_idx    Stream index in the media session.
-     * @param p_port        On input, it specifies the media port of the
+     * @param strm          Audio media stream.
+     * @param stream_idx    Stream index in the audio media session.
+     * @param p_port        On input, it specifies the audio media port of the
      *                      stream. Application may modify this pointer to
      *                      point to different media port to be registered
@@ -983 +983 @@
 
     /**
-     * Notify application when media session is created and before it is
+     * Notify application when audio media session is created and before it is
      * registered to the conference bridge. Application may return different
-     * media port if it has added media processing port to the stream. This
-     * media port then will be added to the conference bridge instead.
+     * audio media port if it has added media processing port to the stream.
+     * This media port then will be added to the conference bridge instead.
      *
      * @param call_id       Call identification.
@@ -995 +995 @@
 
     /**
-     * Notify application when media session has been unregistered from the
-     * conference bridge and about to be destroyed.
+     * Notify application when audio media session has been unregistered from
+     * the conference bridge and about to be destroyed.
      *
      * @param call_id       Call identification.
-     * @param strm          Media stream.
-     * @param stream_idx    Stream index in the media session.
+     * @param strm          Audio media stream.
+     * @param stream_idx    Stream index in the audio media session.
      */
     void (*on_stream_destroyed)(pjsua_call_id call_id,