Player Network Interface Settings Entity (2022/06)
The player network interface settings entities follow one of the structures below, depending on the type of network interface (see Type
):
Player Network Interface Settings
(this is the base definition):
Name
string read-write: The target network interface name (typically "eth0", “usb0”, “wlan0”, or “ppp0”)Type
PlayerNetworkInterfaceType read-only: One of "Ethernet”, “WiFi”, “Virtual”, “Cellular”, or “Other”
Player Ethernet Interface Settings
:
Enabled
bool read-write: Whether the player Ethernet settings are enabledName
string read-write: The target network interface name (typically “eth0”)Type
PlayerNetworkInterfaceType read-only: "Ethernet”Proto
NetworkConfigurationProtocol read-write: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"IP
string[] read-write: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.Gateway
string read-write: In the “Static” network configuration, this defines the optional IPv4 address of the default gateway to be used by the current network interface. When absent, this interface is link local only.DNS
string[] read-write: The DNS address(es) of the deviceRateLimitDuringInitialDownloads
Nullable<uint> read-write: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.RateLimitInsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the Player Synchronization Settings Entity (2022/06) define the inside content download window.RateLimitOutsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.ContentDownloadEnabled
bool read-write: Whether content data is allowed to be downloaded using this connectionTextFeedsDownloadEnabled
bool read-write: Whether text feed data is allowed to be downloaded using this connectionMediaFeedsDownloadEnabled
bool read-write: Whether media feed data is allowed to be downloaded using this connectionHealthReportingEnabled
bool read-write: Whether uploading health reporting data is enabled using this connectionLogsUploadEnabled
bool read-write: Whether uploading log updates is enabled using this connection
Player Virtual Interface Settings
:
Enabled
bool read-write: Defines whether the particular virtual network interface is enabledName
string read-write: The target network interface name (typically "eth0.110")Type
PlayerNetworkInterfaceType read-only: "Virtual”Parent
string read-write: The name of the associated link or parent ethernet interface.VlanId
ushort read-write: The identifier of the virtual interfaceProto
NetworkConfigurationProtocol read-write: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"IP
string[] read-write: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.Gateway
string read-write: The IPv4 address of the player. "Null" means that a default route is absent.DNS
string[] read-write: The DNS address(es) of the deviceRateLimitDuringInitialDownloads
Nullable<uint> read-write: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.RateLimitInsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the Player Synchronization Settings Entity (2022/06) define the inside content download window.RateLimitOutsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.ContentDownloadEnabled
bool read-write: Whether content data is allowed to be downloaded using this connectionTextFeedsDownloadEnabled
bool read-write: Whether text feed data is allowed to be downloaded using this connectionMediaFeedsDownloadEnabled
bool read-write: Whether media feed data is allowed to be downloaded using this connectionHealthReportingEnabled
bool read-write: Whether uploading health reporting data is enabled using this connectionLogsUploadEnabled
bool read-write: Whether uploading log updates is enabled using this connection
Player WiFi Interface Settings
:
Enabled
bool read-write: Whether the player WiFi settings are enabledName
string read-write: The target network interface name (typically "wlan0")Type
PlayerNetworkInterfaceType read-only: "WiFi”SSID
string read-write: The SSID (seen by users as a wireless network name)Security
WiFiSecuritySettings read-write: Defines the authentication and encryption settings to be used:authentication
:mode
string read-write: One of "Open", "Shared", "EAP", "Other" enumeration valuespassphrase
string read-write: Applies only to "Shared" mode
encryption
:mode
string read-write: One of "None", "WEP", "TKIP", "AES", "Other" enumeration values
Proto
NetworkConfigurationProtocol read-write: Defines a configuration protocol or given network interface such as "Static" or "DHCPv4"IP
string[] read-write: In the “Static” network configuration, this defines the target IPv4 address (in CIDR notation) to apply by the current network interface.Gateway
string read-write: The IPv4 address of the player. "Null" means that a default route is absent.DNS
string[] read-write: The DNS address(es) of the deviceRateLimitDuringInitialDownloads
Nullable<uint> read-write: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.RateLimitInsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the Player Synchronization Settings Entity (2022/06) define the inside content download window.RateLimitOutsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.ContentDownloadEnabled
bool read-write: Whether content data is allowed to be downloaded using this connectionTextFeedsDownloadEnabled
bool read-write: Whether text feed data is allowed to be downloaded using this connectionMediaFeedsDownloadEnabled
bool read-write: Whether media feed data is allowed to be downloaded using this connectionHealthReportingEnabled
bool read-write: Whether uploading health reporting data is enabled using this connectionLogsUploadEnabled
bool read-write: Whether uploading log updates is enabled using this connection
Player Cellular Interface Settings
:
Enabled
bool read-write: Whether the player cellular network interface settings are enabledName
string read-write: The target network interface name (typically “ppp0”)Type
PlayerNetworkInterfaceType read-only: "Cellular”Modems
PlayerCellularModemSettings[] read-write: A collection of the cellular modemssupported
by this network interfaceModel
string read-write: The model name of the supported cellular modemUSBDeviceIds
string[] read-write: The identifiers of the supported cellular modems
SIMS
PlayerCellularModuleSettings[] read-write: A collection of the supported SIM cardsMCC
string read-write: The mobile country codeMNC
string read-write: The mobile network codeConnection
PlayerCellularConnectionSettings read-write: The connection options to apply with this SIM card
RateLimitDuringInitialDownloads
Nullable<uint> read-write: The data rate limitation during initial downloads. When set to “Null” the rate is unlimited.RateLimitInsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation during content downloads. When set to “Null” the rate is unlimited. The "Content" start and end timespans in the Player Synchronization Settings Entity (2022/06) define the inside content download window.RateLimitOutsideContentDownloadWindow
Nullable<uint> read-write: The data rate limitation when content is not being downloaded. When set to “Null” the rate is unlimited.ContentDownloadEnabled
bool read-write: Whether content data is allowed to be downloaded using this connectionTextFeedsDownloadEnabled
bool read-write: Whether text feed data is allowed to be downloaded using this connectionMediaFeedsDownloadEnabled
bool read-write: Whether media feed data is allowed to be downloaded using this connectionHealthReportingEnabled
bool read-write: Whether uploading health reporting data is enabled using this connectionLogsUploadEnabled
bool read-write: Whether uploading log updates is enabled using this connection