Creates and manages conferences on a conferenceing service, and send conference invitations to notify participants. More...

#include <conference_scheduler.hh>

Inheritance diagram for linphone::ConferenceScheduler:

Public Types
enum	Type { Type::SIP = 0, Type::DB = 1, Type::CCMP = 2 }
	Type is used to know which conference scheduler type the core is using More...

enum	State { State::Idle = 0, State::Error = 1, State::AllocationPending = 2, State::Ready = 3, State::Updating = 4 }
	Describes conference scheduler possible states. More...

Public Member Functions
LINPHONECXX_PUBLIC	ConferenceScheduler (void *ptr, bool takeRef=true)

LINPHONECXX_PUBLIC _LinphoneConferenceScheduler *	cPtr ()

LINPHONECXX_PUBLIC void	addListener (const std::shared_ptr< ConferenceSchedulerListener > &listener)
	Add an application listener to the ConferenceScheduler instance. More...

LINPHONECXX_PUBLIC void	removeListener (const std::shared_ptr< ConferenceSchedulerListener > &listener)
	Remove a previously added listener from the ConferenceScheduler instance. More...

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Account >	getAccount () const
	Get the Account that is used for the conference scheduler. More...

LINPHONECXX_PUBLIC void	setAccount (const std::shared_ptr< linphone::Account > &account)
	Set the Account to use for the conference scheduler. More...

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Core >	getCore () const
	Gets the Core from a ConferenceScheduler object. More...

LINPHONECXX_PUBLIC std::shared_ptr< const linphone::ConferenceInfo >	getInfo () const
	Returns the ConferenceInfo currently set in this scheduler. More...

LINPHONECXX_PUBLIC void	setInfo (const std::shared_ptr< linphone::ConferenceInfo > &conferenceInfo)
	Sets the ConferenceInfo to use to create/update the conference, which will be done right away. More...

LINPHONECXX_PUBLIC void	cancelConference (const std::shared_ptr< linphone::ConferenceInfo > &conferenceInfo)
	Cancel the conference linked to the ConferenceInfo provided as argument. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	sendInvitations (const std::shared_ptr< linphone::ChatRoomParams > &chatRoomParams)
	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...

LINPHONECXX_PUBLIC void	sendInvitations (const std::shared_ptr< linphone::ConferenceParams > &conferenceParams)
	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...

Detailed Description

Creates and manages conferences on a conferenceing service, and send conference invitations to notify participants.

Member Enumeration Documentation

◆ State

enum linphone::ConferenceScheduler::State

strong

Describes conference scheduler possible states.

Enumerator
Idle	Default state of a freshly created ConferenceScheduler.
Error	An error has happened during conference creation.
AllocationPending	Conference creation is in progress.
Ready	Confererence has been created.
Updating	Conference has been updated.

◆ Type

enum linphone::ConferenceScheduler::Type

strong

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

Enumerator
SIP	SIP conference scheduler type.
DB	Database conference scheduler type.
CCMP	CCMP conference scheduler type.

Member Function Documentation

◆ addListener()

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::addListener ( const std::shared_ptr< ConferenceSchedulerListener > & listener )

Add an application listener to the ConferenceScheduler instance.

Parameters

listener the application listener

◆ cancelConference()

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::cancelConference ( const std::shared_ptr< linphone::ConferenceInfo > & conferenceInfo )

Cancel the conference linked to the ConferenceInfo provided as argument.

Parameters

conferenceInfo the ConferenceInfo object to linked to the conference to cancel.

◆ getAccount()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::Account> linphone::ConferenceScheduler::getAccount ( ) const

Get the Account that is used for the conference scheduler.

Returns: The selected Account for the call, or nullptr if none has been selected.

◆ getCore()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::Core> linphone::ConferenceScheduler::getCore ( ) const

Gets the Core from a ConferenceScheduler object.

Returns: the Core object.

◆ getInfo()

LINPHONECXX_PUBLIC std::shared_ptr<const linphone::ConferenceInfo> linphone::ConferenceScheduler::getInfo ( ) const

Returns the ConferenceInfo currently set in this scheduler.

Returns: the currently configured ConferenceInfo or nullptr if none is set.

◆ removeListener()

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::removeListener ( const std::shared_ptr< ConferenceSchedulerListener > & listener )

Remove a previously added listener from the ConferenceScheduler instance.

Parameters

listener the application listener

◆ sendInvitations() [1/2]

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ConferenceScheduler::sendInvitations ( const std::shared_ptr< linphone::ChatRoomParams > & chatRoomParams )

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

chatRoomParams the ChatRoomParams object to use to use/create the ChatRoom that will be used to send the invite.

Deprecated:: 28/08/2024 Use sendInvitations() instead.

◆ sendInvitations() [2/2]

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::sendInvitations ( const std::shared_ptr< linphone::ConferenceParams > & conferenceParams )

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

conferenceParams the ConferenceParams object to use to use/create the ChatRoom that will be used to send the invite.

◆ setAccount()

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::setAccount ( const std::shared_ptr< linphone::Account > & account )

Set the Account to use for the conference scheduler.

Parameters

account The Account to use, or nullptr if none has been selected. The LinphoneConferenceScheduler keeps a reference to it and removes the previous one, if any.

◆ setInfo()

LINPHONECXX_PUBLIC void linphone::ConferenceScheduler::setInfo ( const std::shared_ptr< linphone::ConferenceInfo > & conferenceInfo )

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

Parameters

conferenceInfo the ConferenceInfo object to use to start creating/updating the client conference.

The documentation for this class was generated from the following file:

conference_scheduler.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ State

◆ Type

Member Function Documentation

◆ addListener()

◆ cancelConference()

◆ getAccount()

◆ getCore()

◆ getInfo()

◆ removeListener()

◆ sendInvitations() [1/2]

◆ sendInvitations() [2/2]

◆ setAccount()

◆ setInfo()