conference.h 5.01 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
 *
 *  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.
 */

26 27
#ifndef LINPHONE_CONFERENCE_H
#define LINPHONE_CONFERENCE_H
28

29
#include "linphone/types.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 44 45
/**
 * 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);
46

47 48 49 50 51 52 53 54 55 56
/**
 * Take a reference on a #LinphoneConferencParams.
 * @param[in] params The #LinphoneConferenceParams to ref.
 * @return The freshly refed #LinphoneConferenceParams.
 */
LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_ref(LinphoneConferenceParams *params);

/**
 * Release a #LinphoneConferenceParams.
 * @param[in] params The #LinphoneConferenceParams to release.
57
 */
58 59
LINPHONE_PUBLIC void linphone_conference_params_unref(LinphoneConferenceParams *params);

60 61 62
/**
 * Free a #LinphoneConferenceParams
 * @param params #LinphoneConferenceParams to free
63
 * @deprecated Use linphone_conference_params_unref() instead.
64
 * @donotwrap
65
 */
66
LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_conference_params_free(LinphoneConferenceParams *params);
67

68 69
/**
 * Clone a #LinphoneConferenceParams
70
 * @param params The #LinphoneConferenceParams to clone
71 72 73
 * @return An allocated #LinphoneConferenceParams with the same parameters than params
 */
LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_clone(const LinphoneConferenceParams *params);
74

75 76
/**
 * Enable video when starting a conference
77
 * @param params A #LinphoneConferenceParams
78 79 80
 * @param enable If true, video will be enabled during conference
 */
LINPHONE_PUBLIC void linphone_conference_params_enable_video(LinphoneConferenceParams *params, bool_t enable);
81

82 83 84 85 86
/**
 * 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);
87

88

89 90 91 92 93 94 95 96 97 98 99 100 101
/**
 * Take a reference on a #LinphoneConference.
 * @param[in] conf The #LinphoneConference to ref.
 * @return The freshly refed #LinphoneConference.
 */
LINPHONE_PUBLIC LinphoneConference *linphone_conference_ref(LinphoneConference *conf);

/**
 * Release a #LinphoneConference.
 * @param[in] conf The #LinphoneConference to release.
 */
LINPHONE_PUBLIC void linphone_conference_unref(LinphoneConference *conf);

102 103 104 105
/**
 * Remove a participant from a conference
 * @param obj A #LinphoneConference
 * @param uri SIP URI of the participant to remove
106
 * @warning The passed SIP URI must be one of the URIs returned by linphone_conference_get_participants()
107 108
 * @return 0 if succeeded, -1 if failed
 */
109
LINPHONE_PUBLIC LinphoneStatus linphone_conference_remove_participant(LinphoneConference *obj, const LinphoneAddress *uri);
110

111 112
/**
 * Get URIs of all participants of one conference
113
 * The returned bctbx_list_t contains URIs of all participant. That list must be
114 115
 * freed after use and each URI must be unref with linphone_address_unref()
 * @param obj A #LinphoneConference
116
 * @return \bctbx_list{LinphoneAddress}
117
 */
118
LINPHONE_PUBLIC bctbx_list_t *linphone_conference_get_participants(const LinphoneConference *obj);
119

120
/**
121
 * Invite participants to the conference, by supplying a list of #LinphoneAddress
122
 * @param obj The conference.
123
 * @param addresses \bctbx_list{LinphoneAddress}
124 125 126 127
 * @param params #LinphoneCallParams to use for inviting the participants.
**/
LINPHONE_PUBLIC LinphoneStatus linphone_conference_invite_participants(LinphoneConference *conf, const bctbx_list_t *addresses, const LinphoneCallParams *params);

128
/**
129
  * Get the conference id as string
130 131 132 133
  */
LINPHONE_PUBLIC const char *linphone_conference_get_ID(const LinphoneConference *obj);

/**
134
  * Set the conference id as string
135 136 137
  */
LINPHONE_PUBLIC void linphone_conference_set_ID(const LinphoneConference *obj, const char *conferenceID);

138 139 140
/**
 * @}
 */
141

Sylvain Berfini's avatar
Sylvain Berfini committed
142 143 144 145
#ifdef __cplusplus
}
#endif

146
#endif // LINPHONE_CONFERENCE_H