Liblinphone  5.4.0
Typedefs | Enumerations | Functions
Conferencing

Making a audio/video conferences. More...

Typedefs

typedef void(* LinphoneConferenceCbsAllowedParticipantListChangedCb) (LinphoneConference *conference)
 Callback used to notify a conference that the list of participants allowed to join the conference has changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantAddedCb) (LinphoneConference *conference, LinphoneParticipant *participant)
 Callback used to notify a conference that a participant has been added. More...
 
typedef void(* LinphoneConferenceCbsParticipantRemovedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)
 Callback used to notify a conference that a participant has been removed. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceStateChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device, const LinphoneParticipantDeviceState state)
 Callback used to notify a conference that a participant device has changed state. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device, bool_t enabled)
 Callback used to notify a conference that a participant device starts or stops screen sharing. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device)
 Callback used to notify a conference that the media availability of a participant device has been changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device)
 Callback used to notify a conference that the media capability of a participant device has been changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantRoleChangedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)
 Callback used to notify a conference that the role of a participant has been changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantAdminStatusChangedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)
 Callback used to notify a conference that the admin status of a participant has been changed. More...
 
typedef void(* LinphoneConferenceCbsStateChangedCb) (LinphoneConference *conference, LinphoneConferenceState newState)
 Callback used to notify a conference state has changed. More...
 
typedef void(* LinphoneConferenceCbsAvailableMediaChangedCb) (LinphoneConference *conference)
 Callback used to notify that the available media of a conference has changed. More...
 
typedef void(* LinphoneConferenceCbsSubjectChangedCb) (LinphoneConference *conference, const char *subject)
 Callback used to notify that the subject of a conference has changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device, bool_t is_speaking)
 Callback used to notify that a participant device is speaking or isn't speaking anymore. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceIsMutedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device, bool_t is_muted)
 Callback used to notify that a participant device is muted or is no longer muted. More...
 
typedef void(* LinphoneConferenceCbsAudioDeviceChangedCb) (LinphoneConference *conference, const LinphoneAudioDevice *audio_device)
 Callback used to notify that the audio device of a conference has changed. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceAddedCb) (LinphoneConference *conference, LinphoneParticipantDevice *participant_device)
 Callback used to notify a conference that a participant device has been added. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceRemovedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device)
 Callback used to notify a conference that a participant device has been removed. More...
 
typedef void(* LinphoneConferenceCbsParticipantDeviceJoiningRequestCb) (LinphoneConference *conference, LinphoneParticipantDevice *participant_device)
 Callback used to notify a conference that a participant has requested to join the conference. More...
 
typedef void(* LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device)
 Callback used to notify which participant device video is being displayed as "actively speaking". More...
 
typedef void(* LinphoneConferenceCbsFullStateReceivedCb) (LinphoneConference *conference)
 Callback used to notify when a notify full state has been received. More...
 
typedef void(* LinphoneParticipantDeviceCbsIsSpeakingChangedCb) (LinphoneParticipantDevice *participant_device, bool_t is_speaking)
 Callback used to notify that is this participant device speaking has changed. More...
 
typedef void(* LinphoneParticipantDeviceCbsIsMutedCb) (LinphoneParticipantDevice *participant_device, bool_t is_muted)
 Callback used to notify that this participant device is muted or is no longer muted. More...
 
typedef void(* LinphoneParticipantDeviceCbsScreenSharingChangedCb) (LinphoneParticipantDevice *participant_device, bool_t is_screen_sharing)
 Callback used to notify that this participant device is screen sharing or is no longer screen sharing. More...
 
typedef void(* LinphoneParticipantDeviceCbsStateChangedCb) (LinphoneParticipantDevice *participant_device, const LinphoneParticipantDeviceState state)
 Callback used to notify that participant device changed state. More...
 
typedef void(* LinphoneParticipantDeviceCbsStreamCapabilityChangedCb) (LinphoneParticipantDevice *participant_device, LinphoneMediaDirection direction, const LinphoneStreamType stream_type)
 Callback used to notify that participant device stream capability has changed. More...
 
typedef void(* LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb) (LinphoneParticipantDevice *participant_device, LinphoneMediaDirection direction)
 Callback used to notify that participant device thumbnail stream capability has changed. More...
 
typedef void(* LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb) (LinphoneParticipantDevice *participant_device, bool_t available, const LinphoneStreamType stream_type)
 Callback used to notify that participant device stream availability has changed. More...
 
typedef void(* LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb) (LinphoneParticipantDevice *participant_device, bool_t available)
 Callback used to notify that participant device thumbnail stream availability has changed. More...
 
typedef void(* LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb) (LinphoneParticipantDevice *participant_device, int error_code)
 Callback to notify that there are errors from the video rendering of the participant device. More...
 
typedef void(* LinphoneConferenceSchedulerCbsStateChangedCb) (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceSchedulerState state)
 Callback for notifying when a registration state has changed for the conference scheduler. More...
 
typedef void(* LinphoneConferenceSchedulerCbsInvitationsSentCb) (LinphoneConferenceScheduler *conference_scheduler, const bctbx_list_t *failed_invitations)
 Callback for notifying when conference invitations have been sent. More...
 
typedef struct _LinphoneConference LinphoneConference
 A conference is the object that allow to make calls when there are 2 or more participants. More...
 
typedef struct _LinphoneConferenceParams LinphoneConferenceParams
 Object defining parameters for a LinphoneConference. More...
 
typedef struct _LinphoneConferenceCbs LinphoneConferenceCbs
 An object to handle the callbacks for the handling a LinphoneConference objects. More...
 
typedef struct _LinphoneConferenceInfo LinphoneConferenceInfo
 Object defining all information related to a past or future conference.
 
typedef struct _LinphoneConferenceScheduler LinphoneConferenceScheduler
 Creates and manages conferences on a conferenceing service, and send conference invitations to notify participants.
 
typedef struct _LinphoneParticipant LinphoneParticipant
 Identifies a member of a LinphoneConference or LinphoneChatRoom. More...
 
typedef struct _LinphoneParticipantInfo LinphoneParticipantInfo
 Object defining all information related to a participant.
 
typedef struct _LinphoneParticipantDevice LinphoneParticipantDevice
 This object represents a unique device for a member of a LinphoneConference or LinphoneChatRoom. More...
 
typedef struct _LinphoneParticipantDeviceCbs LinphoneParticipantDeviceCbs
 An object to handle the callbacks for the handling a LinphoneParticipantDevice objects. More...
 
typedef struct _LinphoneParticipantImdnState LinphoneParticipantImdnState
 This object represents the delivery/display state of a given chat message for a given participant. More...
 
typedef struct _LinphoneParticipantDeviceIdentity LinphoneParticipantDeviceIdentity
 This object is only used on server side for LinphoneChatRoom with LinphoneChatRoomBackendFlexisipChat backend.
 
typedef enum _LinphoneConferenceState LinphoneConferenceState
 LinphoneConferenceState is used to indicate the current state of a conference.
 
typedef enum _LinphoneConferenceLayout LinphoneConferenceLayout
 LinphoneConferenceLayout is used to indicate the layout used by the conference.
 
typedef enum _LinphoneConferenceJoiningMode LinphoneConferenceJoiningMode
 Mode of joining conference. More...
 
typedef enum _LinphoneConferenceParticipantListType LinphoneConferenceParticipantListType
 Type of conference participant list. More...
 
typedef enum _LinphoneConferenceSecurityLevel LinphoneConferenceSecurityLevel
 Conference minimum security level.
 
typedef enum _LinphoneConferenceSchedulerState LinphoneConferenceSchedulerState
 Describes conference scheduler possible states. More...
 
typedef enum _LinphoneConferenceInfoState LinphoneConferenceInfoState
 LinphoneConferenceInfoState is used to list all states of a conference info object
 
typedef enum _LinphoneConferenceSchedulerType LinphoneConferenceSchedulerType
 LinphoneConferenceSchedulerType is used to know which conference scheduler type the core is using
 
typedef enum _LinphoneParticipantRole LinphoneParticipantRole
 LinphoneParticipantRole is used to define a role of a participant within a conference
 
typedef enum _LinphoneParticipantDeviceState LinphoneParticipantDeviceState
 LinphoneParticipantDeviceState is used to list all states a participant device can be in
 
typedef enum _LinphoneParticipantDeviceJoiningMethod LinphoneParticipantDeviceJoiningMethod
 LinphoneParticipantDeviceJoiningMethod is used to indicate how a participant joined a conference or if it is the focus.
 
typedef enum _LinphoneParticipantDeviceDisconnectionMethod LinphoneParticipantDeviceDisconnectionMethod
 LinphoneParticipantDeviceDisconnectionMethod is used to indicate how a participant left a conference.
 

Enumerations

enum  _LinphoneConferenceState {
  LinphoneConferenceStateNone = 0,
  LinphoneConferenceStateInstantiated = 1,
  LinphoneConferenceStateCreationPending = 2,
  LinphoneConferenceStateCreated = 3,
  LinphoneConferenceStateCreationFailed = 4,
  LinphoneConferenceStateTerminationPending = 5,
  LinphoneConferenceStateTerminated = 6,
  LinphoneConferenceStateTerminationFailed = 7,
  LinphoneConferenceStateDeleted = 8
}
 LinphoneConferenceState is used to indicate the current state of a conference. More...
 
enum  _LinphoneConferenceLayout {
  LinphoneConferenceLayoutGrid = 0,
  LinphoneConferenceLayoutActiveSpeaker = 1
}
 LinphoneConferenceLayout is used to indicate the layout used by the conference. More...
 
enum  _LinphoneConferenceJoiningMode {
  LinphoneConferenceJoiningModeDialIn = 0,
  LinphoneConferenceJoiningModeDialOut = 1
}
 Mode of joining conference. More...
 
enum  _LinphoneConferenceParticipantListType {
  LinphoneConferenceParticipantListTypeClosed,
  LinphoneConferenceParticipantListTypeOpen
}
 Type of conference participant list. More...
 
enum  _LinphoneConferenceSecurityLevel {
  LinphoneConferenceSecurityLevelNone = 0,
  LinphoneConferenceSecurityLevelPointToPoint = 1,
  LinphoneConferenceSecurityLevelEndToEnd = 2
}
 Conference minimum security level. More...
 
enum  _LinphoneConferenceSchedulerState {
  LinphoneConferenceSchedulerStateIdle = 0,
  LinphoneConferenceSchedulerStateError = 1,
  LinphoneConferenceSchedulerStateAllocationPending = 2,
  LinphoneConferenceSchedulerStateReady = 3,
  LinphoneConferenceSchedulerStateUpdating = 4
}
 Describes conference scheduler possible states. More...
 
enum  _LinphoneConferenceInfoState {
  LinphoneConferenceInfoStateNew = 0,
  LinphoneConferenceInfoStateUpdated = 1,
  LinphoneConferenceInfoStateCancelled = 2
}
 LinphoneConferenceInfoState is used to list all states of a conference info object More...
 
enum  _LinphoneConferenceSchedulerType {
  LinphoneConferenceSchedulerTypeSIP = 0,
  LinphoneConferenceSchedulerTypeDB = 1,
  LinphoneConferenceSchedulerTypeCCMP = 2
}
 LinphoneConferenceSchedulerType is used to know which conference scheduler type the core is using More...
 
enum  _LinphoneParticipantRole {
  LinphoneParticipantRoleSpeaker = 0,
  LinphoneParticipantRoleListener = 1,
  LinphoneParticipantRoleUnknown = 2
}
 LinphoneParticipantRole is used to define a role of a participant within a conference More...
 
enum  _LinphoneParticipantDeviceState {
  LinphoneParticipantDeviceStateJoining = 0,
  LinphoneParticipantDeviceStatePresent,
  LinphoneParticipantDeviceStateLeaving = 2,
  LinphoneParticipantDeviceStateLeft = 3,
  LinphoneParticipantDeviceStateScheduledForJoining,
  LinphoneParticipantDeviceStateScheduledForLeaving,
  LinphoneParticipantDeviceStateOnHold = 6,
  LinphoneParticipantDeviceStateAlerting = 7,
  LinphoneParticipantDeviceStateMutedByFocus = 8,
  LinphoneParticipantDeviceStateRequestingToJoin
}
 LinphoneParticipantDeviceState is used to list all states a participant device can be in More...
 
enum  _LinphoneParticipantDeviceJoiningMethod {
  LinphoneParticipantDeviceJoiningMethodDialedIn = 0,
  LinphoneParticipantDeviceJoiningMethodDialedOut = 1,
  LinphoneParticipantDeviceJoiningMethodFocusOwner = 2
}
 LinphoneParticipantDeviceJoiningMethod is used to indicate how a participant joined a conference or if it is the focus. More...
 
enum  _LinphoneParticipantDeviceDisconnectionMethod {
  LinphoneParticipantDeviceDisconnectionMethodBooted = 0,
  LinphoneParticipantDeviceDisconnectionMethodDeparted = 1,
  LinphoneParticipantDeviceDisconnectionMethodBusy = 2,
  LinphoneParticipantDeviceDisconnectionMethodFailed
}
 LinphoneParticipantDeviceDisconnectionMethod is used to indicate how a participant left a conference. More...
 

Functions

LinphoneConferencelinphone_core_create_conference_with_params (LinphoneCore *core, const LinphoneConferenceParams *params)
 Create a conference. More...
 
MS2_DEPRECATED LinphoneConferenceSchedulerlinphone_core_create_conference_scheduler (LinphoneCore *core)
 Create a conference scheduler that can be used to schedule conferences on a client conference service and then send conference information invitation as an ICS object through chat. More...
 
LinphoneConferenceSchedulerlinphone_core_create_conference_scheduler_2 (LinphoneCore *core, LinphoneAccount *account)
 Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat. More...
 
LinphoneConferenceSchedulerlinphone_core_create_conference_scheduler_with_type (LinphoneCore *core, LinphoneAccount *account, LinphoneConferenceSchedulerType scheduling_type)
 Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat by specifying its type. More...
 
LinphoneConferenceSchedulerlinphone_core_create_sip_conference_scheduler (LinphoneCore *core, LinphoneAccount *account)
 Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat. More...
 
LinphoneConferenceSchedulerlinphone_core_create_db_conference_scheduler (LinphoneCore *core, LinphoneAccount *account)
 Create a database conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat. More...
 
LinphoneConferenceSchedulerlinphone_core_create_ccmp_conference_scheduler (LinphoneCore *core, LinphoneAccount *account)
 Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat. More...
 
LinphoneConferencelinphone_core_search_conference (const LinphoneCore *core, const LinphoneConferenceParams *params, const LinphoneAddress *localAddr, const LinphoneAddress *remoteAddr, const bctbx_list_t *participants)
 Find a conference. More...
 
LinphoneConferencelinphone_core_search_conference_2 (const LinphoneCore *core, const LinphoneAddress *conferenceAddr)
 Finds a conference. More...
 
LinphoneConferencelinphone_core_search_conference_by_identifier (const LinphoneCore *core, const char *identifier)
 Find a conference by its identifier. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_add_to_conference (LinphoneCore *core, LinphoneCall *call)
 Adds a participant to the conference. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_add_all_to_conference (LinphoneCore *core)
 Adds all calls into the conference. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_remove_from_conference (LinphoneCore *core, LinphoneCall *call)
 Removes a call from the conference. More...
 
MS2_DEPRECATED bool_t linphone_core_is_in_conference (const LinphoneCore *core)
 Indicates whether the local participant is part of a conference. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_enter_conference (LinphoneCore *core)
 Joins the local participant to the running conference. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_leave_conference (LinphoneCore *core)
 Makes the local participant leave the running conference. More...
 
MS2_DEPRECATED float linphone_core_get_conference_local_input_volume (LinphoneCore *core)
 Returns the input volume of the local participant. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_terminate_conference (LinphoneCore *core)
 Terminates the running conference. More...
 
LinphoneConferenceParamslinphone_core_create_conference_params_2 (LinphoneCore *core, LinphoneConference *conference)
 Creates some default conference parameters for instanciating a conference with linphone_core_create_conference_with_params(). More...
 
void linphone_core_enable_conference_server (LinphoneCore *core, bool_t enable)
 Enables the conference server mode. More...
 
bool_t linphone_core_conference_server_enabled (const LinphoneCore *core)
 Tells whether the conference server feature is enabled. More...
 
void linphone_core_enable_fec (LinphoneCore *core, bool_t enable)
 Enables the flexible FEC feature (RFC8627) for video calls to recover RTP packet loss. More...
 
bool_t linphone_core_fec_enabled (const LinphoneCore *core)
 Tells whether the flexible FEC feature (RFC8627) is enabled for this LinphoneCore object. More...
 
void linphone_core_set_conference_participant_list_type (LinphoneCore *core, LinphoneConferenceParticipantListType type)
 Selects whether the default conference participant list is open or closed. More...
 
LinphoneConferenceParticipantListType linphone_core_get_conference_participant_list_type (const LinphoneCore *core)
 Tells whether the default conference participant list is open or closed. More...
 
void linphone_core_enable_conference_ics_in_message_body (LinphoneCore *core, bool_t enable)
 Enable sending conference invitations in the chat message body instead of as a file attachment. More...
 
bool_t linphone_core_conference_ics_in_message_body_enabled (const LinphoneCore *core)
 Gets wether conference invitations will be sent in the chat message body or as a file attachment. More...
 
void linphone_core_set_conference_max_thumbnails (LinphoneCore *core, int max)
 Sets the maximum number of thumbnails requested in the SDP during a conference call. More...
 
int linphone_core_get_conference_max_thumbnails (const LinphoneCore *core)
 Gets the maximum number of thumbnails requested in the SDP during a conference call linphone_account_get_call_logs(). More...
 
void linphone_core_set_default_conference_layout (LinphoneCore *core, LinphoneConferenceLayout value)
 Set the default conference layout. More...
 
LinphoneConferenceLayout linphone_core_get_default_conference_layout (const LinphoneCore *core)
 Gets the default conference layout. More...
 
void linphone_core_set_conference_cleanup_period (LinphoneCore *core, long seconds)
 Set the conference cleanup timer period. More...
 
long linphone_core_get_conference_cleanup_period (const LinphoneCore *core)
 Gets the conference cleanup timer period. More...
 
void linphone_core_set_conference_availability_before_start (LinphoneCore *core, long seconds)
 Set the conference availability before start. More...
 
long linphone_core_get_conference_availability_before_start (const LinphoneCore *core)
 Gets the conference availability before start. More...
 
void linphone_core_set_conference_expire_period (LinphoneCore *core, long seconds)
 Set the conference expire period. More...
 
long linphone_core_get_conference_expire_period (const LinphoneCore *core)
 Gets the conference expire period. More...
 
LinphoneConferenceInfolinphone_core_find_conference_information_from_ccmp_uri (LinphoneCore *core, const char *uri)
 Retrieve the conference information linked to the provided URI if any. More...
 
LinphoneConferenceInfolinphone_core_find_conference_information_from_uri (LinphoneCore *core, LinphoneAddress *uri)
 Retrieve the conference information linked to the provided URI if any. More...
 
bctbx_list_t * linphone_core_get_conference_information_list (LinphoneCore *core)
 Retrieve the list of conference information on DB. More...
 
bctbx_list_t * linphone_core_get_conference_informations_with_participant (LinphoneCore *core, LinphoneAddress *uri)
 Retrieve the list of conference information on DB where the address passed as argument is either the organizer or a participant. More...
 
bctbx_list_t * linphone_core_get_future_conference_information_list (LinphoneCore *core)
 Retrieve the list of future conference information on DB. More...
 
bctbx_list_t * linphone_core_get_conference_information_list_after_time (LinphoneCore *core, time_t time)
 Retrieve the list of conference information on DB after a certain time. More...
 
void linphone_core_delete_conference_information (LinphoneCore *core, LinphoneConferenceInfo *conference_info)
 Deletes a conference information from DB. More...
 
LinphoneConferencelinphone_conference_ref (LinphoneConference *conference)
 Take a reference on a LinphoneConference. More...
 
void linphone_conference_unref (LinphoneConference *conference)
 Release a LinphoneConference. More...
 
MS2_DEPRECATED bctbx_list_t * linphone_conference_get_participants (const LinphoneConference *conference)
 Get URIs of all participants of one conference The returned bctbx_list_t contains URIs of all participants. More...
 
bctbx_list_t * linphone_conference_get_participant_list (const LinphoneConference *conference)
 Get list of all participants of a conference. More...
 
bctbx_list_t * linphone_conference_get_participant_device_list (const LinphoneConference *conference)
 Get list of all participant devices of a conference including me if it is in. More...
 
LinphoneParticipantlinphone_conference_get_screen_sharing_participant (const LinphoneConference *conference)
 Get the participant that is currently screen sharing. More...
 
LinphoneParticipantDevicelinphone_conference_get_screen_sharing_participant_device (const LinphoneConference *conference)
 Get the participant device that is currently screen sharing. More...
 
MS2_DEPRECATED LinphoneStatus linphone_conference_remove_participant (LinphoneConference *conference, const LinphoneAddress *uri)
 
LinphoneStatus linphone_conference_remove_participant_2 (LinphoneConference *conference, LinphoneParticipant *participant)
 
MS2_DEPRECATED LinphoneStatus linphone_conference_remove_participant_3 (LinphoneConference *conference, LinphoneCall *call)
 
LinphoneParticipantlinphone_conference_find_participant (LinphoneConference *conference, const LinphoneAddress *uri)
 Find a participant from a conference. More...
 
LinphoneStatus linphone_conference_invite_participants (LinphoneConference *conference, const bctbx_list_t *addresses, const LinphoneCallParams *params)
 Invite participants to the conference, by supplying a list of LinphoneAddress If the conference is in the state LinphoneConferenceStateCreationPending, then the conference will start on the input and output audio devices used for the currently active call, if any This method will call every address supplied and add it to a conference on devices hosting a conference. More...
 
LinphoneStatus linphone_conference_add_participants (LinphoneConference *conference, const bctbx_list_t *calls)
 Add participants to the conference, by supplying a list of LinphoneCall. More...
 
LinphoneStatus linphone_conference_add_participants_2 (LinphoneConference *conference, const bctbx_list_t *addresses)
 Add participants to the conference, by supplying a list of LinphoneAddress. More...
 
LinphoneStatus linphone_conference_add_participant (LinphoneConference *conference, LinphoneCall *call)
 Join an existing call to the conference. More...
 
LinphoneStatus linphone_conference_add_participant_2 (LinphoneConference *conference, const LinphoneAddress *uri)
 Join a participant to the conference. More...
 
const char * linphone_conference_get_identifier (const LinphoneConference *conference)
 Returns the conference identifier. More...
 
int linphone_conference_update_params (LinphoneConference *conference, const LinphoneConferenceParams *params)
 Update parameters of the conference. More...
 
const LinphoneConferenceParamslinphone_conference_get_current_params (const LinphoneConference *conference)
 Get current parameters of the conference. More...
 
const char * linphone_conference_get_subject (const LinphoneConference *conference)
 Get the conference subject. More...
 
const char * linphone_conference_get_subject_utf8 (const LinphoneConference *conference)
 Get the conference subject as an UTF-8 string. More...
 
void linphone_conference_set_subject (LinphoneConference *conference, const char *subject)
 Set the conference subject. More...
 
void linphone_conference_set_subject_utf8 (LinphoneConference *conference, const char *subject)
 Set the conference subject as an UTF-8 string. More...
 
const char * linphone_conference_get_username (const LinphoneConference *conference)
 Get the conference username. More...
 
void linphone_conference_set_username (LinphoneConference *conference, const char *username)
 Set the conference username. More...
 
void linphone_conference_set_local_participant_stream_capability (LinphoneConference *conference, const LinphoneMediaDirection direction, const LinphoneStreamType stream_type)
 Set stream capability on 'me' device of a local conference. More...
 
int linphone_conference_get_duration (const LinphoneConference *conference)
 Get the conference duration. More...
 
time_t linphone_conference_get_start_time (const LinphoneConference *conference)
 Get the conference start time. More...
 
int linphone_conference_get_participant_count (const LinphoneConference *conference)
 Get number of participants without me. More...
 
LinphoneParticipantlinphone_conference_get_me (const LinphoneConference *conference)
 For a local audio video conference, this function returns the participant hosting the conference For a remote audio video conference, this function returns the local participant of the conference. More...
 
int linphone_conference_terminate (LinphoneConference *conference)
 Terminates conference. More...
 
void linphone_conference_set_participant_admin_status (LinphoneConference *conference, LinphoneParticipant *participant, bool_t is_admin)
 Change the admin status of a participant of a conference (you need to be an admin yourself to do this). More...
 
int linphone_conference_enter (LinphoneConference *conference)
 For a local conference, the local participant joins the conference For a client conference, the participant rejoins the conference after leaving it earlier on. More...
 
int linphone_conference_leave (LinphoneConference *conference)
 For a local conference, the local participant leaves the conference For a client conference, the participant leaves the conference after joining it earlier on. More...
 
bool_t linphone_conference_is_me (const LinphoneConference *conference, const LinphoneAddress *uri)
 For a local audio video conference, this function compares the address provided as argument with that of participant hosting the conference For a remote audio video conference, this function compares the address provided as argument with that of the local participant of the conference. More...
 
bool_t linphone_conference_is_in (const LinphoneConference *conference)
 For a local conference, it returns whether the local participant is enabled For a client conference, it return whether the remote participant has left the conference without bein removed from it. More...
 
void linphone_conference_set_input_audio_device (LinphoneConference *conference, LinphoneAudioDevice *audio_device)
 Sets the given LinphoneAudioDevice as input for this conference only. More...
 
void linphone_conference_set_output_audio_device (LinphoneConference *conference, LinphoneAudioDevice *audio_device)
 Sets the given LinphoneAudioDevice as output for this conference only. More...
 
const LinphoneAudioDevicelinphone_conference_get_input_audio_device (const LinphoneConference *conference)
 Gets the current input device for this conference. More...
 
const LinphoneAudioDevicelinphone_conference_get_output_audio_device (const LinphoneConference *conference)
 Gets the current output device for this conference. More...
 
int linphone_conference_get_participant_device_volume (LinphoneConference *conference, LinphoneParticipantDevice *device)
 Retrieves the volume of a specific participant. More...
 
int linphone_conference_start_recording (LinphoneConference *conference, const char *path)
 Starts recording the conference. More...
 
int linphone_conference_stop_recording (LinphoneConference *conference)
 Stops the conference recording. More...
 
bool_t linphone_conference_is_recording (const LinphoneConference *conference)
 Gets whether the conference is currently being recorded. More...
 
LinphoneCalllinphone_conference_get_call (const LinphoneConference *conference)
 Gets the call that is controlling a conference. More...
 
bool_t linphone_conference_get_microphone_muted (const LinphoneConference *conference)
 Retrieves the volume of a specific participant. More...
 
void linphone_conference_set_microphone_muted (LinphoneConference *conference, bool_t muted)
 Get microphone muted state. More...
 
float linphone_conference_get_input_volume (const LinphoneConference *conference)
 Retrieves the volume of a specific participant. More...
 
void linphone_conference_add_callbacks (LinphoneConference *conference, LinphoneConferenceCbs *cbs)
 Add a listener in order to be notified of LinphoneConference events. More...
 
void linphone_conference_remove_callbacks (LinphoneConference *conference, LinphoneConferenceCbs *cbs)
 Remove a listener from a LinphoneConference. More...
 
void linphone_conference_set_current_callbacks (LinphoneConference *conference, LinphoneConferenceCbs *cbs)
 Gets the current LinphoneConferenceCbs. More...
 
LinphoneConferenceCbslinphone_conference_get_current_callbacks (const LinphoneConference *conference)
 Sets the current LinphoneConferenceCbs. More...
 
LinphoneCorelinphone_conference_get_core (const LinphoneConference *conference)
 Returns core for a LinphoneConference. More...
 
LinphoneChatRoomlinphone_conference_get_chat_room (const LinphoneConference *conference)
 Returns the LinphoneChatRoom linked to the LinphoneConference. More...
 
const LinphoneAddresslinphone_conference_get_conference_address (const LinphoneConference *conference)
 Get the conference address of the conference. More...
 
void linphone_conference_set_conference_address (LinphoneConference *conference, LinphoneAddress *address)
 Set the conference address. More...
 
LinphoneConferenceState linphone_conference_get_state (const LinphoneConference *conference)
 Get the current state of the conference. More...
 
LinphoneParticipantDevicelinphone_conference_get_active_speaker_participant_device (const LinphoneConference *conference)
 Get the currently active speaker participant device. More...
 
LinphonePlayerlinphone_conference_get_player (LinphoneConference *conference)
 Gets a player associated with the conference to play a local file and stream it to the remote peers. More...
 
const LinphoneConferenceInfolinphone_conference_get_info (LinphoneConference *conference)
 Gets the LinphoneConferenceInfo object associated with a conference. More...
 
LinphoneAccountlinphone_conference_get_account (LinphoneConference *conference)
 Gets the LinphoneAccount object associated with the conference. More...
 
LinphoneConferencelinphone_local_conference_new (LinphoneCore *core, LinphoneAddress *addr)
 
LinphoneConferencelinphone_local_conference_new_with_params (LinphoneCore *core, const LinphoneAddress *addr, const LinphoneConferenceParams *params)
 
LinphoneConferencelinphone_remote_conference_new (LinphoneCore *core, LinphoneAddress *addr)
 
LinphoneConferencelinphone_remote_conference_new_with_params (LinphoneCore *core, const LinphoneAddress *focus, const LinphoneAddress *addr, const LinphoneConferenceParams *params)
 
AudioStream * linphone_conference_get_audio_stream (LinphoneConference *conference)
 
void linphone_conference_on_call_terminating (LinphoneConference *conference, LinphoneCall *call)
 
bool_t linphone_conference_check_class (LinphoneConference *conference, LinphoneConferenceClass _class)
 
void linphone_conference_notify_audio_device_changed (LinphoneConference *conference, LinphoneAudioDevice *audio_device)
 
char * linphone_conference_state_to_string (LinphoneConferenceState state)
 A function to convert a LinphoneConferenceState into a string.
 
LinphoneConferenceParamslinphone_conference_params_new (LinphoneCore *core)
 Create an object of type a LinphoneConferenceParams. More...
 
LinphoneConferenceParamslinphone_conference_params_ref (LinphoneConferenceParams *params)
 Take a reference on a LinphoneConferenceParams. More...
 
void linphone_conference_params_unref (LinphoneConferenceParams *params)
 Release a LinphoneConferenceParams. More...
 
MS2_DEPRECATED void linphone_conference_params_free (LinphoneConferenceParams *params)
 Free a LinphoneConferenceParams. More...
 
LinphoneConferenceParamslinphone_conference_params_clone (const LinphoneConferenceParams *params)
 Clone a LinphoneConferenceParams. More...
 
void linphone_conference_params_set_subject (LinphoneConferenceParams *params, const char *subject)
 Set the conference subject. More...
 
void linphone_conference_params_set_subject_utf8 (LinphoneConferenceParams *params, const char *subject)
 Set the conference subject as an UTF8 string. More...
 
const char * linphone_conference_params_get_subject (const LinphoneConferenceParams *params)
 Get the conference subject. More...
 
const char * linphone_conference_params_get_subject_utf8 (const LinphoneConferenceParams *params)
 Get the conference subject as an UTF-8 string. More...
 
MS2_DEPRECATED void linphone_conference_params_set_audio_enabled (LinphoneConferenceParams *params, bool_t enable)
 Enable audio capabilities. More...
 
void linphone_conference_params_enable_audio (LinphoneConferenceParams *params, bool_t enable)
 Enable audio capabilities. More...
 
MS2_DEPRECATED bool_t linphone_conference_params_is_audio_enabled (const LinphoneConferenceParams *params)
 Check whether audio capabilities are enabled. More...
 
bool_t linphone_conference_params_audio_enabled (const LinphoneConferenceParams *params)
 Check whether audio capabilities are enabled. More...
 
MS2_DEPRECATED void linphone_conference_params_set_video_enabled (LinphoneConferenceParams *params, bool_t enable)
 Enable video capabilities. More...
 
MS2_DEPRECATED bool_t linphone_conference_params_is_video_enabled (const LinphoneConferenceParams *params)
 Check whether video capabilities are enabled. More...
 
void linphone_conference_params_enable_video (LinphoneConferenceParams *params, bool_t enable)
 Enable video capabilities. More...
 
bool_t linphone_conference_params_video_enabled (const LinphoneConferenceParams *params)
 Check whether video capabilities are enabled. More...
 
MS2_DEPRECATED void linphone_conference_params_set_chat_enabled (LinphoneConferenceParams *params, bool_t enable)
 Enable chat capabilities. More...
 
void linphone_conference_params_enable_chat (LinphoneConferenceParams *params, bool_t enable)
 Enable chat capabilities. More...
 
MS2_DEPRECATED bool_t linphone_conference_params_is_chat_enabled (const LinphoneConferenceParams *params)
 Check whether chat capabilities are enabled. More...
 
bool_t linphone_conference_params_chat_enabled (const LinphoneConferenceParams *params)
 Check whether chat capabilities are enabled. More...
 
void linphone_conference_params_set_account (LinphoneConferenceParams *params, LinphoneAccount *account)
 Sets the account for the conference. More...
 
LinphoneAccountlinphone_conference_params_get_account (const LinphoneConferenceParams *params)
 Returns the account for the conference. More...
 
MS2_DEPRECATED LinphoneProxyConfiglinphone_conference_params_get_proxy_cfg (const LinphoneConferenceParams *params)
 Returns the proxy configuration for the conference. More...
 
MS2_DEPRECATED void linphone_conference_params_set_local_participant_enabled (LinphoneConferenceParams *params, bool_t enable)
 Enable local participant to enter the conference. More...
 
void linphone_conference_params_enable_local_participant (LinphoneConferenceParams *params, bool_t enable)
 Enable local participant to enter the conference. More...
 
MS2_DEPRECATED bool_t linphone_conference_params_is_local_participant_enabled (const LinphoneConferenceParams *params)
 Returns whether local participant has to enter the conference. More...
 
bool_t linphone_conference_params_local_participant_enabled (const LinphoneConferenceParams *params)
 Returns whether local participant has to enter the conference. More...
 
MS2_DEPRECATED void linphone_conference_params_set_one_participant_conference_enabled (LinphoneConferenceParams *params, bool_t enable)
 Enable conference with one participant. More...
 
void linphone_conference_params_enable_one_participant_conference (LinphoneConferenceParams *params, bool_t enable)
 Enable conference with one participant. More...
 
MS2_DEPRECATED bool_t linphone_conference_params_is_one_participant_conference_enabled (const LinphoneConferenceParams *params)
 Returns whether conference can have only one participant. More...
 
bool_t linphone_conference_params_one_participant_conference_enabled (const LinphoneConferenceParams *params)
 Returns whether conference can have only one participant. More...
 
LinphoneConferenceSecurityLevel linphone_conference_params_get_security_level (const LinphoneConferenceParams *params)
 Retrieve the desired security level of the conference. More...
 
void linphone_conference_params_set_security_level (LinphoneConferenceParams *params, LinphoneConferenceSecurityLevel security_level)
 Set the desired security level of the conference. More...
 
void linphone_conference_params_set_conference_factory_address (LinphoneConferenceParams *params, const LinphoneAddress *address)
 Set the conference factory address of the conference. More...
 
const LinphoneAddresslinphone_conference_params_get_conference_factory_address (const LinphoneConferenceParams *params)
 Get the conference factory address of the conference that has been set. More...
 
void linphone_conference_params_set_description_utf8 (LinphoneConferenceParams *params, const char *description)
 Set the description of the conference (utf8) More...
 
const char * linphone_conference_params_get_description_utf8 (const LinphoneConferenceParams *params)
 Get conference description (utf8). More...
 
void linphone_conference_params_set_participant_list_type (LinphoneConferenceParams *params, LinphoneConferenceParticipantListType type)
 Set the participant list type. More...
 
void linphone_conference_params_set_hidden (LinphoneConferenceParams *params, bool_t hidden)
 Set the conference as hidden. More...
 
bool_t linphone_conference_params_is_hidden (const LinphoneConferenceParams *params)
 Get the value of the hidden flag. More...
 
LinphoneConferenceParticipantListType linphone_conference_params_get_participant_list_type (const LinphoneConferenceParams *params)
 Get the participant list type. More...
 
bool_t linphone_conference_params_is_valid (const LinphoneConferenceParams *params)
 Returns whether the given parameters are valid or not. More...
 
bool_t linphone_conference_params_group_enabled (const LinphoneConferenceParams *params)
 Get the group chat status of the text capabilities of the conference associated with the given parameters. More...
 
void linphone_conference_params_enable_group (LinphoneConferenceParams *params, bool_t group)
 Enables or disables group chat for the text capabilities of the conference associated with the given parameters. More...
 
LinphoneChatParamslinphone_conference_params_get_chat_params (const LinphoneConferenceParams *params)
 Get the chat parameters. More...
 
LinphoneConferenceCbslinphone_conference_cbs_ref (LinphoneConferenceCbs *cbs)
 Acquire a reference to the conference callbacks object. More...
 
void linphone_conference_cbs_unref (LinphoneConferenceCbs *cbs)
 Release reference to the conference callbacks object. More...
 
void * linphone_conference_cbs_get_user_data (const LinphoneConferenceCbs *cbs)
 Retrieve the user pointer associated with the conference callbacks object. More...
 
void linphone_conference_cbs_set_user_data (LinphoneConferenceCbs *cbs, void *ud)
 Assign a user pointer to the conference callbacks object. More...
 
LinphoneConferenceCbsAllowedParticipantListChangedCb linphone_conference_cbs_get_allowed_participant_list_changed (const LinphoneConferenceCbs *cbs)
 Get the allowed participant list changed callback. More...
 
void linphone_conference_cbs_set_allowed_participant_list_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsAllowedParticipantListChangedCb cb)
 Set the allowed participant list changed callback. More...
 
LinphoneConferenceCbsParticipantAddedCb linphone_conference_cbs_get_participant_added (const LinphoneConferenceCbs *cbs)
 Get the participant added callback. More...
 
void linphone_conference_cbs_set_participant_added (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantAddedCb cb)
 Set the participant added callback. More...
 
LinphoneConferenceCbsParticipantRemovedCb linphone_conference_cbs_get_participant_removed (const LinphoneConferenceCbs *cbs)
 Get the participant removed callback. More...
 
void linphone_conference_cbs_set_participant_removed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantRemovedCb cb)
 Set the participant removed callback. More...
 
LinphoneConferenceCbsParticipantDeviceAddedCb linphone_conference_cbs_get_participant_device_added (const LinphoneConferenceCbs *cbs)
 Get the participant device added callback. More...
 
void linphone_conference_cbs_set_participant_device_added (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceAddedCb cb)
 Set the participant device added callback. More...
 
LinphoneConferenceCbsParticipantDeviceRemovedCb linphone_conference_cbs_get_participant_device_removed (const LinphoneConferenceCbs *cbs)
 Get the participant device removed callback. More...
 
void linphone_conference_cbs_set_participant_device_removed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceRemovedCb cb)
 Set the participant device removed callback. More...
 
LinphoneConferenceCbsParticipantDeviceJoiningRequestCb linphone_conference_cbs_get_participant_device_joining_request (const LinphoneConferenceCbs *cbs)
 Get the participant device joining request callback. More...
 
void linphone_conference_cbs_set_participant_device_joining_request (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceJoiningRequestCb cb)
 Set the participant device joining request callback. More...
 
LinphoneConferenceCbsParticipantRoleChangedCb linphone_conference_cbs_get_participant_role_changed (const LinphoneConferenceCbs *cbs)
 Get the participant role changed callback. More...
 
void linphone_conference_cbs_set_participant_role_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantRoleChangedCb cb)
 Set the participant role changed callback. More...
 
LinphoneConferenceCbsParticipantAdminStatusChangedCb linphone_conference_cbs_get_participant_admin_status_changed (const LinphoneConferenceCbs *cbs)
 Get the participant admin status changed callback. More...
 
void linphone_conference_cbs_set_participant_admin_status_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantAdminStatusChangedCb cb)
 Set the participant admin status changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceStateChangedCb linphone_conference_cbs_get_participant_device_state_changed (const LinphoneConferenceCbs *cbs)
 Get the participant device state changed callback. More...
 
void linphone_conference_cbs_set_participant_device_state_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceStateChangedCb cb)
 Set the participant device state changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb linphone_conference_cbs_get_participant_device_screen_sharing_changed (const LinphoneConferenceCbs *cbs)
 Get the participant device is screen sharing changed callback. More...
 
void linphone_conference_cbs_set_participant_device_screen_sharing_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb cb)
 Set the participant device is screen sharing changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb linphone_conference_cbs_get_participant_device_media_availability_changed (const LinphoneConferenceCbs *cbs)
 Get the participant device media availability changed callback. More...
 
void linphone_conference_cbs_set_participant_device_media_availability_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb cb)
 Set the participant device media availability changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb linphone_conference_cbs_get_participant_device_media_capability_changed (const LinphoneConferenceCbs *cbs)
 Get the participant device media capabilities changed callback. More...
 
void linphone_conference_cbs_set_participant_device_media_capability_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb cb)
 Set the participant device media capabilities changed callback. More...
 
LinphoneConferenceCbsStateChangedCb linphone_conference_cbs_get_state_changed (const LinphoneConferenceCbs *cbs)
 Get the state changed callback. More...
 
void linphone_conference_cbs_set_state_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsStateChangedCb cb)
 Set the state changed callback. More...
 
LinphoneConferenceCbsAvailableMediaChangedCb linphone_conference_cbs_get_available_media_changed (const LinphoneConferenceCbs *cbs)
 Get the available media changed callback. More...
 
void linphone_conference_cbs_set_available_media_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsAvailableMediaChangedCb cb)
 Set the available media changed callback. More...
 
LinphoneConferenceCbsSubjectChangedCb linphone_conference_cbs_get_subject_changed (const LinphoneConferenceCbs *cbs)
 Get the subject changed callback. More...
 
void linphone_conference_cbs_set_subject_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsSubjectChangedCb cb)
 Set the subject changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb linphone_conference_cbs_get_participant_device_is_speaking_changed (const LinphoneConferenceCbs *cbs)
 Get the participant device is speaking changed callback. More...
 
void linphone_conference_cbs_set_participant_device_is_speaking_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb cb)
 Set the participant device is speaking changed callback. More...
 
LinphoneConferenceCbsParticipantDeviceIsMutedCb linphone_conference_cbs_get_participant_device_is_muted (const LinphoneConferenceCbs *cbs)
 Get the participant device is muted callback. More...
 
void linphone_conference_cbs_set_participant_device_is_muted (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsParticipantDeviceIsMutedCb cb)
 Set the participant device is muted callback. More...
 
LinphoneConferenceCbsAudioDeviceChangedCb linphone_conference_cbs_get_audio_device_changed (const LinphoneConferenceCbs *cbs)
 Get the audio device changed callback. More...
 
void linphone_conference_cbs_set_audio_device_changed (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsAudioDeviceChangedCb cb)
 Set the audio device changed callback. More...
 
LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb linphone_conference_cbs_get_active_speaker_participant_device (const LinphoneConferenceCbs *cbs)
 Get the actively speaking participant device callback. More...
 
void linphone_conference_cbs_set_active_speaker_participant_device (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb cb)
 Set the actively speaking participant device callback. More...
 
LinphoneConferenceCbsFullStateReceivedCb linphone_conference_cbs_get_full_state_received (const LinphoneConferenceCbs *cbs)
 Get the full state received callback. More...
 
void linphone_conference_cbs_set_full_state_received (LinphoneConferenceCbs *cbs, LinphoneConferenceCbsFullStateReceivedCb cb)
 Set the full state received callback. More...
 
LinphoneChatParamslinphone_chat_params_new (const LinphoneCore *core)
 Create an object of type a LinphoneChatParams. More...
 
LinphoneChatParamslinphone_chat_params_ref (LinphoneChatParams *params)
 Take a reference on a LinphoneChatParams. More...
 
void linphone_chat_params_unref (LinphoneChatParams *params)
 Release a LinphoneChatParams. More...
 
LinphoneChatParamslinphone_chat_params_clone (const LinphoneChatParams *params)
 Clone a LinphoneChatParams. More...
 
LinphoneChatRoomBackend linphone_chat_params_get_backend (const LinphoneChatParams *params)
 Get the backend implementation of the text capabilities of the chat associated with the given parameters. More...
 
LinphoneChatRoomEncryptionBackend linphone_chat_params_get_encryption_backend (const LinphoneChatParams *params)
 Get the encryption implementation of the text capabilities of the chat associated with the given parameters. More...
 
LinphoneChatRoomEphemeralMode linphone_chat_params_get_ephemeral_mode (const LinphoneChatParams *params)
 Get the ephemeral message mode of the text capabilities of the chat associated with the given parameters. More...
 
void linphone_chat_params_set_ephemeral_lifetime (LinphoneChatParams *params, long time)
 Set lifetime (in seconds) for all new ephemral messages in the text capabilities of the chat. More...
 
long linphone_chat_params_get_ephemeral_lifetime (const LinphoneChatParams *params)
 Get lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat. More...
 
bool_t linphone_chat_params_encryption_enabled (const LinphoneChatParams *params)
 Get the encryption status of the text capabilities of the chat associated with the given parameters. More...
 
bool_t linphone_chat_params_rtt_enabled (const LinphoneChatParams *params)
 Get the real time text status of the text capabilities of the chat associated with the given parameters. More...
 
void linphone_chat_params_set_backend (LinphoneChatParams *params, LinphoneChatRoomBackend backend)
 Set the backend implementation of these text capabilities of the chat parameters. More...
 
void linphone_chat_params_set_encryption_backend (LinphoneChatParams *params, LinphoneChatRoomEncryptionBackend backend)
 Set the encryption backend implementation of these text capabilities of the chat parameters. More...
 
void linphone_chat_params_set_ephemeral_mode (LinphoneChatParams *params, LinphoneChatRoomEphemeralMode mode)
 Enables or disables forcing of ephemeral messages for the text capabilities of the chat associated with the given parameters. More...
 
void linphone_chat_params_enable_rtt (LinphoneChatParams *params, bool_t rtt)
 Enables or disables real time text for the text capabilities of the chat associated with the given parameters. More...
 
LinphoneConferenceInfolinphone_conference_info_new (void)
 Create a new LinphoneConferenceInfo object. More...
 
LinphoneConferenceInfolinphone_conference_info_ref (LinphoneConferenceInfo *conference_info)
 Take a reference on a LinphoneConferenceInfo. More...
 
LinphoneConferenceInfolinphone_conference_info_clone (const LinphoneConferenceInfo *conference_info)
 Clone an object LinphoneConferenceInfo. More...
 
void linphone_conference_info_unref (LinphoneConferenceInfo *conference_info)
 Release a LinphoneConferenceInfo. More...
 
const LinphoneParticipantInfolinphone_conference_info_get_organizer_info (const LinphoneConferenceInfo *conference_info)
 Retrieve the organizer of the conference. More...
 
const LinphoneAddresslinphone_conference_info_get_organizer (const LinphoneConferenceInfo *conference_info)
 Retrieve the organizer of the conference. More...
 
void linphone_conference_info_set_organizer (LinphoneConferenceInfo *conference_info, const LinphoneAddress *organizer)
 Set the organizer of the conference. More...
 
MS2_DEPRECATED const bctbx_list_t * linphone_conference_info_get_participants (const LinphoneConferenceInfo *conference_info)
 Retrieve the list of participants as list of addresses. More...
 
const bctbx_list_t * linphone_conference_info_get_participant_infos (const LinphoneConferenceInfo *conference_info)
 Retrieve the list of participants as list of participant infos. More...
 
MS2_DEPRECATED void linphone_conference_info_set_participants (LinphoneConferenceInfo *conference_info, const bctbx_list_t *participants)
 Set the list of participants. More...
 
void linphone_conference_info_set_participant_infos (LinphoneConferenceInfo *conference_info, const bctbx_list_t *participant_infos)
 Set the list of participants. More...
 
void linphone_conference_info_add_participant_infos (LinphoneConferenceInfo *conference_info, const bctbx_list_t *participant_infos)
 Add a list of participants. More...
 
void linphone_conference_info_add_participant (LinphoneConferenceInfo *conference_info, const LinphoneAddress *participant)
 Add a participant to the conference. More...
 
void linphone_conference_info_add_participant_2 (LinphoneConferenceInfo *conference_info, const LinphoneParticipantInfo *participant_info)
 Add a participant to the conference. More...
 
void linphone_conference_info_update_participant (LinphoneConferenceInfo *conference_info, const LinphoneParticipantInfo *participant_info)
 Update the participant information in the conference informations. More...
 
void linphone_conference_info_remove_participant (LinphoneConferenceInfo *conference_info, const LinphoneAddress *participant)
 Remove a participant from the conference. More...
 
const LinphoneParticipantInfolinphone_conference_info_find_participant (LinphoneConferenceInfo *conference_info, const LinphoneAddress *participant)
 Find a participant information in the conference information. More...
 
const LinphoneAddresslinphone_conference_info_get_uri (const LinphoneConferenceInfo *conference_info)
 Retrieve the URI of the conference. More...
 
time_t linphone_conference_info_get_date_time (const LinphoneConferenceInfo *conference_info)
 Retrieve the date and time of the conference. More...
 
void linphone_conference_info_set_date_time (LinphoneConferenceInfo *conference_info, time_t datetime)
 Set the date and time of the conference. More...
 
unsigned int linphone_conference_info_get_duration (const LinphoneConferenceInfo *conference_info)
 Retrieve the duration (in minutes) of the conference. More...
 
void linphone_conference_info_set_duration (LinphoneConferenceInfo *conference_info, unsigned int duration)
 Set the duration (in minutes) of the conference. More...
 
const char * linphone_conference_info_get_subject (const LinphoneConferenceInfo *conference_info)
 Retrieve the subject of the conference. More...
 
void linphone_conference_info_set_subject (LinphoneConferenceInfo *conference_info, const char *subject)
 Set the subject of the conference. More...
 
const char * linphone_conference_info_get_subject_utf8 (const LinphoneConferenceInfo *conference_info)
 Retrieve the subject of the conference. More...
 
void linphone_conference_info_set_subject_utf8 (LinphoneConferenceInfo *conference_info, const char *subject)
 Set the subject of the conference. More...
 
void linphone_conference_info_set_ccmp_uri (LinphoneConferenceInfo *conference_info, const char *uri)
 Set the CCMP URI of the conference. More...
 
const char * linphone_conference_info_get_ccmp_uri (const LinphoneConferenceInfo *conference_info)
 Retrieve the CCMP URI of the conference. More...
 
const char * linphone_conference_info_get_description (const LinphoneConferenceInfo *conference_info)
 Retrieve the description of the conference. More...
 
void linphone_conference_info_set_description (LinphoneConferenceInfo *conference_info, const char *description)
 Set the description of the conference. More...
 
const char * linphone_conference_info_get_description_utf8 (const LinphoneConferenceInfo *conference_info)
 Retrieve the description of the conference. More...
 
void linphone_conference_info_set_description_utf8 (LinphoneConferenceInfo *conference_info, const char *description)
 Set the description of the conference. More...
 
LinphoneConferenceSecurityLevel linphone_conference_info_get_security_level (const LinphoneConferenceInfo *conference_info)
 Retrieve the desired security level of the conference. More...
 
void linphone_conference_info_set_security_level (LinphoneConferenceInfo *conference_info, LinphoneConferenceSecurityLevel security_level)
 Set the desired security level of the conference. More...
 
void linphone_conference_info_set_capability (LinphoneConferenceInfo *conference_info, const LinphoneStreamType stream_type, bool_t enable)
 Set the capability of the conference. More...
 
bool_t linphone_conference_info_get_capability (const LinphoneConferenceInfo *conference_info, const LinphoneStreamType stream_type)
 Get the capability of the conference. More...
 
char * linphone_conference_info_get_icalendar_string (const LinphoneConferenceInfo *conference_info)
 Retrieve the conference as an Icalendar string. More...
 
LinphoneConferenceInfoState linphone_conference_info_get_state (const LinphoneConferenceInfo *conference_info)
 Retrieve the state of the conference info. More...
 
void linphone_conference_info_set_ics_uid (LinphoneConferenceInfo *conference_info, const char *uid)
 Store the ICS UID in the conference info. More...
 
const char * linphone_conference_info_get_ics_uid (const LinphoneConferenceInfo *conference_info)
 Retrieve the ICS UID linked to a conference info. More...
 
LinphoneConferenceSchedulerlinphone_conference_scheduler_ref (LinphoneConferenceScheduler *conference_scheduler)
 Takes a reference on a LinphoneConferenceScheduler. More...
 
void linphone_conference_scheduler_unref (LinphoneConferenceScheduler *conference_scheduler)
 Releases a LinphoneConferenceScheduler. More...
 
LinphoneCorelinphone_conference_scheduler_get_core (const LinphoneConferenceScheduler *conference_scheduler)
 Gets the LinphoneCore from a LinphoneConferenceScheduler object. More...
 
void linphone_conference_scheduler_set_account (LinphoneConferenceScheduler *conference_scheduler, LinphoneAccount *account)
 Set the LinphoneAccount to use for the conference scheduler. More...
 
LinphoneAccountlinphone_conference_scheduler_get_account (const LinphoneConferenceScheduler *conference_scheduler)
 Get the LinphoneAccount that is used for the conference scheduler. More...
 
const LinphoneConferenceInfolinphone_conference_scheduler_get_info (const LinphoneConferenceScheduler *conference_scheduler)
 Returns the LinphoneConferenceInfo currently set in this scheduler. More...
 
void linphone_conference_scheduler_cancel_conference (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceInfo *conference_info)
 Cancel the conference linked to the LinphoneConferenceInfo provided as argument. More...
 
void linphone_conference_scheduler_set_info (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceInfo *conference_info)
 Sets the LinphoneConferenceInfo to use to create/update the conference, which will be done right away. More...
 
MS2_DEPRECATED void linphone_conference_scheduler_send_invitations (LinphoneConferenceScheduler *conference_scheduler, LinphoneChatRoomParams *chat_room_params)
 Sends an invitation to the scheduled conference to each participant by chat, using given chat rooms params to use/create the chat room in which to send it. More...
 
void linphone_conference_scheduler_send_invitations_2 (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceParams *conference_params)
 Sends an invitation to the scheduled conference to each participant by chat, using given conference params to use/create the chat room in which to send it. More...
 
void linphone_conference_scheduler_add_callbacks (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceSchedulerCbs *cbs)
 Add a listener in order to be notified of LinphoneConferenceScheduler events. More...
 
void linphone_conference_scheduler_remove_callbacks (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceSchedulerCbs *cbs)
 Remove a listener from a LinphoneConferenceScheduler. More...
 
LinphoneConferenceSchedulerCbslinphone_conference_scheduler_get_current_callbacks (const LinphoneConferenceScheduler *conference_scheduler)
 Gets the current LinphoneConferenceSchedulerCbs. More...
 
LinphoneConferenceSchedulerCbslinphone_conference_scheduler_cbs_new (void)
 Create a new conference scheduler callbacks object. More...
 
LinphoneConferenceSchedulerCbslinphone_conference_scheduler_cbs_ref (LinphoneConferenceSchedulerCbs *cbs)
 Acquire a reference to the conference scheduler callbacks object. More...
 
void linphone_conference_scheduler_cbs_unref (LinphoneConferenceSchedulerCbs *cbs)
 Release reference to the conference scheduler callbacks object. More...
 
void * linphone_conference_scheduler_cbs_get_user_data (const LinphoneConferenceSchedulerCbs *cbs)
 Retrieve the user pointer associated with the conference scheduler callbacks object. More...
 
void linphone_conference_scheduler_cbs_set_user_data (LinphoneConferenceSchedulerCbs *cbs, void *user_data)
 Assign a user pointer to the conference scheduler callbacks object. More...
 
LinphoneConferenceSchedulerCbsStateChangedCb linphone_conference_scheduler_cbs_get_state_changed (const LinphoneConferenceSchedulerCbs *cbs)
 Get the state changed callback. More...
 
void linphone_conference_scheduler_cbs_set_state_changed (LinphoneConferenceSchedulerCbs *cbs, LinphoneConferenceSchedulerCbsStateChangedCb cb)
 Set the state changed callback. More...
 
LinphoneConferenceSchedulerCbsInvitationsSentCb linphone_conference_scheduler_cbs_get_invitations_sent (const LinphoneConferenceSchedulerCbs *cbs)
 Get the invitations sent callback. More...
 
void linphone_conference_scheduler_cbs_set_invitations_sent (LinphoneConferenceSchedulerCbs *cbs, LinphoneConferenceSchedulerCbsInvitationsSentCb cb)
 Set the invitations sent callback. More...
 
LinphoneParticipantInfolinphone_participant_info_new (const LinphoneAddress *address)
 Create a new LinphoneParticipantInfo object. More...
 
LinphoneParticipantInfolinphone_participant_info_ref (LinphoneParticipantInfo *participant_info)
 Take a reference on a LinphoneParticipantInfo. More...
 
LinphoneParticipantInfolinphone_participant_info_clone (const LinphoneParticipantInfo *participant_info)
 Clone an object LinphoneParticipantInfo. More...
 
void linphone_participant_info_unref (LinphoneParticipantInfo *participant_info)
 Release a LinphoneParticipantInfo. More...
 
const LinphoneAddresslinphone_participant_info_get_address (const LinphoneParticipantInfo *participant_info)
 Get the address of the object LinphoneParticipantInfo. More...
 
void linphone_participant_info_set_role (LinphoneParticipantInfo *participant_info, LinphoneParticipantRole role)
 Set the role of the object LinphoneParticipantInfo. More...
 
LinphoneParticipantRole linphone_participant_info_get_role (const LinphoneParticipantInfo *participant_info)
 Get the role of the object LinphoneParticipantInfo. More...
 
void linphone_participant_info_add_parameter (LinphoneParticipantInfo *participant_info, const char *name, const char *value)
 Set the a custom parameter to object LinphoneParticipantInfo. More...
 
const char * linphone_participant_info_get_parameter_value (const LinphoneParticipantInfo *participant_info, const char *name)
 Get the value of a custom parameter of the object LinphoneParticipantInfo. More...
 
bool_t linphone_participant_info_has_parameter (const LinphoneParticipantInfo *participant_info, const char *name)
 Find whether a LinphoneParticipantInfo has a parameter. More...
 
void linphone_participant_info_remove_parameter (LinphoneParticipantInfo *participant_info, const char *name)
 Find the value of a custom parameter of the object LinphoneParticipantInfo. More...
 
const char * linphone_participant_info_get_ccmp_uri (const LinphoneParticipantInfo *participant_info)
 Get the CCMP uri of the object LinphoneParticipantInfo. More...
 
LinphoneParticipantDeviceCbslinphone_participant_device_cbs_new (void)
 Create a new participant device callbacks object. More...
 
LinphoneParticipantDeviceCbslinphone_participant_device_cbs_ref (LinphoneParticipantDeviceCbs *cbs)
 Acquire a reference to the participant device callbacks object. More...
 
void linphone_participant_device_cbs_unref (LinphoneParticipantDeviceCbs *cbs)
 Release reference to the participant device callbacks object. More...
 
void * linphone_participant_device_cbs_get_user_data (const LinphoneParticipantDeviceCbs *cbs)
 Retrieve the user pointer associated with the participant device callbacks object. More...
 
void linphone_participant_device_cbs_set_user_data (LinphoneParticipantDeviceCbs *cbs, void *ud)
 Assign a user pointer to the participant device callbacks object. More...
 
LinphoneParticipantDeviceCbsIsSpeakingChangedCb linphone_participant_device_cbs_get_is_speaking_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the is this participant device speaking changed callback. More...
 
void linphone_participant_device_cbs_set_is_speaking_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsIsSpeakingChangedCb cb)
 Set the is this participant device speaking changed callback. More...
 
LinphoneParticipantDeviceCbsIsMutedCb linphone_participant_device_cbs_get_is_muted (const LinphoneParticipantDeviceCbs *cbs)
 Get the is this participant device muted callback. More...
 
void linphone_participant_device_cbs_set_is_muted (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsIsMutedCb cb)
 Set the is this participant device muted callback. More...
 
LinphoneParticipantDeviceCbsScreenSharingChangedCb linphone_participant_device_cbs_get_screen_sharing_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the is this participant device screen sharing changed callback. More...
 
void linphone_participant_device_cbs_set_screen_sharing_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsScreenSharingChangedCb cb)
 Set the is this participant device screen sharing changed callback. More...
 
LinphoneParticipantDeviceCbsStateChangedCb linphone_participant_device_cbs_get_state_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the participant device conference state changed callback. More...
 
void linphone_participant_device_cbs_set_state_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsStateChangedCb cb)
 Set the participant device conference state changed callback. More...
 
LinphoneParticipantDeviceCbsStreamCapabilityChangedCb linphone_participant_device_cbs_get_stream_capability_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the participant device stream capability changed callback. More...
 
void linphone_participant_device_cbs_set_stream_capability_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsStreamCapabilityChangedCb cb)
 Set the participant device stream capability changed callback. More...
 
LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb linphone_participant_device_cbs_get_thumbnail_stream_capability_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the participant device thumbnail stream capability changed callback. More...
 
void linphone_participant_device_cbs_set_thumbnail_stream_capability_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb cb)
 Set the participant device thumbnail stream capability changed callback. More...
 
LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb linphone_participant_device_cbs_get_stream_availability_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the participant device stream availability changed callback. More...
 
void linphone_participant_device_cbs_set_stream_availability_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb cb)
 Set the participant device stream availability changed callback. More...
 
LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb linphone_participant_device_cbs_get_thumbnail_stream_availability_changed (const LinphoneParticipantDeviceCbs *cbs)
 Get the participant device thumbnail stream availability changed callback. More...
 
void linphone_participant_device_cbs_set_thumbnail_stream_availability_changed (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb cb)
 Set the participant device thumbnail stream availability changed callback. More...
 
LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb linphone_participant_device_cbs_get_video_display_error_occurred (const LinphoneParticipantDeviceCbs *cbs)
 Get the callback that will be used to notify that there are errors from the video rendering of the participant device. More...
 
void linphone_participant_device_cbs_set_video_display_error_occurred (LinphoneParticipantDeviceCbs *cbs, LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb cb)
 Set the callback that will be used to notify that there are errors from the video rendering of the participant device. More...
 

Detailed Description

Making a audio/video conferences.

Typedef Documentation

◆ LinphoneConference

typedef struct _LinphoneConference LinphoneConference

A conference is the object that allow to make calls when there are 2 or more participants.

To create (or find) a LinphoneConference, you first need a LinphoneConferenceParams object. linphone_core_create_conference_with_params() allows you to create a conference. A conference is uniquely identified by a conference address, meaning you can have more than one conference between two accounts. To find a conference among those a core is part of, you can call linphone_core_search_conference().

A LinphoneConference may be created automatically and implicitely when an outgoing call is made to a conference server. Thanks to the standard 'isfocus' contact parameter, the call is identified as belonging to a conference. The conference object can then be retrieved with linphone_call_get_conference().

◆ LinphoneConferenceCbs

typedef struct _LinphoneConferenceCbs LinphoneConferenceCbs

An object to handle the callbacks for the handling a LinphoneConference objects.

Use linphone_factory_create_conference_cbs() to create an instance. Then pass the object to a LinphoneConference instance through linphone_conference_add_callbacks().

◆ LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb

typedef void(* LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device)

Callback used to notify which participant device video is being displayed as "actively speaking".

Parameters
[in]conferenceLinphoneConference object
[in]participant_devicethe participant device currently displayed as active speaker

◆ LinphoneConferenceCbsAllowedParticipantListChangedCb

typedef void(* LinphoneConferenceCbsAllowedParticipantListChangedCb) (LinphoneConference *conference)

Callback used to notify a conference that the list of participants allowed to join the conference has changed.

Parameters
[in]conferenceLinphoneConference object

◆ LinphoneConferenceCbsAudioDeviceChangedCb

typedef void(* LinphoneConferenceCbsAudioDeviceChangedCb) (LinphoneConference *conference, const LinphoneAudioDevice *audio_device)

Callback used to notify that the audio device of a conference has changed.

Parameters
[in]conferenceLinphoneConference object
[in]audio_deviceaudio device of the conference

◆ LinphoneConferenceCbsAvailableMediaChangedCb

typedef void(* LinphoneConferenceCbsAvailableMediaChangedCb) (LinphoneConference *conference)

Callback used to notify that the available media of a conference has changed.

Parameters
[in]conferenceLinphoneConference object

◆ LinphoneConferenceCbsFullStateReceivedCb

typedef void(* LinphoneConferenceCbsFullStateReceivedCb) (LinphoneConference *conference)

Callback used to notify when a notify full state has been received.

Parameters
[in]conferenceLinphoneConference object

◆ LinphoneConferenceCbsParticipantAddedCb

typedef void(* LinphoneConferenceCbsParticipantAddedCb) (LinphoneConference *conference, LinphoneParticipant *participant)

Callback used to notify a conference that a participant has been added.

Parameters
[in]conferenceLinphoneConference object
[in]participantLinphoneParticipant that has been added to the conference

◆ LinphoneConferenceCbsParticipantAdminStatusChangedCb

typedef void(* LinphoneConferenceCbsParticipantAdminStatusChangedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)

Callback used to notify a conference that the admin status of a participant has been changed.

Parameters
[in]conferenceLinphoneConference object
[in]participantLinphoneParticipant whose admin status has changed

◆ LinphoneConferenceCbsParticipantDeviceAddedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceAddedCb) (LinphoneConference *conference, LinphoneParticipantDevice *participant_device)

Callback used to notify a conference that a participant device has been added.

Parameters
[in]conferenceLinphoneConference object
[in]participant_deviceLinphoneParticipantDevice that has been added to the conference

◆ LinphoneConferenceCbsParticipantDeviceIsMutedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceIsMutedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device, bool_t is_muted)

Callback used to notify that a participant device is muted or is no longer muted.

Parameters
[in]conferenceLinphoneConference object
[in]participant_devicethe participant device
[in]is_mutedTRUE if is muted, FALSE otherwise

◆ LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device, bool_t is_speaking)

Callback used to notify that a participant device is speaking or isn't speaking anymore.

Parameters
[in]conferenceLinphoneConference object
[in]participant_devicethe participant device
[in]is_speakingTRUE if is speaking, FALSE otherwise

◆ LinphoneConferenceCbsParticipantDeviceJoiningRequestCb

typedef void(* LinphoneConferenceCbsParticipantDeviceJoiningRequestCb) (LinphoneConference *conference, LinphoneParticipantDevice *participant_device)

Callback used to notify a conference that a participant has requested to join the conference.

Parameters
[in]conferenceLinphoneConference object
[in]participant_deviceLinphoneParticipantDevice that has requested to join the conference

◆ LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device)

Callback used to notify a conference that the media availability of a participant device has been changed.

Parameters
[in]conferenceLinphoneConference object
[in]deviceLinphoneParticipantDevice whose media availability changed has changed

◆ LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device)

Callback used to notify a conference that the media capability of a participant device has been changed.

Parameters
[in]conferenceLinphoneConference object
[in]deviceLinphoneParticipantDevice whose media capability changed has changed

◆ LinphoneConferenceCbsParticipantDeviceRemovedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceRemovedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *participant_device)

Callback used to notify a conference that a participant device has been removed.

Parameters
[in]conferenceLinphoneConference object
[in]participant_deviceLinphoneParticipantDevice that has been removed to the conference

◆ LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device, bool_t enabled)

Callback used to notify a conference that a participant device starts or stops screen sharing.

Parameters
[in]conferenceLinphoneConference object
[in]deviceLinphoneParticipantDevice who starts or stops screen sharing
[in]enabledwhether the screen sharing is enabled or disabled

◆ LinphoneConferenceCbsParticipantDeviceStateChangedCb

typedef void(* LinphoneConferenceCbsParticipantDeviceStateChangedCb) (LinphoneConference *conference, const LinphoneParticipantDevice *device, const LinphoneParticipantDeviceState state)

Callback used to notify a conference that a participant device has changed state.

Parameters
[in]conferenceLinphoneConference object
[in]deviceLinphoneParticipantDevice who change state
[in]statenew participant device state

◆ LinphoneConferenceCbsParticipantRemovedCb

typedef void(* LinphoneConferenceCbsParticipantRemovedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)

Callback used to notify a conference that a participant has been removed.

Parameters
[in]conferenceLinphoneConference object
[in]participantLinphoneParticipant that has been removed to the conference

◆ LinphoneConferenceCbsParticipantRoleChangedCb

typedef void(* LinphoneConferenceCbsParticipantRoleChangedCb) (LinphoneConference *conference, const LinphoneParticipant *participant)

Callback used to notify a conference that the role of a participant has been changed.

Parameters
[in]conferenceLinphoneConference object
[in]participantLinphoneParticipant whose role has changed

◆ LinphoneConferenceCbsStateChangedCb

typedef void(* LinphoneConferenceCbsStateChangedCb) (LinphoneConference *conference, LinphoneConferenceState newState)

Callback used to notify a conference state has changed.

Parameters
[in]conferenceLinphoneConference object
[in]newStateThe new state of the conference

◆ LinphoneConferenceCbsSubjectChangedCb

typedef void(* LinphoneConferenceCbsSubjectChangedCb) (LinphoneConference *conference, const char *subject)

Callback used to notify that the subject of a conference has changed.

Parameters
[in]conferenceLinphoneConference object
[in]subjectsubject of the conference

◆ LinphoneConferenceJoiningMode

Mode of joining conference.

Warning
It is only valid at the creation of the conferece

◆ LinphoneConferenceParams

typedef struct _LinphoneConferenceParams LinphoneConferenceParams

Object defining parameters for a LinphoneConference.

Can be created by calling function linphone_core_create_conference_params_2().

◆ LinphoneConferenceParticipantListType

Type of conference participant list.

When participant list is closed, no more participants can be added other than those declared when creating the conference When participant list is open, other people can join the conference upon invitation of a participant no more participants can be added other than those declared when creating the conference

◆ LinphoneConferenceSchedulerCbsInvitationsSentCb

typedef void(* LinphoneConferenceSchedulerCbsInvitationsSentCb) (LinphoneConferenceScheduler *conference_scheduler, const bctbx_list_t *failed_invitations)

Callback for notifying when conference invitations have been sent.

In case of error for some participants, their addresses will be given as parameter.

Parameters
conference_schedulerLinphoneConferenceScheduler object whose state has changed.
failed_invitationsa list of addresses for which invitation couldn't be sent.

◆ LinphoneConferenceSchedulerCbsStateChangedCb

typedef void(* LinphoneConferenceSchedulerCbsStateChangedCb) (LinphoneConferenceScheduler *conference_scheduler, LinphoneConferenceSchedulerState state)

Callback for notifying when a registration state has changed for the conference scheduler.

Parameters
conference_schedulerLinphoneConferenceScheduler object whose state has changed.
stateThe current LinphoneConferenceSchedulerState.

◆ LinphoneConferenceSchedulerState

Describes conference scheduler possible states.

It is notified via the conference_scheduler_state_changed callback in LinphoneConferenceSchedulerCbs.

◆ LinphoneParticipant

typedef struct _LinphoneParticipant LinphoneParticipant

Identifies a member of a LinphoneConference or LinphoneChatRoom.

A participant is identified by it's SIP address. It can have many LinphoneParticipantDevice.

◆ LinphoneParticipantDevice

typedef struct _LinphoneParticipantDevice LinphoneParticipantDevice

This object represents a unique device for a member of a LinphoneConference or LinphoneChatRoom.

Devices are identified by the gruu parameter inside the LinphoneAddress which can be obtained by linphone_participant_device_get_address(). It is specially usefull to know the security level of each device inside an end-to-end encrypted LinphoneChatRoom.

You can get a list of all LinphoneParticipantDevice using linphone_participant_get_devices().

◆ LinphoneParticipantDeviceCbs

typedef struct _LinphoneParticipantDeviceCbs LinphoneParticipantDeviceCbs

An object to handle the callbacks for the handling a LinphoneParticipantDevice objects.

Use linphone_factory_create_participant_device_cbs() to create an instance. Then pass the object to a LinphoneParticipantDevice instance through linphone_participant_device_add_callbacks().

◆ LinphoneParticipantDeviceCbsIsMutedCb

typedef void(* LinphoneParticipantDeviceCbsIsMutedCb) (LinphoneParticipantDevice *participant_device, bool_t is_muted)

Callback used to notify that this participant device is muted or is no longer muted.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]is_mutedis this participant device muted

◆ LinphoneParticipantDeviceCbsIsSpeakingChangedCb

typedef void(* LinphoneParticipantDeviceCbsIsSpeakingChangedCb) (LinphoneParticipantDevice *participant_device, bool_t is_speaking)

Callback used to notify that is this participant device speaking has changed.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]is_speakingis this participant device speaking

◆ LinphoneParticipantDeviceCbsScreenSharingChangedCb

typedef void(* LinphoneParticipantDeviceCbsScreenSharingChangedCb) (LinphoneParticipantDevice *participant_device, bool_t is_screen_sharing)

Callback used to notify that this participant device is screen sharing or is no longer screen sharing.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]is_screen_sharingis this participant device screen sharing

◆ LinphoneParticipantDeviceCbsStateChangedCb

typedef void(* LinphoneParticipantDeviceCbsStateChangedCb) (LinphoneParticipantDevice *participant_device, const LinphoneParticipantDeviceState state)

Callback used to notify that participant device changed state.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]statenew participant device state

◆ LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb

typedef void(* LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb) (LinphoneParticipantDevice *participant_device, bool_t available, const LinphoneStreamType stream_type)

Callback used to notify that participant device stream availability has changed.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]availableTRUE if the stream is available on our side
[in]stream_typetype of stream: audio, video or text

◆ LinphoneParticipantDeviceCbsStreamCapabilityChangedCb

typedef void(* LinphoneParticipantDeviceCbsStreamCapabilityChangedCb) (LinphoneParticipantDevice *participant_device, LinphoneMediaDirection direction, const LinphoneStreamType stream_type)

Callback used to notify that participant device stream capability has changed.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]directionparticipant device's stream direction
[in]stream_typetype of stream: audio, video or text

◆ LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb

typedef void(* LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb) (LinphoneParticipantDevice *participant_device, bool_t available)

Callback used to notify that participant device thumbnail stream availability has changed.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]availableparticipant device's thumbnail stream availability

◆ LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb

typedef void(* LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb) (LinphoneParticipantDevice *participant_device, LinphoneMediaDirection direction)

Callback used to notify that participant device thumbnail stream capability has changed.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]directionparticipant device's thumbnail direction

◆ LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb

typedef void(* LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb) (LinphoneParticipantDevice *participant_device, int error_code)

Callback to notify that there are errors from the video rendering of the participant device.

Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.

Parameters
[in]participant_deviceLinphoneParticipantDevice object
[in]error_codethe error code coming from the display render.

◆ LinphoneParticipantImdnState

typedef struct _LinphoneParticipantImdnState LinphoneParticipantImdnState

This object represents the delivery/display state of a given chat message for a given participant.

It also contains a timestamp at which this participant state has changed.

Use linphone_chat_message_get_participants_by_imdn_state() to get all LinphoneParticipantImdnState for a given state. From there use linphone_participant_imdn_state_get_participant() to get the LinphoneParticipant object if you need it.

Enumeration Type Documentation

◆ _LinphoneConferenceInfoState

LinphoneConferenceInfoState is used to list all states of a conference info object

Enumerator
LinphoneConferenceInfoStateNew 

New conference.

LinphoneConferenceInfoStateUpdated 

Conference has been updated.

LinphoneConferenceInfoStateCancelled 

Canceling a conference.

◆ _LinphoneConferenceJoiningMode

Mode of joining conference.

Warning
It is only valid at the creation of the conferece
Enumerator
LinphoneConferenceJoiningModeDialIn 

Participants must dial the conference server.

LinphoneConferenceJoiningModeDialOut 

Conference server dials participants.

◆ _LinphoneConferenceLayout

LinphoneConferenceLayout is used to indicate the layout used by the conference.

Enumerator
LinphoneConferenceLayoutGrid 

Grid - each participant is given an equal sized image size.

LinphoneConferenceLayoutActiveSpeaker 

Active speaker - participant who speaks is prominently displayed in the center of the screen and other participants are minimized.

◆ _LinphoneConferenceParticipantListType

Type of conference participant list.

When participant list is closed, no more participants can be added other than those declared when creating the conference When participant list is open, other people can join the conference upon invitation of a participant no more participants can be added other than those declared when creating the conference

Enumerator
LinphoneConferenceParticipantListTypeClosed 

Only participants in the initiating INVITE are allowed to join the conference.

LinphoneConferenceParticipantListTypeOpen 

All devices calling the conference URI are allowed to join the conference.

◆ _LinphoneConferenceSchedulerState

Describes conference scheduler possible states.

It is notified via the conference_scheduler_state_changed callback in LinphoneConferenceSchedulerCbs.

Enumerator
LinphoneConferenceSchedulerStateIdle 

Default state of a freshly created LinphoneConferenceScheduler.

LinphoneConferenceSchedulerStateError 

An error has happened during conference creation.

LinphoneConferenceSchedulerStateAllocationPending 

Conference creation is in progress.

LinphoneConferenceSchedulerStateReady 

Confererence has been created.

LinphoneConferenceSchedulerStateUpdating 

Conference has been updated.

◆ _LinphoneConferenceSchedulerType

LinphoneConferenceSchedulerType is used to know which conference scheduler type the core is using

Enumerator
LinphoneConferenceSchedulerTypeSIP 

SIP conference scheduler type.

LinphoneConferenceSchedulerTypeDB 

Database conference scheduler type.

LinphoneConferenceSchedulerTypeCCMP 

CCMP conference scheduler type.

◆ _LinphoneConferenceSecurityLevel

Conference minimum security level.

Enumerator
LinphoneConferenceSecurityLevelNone 

No security.

LinphoneConferenceSecurityLevelPointToPoint 

Point-to-point encryption.

LinphoneConferenceSecurityLevelEndToEnd 

End-to-end encryption.

◆ _LinphoneConferenceState

LinphoneConferenceState is used to indicate the current state of a conference.

Enumerator
LinphoneConferenceStateNone 

Initial state.

LinphoneConferenceStateInstantiated 

Conference is now instantiated locally.

LinphoneConferenceStateCreationPending 

One creation request was sent to the service.

LinphoneConferenceStateCreated 

Conference was created on the service.

LinphoneConferenceStateCreationFailed 

Conference creation on service failed.

LinphoneConferenceStateTerminationPending 

Wait for conference termination.

LinphoneConferenceStateTerminated 

The conference is terminated locally, though it may still exist on the service for other participants.

LinphoneConferenceStateTerminationFailed 

Conference termination failed.

LinphoneConferenceStateDeleted 

Conference was deleted locally and on the service.

◆ _LinphoneParticipantDeviceDisconnectionMethod

LinphoneParticipantDeviceDisconnectionMethod is used to indicate how a participant left a conference.

Enumerator
LinphoneParticipantDeviceDisconnectionMethodBooted 

an admin removes the device from a conference

LinphoneParticipantDeviceDisconnectionMethodDeparted 

the device disconnects from the conference

LinphoneParticipantDeviceDisconnectionMethodBusy 

device is busy

LinphoneParticipantDeviceDisconnectionMethodFailed 

an error occurred while the device is leaving the conference or he declined a call from the server

◆ _LinphoneParticipantDeviceJoiningMethod

LinphoneParticipantDeviceJoiningMethod is used to indicate how a participant joined a conference or if it is the focus.

Enumerator
LinphoneParticipantDeviceJoiningMethodDialedIn 

device called the conference

LinphoneParticipantDeviceJoiningMethodDialedOut 

device is called the conference

LinphoneParticipantDeviceJoiningMethodFocusOwner 

device is the focus

◆ _LinphoneParticipantDeviceState

LinphoneParticipantDeviceState is used to list all states a participant device can be in

Enumerator
LinphoneParticipantDeviceStateJoining 

an INVITE has been sent

LinphoneParticipantDeviceStatePresent 

the SIP session has been concluded, participant is part of the conference

LinphoneParticipantDeviceStateLeaving 

A BYE is pending.

LinphoneParticipantDeviceStateLeft 

The Session is terminated.

LinphoneParticipantDeviceStateScheduledForJoining 

Initial state for the server group chatroom, when the participant has not yet been INVITEd.

LinphoneParticipantDeviceStateScheduledForLeaving 

Transitional state for a participant that will receive a BYE shortly.

LinphoneParticipantDeviceStateOnHold 

the SIP session has been concluded, participant is not media mixed

LinphoneParticipantDeviceStateAlerting 

180 Ringing

LinphoneParticipantDeviceStateMutedByFocus 

Some medias have been muted by the focus.

LinphoneParticipantDeviceStateRequestingToJoin 

the participant has sent a request to join the conference as he/she didn't receive any invitation for

◆ _LinphoneParticipantRole

LinphoneParticipantRole is used to define a role of a participant within a conference

Enumerator
LinphoneParticipantRoleSpeaker 

participant is a speaker in the conference

LinphoneParticipantRoleListener 

participant is a listener in the conference.

He/She cannot speak

LinphoneParticipantRoleUnknown 

participant role is unknown

Function Documentation

◆ linphone_chat_params_clone()

LinphoneChatParams* linphone_chat_params_clone ( const LinphoneChatParams params)

Clone a LinphoneChatParams.

Parameters
paramsThe LinphoneChatParams to clone
Returns
An allocated LinphoneChatParams with the same parameters than params

◆ linphone_chat_params_enable_rtt()

void linphone_chat_params_enable_rtt ( LinphoneChatParams params,
bool_t  rtt 
)

Enables or disables real time text for the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
rttTRUE to enable real time text, FALSE to disable.

◆ linphone_chat_params_encryption_enabled()

bool_t linphone_chat_params_encryption_enabled ( const LinphoneChatParams params)

Get the encryption status of the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
Returns
TRUE if encryption is enabled, FALSE otherwise

◆ linphone_chat_params_get_backend()

LinphoneChatRoomBackend linphone_chat_params_get_backend ( const LinphoneChatParams params)

Get the backend implementation of the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
Returns
the LinphoneChatRoomBackend

◆ linphone_chat_params_get_encryption_backend()

LinphoneChatRoomEncryptionBackend linphone_chat_params_get_encryption_backend ( const LinphoneChatParams params)

Get the encryption implementation of the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
Returns
the LinphoneChatRoomEncryptionBackend

◆ linphone_chat_params_get_ephemeral_lifetime()

long linphone_chat_params_get_ephemeral_lifetime ( const LinphoneChatParams params)

Get lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

After the message is read, it will be deleted after "time" seconds.

See also
linphone_chat_params_ephemeral_enabled()
Parameters
paramsThe LinphoneChatParams object.
Returns
the ephemeral lifetime (in seconds)

◆ linphone_chat_params_get_ephemeral_mode()

LinphoneChatRoomEphemeralMode linphone_chat_params_get_ephemeral_mode ( const LinphoneChatParams params)

Get the ephemeral message mode of the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
Returns
the ephemeral message mode LinphoneChatRoomEphemeralMode

◆ linphone_chat_params_new()

LinphoneChatParams* linphone_chat_params_new ( const LinphoneCore core)

Create an object of type a LinphoneChatParams.

Parameters
coreThe LinphoneCore to pass to the constructor.
Returns
The created LinphoneChatParams.

◆ linphone_chat_params_ref()

LinphoneChatParams* linphone_chat_params_ref ( LinphoneChatParams params)

Take a reference on a LinphoneChatParams.

Parameters
paramsThe LinphoneChatParams to ref.
Returns
The freshly refed LinphoneChatParams.

◆ linphone_chat_params_rtt_enabled()

bool_t linphone_chat_params_rtt_enabled ( const LinphoneChatParams params)

Get the real time text status of the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
Returns
TRUE if real time text is enabled, FALSE otherwise

◆ linphone_chat_params_set_backend()

void linphone_chat_params_set_backend ( LinphoneChatParams params,
LinphoneChatRoomBackend  backend 
)

Set the backend implementation of these text capabilities of the chat parameters.

Parameters
paramsThe LinphoneChatParams object.
backendThe LinphoneChatRoomBackend enum value

◆ linphone_chat_params_set_encryption_backend()

void linphone_chat_params_set_encryption_backend ( LinphoneChatParams params,
LinphoneChatRoomEncryptionBackend  backend 
)

Set the encryption backend implementation of these text capabilities of the chat parameters.

Parameters
paramsThe LinphoneChatParams object.
backendThe LinphoneChatRoomEncryptionBackend enum value

◆ linphone_chat_params_set_ephemeral_lifetime()

void linphone_chat_params_set_ephemeral_lifetime ( LinphoneChatParams params,
long  time 
)

Set lifetime (in seconds) for all new ephemral messages in the text capabilities of the chat.

After the message is read, it will be deleted after "time" seconds.

See also
linphone_chat_params_ephemeral_enabled()
Parameters
paramsThe LinphoneChatParams object.
timeThe ephemeral lifetime, default is disabled (0)

◆ linphone_chat_params_set_ephemeral_mode()

void linphone_chat_params_set_ephemeral_mode ( LinphoneChatParams params,
LinphoneChatRoomEphemeralMode  mode 
)

Enables or disables forcing of ephemeral messages for the text capabilities of the chat associated with the given parameters.

Parameters
paramsThe LinphoneChatParams object.
modeEphemeral message mode LinphoneChatRoomEphemeralMode.

◆ linphone_chat_params_unref()

void linphone_chat_params_unref ( LinphoneChatParams params)

Release a LinphoneChatParams.

Parameters
paramsThe LinphoneChatParams to release.

◆ linphone_conference_add_callbacks()

void linphone_conference_add_callbacks ( LinphoneConference conference,
LinphoneConferenceCbs cbs 
)

Add a listener in order to be notified of LinphoneConference events.

Once an event is received, registred LinphoneConferenceCbs are invoked sequencially.

Parameters
conferenceLinphoneConference object.
cbsA LinphoneConferenceCbs object holding the callbacks you need. A reference is taken by the LinphoneConference until you invoke linphone_conference_remove_callbacks().

◆ linphone_conference_add_participant()

LinphoneStatus linphone_conference_add_participant ( LinphoneConference conference,
LinphoneCall call 
)

Join an existing call to the conference.

If the conference is in the state LinphoneConferenceStateCreationPending, then the conference will start on the input and output audio devices used for the currently active call, if any

Parameters
conferenceThe LinphoneConference object.
calla LinphoneCall that has to be added to the conference.
Warning
This function guarantees that the local endpoint is added to the conference only if one of calls added is in state StreamsRunning. It is highly recommended to call linphone_confererence_enter() to guarantee that the local endpoint is added to the conference.

◆ linphone_conference_add_participant_2()

LinphoneStatus linphone_conference_add_participant_2 ( LinphoneConference conference,
const LinphoneAddress uri 
)

Join a participant to the conference.

Parameters
conferenceThe LinphoneConference object.
uria LinphoneAddress that has to be added to the conference.
Warning
This function guarantees that the local endpoint is added to the conference only if there is a call state StreamsRunning towards one of the addresses. It is highly recommended to call linphone_confererence_enter() to guarantee that the local endpoint is added to the conference.

◆ linphone_conference_add_participants()

LinphoneStatus linphone_conference_add_participants ( LinphoneConference conference,
const bctbx_list_t *  calls 
)

Add participants to the conference, by supplying a list of LinphoneCall.

If the conference is in the state LinphoneConferenceStateCreationPending, then the conference will start on the input and output audio devices used for the currently active call, if any

Parameters
conferenceThe LinphoneConference object.
callsA list of calls to add to the conference.

◆ linphone_conference_add_participants_2()

LinphoneStatus linphone_conference_add_participants_2 ( LinphoneConference conference,
const bctbx_list_t *  addresses 
)

Add participants to the conference, by supplying a list of LinphoneAddress.

Parameters
conferenceThe LinphoneConference object.
addressesA list of calls to add to the conference.

◆ linphone_conference_cbs_get_active_speaker_participant_device()

LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb linphone_conference_cbs_get_active_speaker_participant_device ( const LinphoneConferenceCbs cbs)

Get the actively speaking participant device callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current active speaker participant device callback.

◆ linphone_conference_cbs_get_allowed_participant_list_changed()

LinphoneConferenceCbsAllowedParticipantListChangedCb linphone_conference_cbs_get_allowed_participant_list_changed ( const LinphoneConferenceCbs cbs)

Get the allowed participant list changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current allowed participant list changed callback.

◆ linphone_conference_cbs_get_audio_device_changed()

LinphoneConferenceCbsAudioDeviceChangedCb linphone_conference_cbs_get_audio_device_changed ( const LinphoneConferenceCbs cbs)

Get the audio device changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current audio device changed callback.

◆ linphone_conference_cbs_get_available_media_changed()

LinphoneConferenceCbsAvailableMediaChangedCb linphone_conference_cbs_get_available_media_changed ( const LinphoneConferenceCbs cbs)

Get the available media changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current available media changed callback.

◆ linphone_conference_cbs_get_full_state_received()

LinphoneConferenceCbsFullStateReceivedCb linphone_conference_cbs_get_full_state_received ( const LinphoneConferenceCbs cbs)

Get the full state received callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current full state received callback.

◆ linphone_conference_cbs_get_participant_added()

LinphoneConferenceCbsParticipantAddedCb linphone_conference_cbs_get_participant_added ( const LinphoneConferenceCbs cbs)

Get the participant added callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant added callback.

◆ linphone_conference_cbs_get_participant_admin_status_changed()

LinphoneConferenceCbsParticipantAdminStatusChangedCb linphone_conference_cbs_get_participant_admin_status_changed ( const LinphoneConferenceCbs cbs)

Get the participant admin status changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant admin status changed callback.

◆ linphone_conference_cbs_get_participant_device_added()

LinphoneConferenceCbsParticipantDeviceAddedCb linphone_conference_cbs_get_participant_device_added ( const LinphoneConferenceCbs cbs)

Get the participant device added callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device added callback.

◆ linphone_conference_cbs_get_participant_device_is_muted()

LinphoneConferenceCbsParticipantDeviceIsMutedCb linphone_conference_cbs_get_participant_device_is_muted ( const LinphoneConferenceCbs cbs)

Get the participant device is muted callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device is muted callback.

◆ linphone_conference_cbs_get_participant_device_is_speaking_changed()

LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb linphone_conference_cbs_get_participant_device_is_speaking_changed ( const LinphoneConferenceCbs cbs)

Get the participant device is speaking changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device is speaking changed callback.

◆ linphone_conference_cbs_get_participant_device_joining_request()

LinphoneConferenceCbsParticipantDeviceJoiningRequestCb linphone_conference_cbs_get_participant_device_joining_request ( const LinphoneConferenceCbs cbs)

Get the participant device joining request callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device joining request callback.

◆ linphone_conference_cbs_get_participant_device_media_availability_changed()

LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb linphone_conference_cbs_get_participant_device_media_availability_changed ( const LinphoneConferenceCbs cbs)

Get the participant device media availability changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device media availability changed callback.

◆ linphone_conference_cbs_get_participant_device_media_capability_changed()

LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb linphone_conference_cbs_get_participant_device_media_capability_changed ( const LinphoneConferenceCbs cbs)

Get the participant device media capabilities changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device media capabilities changed callback.

◆ linphone_conference_cbs_get_participant_device_removed()

LinphoneConferenceCbsParticipantDeviceRemovedCb linphone_conference_cbs_get_participant_device_removed ( const LinphoneConferenceCbs cbs)

Get the participant device removed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device removed callback.

◆ linphone_conference_cbs_get_participant_device_screen_sharing_changed()

LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb linphone_conference_cbs_get_participant_device_screen_sharing_changed ( const LinphoneConferenceCbs cbs)

Get the participant device is screen sharing changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device is screen sharing changed callback.

◆ linphone_conference_cbs_get_participant_device_state_changed()

LinphoneConferenceCbsParticipantDeviceStateChangedCb linphone_conference_cbs_get_participant_device_state_changed ( const LinphoneConferenceCbs cbs)

Get the participant device state changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant device state changed callback.

◆ linphone_conference_cbs_get_participant_removed()

LinphoneConferenceCbsParticipantRemovedCb linphone_conference_cbs_get_participant_removed ( const LinphoneConferenceCbs cbs)

Get the participant removed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant removed callback.

◆ linphone_conference_cbs_get_participant_role_changed()

LinphoneConferenceCbsParticipantRoleChangedCb linphone_conference_cbs_get_participant_role_changed ( const LinphoneConferenceCbs cbs)

Get the participant role changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current participant role changed callback.

◆ linphone_conference_cbs_get_state_changed()

LinphoneConferenceCbsStateChangedCb linphone_conference_cbs_get_state_changed ( const LinphoneConferenceCbs cbs)

Get the state changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current state changed callback.

◆ linphone_conference_cbs_get_subject_changed()

LinphoneConferenceCbsSubjectChangedCb linphone_conference_cbs_get_subject_changed ( const LinphoneConferenceCbs cbs)

Get the subject changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
Returns
The current subject changed callback.

◆ linphone_conference_cbs_get_user_data()

void* linphone_conference_cbs_get_user_data ( const LinphoneConferenceCbs cbs)

Retrieve the user pointer associated with the conference callbacks object.

Parameters
[in]cbsThe conference callbacks object
Returns
The user pointer associated with the conference callbacks object

◆ linphone_conference_cbs_ref()

LinphoneConferenceCbs* linphone_conference_cbs_ref ( LinphoneConferenceCbs cbs)

Acquire a reference to the conference callbacks object.

Parameters
[in]cbsThe conference callbacks object
Returns
The same conference callbacks object

◆ linphone_conference_cbs_set_active_speaker_participant_device()

void linphone_conference_cbs_set_active_speaker_participant_device ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsActiveSpeakerParticipantDeviceCb  cb 
)

Set the actively speaking participant device callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe active speaker participant device callback to be used.

◆ linphone_conference_cbs_set_allowed_participant_list_changed()

void linphone_conference_cbs_set_allowed_participant_list_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsAllowedParticipantListChangedCb  cb 
)

Set the allowed participant list changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe allowed participant list changed callback to be used.

◆ linphone_conference_cbs_set_audio_device_changed()

void linphone_conference_cbs_set_audio_device_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsAudioDeviceChangedCb  cb 
)

Set the audio device changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe audio device changed callback to be used.

◆ linphone_conference_cbs_set_available_media_changed()

void linphone_conference_cbs_set_available_media_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsAvailableMediaChangedCb  cb 
)

Set the available media changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe available media changed callback to be used.

◆ linphone_conference_cbs_set_full_state_received()

void linphone_conference_cbs_set_full_state_received ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsFullStateReceivedCb  cb 
)

Set the full state received callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe full state received callback to be used.

◆ linphone_conference_cbs_set_participant_added()

void linphone_conference_cbs_set_participant_added ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantAddedCb  cb 
)

Set the participant added callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant added callback to be used.

◆ linphone_conference_cbs_set_participant_admin_status_changed()

void linphone_conference_cbs_set_participant_admin_status_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantAdminStatusChangedCb  cb 
)

Set the participant admin status changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant admin status changed callback to be used.

◆ linphone_conference_cbs_set_participant_device_added()

void linphone_conference_cbs_set_participant_device_added ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceAddedCb  cb 
)

Set the participant device added callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device added callback to be used.

◆ linphone_conference_cbs_set_participant_device_is_muted()

void linphone_conference_cbs_set_participant_device_is_muted ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceIsMutedCb  cb 
)

Set the participant device is muted callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device is muted callback to be used.

◆ linphone_conference_cbs_set_participant_device_is_speaking_changed()

void linphone_conference_cbs_set_participant_device_is_speaking_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceIsSpeakingChangedCb  cb 
)

Set the participant device is speaking changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device is speaking changed callback to be used.

◆ linphone_conference_cbs_set_participant_device_joining_request()

void linphone_conference_cbs_set_participant_device_joining_request ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceJoiningRequestCb  cb 
)

Set the participant device joining request callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device joining request callback to be used.

◆ linphone_conference_cbs_set_participant_device_media_availability_changed()

void linphone_conference_cbs_set_participant_device_media_availability_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceMediaAvailabilityChangedCb  cb 
)

Set the participant device media availability changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device media availability changed callback to be used.

◆ linphone_conference_cbs_set_participant_device_media_capability_changed()

void linphone_conference_cbs_set_participant_device_media_capability_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceMediaCapabilityChangedCb  cb 
)

Set the participant device media capabilities changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device media capabilities changed callback to be used.

◆ linphone_conference_cbs_set_participant_device_removed()

void linphone_conference_cbs_set_participant_device_removed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceRemovedCb  cb 
)

Set the participant device removed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device removed callback to be used.

◆ linphone_conference_cbs_set_participant_device_screen_sharing_changed()

void linphone_conference_cbs_set_participant_device_screen_sharing_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceScreenSharingChangedCb  cb 
)

Set the participant device is screen sharing changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device is screen sharing changed callback to be used.

◆ linphone_conference_cbs_set_participant_device_state_changed()

void linphone_conference_cbs_set_participant_device_state_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantDeviceStateChangedCb  cb 
)

Set the participant device state changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant device state changed callback to be used.

◆ linphone_conference_cbs_set_participant_removed()

void linphone_conference_cbs_set_participant_removed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantRemovedCb  cb 
)

Set the participant removed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant removed callback to be used.

◆ linphone_conference_cbs_set_participant_role_changed()

void linphone_conference_cbs_set_participant_role_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsParticipantRoleChangedCb  cb 
)

Set the participant role changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe participant role changed callback to be used.

◆ linphone_conference_cbs_set_state_changed()

void linphone_conference_cbs_set_state_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsStateChangedCb  cb 
)

Set the state changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe state changed callback to be used.

◆ linphone_conference_cbs_set_subject_changed()

void linphone_conference_cbs_set_subject_changed ( LinphoneConferenceCbs cbs,
LinphoneConferenceCbsSubjectChangedCb  cb 
)

Set the subject changed callback.

Parameters
[in]cbsLinphoneConferenceCbs object.
[in]cbThe subject changed callback to be used.

◆ linphone_conference_cbs_set_user_data()

void linphone_conference_cbs_set_user_data ( LinphoneConferenceCbs cbs,
void *  ud 
)

Assign a user pointer to the conference callbacks object.

Parameters
[in]cbsThe conference callbacks object
[in]udThe user pointer to associate with the conference callbacks object

◆ linphone_conference_cbs_unref()

void linphone_conference_cbs_unref ( LinphoneConferenceCbs cbs)

Release reference to the conference callbacks object.

Parameters
[in]cbsThe conference callbacks object

◆ linphone_conference_enter()

int linphone_conference_enter ( LinphoneConference conference)

For a local conference, the local participant joins the conference For a client conference, the participant rejoins the conference after leaving it earlier on.

Parameters
conferenceA LinphoneConference object
Returns
0 if succeeded. Negative number if failed

◆ linphone_conference_find_participant()

LinphoneParticipant* linphone_conference_find_participant ( LinphoneConference conference,
const LinphoneAddress uri 
)

Find a participant from a conference.

Parameters
conferenceA LinphoneConference.
uriSIP URI of the participant to search.
Returns
a pointer to the participant found or nullptr.

◆ linphone_conference_get_account()

LinphoneAccount* linphone_conference_get_account ( LinphoneConference conference)

Gets the LinphoneAccount object associated with the conference.

Parameters
conferenceLinphoneConference object.
Returns
A LinphoneAccount object.

◆ linphone_conference_get_active_speaker_participant_device()

LinphoneParticipantDevice* linphone_conference_get_active_speaker_participant_device ( const LinphoneConference conference)

Get the currently active speaker participant device.

Parameters
conferencethe LinphoneConference object.
Returns
the LinphoneParticipantDevice currently displayed as active speaker.

◆ linphone_conference_get_call()

LinphoneCall* linphone_conference_get_call ( const LinphoneConference conference)

Gets the call that is controlling a conference.

  • for the local conference, it will return NULL
  • for the client conference, it will return call associated to the conference
Parameters
conferenceThe LinphoneConference
Returns
the LinphoneCall controlling the conference or NULL if none or local conference

◆ linphone_conference_get_chat_room()

LinphoneChatRoom* linphone_conference_get_chat_room ( const LinphoneConference conference)

Returns the LinphoneChatRoom linked to the LinphoneConference.

Parameters
conferenceLinphoneConference object.
Returns
back pointer to LinphoneChatRoom object.

◆ linphone_conference_get_conference_address()

const LinphoneAddress* linphone_conference_get_conference_address ( const LinphoneConference conference)

Get the conference address of the conference.

This function may be return a NULL pointer if called before the conference switches to the Created state

Parameters
conferenceA LinphoneConference object.
Returns
The conference address of the conference.

◆ linphone_conference_get_core()

LinphoneCore* linphone_conference_get_core ( const LinphoneConference conference)

Returns core for a LinphoneConference.

Parameters
conferenceLinphoneConference object.
Returns
back pointer to LinphoneCore object.

◆ linphone_conference_get_current_callbacks()

LinphoneConferenceCbs* linphone_conference_get_current_callbacks ( const LinphoneConference conference)

Sets the current LinphoneConferenceCbs.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneConferenceCbs that is calling the callback.

Parameters
conferenceLinphoneConference object.
Returns
The LinphoneConferenceCbs that has called the last callback.

◆ linphone_conference_get_current_params()

const LinphoneConferenceParams* linphone_conference_get_current_params ( const LinphoneConference conference)

Get current parameters of the conference.

Parameters
conferenceThe LinphoneConference object.
Returns
a LinphoneConferenceParams .

◆ linphone_conference_get_duration()

int linphone_conference_get_duration ( const LinphoneConference conference)

Get the conference duration.

Parameters
conferenceThe LinphoneConference object.
Returns
conference duration.

◆ linphone_conference_get_identifier()

const char* linphone_conference_get_identifier ( const LinphoneConference conference)

Returns the conference identifier.

Warning
This method returns a NULL pointer if the Conference is in the Instantiated state
Parameters
conferenceThe LinphoneConference object.
Returns
the conference identifier.

◆ linphone_conference_get_info()

const LinphoneConferenceInfo* linphone_conference_get_info ( LinphoneConference conference)

Gets the LinphoneConferenceInfo object associated with a conference.

Parameters
conferenceLinphoneConference object.
Returns
A LinphoneConferenceInfo object.

◆ linphone_conference_get_input_audio_device()

const LinphoneAudioDevice* linphone_conference_get_input_audio_device ( const LinphoneConference conference)

Gets the current input device for this conference.

Parameters
conferenceThe LinphoneConference
Returns
the LinphoneAudioDevice used by this conference as input or NULL if there is currently no soundcard configured (depending on the state of the conference)

◆ linphone_conference_get_input_volume()

float linphone_conference_get_input_volume ( const LinphoneConference conference)

Retrieves the volume of a specific participant.

Parameters
conferenceA LinphoneConference object
Returns
The volume of the participant expressed in dbm0.

◆ linphone_conference_get_me()

LinphoneParticipant* linphone_conference_get_me ( const LinphoneConference conference)

For a local audio video conference, this function returns the participant hosting the conference For a remote audio video conference, this function returns the local participant of the conference.

Parameters
conferenceThe LinphoneConference object.
Returns
a LinphoneParticipant .

◆ linphone_conference_get_microphone_muted()

bool_t linphone_conference_get_microphone_muted ( const LinphoneConference conference)

Retrieves the volume of a specific participant.

Parameters
conferenceA LinphoneConference object
Returns
TRUE if the microphone is muted, FALSE otherwise

◆ linphone_conference_get_output_audio_device()

const LinphoneAudioDevice* linphone_conference_get_output_audio_device ( const LinphoneConference conference)

Gets the current output device for this conference.

Parameters
conferenceThe LinphoneConference
Returns
the LinphoneAudioDevice used by this conference as output or NULL if there is currently no soundcard configured (depending on the state of the conference)

◆ linphone_conference_get_participant_count()

int linphone_conference_get_participant_count ( const LinphoneConference conference)

Get number of participants without me.

Parameters
conferenceThe LinphoneConference object.
Returns
the number of participants excluding me in a LinphoneConference

◆ linphone_conference_get_participant_device_list()

bctbx_list_t* linphone_conference_get_participant_device_list ( const LinphoneConference conference)

Get list of all participant devices of a conference including me if it is in.

Parameters
conferenceA LinphoneConference
Returns
The list of participant devices of the conference.

◆ linphone_conference_get_participant_device_volume()

int linphone_conference_get_participant_device_volume ( LinphoneConference conference,
LinphoneParticipantDevice device 
)

Retrieves the volume of a specific participant.

Parameters
conferenceA LinphoneConference object
deviceThe Participant
Returns
The volume of the participant expressed in dbm0.

◆ linphone_conference_get_participant_list()

bctbx_list_t* linphone_conference_get_participant_list ( const LinphoneConference conference)

Get list of all participants of a conference.

Warning
The returned list does not include me.
Parameters
conferenceA LinphoneConference
Returns
The list of participants of the conference.

◆ linphone_conference_get_participants()

MS2_DEPRECATED bctbx_list_t* linphone_conference_get_participants ( const LinphoneConference conference)

Get URIs of all participants of one conference The returned bctbx_list_t contains URIs of all participants.

That list must be freed after use and each URI must be unref with linphone_address_unref()

Warning
The returned list does not include me.
Parameters
conferenceA LinphoneConference
Returns
The list of the participants' address active in the conference.
Deprecated:
10/07/2020 Use linphone_conference_get_participant_list() instead.

◆ linphone_conference_get_player()

LinphonePlayer* linphone_conference_get_player ( LinphoneConference conference)

Gets a player associated with the conference to play a local file and stream it to the remote peers.

Parameters
conferenceLinphoneConference object.
Returns
A LinphonePlayer object.

◆ linphone_conference_get_screen_sharing_participant()

LinphoneParticipant* linphone_conference_get_screen_sharing_participant ( const LinphoneConference conference)

Get the participant that is currently screen sharing.

Parameters
conferenceA LinphoneConference.
Returns
a pointer to the participant found or nullptr.

◆ linphone_conference_get_screen_sharing_participant_device()

LinphoneParticipantDevice* linphone_conference_get_screen_sharing_participant_device ( const LinphoneConference conference)

Get the participant device that is currently screen sharing.

Parameters
conferenceA LinphoneConference.
Returns
a pointer to the participant device found or nullptr.

◆ linphone_conference_get_start_time()

time_t linphone_conference_get_start_time ( const LinphoneConference conference)

Get the conference start time.

Parameters
conferenceThe LinphoneConference object.
Returns
conference start time.

◆ linphone_conference_get_state()

LinphoneConferenceState linphone_conference_get_state ( const LinphoneConference conference)

Get the current state of the conference.

Parameters
conferenceThe LinphoneConference object.
Returns
the LinphoneConferenceState of the conference.

◆ linphone_conference_get_subject()

const char* linphone_conference_get_subject ( const LinphoneConference conference)

Get the conference subject.

Parameters
conferenceThe LinphoneConference object.
Returns
conference subject.

◆ linphone_conference_get_subject_utf8()

const char* linphone_conference_get_subject_utf8 ( const LinphoneConference conference)

Get the conference subject as an UTF-8 string.

Parameters
conferenceThe LinphoneConference object.
Returns
conference subject.

◆ linphone_conference_get_username()

const char* linphone_conference_get_username ( const LinphoneConference conference)

Get the conference username.

Parameters
conferenceThe LinphoneConference object.
Returns
conference subject.

◆ linphone_conference_info_add_participant()

void linphone_conference_info_add_participant ( LinphoneConferenceInfo conference_info,
const LinphoneAddress participant 
)

Add a participant to the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participantThe participant (LinphoneAddress) to add.

◆ linphone_conference_info_add_participant_2()

void linphone_conference_info_add_participant_2 ( LinphoneConferenceInfo conference_info,
const LinphoneParticipantInfo participant_info 
)

Add a participant to the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participant_infoThe participant information (LinphoneParticipantInfo) to add. This method can be called to set attributes such as the role to the organizer of the conference

◆ linphone_conference_info_add_participant_infos()

void linphone_conference_info_add_participant_infos ( LinphoneConferenceInfo conference_info,
const bctbx_list_t *  participant_infos 
)

Add a list of participants.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participant_infosThe list of participant informations to add.

◆ linphone_conference_info_clone()

LinphoneConferenceInfo* linphone_conference_info_clone ( const LinphoneConferenceInfo conference_info)

Clone an object LinphoneConferenceInfo.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
the cloned LinphoneConferenceInfo object.

◆ linphone_conference_info_find_participant()

const LinphoneParticipantInfo* linphone_conference_info_find_participant ( LinphoneConferenceInfo conference_info,
const LinphoneAddress participant 
)

Find a participant information in the conference information.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participantThe participant (LinphoneAddress) to search.
Returns
The participant information (LinphoneParticipantInfo).

◆ linphone_conference_info_get_capability()

bool_t linphone_conference_info_get_capability ( const LinphoneConferenceInfo conference_info,
const LinphoneStreamType  stream_type 
)

Get the capability of the conference.

The capability information represents the capability for the conference linked to the #ConferenceInfo to handle a given stream type (audio, video or text).

Parameters
conference_infoA LinphoneConferenceInfo object
stream_typeA LinphoneStreamType
Returns
the capability of the conference linked to conference information LinphoneConferenceInfo

◆ linphone_conference_info_get_ccmp_uri()

const char* linphone_conference_info_get_ccmp_uri ( const LinphoneConferenceInfo conference_info)

Retrieve the CCMP URI of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The URI of the conference stored in the CCMP server.

◆ linphone_conference_info_get_date_time()

time_t linphone_conference_info_get_date_time ( const LinphoneConferenceInfo conference_info)

Retrieve the date and time of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The date and time of the conference.

◆ linphone_conference_info_get_description()

const char* linphone_conference_info_get_description ( const LinphoneConferenceInfo conference_info)

Retrieve the description of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The description of the conference.

◆ linphone_conference_info_get_description_utf8()

const char* linphone_conference_info_get_description_utf8 ( const LinphoneConferenceInfo conference_info)

Retrieve the description of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The description of the conference.

◆ linphone_conference_info_get_duration()

unsigned int linphone_conference_info_get_duration ( const LinphoneConferenceInfo conference_info)

Retrieve the duration (in minutes) of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The duration of the conference.

◆ linphone_conference_info_get_icalendar_string()

char* linphone_conference_info_get_icalendar_string ( const LinphoneConferenceInfo conference_info)

Retrieve the conference as an Icalendar string.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The conference as an Icalendar string. The returned char* must be freed by the caller.

◆ linphone_conference_info_get_ics_uid()

const char* linphone_conference_info_get_ics_uid ( const LinphoneConferenceInfo conference_info)

Retrieve the ICS UID linked to a conference info.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
the ICS UID.

◆ linphone_conference_info_get_organizer()

const LinphoneAddress* linphone_conference_info_get_organizer ( const LinphoneConferenceInfo conference_info)

Retrieve the organizer of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The LinphoneAddress of the conference's organizer.

◆ linphone_conference_info_get_organizer_info()

const LinphoneParticipantInfo* linphone_conference_info_get_organizer_info ( const LinphoneConferenceInfo conference_info)

Retrieve the organizer of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The LinphoneParticipantInfo of the conference's organizer.

◆ linphone_conference_info_get_participant_infos()

const bctbx_list_t* linphone_conference_info_get_participant_infos ( const LinphoneConferenceInfo conference_info)

Retrieve the list of participants as list of participant infos.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The list of participant informations.

◆ linphone_conference_info_get_participants()

MS2_DEPRECATED const bctbx_list_t* linphone_conference_info_get_participants ( const LinphoneConferenceInfo conference_info)

Retrieve the list of participants as list of addresses.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The list of participants.
Deprecated:
24/08/2023 use linphone_conference_info_get_participant_infos instead

◆ linphone_conference_info_get_security_level()

LinphoneConferenceSecurityLevel linphone_conference_info_get_security_level ( const LinphoneConferenceInfo conference_info)

Retrieve the desired security level of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The desired security level of the conference.

◆ linphone_conference_info_get_state()

LinphoneConferenceInfoState linphone_conference_info_get_state ( const LinphoneConferenceInfo conference_info)

Retrieve the state of the conference info.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
LinphoneConferenceInfoState object.

◆ linphone_conference_info_get_subject()

const char* linphone_conference_info_get_subject ( const LinphoneConferenceInfo conference_info)

Retrieve the subject of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The subject of the conference.

◆ linphone_conference_info_get_subject_utf8()

const char* linphone_conference_info_get_subject_utf8 ( const LinphoneConferenceInfo conference_info)

Retrieve the subject of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The subject of the conference.

◆ linphone_conference_info_get_uri()

const LinphoneAddress* linphone_conference_info_get_uri ( const LinphoneConferenceInfo conference_info)

Retrieve the URI of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
The URI of the conference (LinphoneAddress).

◆ linphone_conference_info_new()

LinphoneConferenceInfo* linphone_conference_info_new ( void  )

Create a new LinphoneConferenceInfo object.

Returns
The newly created LinphoneConferenceInfo object.

◆ linphone_conference_info_ref()

LinphoneConferenceInfo* linphone_conference_info_ref ( LinphoneConferenceInfo conference_info)

Take a reference on a LinphoneConferenceInfo.

Parameters
conference_infoThe LinphoneConferenceInfo object.
Returns
the same LinphoneConferenceInfo object.

◆ linphone_conference_info_remove_participant()

void linphone_conference_info_remove_participant ( LinphoneConferenceInfo conference_info,
const LinphoneAddress participant 
)

Remove a participant from the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participantThe participant (LinphoneAddress) to remove.

◆ linphone_conference_info_set_capability()

void linphone_conference_info_set_capability ( LinphoneConferenceInfo conference_info,
const LinphoneStreamType  stream_type,
bool_t  enable 
)

Set the capability of the conference.

The capability information represents the capability for the conference linked to the #ConferenceInfo to handle a given stream type (audio, video or text).

Parameters
conference_infoA LinphoneConferenceInfo object
stream_typeA LinphoneStreamType
enablethe capability of the conference linked to conference information LinphoneConferenceInfo

◆ linphone_conference_info_set_ccmp_uri()

void linphone_conference_info_set_ccmp_uri ( LinphoneConferenceInfo conference_info,
const char *  uri 
)

Set the CCMP URI of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
uriThe URI of the conference in the CCMP server.

◆ linphone_conference_info_set_date_time()

void linphone_conference_info_set_date_time ( LinphoneConferenceInfo conference_info,
time_t  datetime 
)

Set the date and time of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
datetimeThe date and time of the conference.

◆ linphone_conference_info_set_description()

void linphone_conference_info_set_description ( LinphoneConferenceInfo conference_info,
const char *  description 
)

Set the description of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
descriptionThe description of the conference.

◆ linphone_conference_info_set_description_utf8()

void linphone_conference_info_set_description_utf8 ( LinphoneConferenceInfo conference_info,
const char *  description 
)

Set the description of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
descriptionThe description of the conference.

◆ linphone_conference_info_set_duration()

void linphone_conference_info_set_duration ( LinphoneConferenceInfo conference_info,
unsigned int  duration 
)

Set the duration (in minutes) of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
durationThe duration of the conference.

◆ linphone_conference_info_set_ics_uid()

void linphone_conference_info_set_ics_uid ( LinphoneConferenceInfo conference_info,
const char *  uid 
)

Store the ICS UID in the conference info.

Parameters
conference_infoThe LinphoneConferenceInfo object.
uidthe ICS UID to be associated to the LinphoneConferenceInfo object.

◆ linphone_conference_info_set_organizer()

void linphone_conference_info_set_organizer ( LinphoneConferenceInfo conference_info,
const LinphoneAddress organizer 
)

Set the organizer of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
organizerThe LinphoneAddress of the conference's organizer.

◆ linphone_conference_info_set_participant_infos()

void linphone_conference_info_set_participant_infos ( LinphoneConferenceInfo conference_info,
const bctbx_list_t *  participant_infos 
)

Set the list of participants.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participant_infosThe list of participant informations to set.

◆ linphone_conference_info_set_participants()

MS2_DEPRECATED void linphone_conference_info_set_participants ( LinphoneConferenceInfo conference_info,
const bctbx_list_t *  participants 
)

Set the list of participants.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participantsThe list of participants to set.
Deprecated:
24/08/2023 use linphone_conference_info_set_participant_infos instead

◆ linphone_conference_info_set_security_level()

void linphone_conference_info_set_security_level ( LinphoneConferenceInfo conference_info,
LinphoneConferenceSecurityLevel  security_level 
)

Set the desired security level of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
security_levelThe desired security level of the conference.

◆ linphone_conference_info_set_subject()

void linphone_conference_info_set_subject ( LinphoneConferenceInfo conference_info,
const char *  subject 
)

Set the subject of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
subjectThe subject of the conference.

◆ linphone_conference_info_set_subject_utf8()

void linphone_conference_info_set_subject_utf8 ( LinphoneConferenceInfo conference_info,
const char *  subject 
)

Set the subject of the conference.

Parameters
conference_infoThe LinphoneConferenceInfo object.
subjectThe subject of the conference.

◆ linphone_conference_info_unref()

void linphone_conference_info_unref ( LinphoneConferenceInfo conference_info)

Release a LinphoneConferenceInfo.

Parameters
conference_infoThe LinphoneConferenceInfo object.

◆ linphone_conference_info_update_participant()

void linphone_conference_info_update_participant ( LinphoneConferenceInfo conference_info,
const LinphoneParticipantInfo participant_info 
)

Update the participant information in the conference informations.

Parameters
conference_infoThe LinphoneConferenceInfo object.
participant_infoThe participant information (LinphoneParticipantInfo) to update. This method can be called to change attributes such as the role to the organizer of the conference

◆ linphone_conference_invite_participants()

LinphoneStatus linphone_conference_invite_participants ( LinphoneConference conference,
const bctbx_list_t *  addresses,
const LinphoneCallParams params 
)

Invite participants to the conference, by supplying a list of LinphoneAddress If the conference is in the state LinphoneConferenceStateCreationPending, then the conference will start on the input and output audio devices used for the currently active call, if any This method will call every address supplied and add it to a conference on devices hosting a conference.

On the other hand, if the conference is created on a server, this method will allow to create either a chat only conference or an ad-hoc audio video conference

Parameters
conferenceThe LinphoneConference object.
addressesA list of SIP addresses to invite.
paramsLinphoneCallParams to use for inviting the participants.
Warning
The LinphoneCallParams are only honored by conference servers and devices that host the conference locally.

◆ linphone_conference_is_in()

bool_t linphone_conference_is_in ( const LinphoneConference conference)

For a local conference, it returns whether the local participant is enabled For a client conference, it return whether the remote participant has left the conference without bein removed from it.

Parameters
conferenceA LinphoneConference object
Returns
TRUE if the local participant is in a conference, FALSE otherwise.

◆ linphone_conference_is_me()

bool_t linphone_conference_is_me ( const LinphoneConference conference,
const LinphoneAddress uri 
)

For a local audio video conference, this function compares the address provided as argument with that of participant hosting the conference For a remote audio video conference, this function compares the address provided as argument with that of the local participant of the conference.

Parameters
conferenceA LinphoneConference object
uriA LinphoneAddress object
Returns
TRUE if the participant is me, FALSE otherwise.

◆ linphone_conference_is_recording()

bool_t linphone_conference_is_recording ( const LinphoneConference conference)

Gets whether the conference is currently being recorded.

Parameters
conferenceA LinphoneConference object
Returns
TRUE if conference is being recorded, FALSE otherwise.

◆ linphone_conference_leave()

int linphone_conference_leave ( LinphoneConference conference)

For a local conference, the local participant leaves the conference For a client conference, the participant leaves the conference after joining it earlier on.

Parameters
conferenceA LinphoneConference object
Returns
0 if succeeded. Negative number if failed

◆ linphone_conference_params_audio_enabled()

bool_t linphone_conference_params_audio_enabled ( const LinphoneConferenceParams params)

Check whether audio capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports audio capabilities, FALSE otherwise

◆ linphone_conference_params_chat_enabled()

bool_t linphone_conference_params_chat_enabled ( const LinphoneConferenceParams params)

Check whether chat capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports chat capabilities, FALSE otherwise

◆ linphone_conference_params_clone()

LinphoneConferenceParams* linphone_conference_params_clone ( const LinphoneConferenceParams params)

Clone a LinphoneConferenceParams.

Parameters
paramsThe LinphoneConferenceParams to clone
Returns
An allocated LinphoneConferenceParams with the same parameters than params

◆ linphone_conference_params_enable_audio()

void linphone_conference_params_enable_audio ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable audio capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, audio will be enabled during conference

◆ linphone_conference_params_enable_chat()

void linphone_conference_params_enable_chat ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable chat capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, chat is enabled during conference

◆ linphone_conference_params_enable_group()

void linphone_conference_params_enable_group ( LinphoneConferenceParams params,
bool_t  group 
)

Enables or disables group chat for the text capabilities of the conference associated with the given parameters.

Parameters
paramsThe LinphoneConferenceParams object.
groupTRUE to enable group chat, FALSE to disable (resulting in one-to-one text capabilities of the conference)

◆ linphone_conference_params_enable_local_participant()

void linphone_conference_params_enable_local_participant ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable local participant to enter the conference.

The local participant is the one driving the local LinphoneCore. It uses the local sound devices. The default value is TRUE. Setting to FALSE is mostly helpful when using liblinphone on a server application.

Parameters
paramsA LinphoneConferenceParams
enableTRUE if local participant is automatically added to the conference, FALSE otherwise

◆ linphone_conference_params_enable_one_participant_conference()

void linphone_conference_params_enable_one_participant_conference ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable conference with one participant.

Parameters
paramsA LinphoneConferenceParams
enableTRUE if conference can have only one participant, FALSE otherwise

◆ linphone_conference_params_enable_video()

void linphone_conference_params_enable_video ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable video capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, video will be enabled during conference

◆ linphone_conference_params_free()

MS2_DEPRECATED void linphone_conference_params_free ( LinphoneConferenceParams params)

◆ linphone_conference_params_get_account()

LinphoneAccount* linphone_conference_params_get_account ( const LinphoneConferenceParams params)

Returns the account for the conference.

Parameters
paramsA LinphoneConferenceParams
Returns
a pointer to the account or NULL if it is not set.

◆ linphone_conference_params_get_chat_params()

LinphoneChatParams* linphone_conference_params_get_chat_params ( const LinphoneConferenceParams params)

Get the chat parameters.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
the chat parameters if chat capabilities are on, NULL otherwise

◆ linphone_conference_params_get_conference_factory_address()

const LinphoneAddress* linphone_conference_params_get_conference_factory_address ( const LinphoneConferenceParams params)

Get the conference factory address of the conference that has been set.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
the factory address conference description.

◆ linphone_conference_params_get_description_utf8()

const char* linphone_conference_params_get_description_utf8 ( const LinphoneConferenceParams params)

Get conference description (utf8).

Parameters
paramsThe LinphoneConferenceParams object.
Returns
the conference description.

◆ linphone_conference_params_get_participant_list_type()

LinphoneConferenceParticipantListType linphone_conference_params_get_participant_list_type ( const LinphoneConferenceParams params)

Get the participant list type.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
participant list type LinphoneConferenceParticipantListType.

◆ linphone_conference_params_get_proxy_cfg()

MS2_DEPRECATED LinphoneProxyConfig* linphone_conference_params_get_proxy_cfg ( const LinphoneConferenceParams params)

Returns the proxy configuration for the conference.

Parameters
paramsA LinphoneConferenceParams
Returns
a pointer to the proxy configuration or NULL if it is not set.
Deprecated:
11/01/2022 Use linphone_conference_params_get_account() instead.

◆ linphone_conference_params_get_security_level()

LinphoneConferenceSecurityLevel linphone_conference_params_get_security_level ( const LinphoneConferenceParams params)

Retrieve the desired security level of the conference.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
The desired security level of the conference.

◆ linphone_conference_params_get_subject()

const char* linphone_conference_params_get_subject ( const LinphoneConferenceParams params)

Get the conference subject.

Parameters
paramsA LinphoneConferenceParams
Returns
conference subject.

◆ linphone_conference_params_get_subject_utf8()

const char* linphone_conference_params_get_subject_utf8 ( const LinphoneConferenceParams params)

Get the conference subject as an UTF-8 string.

Parameters
paramsA LinphoneConferenceParams
Returns
conference subject.

◆ linphone_conference_params_group_enabled()

bool_t linphone_conference_params_group_enabled ( const LinphoneConferenceParams params)

Get the group chat status of the text capabilities of the conference associated with the given parameters.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
TRUE if group chat is enabled, FALSE if one-to-one

◆ linphone_conference_params_is_audio_enabled()

MS2_DEPRECATED bool_t linphone_conference_params_is_audio_enabled ( const LinphoneConferenceParams params)

Check whether audio capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports audio capabilities, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_audio_enabled() instead.

◆ linphone_conference_params_is_chat_enabled()

MS2_DEPRECATED bool_t linphone_conference_params_is_chat_enabled ( const LinphoneConferenceParams params)

Check whether chat capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports chat capabilities, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_chat_enabled() instead.

◆ linphone_conference_params_is_hidden()

bool_t linphone_conference_params_is_hidden ( const LinphoneConferenceParams params)

Get the value of the hidden flag.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
whether the conference is hidden or not

◆ linphone_conference_params_is_local_participant_enabled()

MS2_DEPRECATED bool_t linphone_conference_params_is_local_participant_enabled ( const LinphoneConferenceParams params)

Returns whether local participant has to enter the conference.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if local participant is by default part of the conference, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_local_participant_enabled() instead.

◆ linphone_conference_params_is_one_participant_conference_enabled()

MS2_DEPRECATED bool_t linphone_conference_params_is_one_participant_conference_enabled ( const LinphoneConferenceParams params)

Returns whether conference can have only one participant.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference can have only one participant, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_one_participant_conference_enabled() instead.

◆ linphone_conference_params_is_valid()

bool_t linphone_conference_params_is_valid ( const LinphoneConferenceParams params)

Returns whether the given parameters are valid or not.

Parameters
paramsThe LinphoneConferenceParams object.
Returns
TRUE if the given parameters are valid, FALSE otherwise

◆ linphone_conference_params_is_video_enabled()

MS2_DEPRECATED bool_t linphone_conference_params_is_video_enabled ( const LinphoneConferenceParams params)

Check whether video capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports video capabilities, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_video_enabled() instead.

◆ linphone_conference_params_local_participant_enabled()

bool_t linphone_conference_params_local_participant_enabled ( const LinphoneConferenceParams params)

Returns whether local participant has to enter the conference.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if local participant is by default part of the conference, FALSE otherwise

◆ linphone_conference_params_new()

LinphoneConferenceParams* linphone_conference_params_new ( LinphoneCore core)

Create an object of type a LinphoneConferenceParams.

Parameters
coreThe LinphoneCore to pass to the constructor.
Returns
The created LinphoneConferenceParams.

◆ linphone_conference_params_one_participant_conference_enabled()

bool_t linphone_conference_params_one_participant_conference_enabled ( const LinphoneConferenceParams params)

Returns whether conference can have only one participant.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference can have only one participant, FALSE otherwise

◆ linphone_conference_params_ref()

LinphoneConferenceParams* linphone_conference_params_ref ( LinphoneConferenceParams params)

Take a reference on a LinphoneConferenceParams.

Parameters
paramsThe LinphoneConferenceParams to ref.
Returns
The freshly refed LinphoneConferenceParams.

◆ linphone_conference_params_set_account()

void linphone_conference_params_set_account ( LinphoneConferenceParams params,
LinphoneAccount account 
)

Sets the account for the conference.

Parameters
paramsA LinphoneConferenceParams
accounta pointer to the account.
Warning
The account can only be changed upon creation of a conference when calling linphone_core_create_conference_with_params

◆ linphone_conference_params_set_audio_enabled()

MS2_DEPRECATED void linphone_conference_params_set_audio_enabled ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable audio capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, audio will be enabled during conference
Deprecated:
16/12/2021 Use linphone_conference_params_enable_audio() instead.

◆ linphone_conference_params_set_chat_enabled()

MS2_DEPRECATED void linphone_conference_params_set_chat_enabled ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable chat capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, chat is enabled during conference
Deprecated:
16/12/2021 Use linphone_conference_params_enable_chat() instead.

◆ linphone_conference_params_set_conference_factory_address()

void linphone_conference_params_set_conference_factory_address ( LinphoneConferenceParams params,
const LinphoneAddress address 
)

Set the conference factory address of the conference.

By default when creating a new conference, the factory address will come from the current proxy configuration. If NULL then the conference will be local else it will be a client conference.

Parameters
paramsThe LinphoneConferenceParams object.
addressthe conference factory address.

◆ linphone_conference_params_set_description_utf8()

void linphone_conference_params_set_description_utf8 ( LinphoneConferenceParams params,
const char *  description 
)

Set the description of the conference (utf8)

Parameters
paramsThe LinphoneConferenceParams object.
descriptionthe conference description.

◆ linphone_conference_params_set_hidden()

void linphone_conference_params_set_hidden ( LinphoneConferenceParams params,
bool_t  hidden 
)

Set the conference as hidden.

This means that the contact address will not have any conference releated attribute such as isfocus, the conference ID and the admin status.

Parameters
paramsThe LinphoneConferenceParams object.
hiddenBoolean that states whether the conference is hidden or not

◆ linphone_conference_params_set_local_participant_enabled()

MS2_DEPRECATED void linphone_conference_params_set_local_participant_enabled ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable local participant to enter the conference.

The local participant is the one driving the local LinphoneCore. It uses the local sound devices. The default value is TRUE. Setting to FALSE is mostly helpful when using liblinphone on a server application.

Parameters
paramsA LinphoneConferenceParams
enableTRUE if local participant is automatically added to the conference, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_enable_local_participant() instead.

◆ linphone_conference_params_set_one_participant_conference_enabled()

MS2_DEPRECATED void linphone_conference_params_set_one_participant_conference_enabled ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable conference with one participant.

Parameters
paramsA LinphoneConferenceParams
enableTRUE if conference can have only one participant, FALSE otherwise
Deprecated:
16/12/2021 Use linphone_conference_params_enable_one_participant_conference() instead.

◆ linphone_conference_params_set_participant_list_type()

void linphone_conference_params_set_participant_list_type ( LinphoneConferenceParams params,
LinphoneConferenceParticipantListType  type 
)

Set the participant list type.

Parameters
paramsThe LinphoneConferenceParams object.
typeParticipant list type LinphoneConferenceParticipantListType. This allows to restrict the access to the conference to a selected set of participants

◆ linphone_conference_params_set_security_level()

void linphone_conference_params_set_security_level ( LinphoneConferenceParams params,
LinphoneConferenceSecurityLevel  security_level 
)

Set the desired security level of the conference.

Parameters
paramsThe LinphoneConferenceParams object.
security_levelThe desired security level of the conference.

◆ linphone_conference_params_set_subject()

void linphone_conference_params_set_subject ( LinphoneConferenceParams params,
const char *  subject 
)

Set the conference subject.

Parameters
paramsA LinphoneConferenceParams
subjectconference subject

◆ linphone_conference_params_set_subject_utf8()

void linphone_conference_params_set_subject_utf8 ( LinphoneConferenceParams params,
const char *  subject 
)

Set the conference subject as an UTF8 string.

Parameters
paramsA LinphoneConferenceParams
subjectconference subject

◆ linphone_conference_params_set_video_enabled()

MS2_DEPRECATED void linphone_conference_params_set_video_enabled ( LinphoneConferenceParams params,
bool_t  enable 
)

Enable video capabilities.

Parameters
paramsA LinphoneConferenceParams
enableIf TRUE, video will be enabled during conference
Deprecated:
16/12/2021 Use linphone_conference_params_enable_video() instead.

◆ linphone_conference_params_unref()

void linphone_conference_params_unref ( LinphoneConferenceParams params)

Release a LinphoneConferenceParams.

Parameters
paramsThe LinphoneConferenceParams to release.

◆ linphone_conference_params_video_enabled()

bool_t linphone_conference_params_video_enabled ( const LinphoneConferenceParams params)

Check whether video capabilities are enabled.

Parameters
paramsA LinphoneConferenceParams
Returns
TRUE if the conference supports video capabilities, FALSE otherwise

◆ linphone_conference_ref()

LinphoneConference* linphone_conference_ref ( LinphoneConference conference)

Take a reference on a LinphoneConference.

Parameters
conferenceThe LinphoneConference to ref.
Returns
The same LinphoneConference object.

◆ linphone_conference_remove_callbacks()

void linphone_conference_remove_callbacks ( LinphoneConference conference,
LinphoneConferenceCbs cbs 
)

Remove a listener from a LinphoneConference.

Parameters
conferenceLinphoneConference object.
cbsLinphoneConferenceCbs object to remove.

◆ linphone_conference_remove_participant()

MS2_DEPRECATED LinphoneStatus linphone_conference_remove_participant ( LinphoneConference conference,
const LinphoneAddress uri 
)
Parameters
conferenceA LinphoneConference
uriURI of the participant to remove
Warning
The passed participant uri must be one of those returned by linphone_conference_get_participants()
Returns
0 if succeeded, -1 if failed
Deprecated:
10/07/2020 Use linphone_conference_remove_participant_2() instead.

◆ linphone_conference_remove_participant_2()

LinphoneStatus linphone_conference_remove_participant_2 ( LinphoneConference conference,
LinphoneParticipant participant 
)
Parameters
conferenceA LinphoneConference
participantparticipant to remove
Warning
The passed participant must be one of those returned by linphone_conference_get_participant_list()
This method may destroy the conference if the only remaining participant had an existing call to the local participant before the conference was created
Returns
0 if succeeded, -1 if failed

◆ linphone_conference_remove_participant_3()

MS2_DEPRECATED LinphoneStatus linphone_conference_remove_participant_3 ( LinphoneConference conference,
LinphoneCall call 
)
Parameters
conferenceA LinphoneConference
callcall to remove
Returns
0 if succeeded, -1 if failed
Deprecated:
10/07/2020 Use linphone_conference_remove_participant_2() instead.

◆ linphone_conference_scheduler_add_callbacks()

void linphone_conference_scheduler_add_callbacks ( LinphoneConferenceScheduler conference_scheduler,
LinphoneConferenceSchedulerCbs cbs 
)

Add a listener in order to be notified of LinphoneConferenceScheduler events.

Parameters
conference_schedulerThe LinphoneAccount object to monitor.
cbsA LinphoneConferenceSchedulerCbs object holding the callbacks you need.

◆ linphone_conference_scheduler_cancel_conference()

void linphone_conference_scheduler_cancel_conference ( LinphoneConferenceScheduler conference_scheduler,
LinphoneConferenceInfo conference_info 
)

Cancel the conference linked to the LinphoneConferenceInfo provided as argument.

Parameters
conference_schedulerthe LinphoneConferenceScheduler object.
conference_infothe LinphoneConferenceInfo object to linked to the conference to cancel.

◆ linphone_conference_scheduler_cbs_get_invitations_sent()

LinphoneConferenceSchedulerCbsInvitationsSentCb linphone_conference_scheduler_cbs_get_invitations_sent ( const LinphoneConferenceSchedulerCbs cbs)

Get the invitations sent callback.

Parameters
cbsLinphoneConferenceSchedulerCbs object.
Returns
The current invitations sent callback.

◆ linphone_conference_scheduler_cbs_get_state_changed()

LinphoneConferenceSchedulerCbsStateChangedCb linphone_conference_scheduler_cbs_get_state_changed ( const LinphoneConferenceSchedulerCbs cbs)

Get the state changed callback.

Parameters
cbsLinphoneConferenceSchedulerCbs object.
Returns
The current state changed callback.

◆ linphone_conference_scheduler_cbs_get_user_data()

void* linphone_conference_scheduler_cbs_get_user_data ( const LinphoneConferenceSchedulerCbs cbs)

Retrieve the user pointer associated with the conference scheduler callbacks object.

Parameters
cbsThe LinphoneConferenceSchedulerCbs object.
Returns
The user pointer associated with the conference scheduler callbacks object.

◆ linphone_conference_scheduler_cbs_new()

LinphoneConferenceSchedulerCbs* linphone_conference_scheduler_cbs_new ( void  )

Create a new conference scheduler callbacks object.

Returns
The LinphoneConferenceSchedulerCbs object.

◆ linphone_conference_scheduler_cbs_ref()

LinphoneConferenceSchedulerCbs* linphone_conference_scheduler_cbs_ref ( LinphoneConferenceSchedulerCbs cbs)

Acquire a reference to the conference scheduler callbacks object.

Parameters
cbsThe LinphoneConferenceSchedulerCbs object.
Returns
The same conference scheduler callbacks object.

◆ linphone_conference_scheduler_cbs_set_invitations_sent()

void linphone_conference_scheduler_cbs_set_invitations_sent ( LinphoneConferenceSchedulerCbs cbs,
LinphoneConferenceSchedulerCbsInvitationsSentCb  cb 
)

Set the invitations sent callback.

Parameters
cbsLinphoneConferenceSchedulerCbs object.
cbThe invitations sent callback to be used.

◆ linphone_conference_scheduler_cbs_set_state_changed()

void linphone_conference_scheduler_cbs_set_state_changed ( LinphoneConferenceSchedulerCbs cbs,
LinphoneConferenceSchedulerCbsStateChangedCb  cb 
)

Set the state changed callback.

Parameters
cbsLinphoneConferenceSchedulerCbs object.
cbThe state changed callback to be used.

◆ linphone_conference_scheduler_cbs_set_user_data()

void linphone_conference_scheduler_cbs_set_user_data ( LinphoneConferenceSchedulerCbs cbs,
void *  user_data 
)

Assign a user pointer to the conference scheduler callbacks object.

Parameters
cbsThe LinphoneConferenceSchedulerCbs object.
user_dataThe user pointer to associate with the conference scheduler callbacks object.

◆ linphone_conference_scheduler_cbs_unref()

void linphone_conference_scheduler_cbs_unref ( LinphoneConferenceSchedulerCbs cbs)

Release reference to the conference scheduler callbacks object.

Parameters
cbsThe LinphoneConferenceSchedulerCbs object.

◆ linphone_conference_scheduler_get_account()

LinphoneAccount* linphone_conference_scheduler_get_account ( const LinphoneConferenceScheduler conference_scheduler)

Get the LinphoneAccount that is used for the conference scheduler.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
Returns
The selected LinphoneAccount for the call, or NULL if none has been selected.

◆ linphone_conference_scheduler_get_core()

LinphoneCore* linphone_conference_scheduler_get_core ( const LinphoneConferenceScheduler conference_scheduler)

Gets the LinphoneCore from a LinphoneConferenceScheduler object.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
Returns
the LinphoneCore object.

◆ linphone_conference_scheduler_get_current_callbacks()

LinphoneConferenceSchedulerCbs* linphone_conference_scheduler_get_current_callbacks ( const LinphoneConferenceScheduler conference_scheduler)

Gets the current LinphoneConferenceSchedulerCbs.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneConferenceSchedulerCbs that is calling the callback.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
Returns
The LinphoneConferenceSchedulerCbs that has called the last callback.

◆ linphone_conference_scheduler_get_info()

const LinphoneConferenceInfo* linphone_conference_scheduler_get_info ( const LinphoneConferenceScheduler conference_scheduler)

Returns the LinphoneConferenceInfo currently set in this scheduler.

Parameters
conference_schedulerthe LinphoneConferenceScheduler object.
Returns
the currently configured LinphoneConferenceInfo or NULL if none is set.

◆ linphone_conference_scheduler_ref()

LinphoneConferenceScheduler* linphone_conference_scheduler_ref ( LinphoneConferenceScheduler conference_scheduler)

Takes a reference on a LinphoneConferenceScheduler.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
Returns
the same LinphoneConferenceScheduler object.

◆ linphone_conference_scheduler_remove_callbacks()

void linphone_conference_scheduler_remove_callbacks ( LinphoneConferenceScheduler conference_scheduler,
LinphoneConferenceSchedulerCbs cbs 
)

Remove a listener from a LinphoneConferenceScheduler.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
cbsLinphoneConferenceSchedulerCbs object to remove.

◆ linphone_conference_scheduler_send_invitations()

MS2_DEPRECATED void linphone_conference_scheduler_send_invitations ( LinphoneConferenceScheduler conference_scheduler,
LinphoneChatRoomParams chat_room_params 
)

Sends an invitation to the scheduled conference to each participant by chat, using given chat rooms params to use/create the chat room in which to send it.

Parameters
conference_schedulerthe LinphoneConferenceScheduler object.
chat_room_paramsthe LinphoneChatRoomParams object to use to use/create the LinphoneChatRoom that will be used to send the invite.
Deprecated:
28/08/2024 Use linphone_conference_scheduler_send_invitations_2() instead.

◆ linphone_conference_scheduler_send_invitations_2()

void linphone_conference_scheduler_send_invitations_2 ( LinphoneConferenceScheduler conference_scheduler,
LinphoneConferenceParams conference_params 
)

Sends an invitation to the scheduled conference to each participant by chat, using given conference params to use/create the chat room in which to send it.

Parameters
conference_schedulerthe LinphoneConferenceScheduler object.
conference_paramsthe LinphoneConferenceParams object to use to use/create the LinphoneChatRoom that will be used to send the invite.

◆ linphone_conference_scheduler_set_account()

void linphone_conference_scheduler_set_account ( LinphoneConferenceScheduler conference_scheduler,
LinphoneAccount account 
)

Set the LinphoneAccount to use for the conference scheduler.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.
accountThe LinphoneAccount to use, or NULL if none has been selected. The LinphoneConferenceScheduler keeps a reference to it and removes the previous one, if any.

◆ linphone_conference_scheduler_set_info()

void linphone_conference_scheduler_set_info ( LinphoneConferenceScheduler conference_scheduler,
LinphoneConferenceInfo conference_info 
)

Sets the LinphoneConferenceInfo to use to create/update the conference, which will be done right away.

Parameters
conference_schedulerthe LinphoneConferenceScheduler object.
conference_infothe LinphoneConferenceInfo object to use to start creating/updating the client conference.

◆ linphone_conference_scheduler_unref()

void linphone_conference_scheduler_unref ( LinphoneConferenceScheduler conference_scheduler)

Releases a LinphoneConferenceScheduler.

Parameters
conference_schedulerThe LinphoneConferenceScheduler object.

◆ linphone_conference_set_conference_address()

void linphone_conference_set_conference_address ( LinphoneConference conference,
LinphoneAddress address 
)

Set the conference address.

Parameters
conferenceThe LinphoneConference object.
addressthe conference address to set.
Warning
This is only allowed for a client conference if it is in state CreationPending or Instantiated

◆ linphone_conference_set_current_callbacks()

void linphone_conference_set_current_callbacks ( LinphoneConference conference,
LinphoneConferenceCbs cbs 
)

Gets the current LinphoneConferenceCbs.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneConferenceCbs that is calling the callback.

Parameters
conferenceLinphoneConference object.
cbsThe LinphoneConferenceCbs object.

◆ linphone_conference_set_input_audio_device()

void linphone_conference_set_input_audio_device ( LinphoneConference conference,
LinphoneAudioDevice audio_device 
)

Sets the given LinphoneAudioDevice as input for this conference only.

Parameters
conferenceThe LinphoneConference
audio_deviceThe LinphoneAudioDevice. NULL does nothing.

◆ linphone_conference_set_local_participant_stream_capability()

void linphone_conference_set_local_participant_stream_capability ( LinphoneConference conference,
const LinphoneMediaDirection  direction,
const LinphoneStreamType  stream_type 
)

Set stream capability on 'me' device of a local conference.

Parameters
conferenceThe LinphoneConference object.
directionthe direction of stream of type stream_type
stream_typeA LinphoneStreamType

◆ linphone_conference_set_microphone_muted()

void linphone_conference_set_microphone_muted ( LinphoneConference conference,
bool_t  muted 
)

Get microphone muted state.

Note that the microphone may be disabled globally if FALSE was given to linphone_core_enable_mic().

Parameters
conferenceA LinphoneConference object
mutedThe microphone muted state

◆ linphone_conference_set_output_audio_device()

void linphone_conference_set_output_audio_device ( LinphoneConference conference,
LinphoneAudioDevice audio_device 
)

Sets the given LinphoneAudioDevice as output for this conference only.

Parameters
conferenceThe LinphoneConference
audio_deviceThe LinphoneAudioDevice. NULL does nothing.

◆ linphone_conference_set_participant_admin_status()

void linphone_conference_set_participant_admin_status ( LinphoneConference conference,
LinphoneParticipant participant,
bool_t  is_admin 
)

Change the admin status of a participant of a conference (you need to be an admin yourself to do this).

Parameters
conferenceA LinphoneConference object
participantThe Participant for which to change the admin status
is_adminA boolean value telling whether the participant should now be an admin or not

◆ linphone_conference_set_subject()

void linphone_conference_set_subject ( LinphoneConference conference,
const char *  subject 
)

Set the conference subject.

Parameters
conferenceThe LinphoneConference object.
subjectconference subject

◆ linphone_conference_set_subject_utf8()

void linphone_conference_set_subject_utf8 ( LinphoneConference conference,
const char *  subject 
)

Set the conference subject as an UTF-8 string.

Parameters
conferenceThe LinphoneConference object.
subjectconference subject

◆ linphone_conference_set_username()

void linphone_conference_set_username ( LinphoneConference conference,
const char *  username 
)

Set the conference username.

Parameters
conferenceThe LinphoneConference object.
usernameconference subject

◆ linphone_conference_start_recording()

int linphone_conference_start_recording ( LinphoneConference conference,
const char *  path 
)

Starts recording the conference.

Parameters
conferenceA LinphoneConference object
pathWhere to record the conference
Returns
0 if succeeded. Negative number in case of failure.

◆ linphone_conference_stop_recording()

int linphone_conference_stop_recording ( LinphoneConference conference)

Stops the conference recording.

Parameters
conferenceA LinphoneConference object
Returns
0 if succeeded. Negative number in case of failure.

◆ linphone_conference_terminate()

int linphone_conference_terminate ( LinphoneConference conference)

Terminates conference.

Parameters
conferenceThe LinphoneConference object.
Returns
0 if the termination is successful, -1 otherwise.

◆ linphone_conference_unref()

void linphone_conference_unref ( LinphoneConference conference)

Release a LinphoneConference.

Parameters
conferenceThe LinphoneConference to release.

◆ linphone_conference_update_params()

int linphone_conference_update_params ( LinphoneConference conference,
const LinphoneConferenceParams params 
)

Update parameters of the conference.

This is typically used enable or disable the video stream in the conference.

Parameters
conferenceThe LinphoneConference object.
paramsthe new parameters to apply.

◆ linphone_core_add_all_to_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_add_all_to_conference ( LinphoneCore core)

Adds all calls into the conference.

If no conference is running a new internal conference context is created and all current calls are added to it.

Parameters
coreLinphoneCore
Returns
0 if succeeded. Negative number if failed
Warning
This function guarantees that the local endpoint is added to the conference.
Deprecated:
23/01/2025 Use linphone_conference_invite_participants() instead.

◆ linphone_core_add_to_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_add_to_conference ( LinphoneCore core,
LinphoneCall call 
)

Adds a participant to the conference.

If no conference is going on a new internal conference context is created and the participant is added to it.

Parameters
coreLinphoneCore
callThe current call with the participant to add
Returns
0 if succeeded. Negative number if failed
Deprecated:
23/01/2025 Use linphone_conference_add_participant() instead.

◆ linphone_core_conference_ics_in_message_body_enabled()

bool_t linphone_core_conference_ics_in_message_body_enabled ( const LinphoneCore core)

Gets wether conference invitations will be sent in the chat message body or as a file attachment.

Parameters
corethe LinphoneCore
Returns
TRUE if ICS will be sent in the message body (by default), FALSE if it will be sent as a file attachment.

◆ linphone_core_conference_server_enabled()

bool_t linphone_core_conference_server_enabled ( const LinphoneCore core)

Tells whether the conference server feature is enabled.

Parameters
coreA LinphoneCore object
Returns
A boolean value telling whether the conference server feature is enabled or not

◆ linphone_core_create_ccmp_conference_scheduler()

LinphoneConferenceScheduler* linphone_core_create_ccmp_conference_scheduler ( LinphoneCore core,
LinphoneAccount account 
)

Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A CCMPConferenceScheduler creates a conference on a server by using the CCMP protocol

Parameters
coreThe LinphoneCore.
accountThe LinphoneAccount to use in the LinphoneConferenceScheduler.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.

◆ linphone_core_create_conference_params_2()

LinphoneConferenceParams* linphone_core_create_conference_params_2 ( LinphoneCore core,
LinphoneConference conference 
)

Creates some default conference parameters for instanciating a conference with linphone_core_create_conference_with_params().

Parameters
corethe LinphoneCore object
conferenceLinphoneConference for which the parameters are to be build, or NULL in the case where the parameters are to be used for a new conference.
Returns
a LinphoneConferenceParams object.

◆ linphone_core_create_conference_scheduler()

MS2_DEPRECATED LinphoneConferenceScheduler* linphone_core_create_conference_scheduler ( LinphoneCore core)

Create a conference scheduler that can be used to schedule conferences on a client conference service and then send conference information invitation as an ICS object through chat.

Parameters
coreThe LinphoneCore.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.
Deprecated:
23/07/2024 Use linphone_core_create_conference_scheduler_2() or linphone_core_create_conference_scheduler_with_type() instead.

◆ linphone_core_create_conference_scheduler_2()

LinphoneConferenceScheduler* linphone_core_create_conference_scheduler_2 ( LinphoneCore core,
LinphoneAccount account 
)

Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A SipConferenceScheduler is created if the LinphoneAccount has not defined the URL of the CCMP server, other it will create a CCMPConferenceServer

Parameters
coreThe LinphoneCore.
accountThe LinphoneAccount to use in the LinphoneConferenceScheduler.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.

◆ linphone_core_create_conference_scheduler_with_type()

LinphoneConferenceScheduler* linphone_core_create_conference_scheduler_with_type ( LinphoneCore core,
LinphoneAccount account,
LinphoneConferenceSchedulerType  scheduling_type 
)

Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat by specifying its type.

Parameters
coreThe LinphoneCore.
accountThe LinphoneAccount to use in the LinphoneConferenceScheduler.
scheduling_typeThe type of the LinphoneConferenceScheduler.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.

◆ linphone_core_create_conference_with_params()

LinphoneConference* linphone_core_create_conference_with_params ( LinphoneCore core,
const LinphoneConferenceParams params 
)

Create a conference.

Local or client conference is determinated from the 'conference_type' variable in the 'misc' section of the configuration, or by the factory address parameter. See linphone_conference_params_set_conference_factory_address() for more details.

Parameters
coreThe LinphoneCore instance where the conference will be created inside.
paramsParameters of the conference. See LinphoneConferenceParams.
Returns
A pointer on the freshly created conference LinphoneConference. That object will be automatically freed by the core after calling linphone_core_terminate_conference().
Warning
To guarantee the backward comatibility, this method will assign the created conference to the conference context held by the core. Nonetheless starting from release 5.4, the conference context will be override at every conference created by calling this method

◆ linphone_core_create_db_conference_scheduler()

LinphoneConferenceScheduler* linphone_core_create_db_conference_scheduler ( LinphoneCore core,
LinphoneAccount account 
)

Create a database conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

The DBConferenceScheduler only creates a conference info to be stored in the database of the linphone core

Parameters
coreThe LinphoneCore.
accountThe LinphoneAccount to use in the LinphoneConferenceScheduler.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.

◆ linphone_core_create_sip_conference_scheduler()

LinphoneConferenceScheduler* linphone_core_create_sip_conference_scheduler ( LinphoneCore core,
LinphoneAccount account 
)

Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A SipConferenceScheduler creates a conference on a server by using a SIP dialog

Parameters
coreThe LinphoneCore.
accountThe LinphoneAccount to use in the LinphoneConferenceScheduler.
Returns
A pointer on the freshly created LinphoneConferenceScheduler.

◆ linphone_core_delete_conference_information()

void linphone_core_delete_conference_information ( LinphoneCore core,
LinphoneConferenceInfo conference_info 
)

Deletes a conference information from DB.

Parameters
coreLinphoneCore object.
conference_infothe LinphoneConferenceInfo to delete.

◆ linphone_core_enable_conference_ics_in_message_body()

void linphone_core_enable_conference_ics_in_message_body ( LinphoneCore core,
bool_t  enable 
)

Enable sending conference invitations in the chat message body instead of as a file attachment.

Parameters
corethe LinphoneCore
enableTRUE to send ICS as message body, FALSE to send it as file transfer

◆ linphone_core_enable_conference_server()

void linphone_core_enable_conference_server ( LinphoneCore core,
bool_t  enable 
)

Enables the conference server mode.

This has the effect to listen of the conference factory uri to create new conferences when receiving INVITE messages there. Enabling this mode is required when using liblinphone in a conference server application, but shall not be be employed in any client application.

Parameters
coreA LinphoneCore object
enableA boolean value telling whether to enable or disable the conference server feature

◆ linphone_core_enable_fec()

void linphone_core_enable_fec ( LinphoneCore core,
bool_t  enable 
)

Enables the flexible FEC feature (RFC8627) for video calls to recover RTP packet loss.

Parameters
coreA LinphoneCore object
enableA boolean value telling whether to enable or disable the flexible FEC feature

◆ linphone_core_enter_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_enter_conference ( LinphoneCore core)

Joins the local participant to the running conference.

Parameters
coreLinphoneCore
Returns
0 if succeeded. Negative number if failed
Deprecated:
09/03/2021 Use linphone_conference_enter() instead.

◆ linphone_core_fec_enabled()

bool_t linphone_core_fec_enabled ( const LinphoneCore core)

Tells whether the flexible FEC feature (RFC8627) is enabled for this LinphoneCore object.

Parameters
coreA LinphoneCore object
Returns
A boolean value telling whether the flexible FEC feature is enabled or not for this LinphoneCore object

◆ linphone_core_find_conference_information_from_ccmp_uri()

LinphoneConferenceInfo* linphone_core_find_conference_information_from_ccmp_uri ( LinphoneCore core,
const char *  uri 
)

Retrieve the conference information linked to the provided URI if any.

Parameters
coreLinphoneCore object.
uriUri of the conference as provided by the CCMP server backend.
Returns
The LinphoneConferenceInfo found if any, NULL otherwise.

◆ linphone_core_find_conference_information_from_uri()

LinphoneConferenceInfo* linphone_core_find_conference_information_from_uri ( LinphoneCore core,
LinphoneAddress uri 
)

Retrieve the conference information linked to the provided URI if any.

Parameters
coreLinphoneCore object.
uriLinphoneAddress of the uri.
Returns
The LinphoneConferenceInfo found if any, NULL otherwise.

◆ linphone_core_get_conference_availability_before_start()

long linphone_core_get_conference_availability_before_start ( const LinphoneCore core)

Gets the conference availability before start.

Parameters
corethe LinphoneCore.
Returns
the number of seconds the conference can be joined early
Warning
This setting is only applicable to conference servers

◆ linphone_core_get_conference_cleanup_period()

long linphone_core_get_conference_cleanup_period ( const LinphoneCore core)

Gets the conference cleanup timer period.

Parameters
corethe LinphoneCore.
Returns
the period of the conference cleanup timer

◆ linphone_core_get_conference_expire_period()

long linphone_core_get_conference_expire_period ( const LinphoneCore core)

Gets the conference expire period.

Parameters
corethe LinphoneCore.
Returns
the number of second after which the conference cannot be joined
Warning
This setting is only applicable to conference servers

◆ linphone_core_get_conference_information_list()

bctbx_list_t* linphone_core_get_conference_information_list ( LinphoneCore core)

Retrieve the list of conference information on DB.

Parameters
coreLinphoneCore object.
Returns
The list of conference infos.

◆ linphone_core_get_conference_information_list_after_time()

bctbx_list_t* linphone_core_get_conference_information_list_after_time ( LinphoneCore core,
time_t  time 
)

Retrieve the list of conference information on DB after a certain time.

Parameters
coreLinphoneCore object.
timeTime to retrieve conference info.
Returns
The list of conference infos.

◆ linphone_core_get_conference_informations_with_participant()

bctbx_list_t* linphone_core_get_conference_informations_with_participant ( LinphoneCore core,
LinphoneAddress uri 
)

Retrieve the list of conference information on DB where the address passed as argument is either the organizer or a participant.

Parameters
coreLinphoneCore object.
uriLinphoneAddress of the participant.
Returns
The list of conference infos where the address passed as argument is either the organizer or a participant.

◆ linphone_core_get_conference_local_input_volume()

MS2_DEPRECATED float linphone_core_get_conference_local_input_volume ( LinphoneCore core)

Returns the input volume of the local participant.

Parameters
coreLinphoneCore
Returns
A value inside [0.0 ; 1.0]
Deprecated:
23/01/2025 Use linphone_conference_get_input_volume() instead.

◆ linphone_core_get_conference_max_thumbnails()

int linphone_core_get_conference_max_thumbnails ( const LinphoneCore core)

Gets the maximum number of thumbnails requested in the SDP during a conference call linphone_account_get_call_logs().

Parameters
corethe LinphoneCore.
Returns
the maximum number of thumbnails requested in the SDP during a conference call

◆ linphone_core_get_conference_participant_list_type()

LinphoneConferenceParticipantListType linphone_core_get_conference_participant_list_type ( const LinphoneCore core)

Tells whether the default conference participant list is open or closed.

Parameters
coreA LinphoneCore object
Returns
A LinphoneConferenceParticipantListType participant list type

◆ linphone_core_get_default_conference_layout()

LinphoneConferenceLayout linphone_core_get_default_conference_layout ( const LinphoneCore core)

Gets the default conference layout.

Parameters
corethe LinphoneCore.
Returns
conference layout

◆ linphone_core_get_future_conference_information_list()

bctbx_list_t* linphone_core_get_future_conference_information_list ( LinphoneCore core)

Retrieve the list of future conference information on DB.

Parameters
coreLinphoneCore object.
Returns
The list of future conference infos.

◆ linphone_core_is_in_conference()

MS2_DEPRECATED bool_t linphone_core_is_in_conference ( const LinphoneCore core)

Indicates whether the local participant is part of a conference.

Warning
That function automatically fails in the case of conferences using a conferencet server (focus). If you use such a conference, you should use linphone_conference_remove_participant() instead.
Parameters
corethe LinphoneCore.
Returns
TRUE if the local participant is in a conference, FALSE otherwise.
Deprecated:
09/03/2021 Use linphone_conference_is_in() instead.

◆ linphone_core_leave_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_leave_conference ( LinphoneCore core)

Makes the local participant leave the running conference.

Parameters
coreLinphoneCore
Returns
0 if succeeded. Negative number if failed
Deprecated:
09/03/2021 Use linphone_conference_leave() instead.

◆ linphone_core_remove_from_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_remove_from_conference ( LinphoneCore core,
LinphoneCall call 
)

Removes a call from the conference.

Parameters
corethe LinphoneCore.
calla call that has been previously merged into the conference.

After removing the remote participant belonging to the supplied call, the call becomes a normal call in paused state. If one single remote participant is left alone together with the local user in the conference after the removal, then the conference is automatically transformed into a simple call in StreamsRunning state. The conference's resources are then automatically destroyed.

In other words, unless linphone_core_leave_conference() is explicitly called, the last remote participant of a conference is automatically put in a simple call in running state.

Returns
0 if successful, -1 otherwise.
Deprecated:
23/01/2025 Use linphone_conference_remove_participant_2() instead.

◆ linphone_core_search_conference()

LinphoneConference* linphone_core_search_conference ( const LinphoneCore core,
const LinphoneConferenceParams params,
const LinphoneAddress localAddr,
const LinphoneAddress remoteAddr,
const bctbx_list_t *  participants 
)

Find a conference.

Parameters
coreA LinphoneCore object
paramsThe conference parameters to match LinphoneConferenceParams or NULL
localAddrLinphoneAddress representing the local proxy configuration or NULL
remoteAddrLinphoneAddress to search for or NULL
participantsThe participants that must be present in the chat room to find
Returns
A pointer on LinphoneConference satisfying the non-NULL function arguments or NULL if none matches

◆ linphone_core_search_conference_2()

LinphoneConference* linphone_core_search_conference_2 ( const LinphoneCore core,
const LinphoneAddress conferenceAddr 
)

Finds a conference.

Parameters
coreA LinphoneCore object
conferenceAddrLinphoneAddress representing the conference address
Returns
A pointer on LinphoneConference whose conference address is the one provided as argument or NULL if none matches

◆ linphone_core_search_conference_by_identifier()

LinphoneConference* linphone_core_search_conference_by_identifier ( const LinphoneCore core,
const char *  identifier 
)

Find a conference by its identifier.

Parameters
coreA LinphoneCore object
identifierThe conference identifier
Returns
A matching conference or NULL if none matches.

◆ linphone_core_set_conference_availability_before_start()

void linphone_core_set_conference_availability_before_start ( LinphoneCore core,
long  seconds 
)

Set the conference availability before start.

It is the number of seconds clients can join the conference before its actual start time.

Parameters
corethe LinphoneCore.
secondsnumber of seconds the conference can be joined early. A negative value means always
Warning
This setting is only applicable to conference servers

◆ linphone_core_set_conference_cleanup_period()

void linphone_core_set_conference_cleanup_period ( LinphoneCore core,
long  seconds 
)

Set the conference cleanup timer period.

This timer helps managing the automatic deletion of ended conferences. In fact, under normal circumstances a conference is deleted only if it transition from an active to an inactive state after its end time. Nonetheless a side effect is that there may be a conference that never became active or it was terminate before its due date and time. This timer, if setup, therefore periodically looks for expired conference and cleans then up

Parameters
corethe LinphoneCore.
secondsperiod of the timer. A 0 or negative value stops the timer

◆ linphone_core_set_conference_expire_period()

void linphone_core_set_conference_expire_period ( LinphoneCore core,
long  seconds 
)

Set the conference expire period.

It is the number of seconds after the end time or the last participant joined - whichever is later - the conference cannot be joined anymore

Parameters
corethe LinphoneCore.
secondsnumber of seconds before the conference expires. A 0 or negative value means immediately after the end
Warning
This setting is only applicable to conference servers

◆ linphone_core_set_conference_max_thumbnails()

void linphone_core_set_conference_max_thumbnails ( LinphoneCore core,
int  max 
)

Sets the maximum number of thumbnails requested in the SDP during a conference call.

Parameters
corethe LinphoneCore.
maxthe maximum number of thumbnails requested in the SDP during a conference call

◆ linphone_core_set_conference_participant_list_type()

void linphone_core_set_conference_participant_list_type ( LinphoneCore core,
LinphoneConferenceParticipantListType  type 
)

Selects whether the default conference participant list is open or closed.

Parameters
coreA LinphoneCore object
typeA LinphoneConferenceParticipantListType participant list type

◆ linphone_core_set_default_conference_layout()

void linphone_core_set_default_conference_layout ( LinphoneCore core,
LinphoneConferenceLayout  value 
)

Set the default conference layout.

Parameters
corethe LinphoneCore.
valuelayout

◆ linphone_core_terminate_conference()

MS2_DEPRECATED LinphoneStatus linphone_core_terminate_conference ( LinphoneCore core)

Terminates the running conference.

If it is a local conference, all calls inside it will become back separate calls and will be put in #LinphoneCallPaused state. If it is a conference involving a focus server, all calls inside the conference will be terminated.

Parameters
coreLinphoneCore
Returns
0 if succeeded. Negative number if failed
Deprecated:
23/01/2025 Use linphone_conference_terminate() instead.

◆ linphone_participant_device_cbs_get_is_muted()

LinphoneParticipantDeviceCbsIsMutedCb linphone_participant_device_cbs_get_is_muted ( const LinphoneParticipantDeviceCbs cbs)

Get the is this participant device muted callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current is this participant device muted callback.

◆ linphone_participant_device_cbs_get_is_speaking_changed()

LinphoneParticipantDeviceCbsIsSpeakingChangedCb linphone_participant_device_cbs_get_is_speaking_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the is this participant device speaking changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current is this participant device speaking changed callback.

◆ linphone_participant_device_cbs_get_screen_sharing_changed()

LinphoneParticipantDeviceCbsScreenSharingChangedCb linphone_participant_device_cbs_get_screen_sharing_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the is this participant device screen sharing changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current is this participant device screen sharing callback.

◆ linphone_participant_device_cbs_get_state_changed()

LinphoneParticipantDeviceCbsStateChangedCb linphone_participant_device_cbs_get_state_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the participant device conference state changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current participant device conference state changed callback.

◆ linphone_participant_device_cbs_get_stream_availability_changed()

LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb linphone_participant_device_cbs_get_stream_availability_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the participant device stream availability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current participant device stream availability changed callback.

◆ linphone_participant_device_cbs_get_stream_capability_changed()

LinphoneParticipantDeviceCbsStreamCapabilityChangedCb linphone_participant_device_cbs_get_stream_capability_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the participant device stream capability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current participant device stream capability changed callback.

◆ linphone_participant_device_cbs_get_thumbnail_stream_availability_changed()

LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb linphone_participant_device_cbs_get_thumbnail_stream_availability_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the participant device thumbnail stream availability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current participant device thumbnail stream availability changed callback.

◆ linphone_participant_device_cbs_get_thumbnail_stream_capability_changed()

LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb linphone_participant_device_cbs_get_thumbnail_stream_capability_changed ( const LinphoneParticipantDeviceCbs cbs)

Get the participant device thumbnail stream capability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The current participant device thumbnail stream capability changed callback.

◆ linphone_participant_device_cbs_get_user_data()

void* linphone_participant_device_cbs_get_user_data ( const LinphoneParticipantDeviceCbs cbs)

Retrieve the user pointer associated with the participant device callbacks object.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The user pointer associated with the participant device callbacks object

◆ linphone_participant_device_cbs_get_video_display_error_occurred()

LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb linphone_participant_device_cbs_get_video_display_error_occurred ( const LinphoneParticipantDeviceCbs cbs)

Get the callback that will be used to notify that there are errors from the video rendering of the participant device.

Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object.
Returns
The failing video rendering callback.

◆ linphone_participant_device_cbs_new()

LinphoneParticipantDeviceCbs* linphone_participant_device_cbs_new ( void  )

Create a new participant device callbacks object.

Returns
The LinphoneParticipantDeviceCbs object.

◆ linphone_participant_device_cbs_ref()

LinphoneParticipantDeviceCbs* linphone_participant_device_cbs_ref ( LinphoneParticipantDeviceCbs cbs)

Acquire a reference to the participant device callbacks object.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
Returns
The same participant device callbacks object

◆ linphone_participant_device_cbs_set_is_muted()

void linphone_participant_device_cbs_set_is_muted ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsIsMutedCb  cb 
)

Set the is this participant device muted callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe is this participant device muted callback to be used.

◆ linphone_participant_device_cbs_set_is_speaking_changed()

void linphone_participant_device_cbs_set_is_speaking_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsIsSpeakingChangedCb  cb 
)

Set the is this participant device speaking changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe is this participant device speaking changed callback to be used.

◆ linphone_participant_device_cbs_set_screen_sharing_changed()

void linphone_participant_device_cbs_set_screen_sharing_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsScreenSharingChangedCb  cb 
)

Set the is this participant device screen sharing changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe is this participant device screen sharing callback to be used.

◆ linphone_participant_device_cbs_set_state_changed()

void linphone_participant_device_cbs_set_state_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsStateChangedCb  cb 
)

Set the participant device conference state changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe participant device conference state changed callback to be used.

◆ linphone_participant_device_cbs_set_stream_availability_changed()

void linphone_participant_device_cbs_set_stream_availability_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsStreamAvailabilityChangedCb  cb 
)

Set the participant device stream availability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe participant device stream availability changed callback to be used.

◆ linphone_participant_device_cbs_set_stream_capability_changed()

void linphone_participant_device_cbs_set_stream_capability_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsStreamCapabilityChangedCb  cb 
)

Set the participant device stream capability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe participant device stream capability changed callback to be used.

◆ linphone_participant_device_cbs_set_thumbnail_stream_availability_changed()

void linphone_participant_device_cbs_set_thumbnail_stream_availability_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsThumbnailStreamAvailabilityChangedCb  cb 
)

Set the participant device thumbnail stream availability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe participant device thumbnail stream availability changed callback to be used.

◆ linphone_participant_device_cbs_set_thumbnail_stream_capability_changed()

void linphone_participant_device_cbs_set_thumbnail_stream_capability_changed ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsThumbnailStreamCapabilityChangedCb  cb 
)

Set the participant device thumbnail stream capability changed callback.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]cbThe participant device thumbnail stream capability changed callback to be used.

◆ linphone_participant_device_cbs_set_user_data()

void linphone_participant_device_cbs_set_user_data ( LinphoneParticipantDeviceCbs cbs,
void *  ud 
)

Assign a user pointer to the participant device callbacks object.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object
[in]udThe user pointer to associate with the participant device callbacks object

◆ linphone_participant_device_cbs_set_video_display_error_occurred()

void linphone_participant_device_cbs_set_video_display_error_occurred ( LinphoneParticipantDeviceCbs cbs,
LinphoneParticipantDeviceCbsVideoDisplayErrorOccurredCb  cb 
)

Set the callback that will be used to notify that there are errors from the video rendering of the participant device.

Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.

Parameters
[in]cbsThe LinphoneCallCbs object.
[in]cbThe failing video rendering callback to be used.

◆ linphone_participant_device_cbs_unref()

void linphone_participant_device_cbs_unref ( LinphoneParticipantDeviceCbs cbs)

Release reference to the participant device callbacks object.

Parameters
[in]cbsThe LinphoneParticipantDeviceCbs object

◆ linphone_participant_info_add_parameter()

void linphone_participant_info_add_parameter ( LinphoneParticipantInfo participant_info,
const char *  name,
const char *  value 
)

Set the a custom parameter to object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
namethe name of the parameter.
valuethe value of the parameter.

◆ linphone_participant_info_clone()

LinphoneParticipantInfo* linphone_participant_info_clone ( const LinphoneParticipantInfo participant_info)

Clone an object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
Returns
the cloned LinphoneParticipantInfo object.

◆ linphone_participant_info_get_address()

const LinphoneAddress* linphone_participant_info_get_address ( const LinphoneParticipantInfo participant_info)

Get the address of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
Returns
the LinphoneAddress of the LinphoneParticipantInfo object.

◆ linphone_participant_info_get_ccmp_uri()

const char* linphone_participant_info_get_ccmp_uri ( const LinphoneParticipantInfo participant_info)

Get the CCMP uri of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
Returns
the CCMP uri of the LinphoneParticipantInfo or NULL.

◆ linphone_participant_info_get_parameter_value()

const char* linphone_participant_info_get_parameter_value ( const LinphoneParticipantInfo participant_info,
const char *  name 
)

Get the value of a custom parameter of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
namethe name of the parameter.
Returns
value the value of the parameter.

◆ linphone_participant_info_get_role()

LinphoneParticipantRole linphone_participant_info_get_role ( const LinphoneParticipantInfo participant_info)

Get the role of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
Returns
the LinphoneParticipantRole of the LinphoneParticipantInfo object.

◆ linphone_participant_info_has_parameter()

bool_t linphone_participant_info_has_parameter ( const LinphoneParticipantInfo participant_info,
const char *  name 
)

Find whether a LinphoneParticipantInfo has a parameter.

Parameters
participant_infoThe LinphoneParticipantInfo object.
namethe name of the parameter.
Returns
TRUE if the parameter is present, FALSE otherwise

◆ linphone_participant_info_new()

LinphoneParticipantInfo* linphone_participant_info_new ( const LinphoneAddress address)

Create a new LinphoneParticipantInfo object.

Returns
The newly created LinphoneParticipantInfo object.

◆ linphone_participant_info_ref()

LinphoneParticipantInfo* linphone_participant_info_ref ( LinphoneParticipantInfo participant_info)

Take a reference on a LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
Returns
the same LinphoneParticipantInfo object.

◆ linphone_participant_info_remove_parameter()

void linphone_participant_info_remove_parameter ( LinphoneParticipantInfo participant_info,
const char *  name 
)

Find the value of a custom parameter of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
namethe name of the parameter.

◆ linphone_participant_info_set_role()

void linphone_participant_info_set_role ( LinphoneParticipantInfo participant_info,
LinphoneParticipantRole  role 
)

Set the role of the object LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.
rolethe LinphoneParticipantRole of the LinphoneParticipantInfo object.

◆ linphone_participant_info_unref()

void linphone_participant_info_unref ( LinphoneParticipantInfo participant_info)

Release a LinphoneParticipantInfo.

Parameters
participant_infoThe LinphoneParticipantInfo object.