Conference
public class Conference : LinphoneObject
TODO.
-
Undocumented
Declaration
Swift
public static func getSwiftObject(cObject: OpaquePointer) -> Conference
-
Undocumented
Declaration
Swift
public var getCobject: OpaquePointer? { get }
-
See moreState
is used to indicate the current state of a conference.Declaration
Swift
public enum State : Int
-
TODO.
Declaration
Swift
public func addDelegate(delegate: ConferenceDelegate)
-
TODO.
Declaration
Swift
public func removeDelegate(delegate: ConferenceDelegate)
-
Get the conference address of the conference.
Declaration
Swift
public var conferenceAddress: Address? { get }
Return Value
The conference address of the conference or nil if it is unknown.
-
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
Swift
public var currentDelegate: ConferenceDelegate? { get }
Return Value
The LinphoneConferenceCbs that has called the last callback.
-
Get current parameters of the conference.
Declaration
Swift
public var currentParams: ConferenceParams? { get }
Return Value
a
ConferenceParams
. -
Get the conference id as string.
Declaration
Swift
public var ID: String { get set }
Return Value
the conference id
-
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
Swift
public var me: Participant? { get }
Return Value
a
Participant
. -
Get number of participants.
Declaration
Swift
public var participantCount: Int { get }
Return Value
the number of participants in a
Conference
-
Get list of all participants of one conference.
Declaration
Swift
public var participantList: [Participant] { get }
Return Value
A list of 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
- deprecated: 10/07/2020 Use getParticipantList() instead.
Declaration
Swift
@available(*, deprecated) public var participants: [Address] { get }
Return Value
The list of the participants’ address.
-
Get the conference subject.
Declaration
Swift
public var subject: String { get set }
Return Value
conference subject.
-
Retrieves the user pointer that was given to linphone_conference_new()
Declaration
Swift
public var userData: UnsafeMutableRawPointer? { get set }
Return Value
The user data associated with the
Conference
object. -
Find a participant from a conference.
Declaration
Swift
public func findParticipant(uri: Address) -> Participant?
Parameters
uri
SIP URI of the participant to search.
Return Value
a pointer to the participant found or nullptr.
-
Invite participants to the conference, by supplying a list of
Address
.Declaration
Swift
public func inviteParticipants(addresses: [Address], params: CallParams?) throws
Parameters
addresses
A list of SIP addresses to invite.
params
CallParams
to use for inviting the participants. -
Call generic OpenGL render for a given conference.
Declaration
Swift
public func oglRender()
-
Call generic OpenGL render preview for a given conference.
Declaration
Swift
public func previewOglRender()
-
Warning
The passed participant uri must be one of those returned by getParticipants()- deprecated: 10/07/2020 Use removeParticipant() instead.
Declaration
Swift
@available(*, deprecated) public func removeParticipant(uri: Address) throws
Parameters
uri
URI of the participant to remove
Return Value
0 if succeeded, -1 if failed
-
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 createdDeclaration
Swift
public func removeParticipant(participant: Participant) throws
Parameters
participant
participant to remove
Return Value
0 if succeeded, -1 if failed
-
- deprecated: 10/07/2020 Use removeParticipant() instead.
Declaration
Swift
@available(*, deprecated) public func removeParticipant(call: Call) throws
Parameters
call
call to remove
Return Value
0 if succeeded, -1 if failed
-
Terminates conference.
Declaration
Swift
public func terminate() -> Int
Return Value
0 if the termination is successful, -1 otherwise.
-
Update parameters of the conference. This is typically used enable or disable the video stream in the conference.
Declaration
Swift
public func updateParams(params: ConferenceParams) -> Int
Parameters
params
the new parameters to apply.