Namespace for non-external variables and objects.
- Source:
Members
-
<static, readonly> AVPFMode :number
-
Enum describing RTP AVPF activation modes.
Type:
- number
- Source:
Properties:
Name Type Default Description Default
number 0 Use default value defined at upper level Disabled
number 1 AVPF is disabled Enabled
number 2 AVPF is enabled -
<static, readonly> CallDir :number
-
Enum representing the direction of a call.
Type:
- number
- Source:
Properties:
Name Type Default Description Outgoing
number 0 outgoing calls Incoming
number 1 incoming calls -
<static, readonly> CallState :number
-
LinphoneCallState enum represents the different state a call can reach into. The application is notified of state changes through the
Type:
- number
- Source:
Properties:
Name Type Default Description Idle
number 0 Initial call state IncomingReceived
number 1 This is a new incoming call OutgoingInit
number 2 An outgoing call is started OutgoingProgress
number 3 An outgoing call is in progress OutgoingRinging
number 4 An outgoing call is ringing at remote end OutgoingEarlyMedia
number 5 An outgoing call is proposed early media Connected
number 6 Connected, the call is answered StreamsRunning
number 7 The media streams are established and running Pausing
number 8 The call is pausing at the initiative of local end Paused
number 9 The call is paused, remote end has accepted the pause Resuming
number 10 The call is being resumed by local end Refered
number 11 The call is being transfered to another party, resulting in a new outgoing call to follow immediately Error
number 12 The call encountered an error End
number 13 The call ended normally PausedByRemote
number 14 The call is paused by remote end UpdatedByRemote
number 15 The call's parameters change is requested by remote end, used for example when video is added by remote IncomingEarlyMedia
number 16 We are proposing early media to an incoming call Updating
number 17 A call update has been initiated by us Released
number 18 The call object is no more retained by the core EarlyUpdatedByRemote
number 19 EarlyUpdating
number 20 -
<static, readonly> CallStatus :number
-
Enum representing the status of a call
Type:
- number
- Source:
Properties:
Name Type Default Description Success
number 0 The call was sucessful Aborted
number 1 The call was aborted Missed
number 2 The call was missed (unanswered) Declined
number 3 The call was declined, either locally or by remote end -
<static, readonly> ChatMessageState :number
-
LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
Type:
- number
- Source:
Properties:
Name Type Default Description Idle
number 0 Initial state InProgress
number 1 Delivery in progress Delivered
number 2 Message successfully delivered and acknowledged by remote end point NotDelivered
number 3 Message was not delivered FileTransferError
number 4 Message was received(and acknowledged) but cannot get file from server FileTransferDone
number 5 File transfer has been completed successfully. -
<static, readonly> ConfiguringState :number
-
LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the
Type:
- number
- Source:
Properties:
Name Type Default Description Successful
number 0 Failed
number 1 Skipped
number 2 -
<static, readonly> CoreLogCollectionUploadState :number
-
LinphoneCoreLogCollectionUploadState is used to notify if log collection upload have been succesfully delivered or not.
Type:
- number
- Source:
Properties:
Name Type Default Description InProgress
number 0 Delivery in progress Delivered
number 1 Log collection upload successfully delivered and acknowledged by remote end point NotDelivered
number 2 Log collection upload was not delivered -
<static, readonly> FirewallPolicy :number
-
Policy to use to pass through firewalls.
Type:
- number
- Source:
Properties:
Name Type Default Description NoFirewall
number 0 Do not use any mechanism to pass through firewalls UseNatAddress
number 1 Use the specified public adress UseStun
number 2 Use a STUN server to get the public address UseIce
number 3 Use the ICE protocol UseUpnp
number 4 Use the uPnP protocol -
<static, readonly> GlobalState :number
-
LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the
Type:
- number
- Source:
Properties:
Name Type Default Description Off
number 0 Startup
number 1 On
number 2 Shutdown
number 3 Configuring
number 4 -
<static, readonly> IceState :number
-
Enum describing ICE states.
Type:
- number
- Source:
Properties:
Name Type Default Description NotActivated
number 0 ICE has not been activated for this call or stream Failed
number 1 ICE processing has failed InProgress
number 2 ICE process is in progress HostConnection
number 3 ICE has established a direct connection to the remote host ReflexiveConnection
number 4 ICE has established a connection to the remote host through one or several NATs RelayConnection
number 5 ICE has established a connection through a relay -
<static, readonly> MediaEncryption :number
-
Enum describing type of media encryption types.
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 No media encryption is used SRTP
number 1 Use SRTP media encryption ZRTP
number 2 Use ZRTP media encryption -
<static, readonly> PresenceActivityType :number
-
Activities as defined in section 3.2 of RFC 4480
Type:
- number
- Source:
Properties:
Name Type Default Description Offline
number 0 This value is not defined in the RFC, it corresponds to no activity with a basic status of "closed". Online
number 1 This value is not defined in the RFC, it corresponds to no activity with a basic status of "open". Appointment
number 2 The person has a calendar appointment, without specifying exactly of what type. This activity is indicated if more detailed information is not available or the person chooses not to reveal more information. Away
number 3 The person is physically away from all interactive communication devices. Breakfast
number 4 The person is eating the first meal of the day, usually eaten in the morning. Busy
number 5 The person is busy, without further details. Dinner
number 6 The person is having his or her main meal of the day, eaten in the evening or at midday. Holiday
number 7 This is a scheduled national or local holiday. InTransit
number 8 The person is riding in a vehicle, such as a car, but not steering. LookingForWork
number 9 The person is looking for (paid) work. Lunch
number 10 The person is eating his or her midday meal. Meal
number 11 The person is scheduled for a meal, without specifying whether it is breakfast, lunch, or dinner, or some other meal. Meeting
number 12 The person is in an assembly or gathering of people, as for a business, social, or religious purpose. A meeting is a sub-class of an appointment. OnThePhone
number 13 The person is talking on the telephone. Other
number 14 The person is engaged in an activity with no defined representation. A string describing the activity in plain text SHOULD be provided. Performance
number 15 A performance is a sub-class of an appointment and includes musical, theatrical, and cinematic performances as well as lectures. It is distinguished from a meeting by the fact that the person may either be lecturing or be in the audience, with a potentially large number of other people, making interruptions particularly noticeable. PermanentAbsence
number 16 The person will not return for the foreseeable future, e.g., because it is no longer working for the company. Playing
number 17 The person is occupying himself or herself in amusement, sport, or other recreation. Presentation
number 18 The person is giving a presentation, lecture, or participating in a formal round-table discussion. Shopping
number 19 The person is visiting stores in search of goods or services. Sleeping
number 20 The person is sleeping. Spectator
number 21 The person is observing an event, such as a sports event. Steering
number 22 The person is controlling a vehicle, watercraft, or plane. Travel
number 23 The person is on a business or personal trip, but not necessarily in-transit. TV
number 24 The person is watching television. Unknown
number 25 The activity of the person is unknown. Vacation
number 26 A period of time devoted to pleasure, rest, or relaxation. Working
number 27 The person is engaged in, typically paid, labor, as part of a profession or job. Worship
number 28 The person is participating in religious rites. -
<static, readonly> PresenceBasicStatus :number
-
Basic status as defined in section 4.1.4 of RFC 3863
Type:
- number
- Source:
Properties:
Name Type Default Description Open
number 0 This value means that the associated contact element, if any, is ready to accept communication. Closed
number 1 This value means that the associated contact element, if any, is unable to accept communication. -
<static, readonly> Privacy :number
-
Defines privacy policy to apply as described by rfc3323
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 Privacy services must not perform any privacy function User
number 1 Request that privacy services provide a user-level privacy function. With this mode, "from" header is hidden, usually replaced by From: "Anonymous" Header
number 2 Request that privacy services modify headers that cannot be set arbitrarily by the user (Contact/Via). Session
number 3 Request that privacy services provide privacy for session media Id
number 4 rfc3325 The presence of this privacy type in a Privacy header field indicates that the user would like the Network Asserted Identity to be kept private with respect to SIP entities outside the Trust Domain with which the user authenticated. Note that a user requesting multiple types of privacy MUST include all of the requested privacy types in its Privacy header field value Critical
number 5 Privacy service must perform the specified services or fail the request Default
number 6 Special keyword to use privacy as defined either globally or by proxy using -
<static, readonly> PublishState :number
-
Enum for publish states.
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 Initial state, do not use Progress
number 1 An outgoing publish was created and submitted Ok
number 2 Publish is accepted. Error
number 3 Publish encoutered an error, Expiring
number 4 Publish is about to expire, only sent if [sip]->refresh_generic_publish property is set to 0. Cleared
number 5 Event has been un published -
<static, readonly> Reason :number
-
Enum describing various failure reasons or contextual information for some events.
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 NoResponse
number 1 No response received from remote Forbidden
number 2 Authentication failed due to bad credentials or resource forbidden Declined
number 3 The call has been declined NotFound
number 4 Destination of the call was not found. NotAnswered
number 5 The call was not answered in time (request timeout) Busy
number 6 Phone line was busy UnsupportedContent
number 7 Unsupported content IOError
number 8 Transport error: connection failures, disconnections etc... DoNotDisturb
number 9 Do not disturb reason Unauthorized
number 10 Operation is unauthorized because missing credential NotAcceptable
number 11 Operation like call update rejected by peer NoMatch
number 12 Operation could not be executed by server or remote client because it didn't have any context for it MovedPermanently
number 13 Resource moved permanently Gone
number 14 Resource no longer exists TemporarilyUnavailable
number 15 Temporarily unavailable AddressIncomplete
number 16 Address incomplete NotImplemented
number 17 Not implemented BadGateway
number 18 Bad gateway ServerTimeout
number 19 Server timeout Unknown
number 20 Unknown reason -
<static, readonly> RegistrationState :number
-
LinphoneRegistrationState describes proxy registration states.
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 Initial state for registrations Progress
number 1 Registration is in progress Ok
number 2 Registration is successful Cleared
number 3 Unregistration succeeded Failed
number 4 Registration failed -
<static, readonly> SubscribePolicy :number
-
Enum controlling behavior for incoming subscription request.
Type:
- number
- Source:
Properties:
Name Type Default Description Wait
number 0 Does not automatically accept an incoming subscription request. This policy implies that a decision has to be taken for each incoming subscription request notified by callback Deny
number 1 Rejects incoming subscription request. Accept
number 2 Automatically accepts a subscription request. -
<static, readonly> SubscriptionDir :number
-
Enum for subscription direction (incoming or outgoing).
Type:
- number
- Source:
Properties:
Name Type Default Description Incoming
number 0 Incoming subscription. Outgoing
number 1 Outgoing subscription. InvalidDir
number 2 Invalid subscription direction. -
<static, readonly> SubscriptionState :number
-
Enum for subscription states.
Type:
- number
- Source:
Properties:
Name Type Default Description None
number 0 Initial state, should not be used. OutgoingProgress
number 1 An outgoing subcription was sent IncomingReceived
number 2 An incoming subcription is received Pending
number 3 Subscription is pending, waiting for user approval Active
number 4 Subscription is accepted. Terminated
number 5 Subscription is terminated normally Error
number 6 Subscription encountered an error, indicated by Expiring
number 7 Subscription is about to expire, only sent if [sip]->refresh_generic_subscribe property is set to 0. -
<static, readonly> TransportType :number
-
Enum describing transport type for LinphoneAddress.
Type:
- number
- Source:
Properties:
Name Type Default Description Udp
number 0 Tcp
number 1 Tls
number 2 Dtls
number 3 -
<static, readonly> TunnelMode :number
-
Enum describing the tunnel modes.
Type:
- number
- Source:
Properties:
Name Type Default Description Disable
number 0 The tunnel is disabled. Enable
number 1 The tunnel is enabled. Auto
number 2 The tunnel is enabled automatically if it is required. -
<static, readonly> UpnpState :number
-
Enum describing uPnP states.
Type:
- number
- Source:
Properties:
Name Type Default Description Idle
number 0 uPnP is not activate Pending
number 1 uPnP process is in progress Adding
number 2 Internal use: Only used by port binding Removing
number 3 Internal use: Only used by port binding NotAvailable
number 4 uPnP is not available Ok
number 5 uPnP is enabled Ko
number 6 uPnP processing has failed Blacklisted
number 7 IGD router is blacklisted
Methods
-
getAVPFModeText(value)
-
Get the name of a value of the AVPFMode enum as a string.
Parameters:
Name Type Description value
number One of the values of the AVPFMode enum. - Source:
-
getCallDirText(value)
-
Get the name of a value of the CallDir enum as a string.
Parameters:
Name Type Description value
number One of the values of the CallDir enum. - Source:
-
getCallStateText(value)
-
Get the name of a value of the CallState enum as a string.
Parameters:
Name Type Description value
number One of the values of the CallState enum. - Source:
-
getCallStatusText(value)
-
Get the name of a value of the CallStatus enum as a string.
Parameters:
Name Type Description value
number One of the values of the CallStatus enum. - Source:
-
getChatMessageStateText(value)
-
Get the name of a value of the ChatMessageState enum as a string.
Parameters:
Name Type Description value
number One of the values of the ChatMessageState enum. - Source:
-
getConfiguringStateText(value)
-
Get the name of a value of the ConfiguringState enum as a string.
Parameters:
Name Type Description value
number One of the values of the ConfiguringState enum. - Source:
-
getCoreLogCollectionUploadStateText(value)
-
Get the name of a value of the CoreLogCollectionUploadState enum as a string.
Parameters:
Name Type Description value
number One of the values of the CoreLogCollectionUploadState enum. - Source:
-
getFirewallPolicyText(value)
-
Get the name of a value of the FirewallPolicy enum as a string.
Parameters:
Name Type Description value
number One of the values of the FirewallPolicy enum. - Source:
-
getGlobalStateText(value)
-
Get the name of a value of the GlobalState enum as a string.
Parameters:
Name Type Description value
number One of the values of the GlobalState enum. - Source:
-
getIceStateText(value)
-
Get the name of a value of the IceState enum as a string.
Parameters:
Name Type Description value
number One of the values of the IceState enum. - Source:
-
getMediaEncryptionText(value)
-
Get the name of a value of the MediaEncryption enum as a string.
Parameters:
Name Type Description value
number One of the values of the MediaEncryption enum. - Source:
-
getPresenceActivityTypeText(value)
-
Get the name of a value of the PresenceActivityType enum as a string.
Parameters:
Name Type Description value
number One of the values of the PresenceActivityType enum. - Source:
-
getPresenceBasicStatusText(value)
-
Get the name of a value of the PresenceBasicStatus enum as a string.
Parameters:
Name Type Description value
number One of the values of the PresenceBasicStatus enum. - Source:
-
getPrivacyText(value)
-
Get the name of a value of the Privacy enum as a string.
Parameters:
Name Type Description value
number One of the values of the Privacy enum. - Source:
-
getPublishStateText(value)
-
Get the name of a value of the PublishState enum as a string.
Parameters:
Name Type Description value
number One of the values of the PublishState enum. - Source:
-
getReasonText(value)
-
Get the name of a value of the Reason enum as a string.
Parameters:
Name Type Description value
number One of the values of the Reason enum. -
getRegistrationStateText(value)
-
Get the name of a value of the RegistrationState enum as a string.
Parameters:
Name Type Description value
number One of the values of the RegistrationState enum. - Source:
-
getSubscribePolicyText(value)
-
Get the name of a value of the SubscribePolicy enum as a string.
Parameters:
Name Type Description value
number One of the values of the SubscribePolicy enum. - Source:
-
getSubscriptionDirText(value)
-
Get the name of a value of the SubscriptionDir enum as a string.
Parameters:
Name Type Description value
number One of the values of the SubscriptionDir enum. - Source:
-
getSubscriptionStateText(value)
-
Get the name of a value of the SubscriptionState enum as a string.
Parameters:
Name Type Description value
number One of the values of the SubscriptionState enum. - Source:
-
getTransportTypeText(value)
-
Get the name of a value of the TransportType enum as a string.
Parameters:
Name Type Description value
number One of the values of the TransportType enum. - Source:
-
getTunnelModeText(value)
-
Get the name of a value of the TunnelMode enum as a string.
Parameters:
Name Type Description value
number One of the values of the TunnelMode enum. - Source:
-
getUpnpStateText(value)
-
Get the name of a value of the UpnpState enum as a string.
Parameters:
Name Type Description value
number One of the values of the UpnpState enum. - Source: