ConferenceParams

public class ConferenceParams : LinphoneObject

Object defining parameters for a Conference. Can be created by calling function Core.createConferenceParams().

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> ConferenceParams

  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }

  • Returns the account for the conference.

    Declaration

    Swift

    public var account: Account? { get }

    Return Value

    a pointer to the account or nil if it is not set.

  • Enable audio capabilities.

    Declaration

    Swift

    public var audioEnabled: Bool { get set }

    Parameters

    enable

    If true, audio will be enabled during conference Check whether audio capabilities are enabled.

    Return Value

    true if the conference supports audio capabilities, false otherwise

  • Enable chat capabilities.

    Declaration

    Swift

    public var chatEnabled: Bool { get set }

    Parameters

    enable

    If true, chat is enabled during conference Check whether chat capabilities are enabled.

    Return Value

    true if the conference supports chat capabilities, false otherwise

  • 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 nil then the conference will be local else it will be a remote conference.

    Declaration

    Swift

    public var conferenceFactoryAddress: Address? { get set }

    Parameters

    address

    the conference factory address.
    Get the conference factory address of the conference that has been set.

    Return Value

    the factory address conference description.

  • Set the description of the conference.

    Declaration

    Swift

    public var description: String { get set }

    Parameters

    description

    the conference description.
    Get conference description.

    Return Value

    the conference description.

  • Set the conference end time.

    Declaration

    Swift

    public var endTime: time_t { get set }

    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 Get the end time of the conference.

    Return Value

    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

  • Check whether audio capabilities are enabled.

    • deprecated: 16/12/2021 Use audioEnabled() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var isAudioEnabled: Bool { get }

    Return Value

    true if the conference supports audio capabilities, false otherwise

  • Check whether chat capabilities are enabled.

    • deprecated: 16/12/2021 Use chatEnabled() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var isChatEnabled: Bool { get }

    Return Value

    true if the conference supports chat capabilities, false otherwise

  • Returns whether local participant has to enter the conference.

    • deprecated: 16/12/2021 Use localParticipantEnabled() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var isLocalParticipantEnabled: Bool { get }

    Return Value

    true if local participant is by default part of the conference, false otherwise

  • Returns whether conference can have only one participant.

    • deprecated: 16/12/2021 Use oneParticipantConferenceEnabled() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var isOneParticipantConferenceEnabled: Bool { get }

    Return Value

    true if the conference can have only one participant, false otherwise

  • Check whether video capabilities are enabled.

    • deprecated: 16/12/2021 Use videoEnabled() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var isVideoEnabled: Bool { get }

    Return Value

    true if the conference supports video capabilities, false otherwise

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

    Declaration

    Swift

    public var localParticipantEnabled: Bool { get set }

    Parameters

    enable

    true if local participant is automatically added to the conference, false otherwise Returns whether local participant has to enter the conference.

    Return Value

    true if local participant is by default part of the conference, false otherwise

  • Enable conference with one participant.

    Declaration

    Swift

    public var oneParticipantConferenceEnabled: Bool { get set }

    Parameters

    enable

    true if conference can have only one participant, false otherwise Returns whether conference can have only one participant.

    Return Value

    true if the conference can have only one participant, false otherwise

  • Set the participant list type.

    Declaration

    Swift

    public var participantListType: ConferenceParticipantListType { get set }

    Parameters

    type

    Participant list type ConferenceParticipantListType. This allows to restrict the access to the conference to a selected set of participants Get the participant list type.

    Return Value

    participant list type ConferenceParticipantListType.

  • Returns the proxy configuration for the conference.

    • deprecated: 11/01/2022 Use getAccount() instead.

    Declaration

    Swift

    @available(*, deprecated)
public var proxyCfg: ProxyConfig? { get }

    Return Value

    a pointer to the proxy configuration or nil if it is not set.

  • Set the conference start time.

    Declaration

    Swift

    public var startTime: time_t { get set }

    Parameters

    start

    the conference start time as the number of seconds between the desired start time and the 1st of January 1970. In order to program an immediate start of a conference, then program the start time to 0 Get the start time of the conference.

    Return Value

    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

  • Set the conference subject.

    Declaration

    Swift

    public var subject: String { get set }

    Parameters

    subject

    conference subject
    Get the conference subject.

    Return Value

    conference subject.

  • Enable video capabilities.

    Declaration

    Swift

    public var videoEnabled: Bool { get set }

    Parameters

    enable

    If true, video will be enabled during conference Check whether video capabilities are enabled.

    Return Value

    true if the conference supports video capabilities, false otherwise

  • Clone a ConferenceParams.

    Declaration

    Swift

    public func clone() -> ConferenceParams?

    Return Value

    An allocated ConferenceParams with the same parameters than params