Liblinphone  4.5.0
Public Member Functions | List of all members
linphone::ConferenceParams Class Reference

TODO. More...

#include <conference_params.hh>

Inheritance diagram for linphone::ConferenceParams:

Public Member Functions

 ConferenceParams (void *ptr, bool takeRef=true)
 
LINPHONECXX_PUBLIC _LinphoneConferenceParams * cPtr ()
 
LINPHONECXX_PUBLIC bool localParticipantEnabled () const
 Returns whether local participant has to enter the conference. More...
 
LINPHONECXX_PUBLIC void enableLocalParticipant (bool enable)
 Enable local participant to enter the conference. More...
 
LINPHONECXX_PUBLIC bool videoEnabled () const
 Check whether video will be enable at conference starting. More...
 
LINPHONECXX_PUBLIC void enableVideo (bool enable)
 Enable video when starting a conference. More...
 
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ConferenceParamsclone () const
 Clone a ConferenceParams. More...
 

Detailed Description

TODO.

Member Function Documentation

◆ clone()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceParams> linphone::ConferenceParams::clone ( ) const

Clone a ConferenceParams.

Returns
An allocated ConferenceParams with the same parameters than params

◆ enableLocalParticipant()

LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableLocalParticipant ( bool  enable)

Enable local participant to enter the conference.

The local participant is the one driving the local Core. 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
enabletrue if local participant is automatically added to the conference, false otherwise

◆ enableVideo()

LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableVideo ( bool  enable)

Enable video when starting a conference.

Parameters
enableIf true, video will be enabled during conference

◆ localParticipantEnabled()

LINPHONECXX_PUBLIC bool linphone::ConferenceParams::localParticipantEnabled ( ) const

Returns whether local participant has to enter the conference.

Returns
true if local participant is by default part of the conference, false otherwise

◆ videoEnabled()

LINPHONECXX_PUBLIC bool linphone::ConferenceParams::videoEnabled ( ) const

Check whether video will be enable at conference starting.

Returns
true if the video will be enable at conference starting, false otherwise

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