Class Conference

TODO.

Inheritance

System.Object

LinphoneObject

Conference

Inherited Members

LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)

LinphoneObject.CleanStringArrayPtrs()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Linphone

Assembly: cs.temp.dll.dll

Syntax

public class Conference : LinphoneObject

Properties

ConferenceAddress

Get the conference address of the conference.

Declaration

public Address ConferenceAddress { get; }

Property Value

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

Core

Returns core for a Conference.

Declaration

public Core Core { get; }

Property Value

Type	Description
Core	back pointer to Core object. Returns back pointer to Core object.

CurrentCallbacks

Gets the current LinphoneConferenceCbs.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneConferenceCbs that is calling the callback.

Declaration

public ConferenceListener CurrentCallbacks { get; }

Property Value

Type	Description
ConferenceListener	The LinphoneConferenceCbs that has called the last callback.

CurrentParams

Get current parameters of the conference.

Declaration

public ConferenceParams CurrentParams { get; }

Property Value

Type	Description
ConferenceParams	a ConferenceParams .

Id

Get the conference id as string.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	the conference id

Listener

Declaration

public ConferenceListener Listener { get; }

Property Value

Type	Description
ConferenceListener

Me

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.

Declaration

public Participant Me { get; }

Property Value

Type	Description
Participant	a Participant .

ParticipantCount

Get number of participants.

Declaration

public int ParticipantCount { get; }

Property Value

Type	Description
System.Int32	the number of participants in a Conference

ParticipantList

Get list of all participants of one conference.

Declaration

public IEnumerable<Participant> ParticipantList { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Participant>	A list of participants.

Participants

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

Declaration

public IEnumerable<Address> Participants { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Address>	The list of the participants' address.

Subject

Get the conference subject.

Declaration

public string Subject { get; set; }

Property Value

Type	Description
System.String	conference subject.

Methods

AddParticipant(Address)

Join a participant to the conference.

Declaration

public void AddParticipant(Address uri)

Parameters

Type	Name	Description
Address	uri	a Address that has to be added to the conference.

AddParticipant(Call)

Join an existing call to the conference.

Declaration

public void AddParticipant(Call call)

Parameters

Type	Name	Description
Call	call	a Call that has to be added to the conference.

Finalize()

Declaration

protected void Finalize()

FindParticipant(Address)

Find a participant from a conference.

Declaration

public Participant FindParticipant(Address uri)

Parameters

Type	Name	Description
Address	uri	SIP URI of the participant to search.

Returns

Type	Description
Participant	a pointer to the participant found or nullptr.

InviteParticipants(IEnumerable<Address>, CallParams)

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

Declaration

public void InviteParticipants(IEnumerable<Address> addresses, CallParams parameters)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<Address>	addresses	A list of SIP addresses to invite.
CallParams	parameters	CallParams to use for inviting the participants.

OglRender()

Call generic OpenGL render for a given conference.

Declaration

public void OglRender()

PreviewOglRender()

Call generic OpenGL render preview for a given conference.

Declaration

public void PreviewOglRender()

RemoveParticipant(Address)

Declaration

public void RemoveParticipant(Address uri)

Parameters

Type	Name	Description
Address	uri	URI of the participant to remove

Remarks

Warning : The passed participant uri must be one of those returned by Participants

RemoveParticipant(Call)

Declaration

public void RemoveParticipant(Call call)

Parameters

Type	Name	Description
Call	call	call to remove

RemoveParticipant(Participant)

Declaration

public void RemoveParticipant(Participant participant)

Parameters

Type	Name	Description
Participant	participant	participant to remove

Remarks

Warning : The passed participant must be one of those returned by ParticipantList

Terminate()

Terminates conference.

Declaration

public int Terminate()

Returns

Type	Description
System.Int32	0 if the termination is successful, -1 otherwise.

UpdateParams(ConferenceParams)

Update parameters of the conference.

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

Declaration

public int UpdateParams(ConferenceParams parameters)

Parameters

Type	Name	Description
ConferenceParams	parameters	the new parameters to apply.

Returns

Type	Description
System.Int32