#include <conference.hh>

Inheritance diagram for linphone::Conference:

Public Types
enum	State { State::None, State::Instantiated, State::CreationPending, State::Created, State::CreationFailed, State::TerminationPending, State::Terminated, State::TerminationFailed, State::Deleted }
	State is used to indicate the current state of a conference. More...

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

LINPHONECXX_PUBLIC _LinphoneConference *	cPtr ()

LINPHONECXX_PUBLIC void	addListener (const std::shared_ptr< ConferenceListener > &listener)

LINPHONECXX_PUBLIC void	removeListener (const std::shared_ptr< ConferenceListener > &listener)

LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address >	getConferenceAddress () const
	Get the conference address of the conference. More...

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Core >	getCore () const
	Returns core for a Conference. More...

LINPHONECXX_PUBLIC std::shared_ptr< const linphone::ConferenceParams >	getCurrentParams () const
	Get current parameters of the conference. More...

LINPHONECXX_PUBLIC std::string	getId () const
	Get the conference id as string. More...

LINPHONECXX_PUBLIC void	setId (const std::string &conferenceId)
	Set the conference id as string. More...

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Participant >	getMe () const
	For a local audio video conference, this function returns the participant hosting the conference For a remote audio video conference, this function returns the focus of the conference. More...

LINPHONECXX_PUBLIC int	getParticipantCount () const
	Get number of participants. More...

LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::Participant > >	getParticipantList () const
	Get list of all participants of one conference. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::list< std::shared_ptr< linphone::Address > >	getParticipants () const
	Get URIs of all participants of one conference The returned bctbx_list_t contains URIs of all participant. More...

LINPHONECXX_PUBLIC std::string	getSubject () const
	Get the conference subject. More...

LINPHONECXX_PUBLIC void	setSubject (const std::string &subject)
	Set the conference subject. More...

LINPHONECXX_PUBLIC linphone::Status	addParticipant (const std::shared_ptr< linphone::Call > &call)
	Join an existing call to the conference. More...

LINPHONECXX_PUBLIC linphone::Status	addParticipant (const std::shared_ptr< const linphone::Address > &uri)
	Join a participant to the conference. More...

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Participant >	findParticipant (const std::shared_ptr< const linphone::Address > &uri)
	Find a participant from a conference. More...

LINPHONECXX_PUBLIC linphone::Status	inviteParticipants (const std::list< std::shared_ptr< linphone::Address >> &addresses, const std::shared_ptr< const linphone::CallParams > &params)
	Invite participants to the conference, by supplying a list of Address. More...

LINPHONECXX_PUBLIC void	oglRender ()
	Call generic OpenGL render for a given conference.

LINPHONECXX_PUBLIC void	previewOglRender ()
	Call generic OpenGL render preview for a given conference.

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status	removeParticipant (const std::shared_ptr< const linphone::Address > &uri)

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status	removeParticipant (const std::shared_ptr< linphone::Call > &call)

LINPHONECXX_PUBLIC linphone::Status	removeParticipant (const std::shared_ptr< linphone::Participant > &participant)

LINPHONECXX_PUBLIC int	terminate ()
	Terminates conference. More...

LINPHONECXX_PUBLIC int	updateParams (const std::shared_ptr< const linphone::ConferenceParams > &params)
	Update parameters of the conference. More...

Detailed Description

TODO.

Member Enumeration Documentation

◆ State

enum linphone::Conference::State

strong

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

Enumerator
None	Initial state.
Instantiated	Conference is now instantiated on local.
CreationPending	One creation request was sent to the server.
Created	Conference was created on the server.
CreationFailed	Conference creation failed.
TerminationPending	Wait for conference termination.
Terminated	Conference exists on server but not in local.
TerminationFailed	Conference termination failed.
Deleted	Conference was deleted on the server.

Member Function Documentation

◆ addParticipant() [1/2]

LINPHONECXX_PUBLIC linphone::Status linphone::Conference::addParticipant ( const std::shared_ptr< linphone::Call > & call )

Join an existing call to the conference.

Parameters

call	a Call that has to be added to the conference.

◆ addParticipant() [2/2]

LINPHONECXX_PUBLIC linphone::Status linphone::Conference::addParticipant ( const std::shared_ptr< const linphone::Address > & uri )

Join a participant to the conference.

Parameters

uri	a Address that has to be added to the conference.

◆ findParticipant()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::Participant> linphone::Conference::findParticipant ( const std::shared_ptr< const linphone::Address > & uri )

Find a participant from a conference.

Parameters

uri	SIP URI of the participant to search.

Returns: a pointer to the participant found or nullptr.

◆ getConferenceAddress()

LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::Conference::getConferenceAddress ( ) const

Get the conference address of the conference.

Returns: The conference address of the conference or nullptr if it is unknown.

◆ getCore()

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

Returns core for a Conference.

Returns: back pointer to Core object. Returns back pointer to Core object.

◆ getCurrentParams()

LINPHONECXX_PUBLIC std::shared_ptr<const linphone::ConferenceParams> linphone::Conference::getCurrentParams ( ) const

Get current parameters of the conference.

Returns: a ConferenceParams .

◆ getId()

LINPHONECXX_PUBLIC std::string linphone::Conference::getId ( ) const

Get the conference id as string.

Returns: the conference id

◆ getMe()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::Participant> linphone::Conference::getMe ( ) const

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

Returns: a Participant .

◆ getParticipantCount()

LINPHONECXX_PUBLIC int linphone::Conference::getParticipantCount ( ) const

Get number of participants.

Returns: the number of participants in a Conference

◆ getParticipantList()

LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::Participant> > linphone::Conference::getParticipantList ( ) const

Get list of all participants of one conference.

Returns: A list of participants.

◆ getParticipants()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::list<std::shared_ptr<linphone::Address> > linphone::Conference::getParticipants ( ) const

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

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

Returns: The list of the participants' address.

Deprecated:: 10/07/2020 Use getParticipantList() instead.

◆ getSubject()

LINPHONECXX_PUBLIC std::string linphone::Conference::getSubject ( ) const

Get the conference subject.

Returns: conference subject.

◆ inviteParticipants()

LINPHONECXX_PUBLIC linphone::Status linphone::Conference::inviteParticipants	(	const std::list< std::shared_ptr< linphone::Address >> &	addresses,
		const std::shared_ptr< const linphone::CallParams > &	params
	)

Invite participants to the conference, by supplying a list of Address.

Parameters

params CallParams to use for inviting the participants.

◆ removeParticipant() [1/3]

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status linphone::Conference::removeParticipant ( const std::shared_ptr< const linphone::Address > & uri )

Parameters

uri	URI of the participant to remove

Warning: The passed participant uri must be one of those returned by getParticipants()

Returns: 0 if succeeded, -1 if failed

Deprecated:: 10/07/2020 Use removeParticipant() instead.

◆ removeParticipant() [2/3]

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status linphone::Conference::removeParticipant ( const std::shared_ptr< linphone::Call > & call )

Parameters

call	call to remove

Returns: 0 if succeeded, -1 if failed

Deprecated:: 10/07/2020 Use removeParticipant() instead.

◆ removeParticipant() [3/3]

LINPHONECXX_PUBLIC linphone::Status linphone::Conference::removeParticipant ( const std::shared_ptr< linphone::Participant > & participant )

Parameters

participant participant to remove

Warning: The passed participant must be one of those returned by getParticipantList(); 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

◆ setId()

LINPHONECXX_PUBLIC void linphone::Conference::setId ( const std::string & conferenceId )

Set the conference id as string.

Parameters

conferenceId the conference id to set.

◆ setSubject()

LINPHONECXX_PUBLIC void linphone::Conference::setSubject ( const std::string & subject )

Set the conference subject.

Parameters

subject conference subject

◆ terminate()

LINPHONECXX_PUBLIC int linphone::Conference::terminate ( )

Terminates conference.

Returns: 0 if the termination is successful, -1 otherwise.

◆ updateParams()

LINPHONECXX_PUBLIC int linphone::Conference::updateParams ( const std::shared_ptr< const linphone::ConferenceParams > & params )

Update parameters of the conference.

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

Parameters

params the new parameters to apply.

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

conference.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ addParticipant() [1/2]

◆ addParticipant() [2/2]

◆ findParticipant()

◆ getConferenceAddress()

◆ getCore()

◆ getCurrentParams()

◆ getId()

◆ getMe()

◆ getParticipantCount()

◆ getParticipantList()

◆ getParticipants()

◆ getSubject()

◆ inviteParticipants()

◆ removeParticipant() [1/3]

◆ removeParticipant() [2/3]

◆ removeParticipant() [3/3]

◆ setId()

◆ setSubject()

◆ terminate()

◆ updateParams()