Package org.linphone.core
Interface ConferenceParams
public interface ConferenceParams
Object defining parameters for a
Can be created by calling function
Conference
. Can be created by calling function
Core.createConferenceParams(org.linphone.core.Conference)
. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone aConferenceParams
.Returns the account for the conference.Get the conference factory address of the conference that has been set.Get conference description.long
Get the end time of the conference.long
Gets the native pointer used by this class to make native method calls.Get the participant list type.Deprecated.Retrieve the desired security level of the conference.long
Get the start time of the conference.Get conference subject.Gets the object stored in this object user's databoolean
Check whether audio capabilities are enabled.boolean
Check whether chat capabilities are enabled.boolean
isHidden()
Get the value of the hidden flag.boolean
Returns whether local participant has to enter the conference.boolean
Returns whether conference can have only one participant.boolean
Check whether video capabilities are enabled.void
setAudioEnabled
(boolean enable) Enable audio capabilities.void
setChatEnabled
(boolean enable) Enable chat capabilities.void
setConferenceFactoryAddress
(Address address) Set the conference factory address of the conference.void
setDescription
(String description) Set the description of the conference.void
setEndTime
(long end) Set the conference end time.void
setHidden
(boolean hidden) Set the conference as hidden.void
setLocalParticipantEnabled
(boolean enable) Enable local participant to enter the conference.void
setOneParticipantConferenceEnabled
(boolean enable) Enable conference with one participant.void
Set the participant list type.void
setSecurityLevel
(Conference.SecurityLevel securityLevel) Set the desired security level of the conference.void
setStartTime
(long start) Set the conference start time.void
setSubject
(String subject) Set the subject of the conference.void
setUserData
(Object data) Sets the object to store in this object user's datavoid
setVideoEnabled
(boolean enable) Enable video capabilities.toString()
-
Method Details
-
getAccount
Returns the account for the conference.
- Returns:
- a pointer to the account or null if it is not set.
-
isAudioEnabled
boolean isAudioEnabled()Check whether audio capabilities are enabled.
- Returns:
- true if the conference supports audio capabilities, false otherwise
-
setAudioEnabled
void setAudioEnabled(boolean enable) Enable audio capabilities.
- Parameters:
enable
- If true, audio will be enabled during conference
-
isChatEnabled
boolean isChatEnabled()Check whether chat capabilities are enabled.
- Returns:
- true if the conference supports chat capabilities, false otherwise
-
setChatEnabled
void setChatEnabled(boolean enable) Enable chat capabilities.
- Parameters:
enable
- If true, chat is enabled during conference
-
getConferenceFactoryAddress
Get the conference factory address of the conference that has been set.
- Returns:
- the factory address conference description.
-
setConferenceFactoryAddress
Set the conference factory address of the conference.
By default when creating a new conference, the factory address will come from
the current proxy configuration. If null then the conference will be local else
it will be a remote conference.- Parameters:
address
- the conference factory address.
-
getDescription
Get conference description.
- Returns:
- the conference description.
-
setDescription
Set the description of the conference.
- Parameters:
description
- the conference description.
-
getEndTime
long getEndTime()Get the end time of the conference.
- Returns:
- end time of a conference as time_t type or 0 for open end of a
conference. For UNIX based systems it is the number of seconds since 00:00hours
of the 1st of January 1970
-
setEndTime
void setEndTime(long end) Set the conference end time.
- Parameters:
end
- the conference end time as the number of seconds between the desired
end time and the 1st of January 1970. In order to program an undefined end of a
conference, then program the end time to 0
-
setHidden
void setHidden(boolean hidden) Set the conference as hidden.
This means that the contact address will not have any conference releated
attribute such as isfocus, the conference ID and the admin status.- Parameters:
hidden
- Boolean that states whether the conference is hidden or not
-
isHidden
boolean isHidden()Get the value of the hidden flag.
- Returns:
- whether the conference is hidden or not
-
isLocalParticipantEnabled
boolean isLocalParticipantEnabled()Returns whether local participant has to enter the conference.
- Returns:
- true if local participant is by default part of the conference, false
otherwise
-
setLocalParticipantEnabled
void setLocalParticipantEnabled(boolean enable) Enable local participant to enter the conference.
The local participant is the one driving the localCore
. 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
-
isOneParticipantConferenceEnabled
boolean isOneParticipantConferenceEnabled()Returns whether conference can have only one participant.
- Returns:
- true if the conference can have only one participant, false otherwise
-
setOneParticipantConferenceEnabled
void setOneParticipantConferenceEnabled(boolean enable) Enable conference with one participant.
- Parameters:
enable
- true if conference can have only one participant, false otherwise
-
getParticipantListType
Conference.ParticipantListType getParticipantListType()Get the participant list type.
- Returns:
- participant list type
Conference#ParticipantListType
.
-
setParticipantListType
Set the participant list type.
- Parameters:
type
- Participant list typeConference#ParticipantListType
. This
allows to restrict the access to the conference to a selected set of
participants
-
getProxyCfg
Deprecated.11/01/2022 UsegetAccount()
instead.Returns the proxy configuration for the conference.
- Returns:
- a pointer to the proxy configuration or null if it is not set.
-
getSecurityLevel
Conference.SecurityLevel getSecurityLevel()Retrieve the desired security level of the conference.
- Returns:
- The desired security level of the conference.
-
setSecurityLevel
Set the desired security level of the conference.
- Parameters:
securityLevel
- The desired security level of the conference.
-
getStartTime
long getStartTime()Get the start time of the conference.
- Returns:
- start time of a conference as time_t type or 0 for immediate start of a
conference. For UNIX based systems it is the number of seconds since 00:00hours
of the 1st of January 1970
-
setStartTime
void setStartTime(long start) Set the conference start time.
- Parameters:
start
- the conference start time as the number of seconds between the
desired start time and the 1st of January
-
getSubject
Get conference subject.
- Returns:
- the conference subject.
-
setSubject
Set the subject of the conference.
- Parameters:
subject
- the conference subject.
-
isVideoEnabled
boolean isVideoEnabled()Check whether video capabilities are enabled.
- Returns:
- true if the conference supports video capabilities, false otherwise
-
setVideoEnabled
void setVideoEnabled(boolean enable) Enable video capabilities.
- Parameters:
enable
- If true, video will be enabled during conference
-
clone
- Returns:
- An allocated
ConferenceParams
with the same parameters than
params
-
setUserData
Sets the object to store in this object user's data- Parameters:
data
- the object to store
-
getUserData
Object getUserData()Gets the object stored in this object user's data- Returns:
- the object store if any, null otherwise
-
getNativePointer
long getNativePointer()Gets the native pointer used by this class to make native method calls.- Returns:
- the nativer pointer, as long
-
toString
String toString()
-
getAccount()
instead.