org.linphone.core

Interface ConferenceParams

public interface ConferenceParams

Object defining parameters for a Conference.

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

Method Summary

Modifier and Type	Method and Description
ConferenceParams	clone() Clone a ConferenceParams.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
java.lang.Object	getUserData() Gets the object stored in this object user's data
boolean	isAudioEnabled() Check whether audio capabilities are enabled.
boolean	isChatEnabled() Check whether chat capabilities are enabled.
boolean	isLocalParticipantEnabled() Returns whether local participant has to enter the conference.
boolean	isOneParticipantConferenceEnabled() Returns whether conference can have only one participant.
boolean	isVideoEnabled() Check whether video capabilities are enabled.
void	setAudioEnabled(boolean enable) Enable audio capabilities.
void	setChatEnabled(boolean enable) Enable chat capabilities.
void	setLocalParticipantEnabled(boolean enable) Enable local participant to enter the conference.
void	setOneParticipantConferenceEnabled(boolean enable) Enable conference with one participant.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
void	setVideoEnabled(boolean enable) Enable video capabilities.
java.lang.String	toString()

Method Detail

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

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 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

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

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

@NonNull
ConferenceParams clone()

Clone a ConferenceParams.

Returns:

An allocated ConferenceParams with the same parameters than
params

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.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

java.lang.String toString()

Overrides:

toString in class java.lang.Object