Making a audio/video conferences. More...

Typedefs
typedef void(*	LinphoneConferenceCbsParticipantAddedCb) (LinphoneConference conference, const 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(*	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, const LinphoneParticipantDevice participant_device)
	Callback used to notify a conference that a participant has been added. More...

typedef void(*	LinphoneConferenceCbsParticipantDeviceRemovedCb) (LinphoneConference conference, const LinphoneParticipantDevice participant_device)
	Callback used to notify a conference that a participant has been removed. 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(*	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(*	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(*	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(*	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 conference.

typedef struct _LinphoneConferenceScheduler	LinphoneConferenceScheduler
	Object used to create remote conferences and send ICS 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 _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	_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 }
	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
LinphoneConference *	linphone_core_create_conference_with_params (LinphoneCore core, const LinphoneConferenceParams params)
	Create a conference. More...

LinphoneConferenceScheduler *	linphone_core_create_conference_scheduler (LinphoneCore *core)
	Create a conference scheduler that can be used to create remote conferences for now or later and then send conference info as an ICS through chat. More...

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. More...

LinphoneConference *	linphone_core_search_conference_2 (const LinphoneCore core, const LinphoneAddress conferenceAddr)
	Find a conference. More...

LinphoneStatus	linphone_core_add_to_conference (LinphoneCore core, LinphoneCall call)
	Add a participant to the conference. More...

LinphoneStatus	linphone_core_add_all_to_conference (LinphoneCore *core)
	Add all current calls into the conference. More...

LinphoneStatus	linphone_core_remove_from_conference (LinphoneCore core, LinphoneCall call)
	Remove a call from the conference. More...

bool_t	linphone_core_is_in_conference (const LinphoneCore *core)
	Indicates whether the local participant is part of a conference. More...

LinphoneStatus	linphone_core_enter_conference (LinphoneCore *core)
	Join the local participant to the running conference. More...

LinphoneStatus	linphone_core_leave_conference (LinphoneCore *core)
	Make the local participant leave the running conference. More...

float	linphone_core_get_conference_local_input_volume (LinphoneCore *core)
	Get the set input volume of the local participant. More...

LinphoneStatus	linphone_core_terminate_conference (LinphoneCore *core)
	Terminate the running conference. More...

LinphoneConferenceParams *	linphone_core_create_conference_params_2 (LinphoneCore lc, LinphoneConference conference)
	Create some default conference parameters for instanciating a conference with linphone_core_create_conference_with_params(). More...

LinphoneStatus	linphone_core_start_conference_recording (LinphoneCore core, const char path)
	Start recording the running conference. More...

LinphoneStatus	linphone_core_stop_conference_recording (LinphoneCore *core)
	Stop recording the running conference. More...

void	linphone_core_enable_conference_server (LinphoneCore *core, bool_t enable)
	Enable the conference server feature. 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)

bool_t	linphone_core_fec_enabled (const LinphoneCore *core)

void	linphone_core_set_conference_participant_list_type (LinphoneCore *lc, LinphoneConferenceParticipantListType type)
	Select whether the default conference participant list is open or closed. More...

LinphoneConferenceParticipantListType	linphone_core_get_conference_participant_list_type (const LinphoneCore *lc)
	Tells whether the default conference participant list is open or closed. More...

void	linphone_core_set_default_conference_layout (LinphoneCore *lc, LinphoneConferenceLayout value)
	Set the default conference layout. More...

LinphoneConferenceLayout	linphone_core_get_default_conference_layout (const LinphoneCore *lc)
	Gets the default conference layout core the linphone core. More...

LinphoneConferenceInfo *	linphone_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_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...

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...

LinphoneConferenceCbs *	linphone_conference_get_current_callbacks (const LinphoneConference *conference)
	Sets the current LinphoneConferenceCbs. More...

LinphoneCore *	linphone_conference_get_core (const LinphoneConference *conference)
	Returns core for a LinphoneConference. More...

const LinphoneAddress *	linphone_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...

void	linphone_conference_params_set_conference_factory_address (LinphoneConferenceParams params, const LinphoneAddress address)
	Set the conference factory address of the conference. More...

const LinphoneAddress *	linphone_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 (LinphoneConferenceParams params, const char description)
	Set the description of the conference. More...

const char *	linphone_conference_params_get_description (const LinphoneConferenceParams *params)
	Get conference description. More...

void	linphone_conference_params_set_subject (LinphoneConferenceParams params, const char subject)
	Set the subject of the conference. More...

const char *	linphone_conference_params_get_subject (const LinphoneConferenceParams *params)
	Get conference subject. More...

void	linphone_conference_params_set_start_time (LinphoneConferenceParams *params, time_t start)
	Set the conference start time. More...

time_t	linphone_conference_params_get_start_time (const LinphoneConferenceParams *params)
	Get the start time of the conference. More...

void	linphone_conference_params_set_end_time (LinphoneConferenceParams *params, time_t end)
	Set the conference end time. More...

time_t	linphone_conference_params_get_end_time (const LinphoneConferenceParams *params)
	Get the end time of the conference. 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...

LinphoneConferenceState	linphone_conference_get_state (const LinphoneConference *conference)
	Get the current state of the conference. More...

LinphoneParticipantDevice *	linphone_conference_get_active_speaker_participant_device (const LinphoneConference *conference)
	Get the currently active speaker participant device. More...

LinphoneConferenceCbs *	linphone_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...

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...

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...

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...

LinphoneConferenceInfo *	linphone_conference_info_new (void)
	Create a new LinphoneConferenceInfo object. More...

LinphoneConferenceInfo *	linphone_conference_info_ref (LinphoneConferenceInfo *conference_info)
	Take a reference on a LinphoneConferenceInfo. More...

LinphoneConferenceInfo *	linphone_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 LinphoneAddress *	linphone_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 LinphoneParticipantInfo *	linphone_conference_info_find_participant (LinphoneConferenceInfo conference_info, const LinphoneAddress participant)
	Find a participant information in the conference information. More...

const LinphoneAddress *	linphone_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_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...

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...

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...

LinphoneConferenceScheduler *	linphone_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...

LinphoneCore *	linphone_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...

LinphoneAccount *	linphone_conference_scheduler_get_account (const LinphoneConferenceScheduler *conference_scheduler)
	Get the LinphoneAccount that is used for the conference scheduler. More...

const LinphoneConferenceInfo *	linphone_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...

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_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...

LinphoneConferenceSchedulerCbs *	linphone_conference_scheduler_get_current_callbacks (const LinphoneConferenceScheduler *conference_scheduler)
	Gets the current LinphoneConferenceSchedulerCbs. More...

LinphoneConferenceSchedulerCbs *	linphone_conference_scheduler_cbs_new (void)
	Create a new conference scheduler callbacks object. More...

LinphoneConferenceSchedulerCbs *	linphone_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...

LinphoneParticipantInfo *	linphone_participant_info_new (const LinphoneAddress *address)
	Create a new LinphoneParticipantInfo object. More...

LinphoneParticipantInfo *	linphone_participant_info_ref (LinphoneParticipantInfo *participant_info)
	Take a reference on a LinphoneParticipantInfo. More...

LinphoneParticipantInfo *	linphone_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 LinphoneAddress *	linphone_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...

LinphoneParticipantDeviceCbs *	linphone_participant_device_cbs_new (void)
	Create a new participant device callbacks object. More...

LinphoneParticipantDeviceCbs *	linphone_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...

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...

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...

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. As of now, each LinphoneCore can host only 1 conference but it can be part of many conferences as a remote participant. To find a conference among those a core is part of, you can call linphone_core_search_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]	conference	LinphoneConference object
[in]	participant_device	the participant device currently displayed as active speaker

◆ 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]	conference	LinphoneConference object
[in]	audio_device	audio 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] conference LinphoneConference object

◆ LinphoneConferenceCbsParticipantAddedCb

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

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

Parameters

[in]	conference	LinphoneConference object
[in]	participant	LinphoneParticipant 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]	conference	LinphoneConference object
[in]	participant	LinphoneParticipant whose admin status has changed

◆ LinphoneConferenceCbsParticipantDeviceAddedCb

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

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

Parameters

[in]	conference	LinphoneConference object
[in]	participant_device	LinphoneParticipantDevice 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]	conference	LinphoneConference object
[in]	participant_device	the participant device
[in]	is_muted	TRUE 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]	conference	LinphoneConference object
[in]	participant_device	the participant device
[in]	is_speaking	TRUE if is speaking, FALSE otherwise

◆ 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]	conference	LinphoneConference object
[in]	device	LinphoneParticipantDevice 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]	conference	LinphoneConference object
[in]	device	LinphoneParticipantDevice 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 has been removed.

Parameters

[in]	conference	LinphoneConference object
[in]	participant_device	LinphoneParticipantDevice that has been removed to the conference

◆ 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]	conference	LinphoneConference object
[in]	device	LinphoneParticipantDevice who change state
[in]	state	new 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]	conference	LinphoneConference object
[in]	participant	LinphoneParticipant 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]	conference	LinphoneConference object
[in]	participant	LinphoneParticipant whose role has changed

◆ LinphoneConferenceCbsStateChangedCb

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

Callback used to notify a conference state has changed.

Parameters

[in]	conference	LinphoneConference object
[in]	newState	The 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]	conference	LinphoneConference object
[in]	subject	subject of the conference

◆ LinphoneConferenceJoiningMode

typedef enum _LinphoneConferenceJoiningMode 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

typedef enum _LinphoneConferenceParticipantListType 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_scheduler	LinphoneConferenceScheduler object whose state has changed.
failed_invitations	a 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_scheduler	LinphoneConferenceScheduler object whose state has changed.
state	The current LinphoneConferenceSchedulerState.

◆ LinphoneConferenceSchedulerState

typedef enum _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_device	LinphoneParticipantDevice object
[in]	is_muted	is 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_device	LinphoneParticipantDevice object
[in]	is_speaking	is this participant device speaking

◆ LinphoneParticipantDeviceCbsStateChangedCb

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

Callback used to notify that participant device changed state.

Parameters

[in] participant_device LinphoneParticipantDevice object

◆ 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_device	LinphoneParticipantDevice object
[in]	direction	participant device's video direction

◆ 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_device	LinphoneParticipantDevice object
[in]	direction	participant device's audio 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_device	LinphoneParticipantDevice object
[in]	error_code	the 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

enum _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

enum _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

enum _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

enum _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

enum _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.

◆ _LinphoneConferenceSecurityLevel

enum _LinphoneConferenceSecurityLevel

Conference minimum security level.

Enumerator
LinphoneConferenceSecurityLevelNone	No security.
LinphoneConferenceSecurityLevelPointToPoint	Point-to-point encryption.
LinphoneConferenceSecurityLevelEndToEnd	End-to-end encryption.

◆ _LinphoneConferenceState

enum _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

enum _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

enum _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

enum _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.

◆ _LinphoneParticipantRole

enum _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_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

conference	LinphoneConference object.
cbs	A LinphoneConferenceCbs object holding the callbacks you need. A reference is taken by the LinphoneConference until you invoke linphone_conference_remove_callbacks().

◆ 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