Cloud APIs
...
Data Types (2022/06)
Custom Data Types (2022/06)
Player Network Interface Settings Entity (2022/06)
3min
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 string read write read write the target network interface name (typically "eth0", “usb0”, “wlan0”, or “ppp0”) type playernetworkinterfacetype playernetworkinterfacetype read only read only one of "ethernet”, “wifi”, “virtual”, “cellular”, or “other” player ethernet interface settings enabled bool bool r r ead write ead write whether the player ethernet settings are enabled name string string read write read write the target network interface name (typically “eth0”) type playernetworkinterfacetype playernetworkinterfacetype read only read only "ethernet” proto networkconfigurationprotocol networkconfigurationprotocol read write read write defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] read write 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 string read write 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\[] string\[] r ead write ead write the dns address(es) of the device ratelimitduringinitialdownloads nullable nullable read write read write the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable nullable read write 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) docid 9wqlt7ew ktnaogp5wtjd define the inside content download window ratelimitoutsidecontentdownloadwindow nullable nullable read write read write the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool read write read write whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool read write read write whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool read write read write whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool read write read write whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool read write read write whether uploading log updates is enabled using this connection player virtual interface settings enabled bool bool read write read write defines whether the particular virtual network interface is enabled name string string read write read write the target network interface name (typically "eth0 110") type playernetworkinterfacetype playernetworkinterfacetype read only read only "virtual” parent string string read write read write the name of the associated link or parent ethernet interface vlanid ushort ushort read write read write the identifier of the virtual interface proto networkconfigurationprotocol networkconfigurationprotocol read write read write defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] read write 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 string read write read write the ipv4 address of the player "null" means that a default route is absent dns string\[] string\[] read write read write the dns address(es) of the device ratelimitduringinitialdownloads nullable nullable read write read write the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable nullable read write 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) docid 9wqlt7ew ktnaogp5wtjd define the inside content download window ratelimitoutsidecontentdownloadwindow nullable nullable read write read write the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool read write read write whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool read write read write whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool read write read write whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool read write read write whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool read write read write whether uploading log updates is enabled using this connection player wifi interface settings enabled bool bool read write read write whether the player wifi settings are enabled name string string read write read write the target network interface name (typically "wlan0") type playernetworkinterfacetype playernetworkinterfacetype read only read only "wifi” ssid string string read write read write the ssid (seen by users as a wireless network name) security wifisecuritysettings wifisecuritysettings read write read write defines the authentication and encryption settings to be used authentication mode string string read write read write one of "open", "shared", "eap", "other" enumeration values passphrase string string read write read write applies only to "shared" mode encryption mode string string read write read write one of "none", "wep", "tkip", "aes", "other" enumeration values proto networkconfigurationprotocol networkconfigurationprotocol read write read write defines a configuration protocol or given network interface such as "static" or "dhcpv4" ip string\[] string\[] read write 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 string read write the ipv4 address of the player "null" means that a default route is absent dns string\[] string\[] read write read write the dns address(es) of the device ratelimitduringinitialdownloads nullable nullable read write read write the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable nullable read write 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) docid 9wqlt7ew ktnaogp5wtjd define the inside content download window ratelimitoutsidecontentdownloadwindow nullable nullable read write read write the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool read write read write whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool read write read write whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool read write read write whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool read write read write whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool read write read write whether uploading log updates is enabled using this connection player cellular interface settings enabled bool bool read write read write whether the player cellular network interface settings are enabled name string string read write read write the target network interface name (typically “ppp0”) type playernetworkinterfacetype playernetworkinterfacetype read only read only "cellular” modems playercellularmodemsettings\[] playercellularmodemsettings\[] read write read write a collection of the cellular modems supported by this network interface model string string read write read write the model name of the supported cellular modem usbdeviceids string\[] string\[] read write read write the identifiers of the supported cellular modems sims playercellularmodulesettings\[] playercellularmodulesettings\[] read write read write a collection of the supported sim cards mcc string string read write read write the mobile country code mnc string string read write read write the mobile network code connection playercellularconnectionsettings playercellularconnectionsettings read write read write the connection options to apply with this sim card ratelimitduringinitialdownloads nullable nullable read write read write the data rate limitation during initial downloads when set to “null” the rate is unlimited ratelimitinsidecontentdownloadwindow nullable nullable read write 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) docid 9wqlt7ew ktnaogp5wtjd define the inside content download window ratelimitoutsidecontentdownloadwindow nullable nullable read write read write the data rate limitation when content is not being downloaded when set to “null” the rate is unlimited contentdownloadenabled bool bool read write read write whether content data is allowed to be downloaded using this connection textfeedsdownloadenabled bool bool read write read write whether text feed data is allowed to be downloaded using this connection mediafeedsdownloadenabled bool bool read write read write whether media feed data is allowed to be downloaded using this connection healthreportingenabled bool bool read write read write whether uploading health reporting data is enabled using this connection logsuploadenabled bool bool read write read write whether uploading log updates is enabled using this connection