conference.h 3.52 KB
Newer Older
1
/*******************************************************************************
2
 *            conference.h
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 *  Thu Nov 26, 2015
 *  Copyright  2015  Belledonne Communications
 *  Author: Linphone's team
 *  Email info@belledonne-communications.com
 ******************************************************************************/

/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef CONFERENCE_H
#define CONFERENCE_H
28 29
	
#include "linphonecore.h"
30

Sylvain Berfini's avatar
Sylvain Berfini committed
31 32 33
#ifdef __cplusplus
extern "C" {
#endif
34

35 36 37 38
/**
 * @addtogroup call_control
 * @{
 */
39

40 41 42 43
/**
 * LinphoneConference class
 */
typedef struct _LinphoneConference LinphoneConference;
44 45 46 47 48
/**
 * Parameters for initialization of conferences
 */
typedef struct _LinphoneCorferenceParams LinphoneConferenceParams;

49 50 51



52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
/**
 * Create a #LinphoneConferenceParams with default parameters set.
 * @param core #LinphoneCore to use to find out the default parameters. Can be NULL.
 * @return A freshly allocated #LinphoneConferenceParams
 */
LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_new(const LinphoneCore *core);
/**
 * Free a #LinphoneConferenceParams
 * @param params #LinphoneConferenceParams to free
 */
LINPHONE_PUBLIC void linphone_conference_params_free(LinphoneConferenceParams *params);
/**
 * Clone a #LinphoneConferenceParams
 * @param params The #LinphoneConfrenceParams to clone
 * @return An allocated #LinphoneConferenceParams with the same parameters than params
 */
LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_clone(const LinphoneConferenceParams *params);
/**
 * Enable video when starting a conference
 * @param params A #LinphoneConnferenceParams
 * @param enable If true, video will be enabled during conference
 */
LINPHONE_PUBLIC void linphone_conference_params_enable_video(LinphoneConferenceParams *params, bool_t enable);
/**
 * Check whether video will be enable at conference starting
 * @return if true, the video will be enable at conference starting
 */
LINPHONE_PUBLIC bool_t linphone_conference_params_video_requested(const LinphoneConferenceParams *params);
80

81

82

83

84

85 86 87 88
/**
 * Remove a participant from a conference
 * @param obj A #LinphoneConference
 * @param uri SIP URI of the participant to remove
89
 * @warning The passed SIP URI must be one of the URIs returned by linphone_conference_get_participants()
90 91
 * @return 0 if succeeded, -1 if failed
 */
92
LINPHONE_PUBLIC int linphone_conference_remove_participant(LinphoneConference *obj, const LinphoneAddress *uri);
93 94 95 96 97 98 99
/**
 * Get URIs of all participants of one conference
 * The returned MSList contains URIs of all participant. That list must be
 * freed after use and each URI must be unref with linphone_address_unref()
 * @param obj A #LinphoneConference
 * @return \mslist{LinphoneAddress}
 */
100
LINPHONE_PUBLIC MSList *linphone_conference_get_participants(const LinphoneConference *obj);
101

102 103 104
/**
 * @}
 */
105

Sylvain Berfini's avatar
Sylvain Berfini committed
106 107 108 109
#ifdef __cplusplus
}
#endif

110
#endif // CONFERENCE_H