Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::DTO::NetworkConfiguration Class Reference

#include <networkconfiguration.h>

Public Member Functions

 NetworkConfiguration (QString baseUrl, bool enableHttps, bool requireHttps, QString certificatePath, QString certificatePassword, qint32 internalHttpPort, qint32 internalHttpsPort, qint32 publicHttpPort, qint32 publicHttpsPort, bool autoDiscovery, bool enableUPnP, bool enableIPv4, bool enableIPv6, bool enableRemoteAccess, QStringList localNetworkSubnets, QStringList localNetworkAddresses, QStringList knownProxies, bool ignoreVirtualInterfaces, QStringList virtualInterfaceNames, bool enablePublishedServerUriByRequest, QStringList publishedServerUriBySubnet, QStringList remoteIPFilter, bool isRemoteIPFilterBlacklist)
 NetworkConfiguration (const NetworkConfiguration &other)
void replaceData (NetworkConfiguration &other)
void setFromJson (QJsonObject source)
QJsonObject toJson () const
QString baseUrl () const
 Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.
void setBaseUrl (QString newBaseUrl)
 Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.
bool enableHttps () const
 Gets or sets a value indicating whether to use HTTPS.
void setEnableHttps (bool newEnableHttps)
 Gets or sets a value indicating whether to use HTTPS.
bool requireHttps () const
 Gets or sets a value indicating whether the server should force connections over HTTPS.
void setRequireHttps (bool newRequireHttps)
 Gets or sets a value indicating whether the server should force connections over HTTPS.
QString certificatePath () const
 Gets or sets the filesystem path of an X.509 certificate to use for SSL.
void setCertificatePath (QString newCertificatePath)
 Gets or sets the filesystem path of an X.509 certificate to use for SSL.
QString certificatePassword () const
 Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath.
void setCertificatePassword (QString newCertificatePassword)
 Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath.
qint32 internalHttpPort () const
 Gets or sets the internal HTTP server port.
void setInternalHttpPort (qint32 newInternalHttpPort)
 Gets or sets the internal HTTP server port.
qint32 internalHttpsPort () const
 Gets or sets the internal HTTPS server port.
void setInternalHttpsPort (qint32 newInternalHttpsPort)
 Gets or sets the internal HTTPS server port.
qint32 publicHttpPort () const
 Gets or sets the public HTTP port.
void setPublicHttpPort (qint32 newPublicHttpPort)
 Gets or sets the public HTTP port.
qint32 publicHttpsPort () const
 Gets or sets the public HTTPS port.
void setPublicHttpsPort (qint32 newPublicHttpsPort)
 Gets or sets the public HTTPS port.
bool autoDiscovery () const
 Gets or sets a value indicating whether Autodiscovery is enabled.
void setAutoDiscovery (bool newAutoDiscovery)
 Gets or sets a value indicating whether Autodiscovery is enabled.
bool enableUPnP () const
 Gets or sets a value indicating whether to enable automatic port forwarding.
void setEnableUPnP (bool newEnableUPnP)
 Gets or sets a value indicating whether to enable automatic port forwarding.
bool enableIPv4 () const
 Gets or sets a value indicating whether IPv6 is enabled.
void setEnableIPv4 (bool newEnableIPv4)
 Gets or sets a value indicating whether IPv6 is enabled.
bool enableIPv6 () const
 Gets or sets a value indicating whether IPv6 is enabled.
void setEnableIPv6 (bool newEnableIPv6)
 Gets or sets a value indicating whether IPv6 is enabled.
bool enableRemoteAccess () const
 Gets or sets a value indicating whether access from outside of the LAN is permitted.
void setEnableRemoteAccess (bool newEnableRemoteAccess)
 Gets or sets a value indicating whether access from outside of the LAN is permitted.
QStringList localNetworkSubnets () const
 Gets or sets the subnets that are deemed to make up the LAN.
void setLocalNetworkSubnets (QStringList newLocalNetworkSubnets)
 Gets or sets the subnets that are deemed to make up the LAN.
QStringList localNetworkAddresses () const
 Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.
void setLocalNetworkAddresses (QStringList newLocalNetworkAddresses)
 Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.
QStringList knownProxies () const
 Gets or sets the known proxies.
void setKnownProxies (QStringList newKnownProxies)
 Gets or sets the known proxies.
bool ignoreVirtualInterfaces () const
 Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding.
void setIgnoreVirtualInterfaces (bool newIgnoreVirtualInterfaces)
 Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding.
QStringList virtualInterfaceNames () const
 Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive.

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces

.

void setVirtualInterfaceNames (QStringList newVirtualInterfaceNames)
 Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive.

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces

.

bool enablePublishedServerUriByRequest () const
 Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.
void setEnablePublishedServerUriByRequest (bool newEnablePublishedServerUriByRequest)
 Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.
QStringList publishedServerUriBySubnet () const
void setPublishedServerUriBySubnet (QStringList newPublishedServerUriBySubnet)
QStringList remoteIPFilter () const
 Gets or sets the filter for remote IP connectivity. Used in conjunction with

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist

.

void setRemoteIPFilter (QStringList newRemoteIPFilter)
 Gets or sets the filter for remote IP connectivity. Used in conjunction with

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist

.

bool isRemoteIPFilterBlacklist () const
 Gets or sets a value indicating whether

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter

contains a blacklist or a whitelist. Default is a whitelist.

void setIsRemoteIPFilterBlacklist (bool newIsRemoteIPFilterBlacklist)
 Gets or sets a value indicating whether

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter

contains a blacklist or a whitelist. Default is a whitelist.

Static Public Member Functions

static NetworkConfiguration fromJson (QJsonObject source)

Protected Attributes

QString m_baseUrl
bool m_enableHttps
bool m_requireHttps
QString m_certificatePath
QString m_certificatePassword
qint32 m_internalHttpPort
qint32 m_internalHttpsPort
qint32 m_publicHttpPort
qint32 m_publicHttpsPort
bool m_autoDiscovery
bool m_enableUPnP
bool m_enableIPv4
bool m_enableIPv6
bool m_enableRemoteAccess
QStringList m_localNetworkSubnets
QStringList m_localNetworkAddresses
QStringList m_knownProxies
bool m_ignoreVirtualInterfaces
QStringList m_virtualInterfaceNames
bool m_enablePublishedServerUriByRequest
QStringList m_publishedServerUriBySubnet
QStringList m_remoteIPFilter
bool m_isRemoteIPFilterBlacklist

Constructor & Destructor Documentation

◆ NetworkConfiguration() [1/2]

Jellyfin::DTO::NetworkConfiguration::NetworkConfiguration ( QString baseUrl,
bool enableHttps,
bool requireHttps,
QString certificatePath,
QString certificatePassword,
qint32 internalHttpPort,
qint32 internalHttpsPort,
qint32 publicHttpPort,
qint32 publicHttpsPort,
bool autoDiscovery,
bool enableUPnP,
bool enableIPv4,
bool enableIPv6,
bool enableRemoteAccess,
QStringList localNetworkSubnets,
QStringList localNetworkAddresses,
QStringList knownProxies,
bool ignoreVirtualInterfaces,
QStringList virtualInterfaceNames,
bool enablePublishedServerUriByRequest,
QStringList publishedServerUriBySubnet,
QStringList remoteIPFilter,
bool isRemoteIPFilterBlacklist )

◆ NetworkConfiguration() [2/2]

Jellyfin::DTO::NetworkConfiguration::NetworkConfiguration ( const NetworkConfiguration & other)

Member Function Documentation

◆ autoDiscovery()

bool Jellyfin::DTO::NetworkConfiguration::autoDiscovery ( ) const

Gets or sets a value indicating whether Autodiscovery is enabled.

◆ baseUrl()

QString Jellyfin::DTO::NetworkConfiguration::baseUrl ( ) const

Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.

◆ certificatePassword()

QString Jellyfin::DTO::NetworkConfiguration::certificatePassword ( ) const

Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath.

◆ certificatePath()

QString Jellyfin::DTO::NetworkConfiguration::certificatePath ( ) const

Gets or sets the filesystem path of an X.509 certificate to use for SSL.

◆ enableHttps()

bool Jellyfin::DTO::NetworkConfiguration::enableHttps ( ) const

Gets or sets a value indicating whether to use HTTPS.

◆ enableIPv4()

bool Jellyfin::DTO::NetworkConfiguration::enableIPv4 ( ) const

Gets or sets a value indicating whether IPv6 is enabled.

◆ enableIPv6()

bool Jellyfin::DTO::NetworkConfiguration::enableIPv6 ( ) const

Gets or sets a value indicating whether IPv6 is enabled.

◆ enablePublishedServerUriByRequest()

bool Jellyfin::DTO::NetworkConfiguration::enablePublishedServerUriByRequest ( ) const

Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.

◆ enableRemoteAccess()

bool Jellyfin::DTO::NetworkConfiguration::enableRemoteAccess ( ) const

Gets or sets a value indicating whether access from outside of the LAN is permitted.

◆ enableUPnP()

bool Jellyfin::DTO::NetworkConfiguration::enableUPnP ( ) const

Gets or sets a value indicating whether to enable automatic port forwarding.

◆ fromJson()

NetworkConfiguration Jellyfin::DTO::NetworkConfiguration::fromJson ( QJsonObject source)
static

◆ ignoreVirtualInterfaces()

bool Jellyfin::DTO::NetworkConfiguration::ignoreVirtualInterfaces ( ) const

Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding.

◆ internalHttpPort()

qint32 Jellyfin::DTO::NetworkConfiguration::internalHttpPort ( ) const

Gets or sets the internal HTTP server port.

◆ internalHttpsPort()

qint32 Jellyfin::DTO::NetworkConfiguration::internalHttpsPort ( ) const

Gets or sets the internal HTTPS server port.

◆ isRemoteIPFilterBlacklist()

bool Jellyfin::DTO::NetworkConfiguration::isRemoteIPFilterBlacklist ( ) const

Gets or sets a value indicating whether

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter

contains a blacklist or a whitelist. Default is a whitelist.

◆ knownProxies()

QStringList Jellyfin::DTO::NetworkConfiguration::knownProxies ( ) const

Gets or sets the known proxies.

◆ localNetworkAddresses()

QStringList Jellyfin::DTO::NetworkConfiguration::localNetworkAddresses ( ) const

Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.

◆ localNetworkSubnets()

QStringList Jellyfin::DTO::NetworkConfiguration::localNetworkSubnets ( ) const

Gets or sets the subnets that are deemed to make up the LAN.

◆ publicHttpPort()

qint32 Jellyfin::DTO::NetworkConfiguration::publicHttpPort ( ) const

Gets or sets the public HTTP port.

◆ publicHttpsPort()

qint32 Jellyfin::DTO::NetworkConfiguration::publicHttpsPort ( ) const

Gets or sets the public HTTPS port.

◆ publishedServerUriBySubnet()

QStringList Jellyfin::DTO::NetworkConfiguration::publishedServerUriBySubnet ( ) const
   @brief Gets or sets the PublishedServerUriBySubnet

Gets or sets PublishedServerUri to advertise for specific subnets.

◆ remoteIPFilter()

QStringList Jellyfin::DTO::NetworkConfiguration::remoteIPFilter ( ) const

Gets or sets the filter for remote IP connectivity. Used in conjunction with

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist

.

◆ replaceData()

void Jellyfin::DTO::NetworkConfiguration::replaceData ( NetworkConfiguration & other)

Replaces the data being hold by this class with that of the other.

◆ requireHttps()

bool Jellyfin::DTO::NetworkConfiguration::requireHttps ( ) const

Gets or sets a value indicating whether the server should force connections over HTTPS.

◆ setAutoDiscovery()

void Jellyfin::DTO::NetworkConfiguration::setAutoDiscovery ( bool newAutoDiscovery)

Gets or sets a value indicating whether Autodiscovery is enabled.

◆ setBaseUrl()

void Jellyfin::DTO::NetworkConfiguration::setBaseUrl ( QString newBaseUrl)

Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.

◆ setCertificatePassword()

void Jellyfin::DTO::NetworkConfiguration::setCertificatePassword ( QString newCertificatePassword)

Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath.

◆ setCertificatePath()

void Jellyfin::DTO::NetworkConfiguration::setCertificatePath ( QString newCertificatePath)

Gets or sets the filesystem path of an X.509 certificate to use for SSL.

◆ setEnableHttps()

void Jellyfin::DTO::NetworkConfiguration::setEnableHttps ( bool newEnableHttps)

Gets or sets a value indicating whether to use HTTPS.

◆ setEnableIPv4()

void Jellyfin::DTO::NetworkConfiguration::setEnableIPv4 ( bool newEnableIPv4)

Gets or sets a value indicating whether IPv6 is enabled.

◆ setEnableIPv6()

void Jellyfin::DTO::NetworkConfiguration::setEnableIPv6 ( bool newEnableIPv6)

Gets or sets a value indicating whether IPv6 is enabled.

◆ setEnablePublishedServerUriByRequest()

void Jellyfin::DTO::NetworkConfiguration::setEnablePublishedServerUriByRequest ( bool newEnablePublishedServerUriByRequest)

Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.

◆ setEnableRemoteAccess()

void Jellyfin::DTO::NetworkConfiguration::setEnableRemoteAccess ( bool newEnableRemoteAccess)

Gets or sets a value indicating whether access from outside of the LAN is permitted.

◆ setEnableUPnP()

void Jellyfin::DTO::NetworkConfiguration::setEnableUPnP ( bool newEnableUPnP)

Gets or sets a value indicating whether to enable automatic port forwarding.

◆ setFromJson()

void Jellyfin::DTO::NetworkConfiguration::setFromJson ( QJsonObject source)

◆ setIgnoreVirtualInterfaces()

void Jellyfin::DTO::NetworkConfiguration::setIgnoreVirtualInterfaces ( bool newIgnoreVirtualInterfaces)

Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding.

◆ setInternalHttpPort()

void Jellyfin::DTO::NetworkConfiguration::setInternalHttpPort ( qint32 newInternalHttpPort)

Gets or sets the internal HTTP server port.

◆ setInternalHttpsPort()

void Jellyfin::DTO::NetworkConfiguration::setInternalHttpsPort ( qint32 newInternalHttpsPort)

Gets or sets the internal HTTPS server port.

◆ setIsRemoteIPFilterBlacklist()

void Jellyfin::DTO::NetworkConfiguration::setIsRemoteIPFilterBlacklist ( bool newIsRemoteIPFilterBlacklist)

Gets or sets a value indicating whether

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter

contains a blacklist or a whitelist. Default is a whitelist.

◆ setKnownProxies()

void Jellyfin::DTO::NetworkConfiguration::setKnownProxies ( QStringList newKnownProxies)

Gets or sets the known proxies.

◆ setLocalNetworkAddresses()

void Jellyfin::DTO::NetworkConfiguration::setLocalNetworkAddresses ( QStringList newLocalNetworkAddresses)

Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.

◆ setLocalNetworkSubnets()

void Jellyfin::DTO::NetworkConfiguration::setLocalNetworkSubnets ( QStringList newLocalNetworkSubnets)

Gets or sets the subnets that are deemed to make up the LAN.

◆ setPublicHttpPort()

void Jellyfin::DTO::NetworkConfiguration::setPublicHttpPort ( qint32 newPublicHttpPort)

Gets or sets the public HTTP port.

◆ setPublicHttpsPort()

void Jellyfin::DTO::NetworkConfiguration::setPublicHttpsPort ( qint32 newPublicHttpsPort)

Gets or sets the public HTTPS port.

◆ setPublishedServerUriBySubnet()

void Jellyfin::DTO::NetworkConfiguration::setPublishedServerUriBySubnet ( QStringList newPublishedServerUriBySubnet)
  @brief Gets or sets the PublishedServerUriBySubnet

Gets or sets PublishedServerUri to advertise for specific subnets.

◆ setRemoteIPFilter()

void Jellyfin::DTO::NetworkConfiguration::setRemoteIPFilter ( QStringList newRemoteIPFilter)

Gets or sets the filter for remote IP connectivity. Used in conjunction with

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist

.

◆ setRequireHttps()

void Jellyfin::DTO::NetworkConfiguration::setRequireHttps ( bool newRequireHttps)

Gets or sets a value indicating whether the server should force connections over HTTPS.

◆ setVirtualInterfaceNames()

void Jellyfin::DTO::NetworkConfiguration::setVirtualInterfaceNames ( QStringList newVirtualInterfaceNames)

Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive.

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces

.

◆ toJson()

QJsonObject Jellyfin::DTO::NetworkConfiguration::toJson ( ) const

◆ virtualInterfaceNames()

QStringList Jellyfin::DTO::NetworkConfiguration::virtualInterfaceNames ( ) const

Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive.

See also
P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces

.

Member Data Documentation

◆ m_autoDiscovery

bool Jellyfin::DTO::NetworkConfiguration::m_autoDiscovery
protected

◆ m_baseUrl

QString Jellyfin::DTO::NetworkConfiguration::m_baseUrl
protected

◆ m_certificatePassword

QString Jellyfin::DTO::NetworkConfiguration::m_certificatePassword
protected

◆ m_certificatePath

QString Jellyfin::DTO::NetworkConfiguration::m_certificatePath
protected

◆ m_enableHttps

bool Jellyfin::DTO::NetworkConfiguration::m_enableHttps
protected

◆ m_enableIPv4

bool Jellyfin::DTO::NetworkConfiguration::m_enableIPv4
protected

◆ m_enableIPv6

bool Jellyfin::DTO::NetworkConfiguration::m_enableIPv6
protected

◆ m_enablePublishedServerUriByRequest

bool Jellyfin::DTO::NetworkConfiguration::m_enablePublishedServerUriByRequest
protected

◆ m_enableRemoteAccess

bool Jellyfin::DTO::NetworkConfiguration::m_enableRemoteAccess
protected

◆ m_enableUPnP

bool Jellyfin::DTO::NetworkConfiguration::m_enableUPnP
protected

◆ m_ignoreVirtualInterfaces

bool Jellyfin::DTO::NetworkConfiguration::m_ignoreVirtualInterfaces
protected

◆ m_internalHttpPort

qint32 Jellyfin::DTO::NetworkConfiguration::m_internalHttpPort
protected

◆ m_internalHttpsPort

qint32 Jellyfin::DTO::NetworkConfiguration::m_internalHttpsPort
protected

◆ m_isRemoteIPFilterBlacklist

bool Jellyfin::DTO::NetworkConfiguration::m_isRemoteIPFilterBlacklist
protected

◆ m_knownProxies

QStringList Jellyfin::DTO::NetworkConfiguration::m_knownProxies
protected

◆ m_localNetworkAddresses

QStringList Jellyfin::DTO::NetworkConfiguration::m_localNetworkAddresses
protected

◆ m_localNetworkSubnets

QStringList Jellyfin::DTO::NetworkConfiguration::m_localNetworkSubnets
protected

◆ m_publicHttpPort

qint32 Jellyfin::DTO::NetworkConfiguration::m_publicHttpPort
protected

◆ m_publicHttpsPort

qint32 Jellyfin::DTO::NetworkConfiguration::m_publicHttpsPort
protected

◆ m_publishedServerUriBySubnet

QStringList Jellyfin::DTO::NetworkConfiguration::m_publishedServerUriBySubnet
protected

◆ m_remoteIPFilter

QStringList Jellyfin::DTO::NetworkConfiguration::m_remoteIPFilter
protected

◆ m_requireHttps

bool Jellyfin::DTO::NetworkConfiguration::m_requireHttps
protected

◆ m_virtualInterfaceNames

QStringList Jellyfin::DTO::NetworkConfiguration::m_virtualInterfaceNames
protected

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