Object defining parameters for a Conference.
More...
#include <conference_params.hh>
Object defining parameters for a Conference.
Can be created by calling function Core::createConferenceParams().
◆ audioEnabled()
LINPHONECXX_PUBLIC bool linphone::ConferenceParams::audioEnabled |
( |
| ) |
const |
Check whether audio capabilities are enabled.
- Returns
- true if the conference supports audio capabilities, false otherwise
◆ chatEnabled()
LINPHONECXX_PUBLIC bool linphone::ConferenceParams::chatEnabled |
( |
| ) |
const |
Check whether chat capabilities are enabled.
- Returns
- true if the conference supports chat capabilities, false otherwise
◆ clone()
◆ enableAudio()
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableAudio |
( |
bool |
enable | ) |
|
Enable audio capabilities.
- Parameters
-
enable | If true, audio will be enabled during conference |
◆ enableChat()
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableChat |
( |
bool |
enable | ) |
|
Enable chat capabilities.
- Parameters
-
enable | If true, chat is enabled during conference |
◆ 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
-
enable | true if local participant is automatically added to the conference, false otherwise |
◆ enableOneParticipantConference()
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableOneParticipantConference |
( |
bool |
enable | ) |
|
Enable conference with one participant.
- Parameters
-
enable | true if conference can have only one participant, false otherwise |
◆ enableVideo()
LINPHONECXX_PUBLIC void linphone::ConferenceParams::enableVideo |
( |
bool |
enable | ) |
|
Enable video capabilities.
- Parameters
-
enable | If true, video will be enabled during conference |
◆ isAudioEnabled()
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.
◆ isChatEnabled()
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.
◆ isLocalParticipantEnabled()
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.
◆ isOneParticipantConferenceEnabled()
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ConferenceParams::isOneParticipantConferenceEnabled |
( |
| ) |
const |
◆ isVideoEnabled()
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.
◆ 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
◆ oneParticipantConferenceEnabled()
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
◆ videoEnabled()
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: