![]() |
Speedify SDK for Desktop/Embedded 16.1.0
|
SpeedifySDK_SetDNSServers has been deprecated. Use SpeedifySDK_SetDNSServerAddresses instead.subscriptionEndDateisSelfHosted field.SpeedifySDK_DeviceRole and SpeedifySDK_SystemData structure to provide information about the device role (Client, Router, Professional Video Gear). See SpeedifySDK_GetSystemData to retrieve the system data.SpeedifySDK_SetPepDscp.SpeedifySDK_SetPepIPs.SpeedifySDK_SetPepIPs and SpeedifySDK_SetPepPorts.SpeedifySDK_SetPepEnabled.AA_ACTIVATE_OR_PURCHASE_LICENCE is deprecated in favor of AA_ACTIVATE_OR_PURCHASE_LICENSESpeedifySDK_StartSpeedTest, SpeedifySDK_StartStreamTest.SpeedifySDK_SetAdvancedIspStats.SpeedifySDK_SetFixedDelayIPs/SpeedifySDK_SetFixedDelayPorts/SpeedifySDK_SetFixedDelayDomains.ispStats. Currently only implemented for Starlink.SpeedifySDK_SetConnectionRateLimitsSpeedifySDK_SetFixedDelay.SpeedifySDK_AccountCheck/SpeedifySDK_AccountCreate/SpeedifySDK_AccountPasswordChange have been deprecated. Manage via SSO logins on my.speeedify.com instead.SpeedifySDK_SetDSCPQueues/SpeedifySDK_GetDSCPSettings to set/get the DSCP queues used by the SDK. See DSCP Queue Configuration for more information.SpeedifySDK_AccountingData now contains action to provide hints for what action may be needed on an account.SpeedifySDK_ServerInformationDetailed now contains DNS information in the dnsIP field.SpeedifySDK_SetConnectionDirectionalMode.SpeedifySDK_SendLogReport to send logs to the directory server for automatic processingSpeedifySDK_SetAPIProtection can be used to enable or disable the API protection feature. Disabling this allows for remote control of Speedify on the local network.SpeedifySDK_SetPacketPoolSize can be used to set the size of the packet pool used by the SDK. This can be used to tune performance.SpeedifySDK_SetNetworkSharingAutoPairBehavior controls how network sharing automatically pairs with other devices on the same account and/or teamSpeedifySDK_SendFeedback.NTS_PAUSED.SpeedifySDK_SetNetworkSharingAlwaysOnDiscovery.SpeedifySDK_SetMaximumConnectRetry.SpeedifySDK_SetMaximumTransportRetry.SpeedifySDK_SetMaxRedundantSends.SpeedifySDK_SetConnectionExposeDscp.SpeedifySDK_SetNetworkSharingSameUserAutoPair.SpeedifySDK_StreamStats expanded to include health, remoteIp, remotePort, protocolSpeedifySDK_ConnectionStats now contains sendBytes and receiveBytes.SpeedifySDK_ErrorType contains 3 new error types:
ET_SDK_SETTING_LOCKED_TEAM and ET_SDK_SETTING_LOCKED_ACCOUNT. Use ET_LOCK_TEAM and ET_LOCK_ACCOUNT respectively.ET_DEVICE_LIMIT if an account has exceeded the allowed number of active devices.SpeedifySDK_SetLocalProxyGlobalDomainWatchlistEnable) and reset all entries back to defaults (SpeedifySDK_ResetLocalProxyDomainWatchlist).ulpReportIntervalSeconds setting to represent the ULP reporting interval in seconds.SpeedifySDK_SetUlpReportIntervalSeconds function.DR_NONE, for cases when there is nothing to report, to the disconnect reasons.SpeedifySDK_RefreshOAuthToken to refresh token without triggering a login.ACM_IGNORELAST to reconnect while ignoring the most recently used server.CP_AUTOMATIC connection priorities, where Speedify will manage the priority based on the dynamically discovered connection type. This feature is enabled via SpeedifySDK_EnableAutomaticConnectionPriority.SpeedifySDK_AdapterData has 2 new fields:workingPriority - the priority the adapter is functioning underisp - the discovered Internet Service Provider of the connectionprotocol field on SpeedifySDK_ConnectionStats objects is now available on historic tunnel stats.SpeedifySDK_SetRequestToDisableDoH.SpeedifySDK_SetLocalProxyPorts, SpeedifySDK_SetFirewallPorts, and SpeedifySDK_SetStreamingPortsSpeedifySDK_ConnectionStats objects with a transport type of TMODE_PROXY.SpeedifySDK_SetPriorityOverflowThreshold.SpeedifySDK_SetDNSLeakProtectionSpeedifySDK_SetIPLeakProtectiondnsLeakProtectionipLeakProtectionSpeedifySDK_DirectorySettingsCallback.SpeedifySDK_DirectorySettingsResult.SpeedifySDK_GetDirectorySettings.SpeedifySDK_EnableStatUpdates instead.SpeedifySDK_SetAppName or automatically by using the name field of SpeedifySDK_CreateSettings. If setting manually, this should be called before any login method.lsofSpeedifySDK_StreamStats field health, giving an indication of how well the stream is performing.SpeedifySDK_StreamingStats fields:
SpeedifySDK_ConnectionStats fields:
SpeedifySDK_StartStreamTest.SpeedifySDK_SpeedTestResultData fields:
lossReceive and lossSend to be doubles.SpeedifySDK_ConnectProxy and using default DNS server settings, or setting an empty DNS server list via SpeedifySDK_SetDNSServers with 0 addresses, the DNS servers of the other physical connections will be used instead of setting an explicit DNS server over the VPN connection.SpeedifySDK_DisconnectEvent objects have 2 new fields: sessionEnd and sessionLengthET_SDK_SETTING_LOCKED_TEAM to differentiate between team settings locks and account settings locks, ET_SDK_SETTING_LOCKED_ACCOUNT.TMODE_AUTO transport mode now automatically scales the number of tcp sockets it uses, providing better performance.SpeedifySDK_StartSpeedTest to initiate a new test. Results of prior tests can be retrieved with SpeedifySDK_GetSpeedTestResults.totalBps, sendBps, and receiveBps to be bits per second.sendEstimateMbps and receiveEstimateMbps to be megabits per second.mbpsDownBenefit and mbpsUpBenefit to specify megabits per second.SpeedifySDK_TransportMode#TMODE_MULTITCP transport mode, using multiple TCP sockets over connections to increase bandwidth. SpeedifySDK_ConnectionStats#numberOfSockets shows how many sockets are in use.STATE_OVERLIMIT state.SpeedifySDK_StreamingSettings. These can be set via SpeedifySDK_SetStreamingDomains, SpeedifySDK_SetStreamingIPv4, SpeedifySDK_SetStreamingIPv6, and SpeedifySDK_SetStreamingPorts. Use SpeedifySDK_GetStreamingSettings to pull current settings.DR_OVERQUOTA disconnect reason.sendBps and receiveBps on all physical adapters to be in bits per second, matching totalBps.SpeedifySDK_SetLanguage. This takes a 2-character ISO language code. Supported languages include 'en', 'ar, 'de', 'es', 'fr', 'pt', 'ro', 'ru', 'tr', 'zh'.{speedifyProductName}. You should replace this with your product name.DR_DNSTIMEOUT and DR_TUNNELTIMEOUT.SpeedifySDK_Logout will now reset your connect method to ACM_CLOSEST.SpeedifySDK_SetHeaderCompression. Currently support extends to IPv4, UDP, and partial TCP (ports only).SpeedifySDK_SetDirectoryGatewayURI before logging in with SpeedifySDK_LoginOAuth.SpeedifySDK_SetDaemonLogSettings.SpeedifySDK_EraseAllLogFiles. Note that the current active log file is not erased.SpeedifySDK_SetDoNotStoreCredentials. Note that you will have to manually call a login method on every new SDK daemon run.SpeedifySDK_LoginOAuth.SpeedifySDK_DirectorySettingsCallback.SpeedifySDK_DirectorySettingsResult.SpeedifySDK_GetDirectorySettings.SpeedifySDK_ConnectProxy. All traffic through the VPN will be sent out via the Local Proxy over the default network interface.SpeedifySDK_SetESNIEnabled if your custom directory server does not support ESNI.SpeedifySDK_GetLastDisconnectEvent.SpeedifySDK_SetIpLeak.SpeedifySDK_ProxyMatchModePMM_ALLOWLIST and PMM_DENYLIST.SpeedifySDK_FirewallModeFWM_ALLOWLIST and FWM_DENYLIST.periods member now contains a list of all requested time periods. Use the period member of SpeedifySDK_SessionStats to identify the period the stats are for.SpeedifySDK_EnableStatUpdates to specify wanted time periods.SpeedifySDK_StreamingSessionStats for each period.SpeedifySDK_WaitOnCallback. This will wait in the current thread until the desired callback has returned.SpeedifySDK_EnableStatUpdates instead.SpeedifySDK_SessionStatPeriodsperiods member now contains a list of all requested time periods. Use the period member of SpeedifySDK_SessionStats to identify the period the stats are for.SpeedifySDK_StreamingSessionStats available in SpeedifySDK_SessionStatsSpeedifySDK_SetLocalProxyPorts.SpeedifySDK_SetVendorUserData can be used to provide a string of user data for an account.StreamingStats fields: (these are now under SpeedifySDK_StreamingSessionStats as of 10.0)StreamStats fields:
SpeedifySDK_SetMode with BMODE_STREAMING. Statistics on individual streams are available from SpeedifySDK_GetStreamingStats, and are provided once per second when enabling SpeedifySDK_EnableStatUpdates.SpeedifySDK_SessionStatsResult are now tracked over multiple time periods, including current session, last day, last week, last month, and total.SpeedifySDK_SessionStatsResultSpeedifySDK_SessionStatPeriods object instead of a SpeedifySDK_SessionStats to accommodate stats over various time periods.SpeedifySDK_SetEnableDefaultRoute can be used to disable Speedify from obtaining the default route and handling all Internet traffic.SpeedifySDK_LocalProxyDomainWatchlistItemwatchedDomains and proxiedDomains lists.SpeedifySDK_SetFirewallIPv6. ICMP and other protocols are now also blockable by domain and IP.SpeedifySDK_SetLocalProxyDomainWatchlist. When an attempt to access a watched domain is seen, SpeedifySDK_ListenForLocalProxyDomainWatchlistHit is triggered. SpeedifySDK_SetLocalProxyDomainWatchlistEnable can then be used to enable that service's domains to be sent through the local proxy instead of the VPN.SpeedifySDK_SetFirewallIPv4 and SpeedifySDK_SetLocalProxyIPv4 have been changed to take an array of struct in_addr instead of uint32_t, for consistency with new SpeedifySDK_SetFirewallIPv6 method arguments.SpeedifySDK_SetLocalVendorSettings for saving a custom JSON object for later consumption.SpeedifySDK_IPAddressString to match namespace convention with rest of SDK.