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

Object defining parameters for a Conference. 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 audioEnabled () const
 Check whether audio capabilities are enabled. More...
 
LINPHONECXX_PUBLIC void enableAudio (bool enable)
 Enable audio capabilities. More...
 
LINPHONECXX_PUBLIC bool chatEnabled () const
 Check whether chat capabilities are enabled. More...
 
LINPHONECXX_PUBLIC void enableChat (bool enable)
 Enable chat capabilities. More...
 
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool isAudioEnabled () const
 Check whether audio capabilities are enabled. More...
 
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool isChatEnabled () const
 Check whether chat capabilities are enabled. More...
 
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool isLocalParticipantEnabled () const
 Returns whether local participant has to enter the conference. More...
 
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool isOneParticipantConferenceEnabled () const
 Returns whether conference can have only one participant. More...
 
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool isVideoEnabled () const
 Check whether video capabilities are enabled. More...
 
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 oneParticipantConferenceEnabled () const
 Returns whether conference can have only one participant. More...
 
LINPHONECXX_PUBLIC void enableOneParticipantConference (bool enable)
 Enable conference with one participant. More...
 
LINPHONECXX_PUBLIC bool videoEnabled () const
 Check whether video capabilities are enabled. More...
 
LINPHONECXX_PUBLIC void enableVideo (bool enable)
 Enable video capabilities. More...
 
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ConferenceParamsclone () const
 Clone a ConferenceParams. More...
 

Detailed Description

Object defining parameters for a Conference.

Can be created by calling function Core::createConferenceParams().

Member Function Documentation

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

Check whether audio capabilities are enabled.

Returns
true if the conference supports audio capabilities, false otherwise
LINPHONECXX_PUBLIC bool linphone::ConferenceParams::chatEnabled ( ) const

Check whether chat capabilities are enabled.

Returns
true if the conference supports chat capabilities, false otherwise
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceParams> linphone::ConferenceParams::clone ( ) const

Clone a ConferenceParams.

Returns
An allocated ConferenceParams with the same parameters than params
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableAudio ( bool  enable)

Enable audio capabilities.

Parameters
enableIf true, audio will be enabled during conference
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableChat ( bool  enable)

Enable chat capabilities.

Parameters
enableIf true, chat is enabled during conference
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
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableOneParticipantConference ( bool  enable)

Enable conference with one participant.

Parameters
enabletrue if conference can have only one participant, false otherwise
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableVideo ( bool  enable)

Enable video capabilities.

Parameters
enableIf true, video will be enabled during conference
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isAudioEnabled ( ) const

Check whether audio capabilities are enabled.

Returns
true if the conference supports audio capabilities, false otherwise
Deprecated:
16/12/2021 Use audioEnabled() instead.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isChatEnabled ( ) const

Check whether chat capabilities are enabled.

Returns
true if the conference supports chat capabilities, false otherwise
Deprecated:
16/12/2021 Use chatEnabled() instead.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isLocalParticipantEnabled ( ) const

Returns whether local participant has to enter the conference.

Returns
true if local participant is by default part of the conference, false otherwise
Deprecated:
16/12/2021 Use localParticipantEnabled() instead.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isOneParticipantConferenceEnabled ( ) const

Returns whether conference can have only one participant.

Returns
true if the conference can have only one participant, false otherwise
Deprecated:
16/12/2021 Use oneParticipantConferenceEnabled() instead.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isVideoEnabled ( ) const

Check whether video capabilities are enabled.

Returns
true if the conference supports video capabilities, false otherwise
Deprecated:
16/12/2021 Use videoEnabled() instead.
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
LINPHONECXX_PUBLIC bool linphone::ConferenceParams::oneParticipantConferenceEnabled ( ) const

Returns whether conference can have only one participant.

Returns
true if the conference can have only one participant, false otherwise
LINPHONECXX_PUBLIC bool linphone::ConferenceParams::videoEnabled ( ) const

Check whether video capabilities are enabled.

Returns
true if the conference supports video capabilities, false otherwise

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