Liblinphone  5.3.0
Typedefs | Enumerations | Functions
SignalInformation

Typedefs

typedef enum _LinphoneSignalType LinphoneSignalType
 All signal types that a device can use.
 
typedef enum _LinphoneSignalStrengthUnit LinphoneSignalStrengthUnit
 All signal units that a device can use.
 

Enumerations

enum  _LinphoneSignalType {
  LinphoneSignalTypeWifi = 0,
  LinphoneSignalTypeMobile = 1,
  LinphoneSignalTypeOther = 2
}
 All signal types that a device can use.
 
enum  _LinphoneSignalStrengthUnit {
  LinphoneSignalStrengthUnitRssi = 0,
  LinphoneSignalStrengthUnitDbm = 1
}
 All signal units that a device can use.
 

Functions

LinphoneSignalInformationlinphone_signal_information_clone (const LinphoneSignalInformation *signalInformation)
 Clone the given signalInformation. More...
 
LinphoneSignalInformationlinphone_signal_information_ref (LinphoneSignalInformation *signalInformation)
 Take a reference on a LinphoneSignalInformation. More...
 
void linphone_signal_information_unref (LinphoneSignalInformation *signalInformation)
 Release a LinphoneSignalInformation. More...
 
float linphone_signal_information_get_strength (LinphoneSignalInformation *signalInformation)
 Get the value of the LinphoneSignalInformation. More...
 
void linphone_signal_information_set_value (LinphoneSignalInformation *signalInformation, float value)
 Set a new value to a LinphoneSignalInformation. More...
 
LinphoneSignalType linphone_signal_information_get_signal_type (LinphoneSignalInformation *signalInformation)
 Get the LinphoneSignalType of the LinphoneSignalInformation. More...
 
void linphone_signal_information_set_signal_type (LinphoneSignalInformation *signalInformation, LinphoneSignalType type)
 Set a new LinphoneSignalType to a LinphoneSignalInformation. More...
 
LinphoneSignalStrengthUnit linphone_signal_information_get_signal_unit (LinphoneSignalInformation *signalInformation)
 Get the LinphoneSignalStrengthUnit value of the LinphoneSignalInformation. More...
 
void linphone_signal_information_set_signal_unit (LinphoneSignalInformation *signalInformation, LinphoneSignalStrengthUnit unit)
 Set a new LinphoneSignalStrengthUnit to a LinphoneSignalInformation. More...
 

Detailed Description

Function Documentation

LinphoneSignalInformation* linphone_signal_information_clone ( const LinphoneSignalInformation signalInformation)

Clone the given signalInformation.

Parameters
signalInformationThe given signalInformation.
Returns
A new signalInformation with exactly same informations that param.
LinphoneSignalType linphone_signal_information_get_signal_type ( LinphoneSignalInformation signalInformation)

Get the LinphoneSignalType of the LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
Returns
A LinphoneSignalType.
LinphoneSignalStrengthUnit linphone_signal_information_get_signal_unit ( LinphoneSignalInformation signalInformation)

Get the LinphoneSignalStrengthUnit value of the LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
Returns
A LinphoneSignalStrengthUnit.
float linphone_signal_information_get_strength ( LinphoneSignalInformation signalInformation)

Get the value of the LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
Returns
A float containing the value.
LinphoneSignalInformation* linphone_signal_information_ref ( LinphoneSignalInformation signalInformation)

Take a reference on a LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
Returns
the same LinphoneSignalInformation object.
void linphone_signal_information_set_signal_type ( LinphoneSignalInformation signalInformation,
LinphoneSignalType  type 
)

Set a new LinphoneSignalType to a LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
typeThe new LinphoneSignalType to set.
void linphone_signal_information_set_signal_unit ( LinphoneSignalInformation signalInformation,
LinphoneSignalStrengthUnit  unit 
)

Set a new LinphoneSignalStrengthUnit to a LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
unitThe new LinphoneSignalStrengthUnit to set.
void linphone_signal_information_set_value ( LinphoneSignalInformation signalInformation,
float  value 
)

Set a new value to a LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.
valuea float containing the new value to set.
void linphone_signal_information_unref ( LinphoneSignalInformation signalInformation)

Release a LinphoneSignalInformation.

Parameters
signalInformationThe LinphoneSignalInformation object.