Changeset 6097


Ignore:
Timestamp:
Oct 25, 2019 1:42:02 AM (4 weeks ago)
Author:
ming
Message:

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

Location:
pjproject/trunk/pjsip/include
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

    r6094 r6097  
    511511{ 
    512512    /** 
    513      * The media stream, read-only. 
     513     * The audio media stream, read-only. 
    514514     */ 
    515515    pjmedia_stream      *stream; 
    516516 
    517517    /** 
    518      * Stream index in the media session, read-only. 
     518     * Stream index in the audio media session, read-only. 
    519519     */ 
    520520    unsigned             stream_idx; 
     
    531531 
    532532    /** 
    533      * On input, it specifies the media port of the stream. Application 
     533     * On input, it specifies the audio media port of the stream. Application 
    534534     * may modify this pointer to point to different media port to be 
    535535     * registered to the conference bridge. 
     
    961961 
    962962    /** 
    963      * Notify application when media session is created and before it is 
     963     * Notify application when audio media session is created and before it is 
    964964     * registered to the conference bridge. Application may return different 
    965      * media port if it has added media processing port to the stream. This 
    966      * media port then will be added to the conference bridge instead. 
     965     * audio media port if it has added media processing port to the stream. 
     966     * This media port then will be added to the conference bridge instead. 
    967967     * 
    968968     * Note: if implemented, #on_stream_created2() callback will be called 
     
    970970     * 
    971971     * @param call_id       Call identification. 
    972      * @param strm          Media stream. 
    973      * @param stream_idx    Stream index in the media session. 
    974      * @param p_port        On input, it specifies the media port of the 
     972     * @param strm          Audio media stream. 
     973     * @param stream_idx    Stream index in the audio media session. 
     974     * @param p_port        On input, it specifies the audio media port of the 
    975975     *                      stream. Application may modify this pointer to 
    976976     *                      point to different media port to be registered 
     
    983983 
    984984    /** 
    985      * Notify application when media session is created and before it is 
     985     * Notify application when audio media session is created and before it is 
    986986     * registered to the conference bridge. Application may return different 
    987      * media port if it has added media processing port to the stream. This 
    988      * media port then will be added to the conference bridge instead. 
     987     * audio media port if it has added media processing port to the stream. 
     988     * This media port then will be added to the conference bridge instead. 
    989989     * 
    990990     * @param call_id       Call identification. 
     
    995995 
    996996    /** 
    997      * Notify application when media session has been unregistered from the 
    998      * conference bridge and about to be destroyed. 
     997     * Notify application when audio media session has been unregistered from 
     998     * the conference bridge and about to be destroyed. 
    999999     * 
    10001000     * @param call_id       Call identification. 
    1001      * @param strm          Media stream. 
    1002      * @param stream_idx    Stream index in the media session. 
     1001     * @param strm          Audio media stream. 
     1002     * @param stream_idx    Stream index in the audio media session. 
    10031003     */ 
    10041004    void (*on_stream_destroyed)(pjsua_call_id call_id, 
  • pjproject/trunk/pjsip/include/pjsua2/call.hpp

    r6051 r6097  
    679679{ 
    680680    /** 
    681      * Media stream, read-only. 
     681     * Audio media stream, read-only. 
    682682     */ 
    683683    MediaStream stream; 
    684684     
    685685    /** 
    686      * Stream index in the media session, read-only. 
     686     * Stream index in the audio media session, read-only. 
    687687     */ 
    688688    unsigned    streamIdx; 
     
    699699 
    700700    /** 
    701      * On input, it specifies the media port of the stream. Application 
     701     * On input, it specifies the audio media port of the stream. Application 
    702702     * may modify this pointer to point to different media port to be 
    703703     * registered to the conference bridge. 
     
    713713{ 
    714714    /** 
    715      * Media stream. 
     715     * Audio media stream. 
    716716     */ 
    717717    MediaStream stream; 
    718718     
    719719    /** 
    720      * Stream index in the media session. 
     720     * Stream index in the audio media session. 
    721721     */ 
    722722    unsigned    streamIdx; 
     
    17121712     
    17131713    /** 
    1714      * Notify application when media session is created and before it is 
     1714     * Notify application when audio media session is created and before it is 
    17151715     * registered to the conference bridge. Application may return different 
    1716      * media port if it has added media processing port to the stream. This 
    1717      * media port then will be added to the conference bridge instead. 
     1716     * audio media port if it has added media processing port to the stream. 
     1717     * This media port then will be added to the conference bridge instead. 
    17181718     * 
    17191719     * @param prm       Callback parameter. 
     
    17231723     
    17241724    /** 
    1725      * Notify application when media session has been unregistered from the 
    1726      * conference bridge and about to be destroyed. 
     1725     * Notify application when audio media session has been unregistered from 
     1726     * the conference bridge and about to be destroyed. 
    17271727     * 
    17281728     * @param prm       Callback parameter. 
Note: See TracChangeset for help on using the changeset viewer.