Liblinphone
5.3.0
|
The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Core itself. More...
#include <factory.hh>
Public Member Functions | |
LINPHONECXX_PUBLIC | Factory (void *ptr, bool takeRef=true) |
LINPHONECXX_PUBLIC _LinphoneFactory * | cPtr () |
LINPHONECXX_PUBLIC void | setCacheDir (const std::string &path) |
Set the directory where the application local cache is located. More... | |
LINPHONECXX_PUBLIC void | setConfigDir (const std::string &path) |
Set the directory where the configurations are located. More... | |
LINPHONECXX_PUBLIC void | setDataDir (const std::string &path) |
Set the directory where the application local data are located. More... | |
LINPHONECXX_PUBLIC std::string | getDataResourcesDir () |
Get the directory where the data resources are located. More... | |
LINPHONECXX_PUBLIC void | setDataResourcesDir (const std::string &path) |
Set the directory where the data resources are located. More... | |
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::DialPlan > > | getDialPlans () const |
Returns a bctbx_list_t of all DialPlans. More... | |
LINPHONECXX_PUBLIC void | setDownloadDir (const std::string &path) |
Set the directory where downloads are located. More... | |
LINPHONECXX_PUBLIC std::string | getImageResourcesDir () |
Get the directory where the image resources are located. More... | |
LINPHONECXX_PUBLIC void | setImageResourcesDir (const std::string &path) |
Set the directory where the image resources are located. More... | |
LINPHONECXX_PUBLIC bool | isCacheDirSet () const |
Test if cache dir has been set. More... | |
LINPHONECXX_PUBLIC bool | isConfigDirSet () const |
Test if config dir has been set. More... | |
LINPHONECXX_PUBLIC bool | isDataDirSet () const |
Test if data dir has been set. More... | |
LINPHONECXX_PUBLIC bool | isDatabaseStorageAvailable () |
Indicates if the storage in database is available. More... | |
LINPHONECXX_PUBLIC bool | isDownloadDirSet () const |
Test if download dir has been set. More... | |
LINPHONECXX_PUBLIC bool | isImdnAvailable () |
Indicates if IMDN are available. More... | |
LINPHONECXX_PUBLIC bool | isQrcodeAvailable () |
Indicates if the QRCode feature is available. More... | |
LINPHONECXX_PUBLIC std::string | getLiblinphonePluginsDir () |
Get the directory where the liblinphone plugins are located. More... | |
LINPHONECXX_PUBLIC void | setLiblinphonePluginsDir (const std::string &path) |
Set the directory where the liblinphone plugins are located. More... | |
LINPHONECXX_PUBLIC void | setLogCollectionPath (const std::string &path) |
Sets the log collection path. More... | |
LINPHONECXX_PUBLIC std::string | getMspluginsDir () |
Get the directory where the mediastreamer2 plugins are located. More... | |
LINPHONECXX_PUBLIC void | setMspluginsDir (const std::string &path) |
Set the directory where the mediastreamer2 plugins are located. More... | |
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::VideoDefinition > > | getRecommendedVideoDefinitions () const |
Get the recommended list of standard video definitions. More... | |
LINPHONECXX_PUBLIC std::string | getRingResourcesDir () |
Get the directory where the ring resources are located. More... | |
LINPHONECXX_PUBLIC void | setRingResourcesDir (const std::string &path) |
Set the directory where the ring resources are located. More... | |
LINPHONECXX_PUBLIC std::string | getSoundResourcesDir () |
Get the directory where the sound resources are located. More... | |
LINPHONECXX_PUBLIC void | setSoundResourcesDir (const std::string &path) |
Set the directory where the sound resources are located. More... | |
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::VideoDefinition > > | getSupportedVideoDefinitions () const |
Get the list of standard video definitions supported by Linphone. More... | |
LINPHONECXX_PUBLIC std::string | getTopResourcesDir () const |
Get the top directory where the resources are located. More... | |
LINPHONECXX_PUBLIC void | setTopResourcesDir (const std::string &path) |
Set the top directory where the resources are located. More... | |
LINPHONECXX_PUBLIC std::string | computeHa1ForAlgorithm (const std::string &userid, const std::string &password, const std::string &realm, const std::string &algorithm) const |
Computes the hashed version of the password given the user ID and the realm, using given algorithm. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Address > | createAddress (const std::string &addr) const |
Parse a string holding a SIP URI and create the according Address object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::AuthInfo > | createAuthInfo (const std::string &username, const std::string &userid, const std::string &passwd, const std::string &ha1, const std::string &realm, const std::string &domain) const |
Creates a AuthInfo object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::AuthInfo > | createAuthInfo (const std::string &username, const std::string &userid, const std::string &passwd, const std::string &ha1, const std::string &realm, const std::string &domain, const std::string &algorithm) const |
Creates a AuthInfo object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Buffer > | createBuffer () |
Creates an object Buffer. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Buffer > | createBufferFromData (const uint8_t *data, size_t size) |
Creates an object Buffer. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Buffer > | createBufferFromString (const std::string &data) |
Creates an object Buffer. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ConferenceInfo > | createConferenceInfo () |
Creates an object ConferenceInfo. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ConferenceInfo > | createConferenceInfoFromIcalendarContent (const std::shared_ptr< linphone::Content > &content) |
Creates an object ConferenceInfo from an Icalendar Content. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Config > | createConfig (const std::string &path) |
Creates an object Config. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Config > | createConfigFromString (const std::string &data) |
Creates an object Config. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Config > | createConfigWithFactory (const std::string &path, const std::string &factoryPath) |
Creates an object Config. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Content > | createContent () |
Creates an object Content. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Content > | createContentFromFile (const std::string &filePath) |
Creates a file object of Content from a file path. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Core > | createCore (const std::string &configPath, const std::string &factoryConfigPath, void *systemContext) const |
Instantiate a Core object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Core > | createCoreWithConfig (const std::shared_ptr< linphone::Config > &config, void *systemContext) const |
Instantiate a Core object with a given LinphoneConfig. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::DigestAuthenticationPolicy > | createDigestAuthenticationPolicy () const |
Create a DigestAuthenticationPolicy object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ErrorInfo > | createErrorInfo () |
Creates an object LinphoneErrorInfo. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::FriendPhoneNumber > | createFriendPhoneNumber (const std::string &phoneNumber, const std::string &label) const |
Creates a new FriendPhoneNumber objects. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ParticipantDeviceIdentity > | createParticipantDeviceIdentity (const std::shared_ptr< const linphone::Address > &address, const std::string &name) const |
Create a ParticipantDeviceIdentity object. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ParticipantInfo > | createParticipantInfo (const std::shared_ptr< linphone::Address > &address) |
Creates an object ConferenceInfo from an Icalendar Content. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Content > | createQrcode (const std::string &code, unsigned int width, unsigned int height, unsigned int margin) |
Creates a Bitmap QRCode and return it into an object Content. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Range > | createRange () |
Creates an object LinphoneRange. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::SignalInformation > | createSignalInformation () |
Creates an object SignalInformation. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Transports > | createTransports () |
Creates an object LinphoneTransports. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::TunnelConfig > | createTunnelConfig () |
Creates an object TunnelConfig. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Vcard > | createVcard () |
Create an empty Vcard. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::VideoActivationPolicy > | createVideoActivationPolicy () |
Creates an object LinphoneVideoActivationPolicy. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::VideoDefinition > | createVideoDefinition (unsigned int width, unsigned int height) const |
Create a VideoDefinition from a given width and height. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::VideoDefinition > | createVideoDefinitionFromName (const std::string &name) const |
Create a VideoDefinition from a given standard definition name. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::VideoSourceDescriptor > | createVideoSourceDescriptor () |
Creates an object VideoSourceDescriptor. More... | |
LINPHONECXX_PUBLIC void | enableLogCollection (linphone::LogCollectionState state) |
Enables or disables log collection. More... | |
LINPHONECXX_PUBLIC std::string | getCacheDir (void *context) |
Get the cache path. More... | |
LINPHONECXX_PUBLIC std::string | getConfigDir (void *context) |
Get the config path. More... | |
LINPHONECXX_PUBLIC std::string | getDataDir (void *context) |
Get the data path. More... | |
LINPHONECXX_PUBLIC std::string | getDownloadDir (void *context) |
Get the download path. More... | |
LINPHONECXX_PUBLIC bool | isChatroomBackendAvailable (linphone::ChatRoom::Backend chatroomBackend) |
Indicates if the given LinphoneChatRoomBackend is available. More... | |
LINPHONECXX_PUBLIC void | setVfsEncryption (const uint16_t encryptionModule, const uint8_t *secret, const size_t secretSize) |
Select encryption module and set secret material to encrypt the files. More... | |
LINPHONECXX_PUBLIC int | writeQrcodeFile (const std::string &filePath, const std::string &code, unsigned int width, unsigned int height, unsigned int margin) |
Creates a QRCode and write it into a JPEG file specified by file_path (only if build with JPEG). More... | |
Static Public Member Functions | |
static LINPHONECXX_PUBLIC void | clean () |
Clean the factory. More... | |
static LINPHONECXX_PUBLIC std::shared_ptr< linphone::Factory > | get () |
Create the Factory if that has not been done and return a pointer on it. More... | |
The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Core itself.
It is also used to configure a few behaviors before creating the Core, like the logs verbosity or collection.
|
static |
Clean the factory.
This function is generally useless as the factory is unique per process, however calling this function at the end avoid getting reports from belle-sip leak detector about memory leaked in get().
LINPHONECXX_PUBLIC std::string linphone::Factory::computeHa1ForAlgorithm | ( | const std::string & | userid, |
const std::string & | password, | ||
const std::string & | realm, | ||
const std::string & | algorithm | ||
) | const |
Computes the hashed version of the password given the user ID and the realm, using given algorithm.
userid | the username or user ID to use. |
password | the password to hash. |
realm | the real to use. |
algorithm | the algorithm to use (MD5 or SHA-256). |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Address> linphone::Factory::createAddress | ( | const std::string & | addr | ) | const |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::AuthInfo> linphone::Factory::createAuthInfo | ( | const std::string & | username, |
const std::string & | userid, | ||
const std::string & | passwd, | ||
const std::string & | ha1, | ||
const std::string & | realm, | ||
const std::string & | domain | ||
) | const |
Creates a AuthInfo object.
The object can be created empty, that is with all arguments set to nullptr. Username, userid, password, realm and domain can be set later using specific methods. At the end, username and passwd (or ha1) are required.
username | The username that needs to be authenticated |
userid | The userid used for authenticating (use nullptr if you don't know what it is) |
passwd | The password in clear text |
ha1 | The ha1-encrypted password if password is not given in clear text. |
realm | The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter. |
domain | The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::AuthInfo> linphone::Factory::createAuthInfo | ( | const std::string & | username, |
const std::string & | userid, | ||
const std::string & | passwd, | ||
const std::string & | ha1, | ||
const std::string & | realm, | ||
const std::string & | domain, | ||
const std::string & | algorithm | ||
) | const |
Creates a AuthInfo object.
The object can be created empty, that is with all arguments set to nullptr. Username, userid, password, realm and domain can be set later using specific methods. At the end, username and passwd (or ha1) are required.
username | The username that needs to be authenticated |
userid | The userid used for authenticating (use nullptr if you don't know what it is) |
passwd | The password in clear text |
ha1 | The ha1-encrypted password if password is not given in clear text. |
realm | The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter. |
domain | The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain. |
algorithm | The algorithm for encrypting password. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Buffer> linphone::Factory::createBuffer | ( | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Buffer> linphone::Factory::createBufferFromData | ( | const uint8_t * | data, |
size_t | size | ||
) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Buffer> linphone::Factory::createBufferFromString | ( | const std::string & | data | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceInfo> linphone::Factory::createConferenceInfo | ( | ) |
Creates an object ConferenceInfo.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceInfo> linphone::Factory::createConferenceInfoFromIcalendarContent | ( | const std::shared_ptr< linphone::Content > & | content | ) |
Creates an object ConferenceInfo from an Icalendar Content.
content | the Icalendar Content |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Config> linphone::Factory::createConfig | ( | const std::string & | path | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Config> linphone::Factory::createConfigFromString | ( | const std::string & | data | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Config> linphone::Factory::createConfigWithFactory | ( | const std::string & | path, |
const std::string & | factoryPath | ||
) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Content> linphone::Factory::createContent | ( | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Content> linphone::Factory::createContentFromFile | ( | const std::string & | filePath | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Core> linphone::Factory::createCore | ( | const std::string & | configPath, |
const std::string & | factoryConfigPath, | ||
void * | systemContext | ||
) | const |
Instantiate a Core object.
The Core object is the primary handle for doing all phone actions. It should be unique within your application. The Core object is not started automatically, you need to call Core::start() to that effect. The returned Core will be in GlobalState Ready. Core ressources can be released using Core::stop() which is strongly encouraged on garbage collected languages.
configPath | A path to a config file. If it does not exists it will be created. The config file is used to store all settings, proxies... so that all these settings become persistent over the life of the Core object. It is allowed to set a nullptr config file. In that case Core will not store any settings. |
factoryConfigPath | A path to a read-only config file that can be used to store hard-coded preferences such as proxy settings or internal preferences. The settings in this factory file always override the ones in the normal config file. It is optional, use nullptr if unneeded. |
systemContext | A pointer to a system object required by the core to operate. Currently it is required to pass an android Context on android, pass nullptr on other platforms. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Core> linphone::Factory::createCoreWithConfig | ( | const std::shared_ptr< linphone::Config > & | config, |
void * | systemContext | ||
) | const |
Instantiate a Core object with a given LinphoneConfig.
The Core object is the primary handle for doing all phone actions. It should be unique within your application. The Core object is not started automatically, you need to call Core::start() to that effect. The returned Core will be in GlobalState Ready. Core ressources can be released using Core::stop() which is strongly encouraged on garbage collected languages.
config | A Config object holding the configuration for the Core to be instantiated. |
systemContext | A pointer to a system object required by the core to operate. Currently it is required to pass an android Context on android, pass nullptr on other platforms. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::DigestAuthenticationPolicy> linphone::Factory::createDigestAuthenticationPolicy | ( | ) | const |
Create a DigestAuthenticationPolicy object.
The DigestAuthenticationPolicy object which is used to configure a policy for digest authentication, such as allowing MD5 or mode without qop=auth.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ErrorInfo> linphone::Factory::createErrorInfo | ( | ) |
Creates an object LinphoneErrorInfo.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::FriendPhoneNumber> linphone::Factory::createFriendPhoneNumber | ( | const std::string & | phoneNumber, |
const std::string & | label | ||
) | const |
Creates a new FriendPhoneNumber objects.
phoneNumber | The phone number. |
label | the type of phone number, for example "home", "cell", etc. Use nullptr or empty for no label. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ParticipantDeviceIdentity> linphone::Factory::createParticipantDeviceIdentity | ( | const std::shared_ptr< const linphone::Address > & | address, |
const std::string & | name | ||
) | const |
Create a ParticipantDeviceIdentity object.
address | Address object. |
name | the name given to the device. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ParticipantInfo> linphone::Factory::createParticipantInfo | ( | const std::shared_ptr< linphone::Address > & | address | ) |
Creates an object ConferenceInfo from an Icalendar Content.
address | the Address of the participant |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Content> linphone::Factory::createQrcode | ( | const std::string & | code, |
unsigned int | width, | ||
unsigned int | height, | ||
unsigned int | margin | ||
) |
Creates a Bitmap QRCode and return it into an object Content.
code | The code to be generated into an image. It must not be empty. |
width | The requested width of the QRCode image. It will be 100 if 0. |
height | The requested height of the QRCode image. It will be 100 if 0. |
margin | The requested margin of the QRCode image. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Range> linphone::Factory::createRange | ( | ) |
Creates an object LinphoneRange.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::SignalInformation> linphone::Factory::createSignalInformation | ( | ) |
Creates an object SignalInformation.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Transports> linphone::Factory::createTransports | ( | ) |
Creates an object LinphoneTransports.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::TunnelConfig> linphone::Factory::createTunnelConfig | ( | ) |
Creates an object TunnelConfig.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Vcard> linphone::Factory::createVcard | ( | ) |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::VideoActivationPolicy> linphone::Factory::createVideoActivationPolicy | ( | ) |
Creates an object LinphoneVideoActivationPolicy.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::VideoDefinition> linphone::Factory::createVideoDefinition | ( | unsigned int | width, |
unsigned int | height | ||
) | const |
Create a VideoDefinition from a given width and height.
width | The width of the created video definition |
height | The height of the created video definition |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::VideoDefinition> linphone::Factory::createVideoDefinitionFromName | ( | const std::string & | name | ) | const |
Create a VideoDefinition from a given standard definition name.
name | The standard definition name of the video definition to create |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::VideoSourceDescriptor> linphone::Factory::createVideoSourceDescriptor | ( | ) |
Creates an object VideoSourceDescriptor.
LINPHONECXX_PUBLIC void linphone::Factory::enableLogCollection | ( | linphone::LogCollectionState | state | ) |
Enables or disables log collection.
state | the LogCollectionState for log collection |
|
static |
LINPHONECXX_PUBLIC std::string linphone::Factory::getCacheDir | ( | void * | context | ) |
Get the cache path.
context | used to compute path. Can be nullptr. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core. |
LINPHONECXX_PUBLIC std::string linphone::Factory::getConfigDir | ( | void * | context | ) |
Get the config path.
context | used to compute path. Can be nullptr. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core. |
LINPHONECXX_PUBLIC std::string linphone::Factory::getDataDir | ( | void * | context | ) |
Get the data path.
context | used to compute path. Can be nullptr. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core. |
LINPHONECXX_PUBLIC std::string linphone::Factory::getDataResourcesDir | ( | ) |
Get the directory where the data resources are located.
LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::DialPlan> > linphone::Factory::getDialPlans | ( | ) | const |
Returns a bctbx_list_t of all DialPlans.
LINPHONECXX_PUBLIC std::string linphone::Factory::getDownloadDir | ( | void * | context | ) |
Get the download path.
context | used to compute path. Can be nullptr. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core. |
LINPHONECXX_PUBLIC std::string linphone::Factory::getImageResourcesDir | ( | ) |
Get the directory where the image resources are located.
LINPHONECXX_PUBLIC std::string linphone::Factory::getLiblinphonePluginsDir | ( | ) |
Get the directory where the liblinphone plugins are located.
LINPHONECXX_PUBLIC std::string linphone::Factory::getMspluginsDir | ( | ) |
Get the directory where the mediastreamer2 plugins are located.
LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::VideoDefinition> > linphone::Factory::getRecommendedVideoDefinitions | ( | ) | const |
Get the recommended list of standard video definitions.
This list is suitable for a widest set of hardware for all video codec implementations, and thus excludes some very high definition formats that are unlikely to work unless specific hardware or codecs are used.
LINPHONECXX_PUBLIC std::string linphone::Factory::getRingResourcesDir | ( | ) |
Get the directory where the ring resources are located.
LINPHONECXX_PUBLIC std::string linphone::Factory::getSoundResourcesDir | ( | ) |
Get the directory where the sound resources are located.
LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::VideoDefinition> > linphone::Factory::getSupportedVideoDefinitions | ( | ) | const |
Get the list of standard video definitions supported by Linphone.
LINPHONECXX_PUBLIC std::string linphone::Factory::getTopResourcesDir | ( | ) | const |
Get the top directory where the resources are located.
LINPHONECXX_PUBLIC bool linphone::Factory::isCacheDirSet | ( | ) | const |
Test if cache dir has been set.
LINPHONECXX_PUBLIC bool linphone::Factory::isChatroomBackendAvailable | ( | linphone::ChatRoom::Backend | chatroomBackend | ) |
Indicates if the given LinphoneChatRoomBackend is available.
chatroomBackend | the ChatRoom::Backend |
LINPHONECXX_PUBLIC bool linphone::Factory::isConfigDirSet | ( | ) | const |
Test if config dir has been set.
LINPHONECXX_PUBLIC bool linphone::Factory::isDatabaseStorageAvailable | ( | ) |
Indicates if the storage in database is available.
LINPHONECXX_PUBLIC bool linphone::Factory::isDataDirSet | ( | ) | const |
Test if data dir has been set.
LINPHONECXX_PUBLIC bool linphone::Factory::isDownloadDirSet | ( | ) | const |
Test if download dir has been set.
LINPHONECXX_PUBLIC bool linphone::Factory::isImdnAvailable | ( | ) |
Indicates if IMDN are available.
LINPHONECXX_PUBLIC bool linphone::Factory::isQrcodeAvailable | ( | ) |
Indicates if the QRCode feature is available.
LINPHONECXX_PUBLIC void linphone::Factory::setCacheDir | ( | const std::string & | path | ) |
Set the directory where the application local cache is located.
If the path is empty (default value), the path will be computed when calling getDataDir()
path | The path to the directory where the application local cache is located |
LINPHONECXX_PUBLIC void linphone::Factory::setConfigDir | ( | const std::string & | path | ) |
Set the directory where the configurations are located.
If the path is empty (default value), the path will be computed when calling getConfigDir()
path | The path to the directory where the configurations are located |
LINPHONECXX_PUBLIC void linphone::Factory::setDataDir | ( | const std::string & | path | ) |
Set the directory where the application local data are located.
If the path is empty (default value), the path will be computed when calling getDataDir()
path | The path to the directory where the application local data are located |
LINPHONECXX_PUBLIC void linphone::Factory::setDataResourcesDir | ( | const std::string & | path | ) |
Set the directory where the data resources are located.
path | The path where the data resources are located |
LINPHONECXX_PUBLIC void linphone::Factory::setDownloadDir | ( | const std::string & | path | ) |
Set the directory where downloads are located.
If the path is empty (default value), the path will be computed when calling getDownloadDir()
path | The path to the directory where downloads are located |
LINPHONECXX_PUBLIC void linphone::Factory::setImageResourcesDir | ( | const std::string & | path | ) |
Set the directory where the image resources are located.
path | The path where the image resources are located |
LINPHONECXX_PUBLIC void linphone::Factory::setLiblinphonePluginsDir | ( | const std::string & | path | ) |
Set the directory where the liblinphone plugins are located.
path | The path to the directory where the liblinphone plugins are located |
LINPHONECXX_PUBLIC void linphone::Factory::setLogCollectionPath | ( | const std::string & | path | ) |
Sets the log collection path.
path | the path of the logs |
LINPHONECXX_PUBLIC void linphone::Factory::setMspluginsDir | ( | const std::string & | path | ) |
Set the directory where the mediastreamer2 plugins are located.
path | The path to the directory where the mediastreamer2 plugins are located |
LINPHONECXX_PUBLIC void linphone::Factory::setRingResourcesDir | ( | const std::string & | path | ) |
Set the directory where the ring resources are located.
path | The path where the ring resources are located |
LINPHONECXX_PUBLIC void linphone::Factory::setSoundResourcesDir | ( | const std::string & | path | ) |
Set the directory where the sound resources are located.
path | The path where the sound resources are located |
LINPHONECXX_PUBLIC void linphone::Factory::setTopResourcesDir | ( | const std::string & | path | ) |
Set the top directory where the resources are located.
If you only define this top directory, the other resources directory will automatically be derived form this one.
path | The path to the top directory where the resources are located |
LINPHONECXX_PUBLIC void linphone::Factory::setVfsEncryption | ( | const uint16_t | encryptionModule, |
const uint8_t * | secret, | ||
const size_t | secretSize | ||
) |
Select encryption module and set secret material to encrypt the files.
encryptionModule | One of the available encryption module for VFS, pick in the LINPHONE_VFS_ENCRYPTION_* list if set to _UNSET, default bctoolbox VFS is switch to Standard one |
secret | the secret material used to encrypt the files, can be nullptr for the _PLAIN module |
secretSize | size of the secret |
LINPHONECXX_PUBLIC int linphone::Factory::writeQrcodeFile | ( | const std::string & | filePath, |
const std::string & | code, | ||
unsigned int | width, | ||
unsigned int | height, | ||
unsigned int | margin | ||
) |
Creates a QRCode and write it into a JPEG file specified by file_path (only if build with JPEG).
filePath | The file where to write the QRCode JPEG image. |
code | The code to be generated into an image. It must not be empty. |
width | The requested width of the QRCode image. It will be 100 if 0. |
height | The requested height of the QRCode image. It will be 100 if 0. |
margin | The requested margin of the QRCode image. |