media/webrtc/signaling/src/sipcc/include/ccapi_conf_roster.h

Thu, 15 Jan 2015 15:59:08 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 15 Jan 2015 15:59:08 +0100
branch
TOR_BUG_9701
changeset 10
ac0c01689b40
permissions
-rw-r--r--

Implement a real Private Browsing Mode condition by changing the API/ABI;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

michael@0 1 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 2 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 4
michael@0 5 #ifndef _CCAPI_CONF_ROSTER_H_
michael@0 6 #define _CCAPI_CONF_ROSTER_H_
michael@0 7
michael@0 8 #include "cpr_stdio.h"
michael@0 9 #include "ccapi_call.h"
michael@0 10 #include "CCProvider.h"
michael@0 11 #include "phone_debug.h"
michael@0 12
michael@0 13 // Basic type definitions for conferencing
michael@0 14 typedef string_t cc_participant_ref_t;
michael@0 15
michael@0 16 /**
michael@0 17 * Get Conference Participants
michael@0 18 *
michael@0 19 * Returns list of conference participant information last received from the UCM.
michael@0 20 * Note that the list may include conference participants in various states in addition to Connected.
michael@0 21 * [ For exampke, a listed participant may be in the ringing state (not yet on conference),
michael@0 22 * or disconnected state (leaving/left the conference).] Application should invoke
michael@0 23 * getConferenceParticipantStatus for each participant in the list to query exact status.
michael@0 24 *
michael@0 25 * @param [in] handle - call handle
michael@0 26 * @param [in/out] participantHandles - array of participant handles to be returned
michael@0 27 * @param [in/out] count - in: size of array provided in participantHandles; out: number of entries populated (up to original value provided)
michael@0 28 * @return void
michael@0 29 */
michael@0 30 void CCAPI_CallInfo_getConfParticipants (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandles[], int* count);
michael@0 31
michael@0 32
michael@0 33 /**
michael@0 34 * Get Maximum Number of Conference Participants ( in case gui wants to show %full conference info )
michael@0 35 * @param [in] handle - call handle
michael@0 36 * @return maximum number of conference participants
michael@0 37 */
michael@0 38 cc_uint16_t CCAPI_CallInfo_getConfParticipantMax (cc_callinfo_ref_t handle);
michael@0 39
michael@0 40
michael@0 41 /**
michael@0 42 * Get Participant Name
michael@0 43 * @param [in] handle - call info handle
michael@0 44 * @param [in] participantHandle - specific handle for conference participant
michael@0 45 * @return display name of the conference participant
michael@0 46 */
michael@0 47 cc_string_t CCAPI_CallInfo_getConfParticipantName (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);
michael@0 48
michael@0 49 /**
michael@0 50 * Get Participant Number
michael@0 51 * @param [in] handle - handle of call
michael@0 52 * @param [in] participantHandle - handle of conference participant
michael@0 53 * @return display number of the conference participant
michael@0 54 */
michael@0 55 cc_string_t CCAPI_CallInfo_getConfParticipantNumber (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);
michael@0 56
michael@0 57 /**
michael@0 58 * Get Conference Participant Status
michael@0 59 * @param [in] handle - call handle
michael@0 60 * @param [in] participantHandle - handle of conference participant
michael@0 61 * @return conference status of specific participant
michael@0 62 */
michael@0 63 cc_conf_participant_status_t CCAPI_CallInfo_getConfParticipantStatus (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandleHandle);
michael@0 64
michael@0 65 /**
michael@0 66 * Get Participant Security
michael@0 67 * @param [in] handle - call handle
michael@0 68 * @param [in] participantHandle - handle of conference participant
michael@0 69 * @return security setting of the specific conference participant
michael@0 70 */
michael@0 71 cc_call_security_t CCAPI_CallInfo_getConfParticipantSecurity (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandleHandle);
michael@0 72
michael@0 73 /**
michael@0 74 * Able To Remove Others?
michael@0 75 * Find out whether this participant is capable of removing another participant
michael@0 76 * @param [in] handle - call handle
michael@0 77 * @return return code (0=indicates not capable, 1=indicates capable)
michael@0 78 */
michael@0 79 cc_boolean CCAPI_CallInfo_selfHasRemoveConfParticipantCapability (cc_callinfo_ref_t handle);
michael@0 80
michael@0 81 /**
michael@0 82 * Check to see if a given conference participant reference is the one using this endpoint
michael@0 83 * @param [in] handle - call handle
michael@0 84 * @param [in] participantHandle - handle of a conference participant
michael@0 85 * @returns cc_boolean (TRUE if yes, FALSE if no)
michael@0 86 */
michael@0 87 cc_boolean CCAPI_CallInfo_isConfSelfParticipant (cc_callinfo_ref_t handle, cc_participant_ref_t participantHandle);
michael@0 88
michael@0 89 /**
michael@0 90 * Return our conference participant-id
michael@0 91 * @param [in] handle - call handle
michael@0 92 * @return participant id of self
michael@0 93 */
michael@0 94 cc_participant_ref_t CCAPI_CallInfo_getConfSelfParticipant (cc_callinfo_ref_t handle);
michael@0 95
michael@0 96
michael@0 97 #endif /* _CCAPI_CONF_ROSTER_H_ */

mercurial