Ring Daemon 16.0.0
Loading...
Searching...
No Matches
jami::SipAccountBaseConfig Struct Reference

#include <sipaccountbase_config.h>

Inheritance diagram for jami::SipAccountBaseConfig:
Inheritance graph
Collaboration diagram for jami::SipAccountBaseConfig:
Collaboration graph

Public Member Functions

void fromMap (const std::map< std::string, std::string > &) override
 
void serializeDiff (YAML::Emitter &out, const SipAccountBaseConfig &def) const
 
 SipAccountBaseConfig (const std::string &type, const std::string &id, const std::filesystem::path &path)
 
std::map< std::string, std::string > toMap () const override
 
void unserialize (const YAML::Node &node) override
 
- Public Member Functions inherited from jami::AccountConfig
 AccountConfig (const std::string &type_, const std::string &id_, const std::filesystem::path &path_={})
 
virtual void serialize (YAML::Emitter &out) const =0
 
void serializeDiff (YAML::Emitter &out, const AccountConfig &def) const
 
- Public Member Functions inherited from jami::Serializable
virtual ~Serializable ()
 

Public Attributes

std::pair< uint16_t, uint16_taudioPortRange {16384, 32766}
 
std::string dtmfType {OVERRTP_STR}
 
std::string interface {"default"}
 interface name on which this account is bound
 
std::string publishedIp
 
bool publishedSameasLocal {true}
 Flag which determine if localIpAddress_ or publishedIpAddress_ is used in sip headers.
 
std::string tlsCaListFile
 
std::string tlsCertificateFile
 
std::string tlsPassword
 
std::string tlsPrivateKeyFile
 
bool turnEnabled {false}
 Determine if TURN public address resolution is required to register this account.
 
std::string turnServer
 The TURN server hostname (optional), used to provide the public IP address in case the softphone stay behind a NAT.
 
std::string turnServerPwd
 
std::string turnServerRealm
 
std::string turnServerUserName
 
std::pair< uint16_t, uint16_tvideoPortRange {49152, (65536) -2}
 Port range for video RTP ports.
 
- Public Attributes inherited from jami::AccountConfig
int activeCallLimit {-1}
 The number of concurrent calls for the account -1: Unlimited 0: Do not disturb 1: Single call +: Multi line.
 
std::vector< unsignedactiveCodecs {}
 
std::string alias {}
 A user-defined name for this account.
 
bool allModeratorsEnabled {true}
 
bool autoAnswerEnabled {false}
 If true, automatically answer calls to this account.
 
std::string customUserAgent {}
 User-agent used for registration.
 
std::set< std::string > defaultModerators {}
 
bool denySecondCallEnabled {false}
 If true, automatically deny new calls when already in one call to this account.
 
std::string deviceKey {}
 Device push notification token.
 
std::string displayName {}
 Display name when calling.
 
bool enabled {true}
 True if the account is enabled.
 
std::string hostname {}
 SIP hostname (SIP account) or DHT bootstrap nodes (Jami account)
 
const std::string id
 Account id.
 
bool isRendezVous {false}
 If true mix calls into a conference.
 
bool localModeratorsEnabled {true}
 
std::string mailbox {}
 Account mail box.
 
std::string notificationTopic {}
 Push notification topic.
 
const std::filesystem::path path
 Path where the configuration file is stored.
 
std::string platform {}
 Device push notification platform.
 
bool ringtoneEnabled {true}
 Play ringtone when receiving a call.
 
std::string ringtonePath {DEFAULT_RINGTONE_PATH}
 Ringtone file used for this account.
 
bool sendComposing {true}
 If true, send composing status (and emit to the client)
 
bool sendReadReceipt {true}
 If true, send displayed status (and emit to the client)
 
const std::string type
 Account type.
 
std::string uiCustomization {}
 information about the customization of ui
 
bool upnpEnabled {true}
 UPnP IGD controller and the mutex to access it.
 
std::string username {}
 
bool videoEnabled {true}
 Allows user to temporarily disable video calling.
 

Detailed Description

Definition at line 26 of file sipaccountbase_config.h.

Constructor & Destructor Documentation

◆ SipAccountBaseConfig()

jami::SipAccountBaseConfig::SipAccountBaseConfig ( const std::string &  type,
const std::string &  id,
const std::filesystem::path &  path 
)
inline

Definition at line 27 of file sipaccountbase_config.h.

Member Function Documentation

◆ fromMap()

◆ serializeDiff()

◆ toMap()

◆ unserialize()

Member Data Documentation

◆ audioPortRange

std::pair<uint16_t, uint16_t> jami::SipAccountBaseConfig::audioPortRange {16384, 32766}

Definition at line 73 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ dtmfType

◆ interface

std::string jami::SipAccountBaseConfig::interface {"default"}

interface name on which this account is bound

Definition at line 39 of file sipaccountbase_config.h.

Referenced by fromMap(), jami::SIPAccountBase::getLocalInterface(), serializeDiff(), toMap(), and unserialize().

◆ publishedIp

◆ publishedSameasLocal

bool jami::SipAccountBaseConfig::publishedSameasLocal {true}

Flag which determine if localIpAddress_ or publishedIpAddress_ is used in sip headers.

Definition at line 45 of file sipaccountbase_config.h.

Referenced by jami::SipAccountConfig::fromMap(), fromMap(), jami::SIPAccountBase::getPublishedSameasLocal(), serializeDiff(), jami::SipAccountConfig::toMap(), toMap(), and unserialize().

◆ tlsCaListFile

◆ tlsCertificateFile

◆ tlsPassword

◆ tlsPrivateKeyFile

◆ turnEnabled

bool jami::SipAccountBaseConfig::turnEnabled {false}

Determine if TURN public address resolution is required to register this account.

In this case a TURN server hostname must be specified.

Definition at line 53 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ turnServer

std::string jami::SipAccountBaseConfig::turnServer

The TURN server hostname (optional), used to provide the public IP address in case the softphone stay behind a NAT.

Definition at line 59 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ turnServerPwd

std::string jami::SipAccountBaseConfig::turnServerPwd

Definition at line 61 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ turnServerRealm

std::string jami::SipAccountBaseConfig::turnServerRealm

Definition at line 62 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ turnServerUserName

std::string jami::SipAccountBaseConfig::turnServerUserName

Definition at line 60 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ videoPortRange

std::pair<uint16_t, uint16_t> jami::SipAccountBaseConfig::videoPortRange {49152, (65536) -2}

Port range for video RTP ports.

Definition at line 78 of file sipaccountbase_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().


The documentation for this struct was generated from the following files: