Classes

The following classes are available globally.

  • Class basic linphone class

    Declaration

    Swift

    public class LinphoneObject

  • Undocumented

    See more

    Declaration

    Swift

    open class AccountCreatorDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class CallDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class ChatMessageDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class ChatRoomDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class CoreDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class EventDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class FriendListDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class LoggingServiceDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class PlayerDelegate : LinphoneObjectDelegate

  • Undocumented

    See more

    Declaration

    Swift

    open class XmlRpcRequestDelegate : LinphoneObjectDelegate

  • The AccountCreator object used to configure an account on a server via XML-RPC.

    See more

    Declaration

    Swift

    public class AccountCreator : LinphoneObject

  • Object that represents a SIP address. The Address is an opaque object to represents SIP addresses, ie the content of SIP’s ‘from’ and ‘to’ headers. A SIP address is made of display name, username, domain name, port, and various uri headers (such as tags). It looks like ‘Alice sip:alice@example.net’. The Address has methods to extract and manipulate all parts of the address. When some part of the address (for example the username) is empty, the accessor methods return nil.

    See more

    Declaration

    Swift

    public class Address : LinphoneObject

  • Object holding authentication information.

    Note

    The object’s fields should not be accessed directly. Prefer using the accessor methods.

    In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.

    Once created and filled, a AuthInfo must be added to the Core in order to become known and used automatically when needed. Use {@link Core#addAuthInfo} for that purpose.

    The Core object can take the initiative to request authentication information when needed to the application through the auth_info_requested callback of the LinphoneCoreVTable structure.

    The application can respond to this information request later using {@link Core#addAuthInfo}. This will unblock all pending authentication transactions and retry them with authentication headers.

    See more

    Declaration

    Swift

    public class AuthInfo : LinphoneObject

  • The Content object representing a data buffer.

    See more

    Declaration

    Swift

    public class Buffer : LinphoneObject

  • The Call object represents a call issued or received by the Core.

    See more

    Declaration

    Swift

    public class Call : LinphoneObject

  • Structure representing a call log.

    See more

    Declaration

    Swift

    public class CallLog : LinphoneObject

  • The CallParams is an object containing various call related parameters. It can be used to retrieve parameters from a currently running call or modify the call’s characteristics dynamically.

    See more

    Declaration

    Swift

    public class CallParams : LinphoneObject

  • The CallStats objects carries various statistic informations regarding quality of audio or video streams. To receive these informations periodically and as soon as they are computed, the application is invited to place a LinphoneCoreCallStatsUpdatedCb callback in the LinphoneCoreVTable structure it passes for instanciating the Core object (see linphone_core_new ).

    At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().

    See more

    Declaration

    Swift

    public class CallStats : LinphoneObject

  • An chat message is the object that is sent and received through LinphoneChatRooms.

    See more

    Declaration

    Swift

    public class ChatMessage : LinphoneObject

  • A chat room is the place where text messages are exchanged. Can be created by {@link Core#createChatRoom}.

    See more

    Declaration

    Swift

    public class ChatRoom : LinphoneObject

  • An object to handle a chat room parameters. Can be created with linphone_core_get_default_chat_room_params() or linphone_chat_room_params_new.

    See more

    Declaration

    Swift

    public class ChatRoomParams : LinphoneObject

  • Conference class The _LinphoneConference struct does not exists, it’s the Conference C++ class that is used behind

    See more

    Declaration

    Swift

    public class Conference : LinphoneObject

  • Parameters for initialization of conferences The _LinphoneConferenceParams struct does not exists, it’s the ConferenceParams C++ class that is used behind.

    See more

    Declaration

    Swift

    public class ConferenceParams : LinphoneObject

  • The Config object is used to manipulate a configuration file. The format of the configuration file is a .ini like format:

    Example:

    See more

    Declaration

    Swift

    public class Config : LinphoneObject

  • The LinphoneContent object holds data that can be embedded in a signaling message.

    See more

    Declaration

    Swift

    public class Content : LinphoneObject

  • Linphone core main object created by function linphone_core_new .

    See more

    Declaration

    Swift

    public class Core : LinphoneObject

  • Represents a dial plan.

    See more

    Declaration

    Swift

    public class DialPlan : LinphoneObject

  • Object representing full details about a signaling error or status. All ErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.

    See more

    Declaration

    Swift

    public class ErrorInfo : LinphoneObject

  • Object representing an event state, which is subcribed or published.

    See

    See also: {@link Core#publish}

    See

    See also: {@link Core#subscribe}

    See more

    Declaration

    Swift

    public class Event : LinphoneObject

  • Base object of events.

    See more

    Declaration

    Swift

    public class EventLog : LinphoneObject

  • Factory is a singleton object devoted to the creation of all the object of Liblinphone that cannot be created by Core itself.

    See more

    Declaration

    Swift

    public class Factory : LinphoneObject

  • Represents a buddy, all presence actions like subscription and status change notification are performed on this object.

    See more

    Declaration

    Swift

    public class Friend : LinphoneObject

  • The FriendList object representing a list of friends.

    See more

    Declaration

    Swift

    public class FriendList : LinphoneObject

  • Object representing a chain of protocol headers. It provides read/write access to the headers of the underlying protocol.

    See more

    Declaration

    Swift

    public class Headers : LinphoneObject

  • Policy to use to send/receive instant messaging composing/delivery/display notifications. The sending of this information is done as in the RFCs 3994 (is_composing) and 5438 (imdn delivered/displayed).

    See more

    Declaration

    Swift

    public class ImNotifPolicy : LinphoneObject

  • The InfoMessage is an object representing an informational message sent or received by the core.

    See more

    Declaration

    Swift

    public class InfoMessage : LinphoneObject

  • Singleton class giving access to logging features.

    See more

    Declaration

    Swift

    public class LoggingService : LinphoneObject

  • A MagicSearch is used to do specifics searchs.

    See more

    Declaration

    Swift

    public class MagicSearch : LinphoneObject

  • Policy to use to pass through NATs/firewalls.

    See more

    Declaration

    Swift

    public class NatPolicy : LinphoneObject

  • Undocumented

    See more

    Declaration

    Swift

    public class Participant : LinphoneObject

  • Undocumented

    See more

    Declaration

    Swift

    public class ParticipantDevice : LinphoneObject

  • Undocumented

    See more

    Declaration

    Swift

    public class ParticipantDeviceIdentity : LinphoneObject

  • The LinphoneParticipantImdnState object represents the state of chat message for a participant of a conference chat room.

    See more

    Declaration

    Swift

    public class ParticipantImdnState : LinphoneObject

  • Object representing an RTP payload type.

    See more

    Declaration

    Swift

    public class PayloadType : LinphoneObject

  • Player interface.

    See more

    Declaration

    Swift

    public class Player : LinphoneObject

  • Presence activity type holding information about a presence activity.

    See more

    Declaration

    Swift

    public class PresenceActivity : LinphoneObject

  • Presence model type holding information about the presence of a person.

    See more

    Declaration

    Swift

    public class PresenceModel : LinphoneObject

  • Presence note type holding information about a presence note.

    See more

    Declaration

    Swift

    public class PresenceNote : LinphoneObject

  • Presence person holding information about a presence person.

    See more

    Declaration

    Swift

    public class PresencePerson : LinphoneObject

  • Presence service type holding information about a presence service.

    See more

    Declaration

    Swift

    public class PresenceService : LinphoneObject

  • The ProxyConfig object represents a proxy configuration to be used by the Core object. Its fields must not be used directly in favour of the accessors methods. Once created and filled properly the ProxyConfig can be given to Core with {@link Core#addProxyConfig}. This will automatically triggers the registration, if enabled.

    The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after linphone_core_new there might already be a list of configured proxy that can be examined with {@link Core#getProxyConfigList}.

    The default proxy (see linphone_core_set_default_proxy ) is the one of the list that is used by default for calls.

    See more

    Declaration

    Swift

    public class ProxyConfig : LinphoneObject

  • Object holding chat message data received by a push notification.

    See more

    Declaration

    Swift

    public class PushNotificationMessage : LinphoneObject

  • Structure describing a range of integers.

    See more

    Declaration

    Swift

    public class Range : LinphoneObject

  • The LinphoneSearchResult object represents a result of a search.

    See more

    Declaration

    Swift

    public class SearchResult : LinphoneObject

  • Linphone core SIP transport ports. Special values LC_SIP_TRANSPORT_RANDOM, LC_SIP_TRANSPORT_RANDOM, LC_SIP_TRANSPORT_DONTBIND can be used. Use with linphone_core_set_sip_transports

    See more

    Declaration

    Swift

    public class Transports : LinphoneObject

  • Linphone tunnel object.

    See more

    Declaration

    Swift

    public class Tunnel : LinphoneObject

  • Tunnel settings.

    See more

    Declaration

    Swift

    public class TunnelConfig : LinphoneObject

  • The Vcard object.

    See more

    Declaration

    Swift

    public class Vcard : LinphoneObject

  • Structure describing policy regarding video streams establishments.

    See more

    Declaration

    Swift

    public class VideoActivationPolicy : LinphoneObject

  • The VideoDefinition object represents a video definition, eg. its width and its height.

    See more

    Declaration

    Swift

    public class VideoDefinition : LinphoneObject

  • The XmlRpcRequest object representing a XML-RPC request to be sent.

    See more

    Declaration

    Swift

    public class XmlRpcRequest : LinphoneObject

  • The XmlRpcSession object used to send XML-RPC requests and handle their responses.

    See more

    Declaration

    Swift

    public class XmlRpcSession : LinphoneObject