org.linphone.core

Interface Conference

public interface Conference

TODO.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Conference.State

Method Summary

Modifier and Type	Method and Description
void	addListener(ConferenceListener listener)
int	addParticipant(Address uri) Join a participant to the conference.
int	addParticipant(Call call) Join an existing call to the conference.
Participant	findParticipant(Address uri) Find a participant from a conference.
Address	getConferenceAddress() Get the conference address of the conference.
Core	getCore() Returns core for a Conference.
ConferenceParams	getCurrentParams() Get current parameters of the conference.
java.lang.String	getId() Get the conference id as string.
Participant	getMe() For a local audio video conference, this function returns the participant hosting the conference For a remote audio video conference, this function returns the focus of the conference.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
int	getParticipantCount() Get number of participants.
Participant[]	getParticipantList() Get list of all participants of one conference.
Address[]	getParticipants() Deprecated. 10/07/2020 Use getParticipantList() instead.
java.lang.String	getSubject() Get the conference subject.
java.lang.Object	getUserData() Gets the object stored in this object user's data
int	inviteParticipants(Address[] addresses, CallParams params) Invite participants to the conference, by supplying a list of Address.
void	oglRender() Call generic OpenGL render for a given conference.
void	previewOglRender() Call generic OpenGL render preview for a given conference.
void	removeListener(ConferenceListener listener)
int	removeParticipant(Address uri) Deprecated. 10/07/2020 Use removeParticipant(org.linphone.core.Address) instead.
int	removeParticipant(Call call) Deprecated. 10/07/2020 Use removeParticipant(org.linphone.core.Address) instead.
int	removeParticipant(Participant participant)
void	setId(java.lang.String conferenceId) Set the conference id as string.
void	setSubject(java.lang.String subject) Set the conference subject.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
int	terminate() Terminates conference.
java.lang.String	toString()
int	updateParams(ConferenceParams params) Update parameters of the conference.

Method Detail

getConferenceAddress

@Nullable
Address getConferenceAddress()

Get the conference address of the conference.

Returns:

The conference address of the conference or null if it is unknown.

getCore

@NonNull
Core getCore()

Returns core for a Conference.

Returns:

back pointer to Core object. Returns back pointer to Core
object.

getCurrentParams

@NonNull
ConferenceParams getCurrentParams()

Get current parameters of the conference.

Returns:

a ConferenceParams .

getId

@Nullable
java.lang.String getId()

Get the conference id as string.

Returns:

the conference id

setId

void setId(@Nullable
           java.lang.String conferenceId)

Set the conference id as string.

Parameters:

conferenceId - the conference id to set.

getMe

@NonNull
Participant getMe()

For a local audio video conference, this function returns the participant
hosting the conference For a remote audio video conference, this function
returns the focus of the conference.

Returns:

a Participant .

getParticipantCount

int getParticipantCount()

Get number of participants.

Returns:

the number of participants in a Conference

getParticipantList

@NonNull
Participant[] getParticipantList()

Get list of all participants of one conference.

Returns:

A list of participants.

getParticipants

@Deprecated
 @NonNull
Address[] getParticipants()

Deprecated. 10/07/2020 Use getParticipantList() instead.

Get URIs of all participants of one conference The returned bctbx_list_t
contains URIs of all participant.

That list must be freed after use and each URI must be unref with
linphone_address_unref

Returns:

The list of the participants' address.

getSubject

@Nullable
java.lang.String getSubject()

Get the conference subject.

Returns:

conference subject.

setSubject

void setSubject(@Nullable
                java.lang.String subject)

Set the conference subject.

Parameters:

subject - conference subject

addParticipant

int addParticipant(@NonNull
                   Call call)

Join an existing call to the conference.

Parameters:

call - a Call that has to be added to the conference.

addParticipant

int addParticipant(@NonNull
                   Address uri)

Join a participant to the conference.

Parameters:

uri - a Address that has to be added to the conference.

findParticipant

@Nullable
Participant findParticipant(@NonNull
                                      Address uri)

Find a participant from a conference.

Parameters:

uri - SIP URI of the participant to search.

Returns:

a pointer to the participant found or nullptr.

inviteParticipants

int inviteParticipants(@NonNull
                       Address[] addresses,
                       @Nullable
                       CallParams params)

Invite participants to the conference, by supplying a list of Address.

Parameters:

addresses - A list of SIP addresses to invite.

params - CallParams to use for inviting the participants.

oglRender

void oglRender()

Call generic OpenGL render for a given conference.

previewOglRender

void previewOglRender()

Call generic OpenGL render preview for a given conference.

removeParticipant

@Deprecated
int removeParticipant(@NonNull
                                  Address uri)

Deprecated. 10/07/2020 Use removeParticipant(org.linphone.core.Address) instead.

Parameters:

uri - URI of the participant to remove
warning: The passed participant uri must be one of those returned by getParticipants()

Returns:

0 if succeeded, -1 if failed

removeParticipant

int removeParticipant(@NonNull
                      Participant participant)

Parameters:

participant - participant to remove
warning: The passed participant must be one of those returned by getParticipantList()
warning: This method may destroy the conference if the only remaining
participant had an existing call to the local participant before the conference
was created

Returns:

0 if succeeded, -1 if failed

removeParticipant

@Deprecated
int removeParticipant(@NonNull
                                  Call call)

Deprecated. 10/07/2020 Use removeParticipant(org.linphone.core.Address) instead.

Parameters:

call - call to remove

Returns:

0 if succeeded, -1 if failed

terminate

int terminate()

Terminates conference.

Returns:

0 if the termination is successful, -1 otherwise.

updateParams

int updateParams(@NonNull
                 ConferenceParams params)

Update parameters of the conference.

This is typically used enable or disable the video stream in the conference.

Parameters:

params - the new parameters to apply.

addListener

void addListener(ConferenceListener listener)

removeListener

void removeListener(ConferenceListener listener)

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