The Tor Browser: media/webrtc/signaling/src/sipcc/include/ccapi_conf

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 /* This Source Code Form is subject to the terms of the Mozilla Public

     2  * License, v. 2.0. If a copy of the MPL was not distributed with this

     3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

     5 #ifndef _CCAPI_CONF_ROSTER_H_

     6 #define _CCAPI_CONF_ROSTER_H_

     8 #include "cpr_stdio.h"

     9 #include "ccapi_call.h"

    10 #include "CCProvider.h"

    11 #include "phone_debug.h"

    13 // Basic type definitions for conferencing

    14 typedef string_t cc_participant_ref_t;

    16 /**

    17 * Get Conference Participants

    18 *

    19 * Returns list of conference participant information last received from the UCM.

    20 * Note that the list may include conference participants in various states in addition to Connected.

    21 * [ For exampke, a listed participant may be in the ringing state (not yet on conference),

    22 * or disconnected state (leaving/left the conference).]  Application should invoke

    23 * getConferenceParticipantStatus for each participant in the list to query exact status.

    24 *

    25 * @param [in] handle - call handle

    26 * @param [in/out] participantHandles - array of participant handles to be returned

    27 * @param [in/out] count - in:  size of array provided in participantHandles; out:  number of entries populated (up to original value provided)

    28 * @return void

    29 */

    30 void CCAPI_CallInfo_getConfParticipants (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandles[], int* count);

    33 /**

    34 * Get Maximum Number of Conference Participants ( in case gui wants to show %full conference info )

    35 * @param [in] handle - call handle

    36 * @return maximum number of conference participants

    37 */

    38 cc_uint16_t CCAPI_CallInfo_getConfParticipantMax (cc_callinfo_ref_t handle);

    41 /**

    42 * Get Participant Name

    43 * @param [in] handle - call info handle

    44 * @param [in] participantHandle - specific handle for conference participant

    45 * @return display name of the conference participant

    46 */

    47 cc_string_t CCAPI_CallInfo_getConfParticipantName (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);

    49 /**

    50 * Get Participant Number

    51 * @param [in] handle - handle of call

    52 * @param [in] participantHandle - handle of conference participant

    53 * @return display number of the conference participant

    54 */

    55 cc_string_t CCAPI_CallInfo_getConfParticipantNumber (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);

    57 /**

    58 * Get Conference Participant Status

    59 * @param [in] handle - call handle

    60 * @param [in] participantHandle - handle of conference participant

    61 * @return conference status of specific participant

    62 */

    63 cc_conf_participant_status_t CCAPI_CallInfo_getConfParticipantStatus (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandleHandle);

    65 /**

    66 * Get Participant Security

    67 * @param [in] handle - call handle

    68 * @param [in] participantHandle - handle of conference participant

    69 * @return security setting of the specific conference participant

    70 */

    71 cc_call_security_t CCAPI_CallInfo_getConfParticipantSecurity (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandleHandle);

    73 /**

    74 * Able To Remove Others?

    75 * Find out whether this participant is capable of removing another participant

    76 * @param [in] handle - call handle

    77 * @return return code (0=indicates not capable, 1=indicates capable)

    78 */

    79 cc_boolean CCAPI_CallInfo_selfHasRemoveConfParticipantCapability (cc_callinfo_ref_t handle);

    81 /**

    82 * Check to see if a given conference participant reference is the one using this endpoint

    83 * @param [in] handle - call handle

    84 * @param [in] participantHandle - handle of a conference participant

    85 * @returns cc_boolean (TRUE if yes, FALSE if no)

    86 */

    87 cc_boolean CCAPI_CallInfo_isConfSelfParticipant (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);

    89 /**

    90 * Return our conference participant-id

    91 * @param [in] handle - call handle

    92 * @return participant id of self

    93 */

    94 cc_participant_ref_t CCAPI_CallInfo_getConfSelfParticipant (cc_callinfo_ref_t handle);

    97 #endif /* _CCAPI_CONF_ROSTER_H_ */

The Tor Browser / file revision