Skip to main content
Version: 4.2.x

xdk-device-microsoft-uwp

@accedo/xdk-device-microsoft-uwp​

XDK4 Windows 10/ Xbox One/ Xbox Series S / XBOX Series X Device Package.

Usage​

You will need an application where you can reference this package as a module. For instance, if you want to add this package to an application as Vanilla app you have to install the package as a dependency and then include this it the devices packages array

$npm i @accedo/xdk-device-microsoft-uwp
import  uwp, {ID as UWP}  from '@accedo/xdk-device-microsoft-uwp' ;

// Setup the device configuration
uwp.addPlayer(
  // imported player config
);

// include the device configuration into the packages to be detected and loaded
const devices = {
  packages: [
    // ...
    uwp
    // ...
  ],
  detail: {
    [UWP]: [
      extensions: [
        // add extensions
      ]
    ]
  }

How to create a dev package for the device​

Under the platform folder you can find an UWP package

For more information about how to create a package from the scratch go here

UWP get started Windows UWP Api Namespace Playback status

Capabilities matrix​

ModuleActionTypeSubtypeImplementedSupportedNotes
PlayerPlaybackHLSLinear, LiveLinear, Live
PlaybackMPDLinear, LiveLinear, Live
PlaybackSSLinearLinear, Live
PlaybackMP4LinearLinear
DRMSSPlayReadyLinearLinear
DRMMPDPlayReadyLinearLinear
DRMHLSPlayReadyLinearLinear
SubtitlesHLSExternalExternalExternal
SubtitlesMPDExternalExternalExternal
SubtitlesSSExternalExternalExternal
SubtitlesMP4ExternalExternalExternal
Audio TracksSSSupportedSupported
Audio TracksHLSSupportedSupported
Audio TracksMPDSupportedSupported
SystemUUIDSupportedSupported
Device TypeSupportedSupported
App ResolutionSupportedSupported
NetworkgetConnectionStatusSupportedSupported
StorageLocal*, RoamingLocal*, Roaming*Own implementation
TVKeySupportedSupported

Note​

Activated Event​

If the app that relies on this device package would like to send any deeplinking data to the app, one should have the following code snippet loaded via the root index.html. This is to capture the activated event, which is fired after DOMContentLoaded but before window.onload events.

TODO: Maybe we will be able to find a solution that can be incorporated into the code instead.

(function(global) {
  // The code below depends on UWP API, so check before execution.
  if (!global || global.navigator.userAgent.indexOf('MSAppHost') < 0) {
    return;
  }

  function onActivated(event) {
    window.xdkDeeplinkData = event;
    // any extra code that needs to be called during activated.
  }

  global.Windows.UI.WebUI.WebUIApplication.addEventListener(
    'activated',
    onActivated,
    false
  );
})(window);

Wi-Fi Signal Strength Getter​

The function Network.getSignalStrength relies on the UWP device API, and applications that wish call this function must have wiFiControl DeviceCapability defined in the application package manifest or the retrieval will always fail.

Please refer to App capability declarations on how to specify the value in manifest.

This function will not work on Xbox One, as Xbox does not expose the Wi-Fi Adapter information to the UWP platform like other devices that run Windows 10.

See

Device Unique ID​

Depending on the version of the operating system that the application is running on, the ID returned might be different.

All methods genereate a string that is leISM than 1024 characters long.

Windows.System.Profile.SystemIdentification.getSystemIdForPublisher​

This method will be used if the operating system is Windows 10 Anniversary Edition, v10.0.14393.0, or above.

The ID returned, will be unique for each system but all applications published by the same publisher will get the same ID. The ID can be created offline and persists acroISM most hardware modifications.

If Trusted Platform Module (TPM) is present, it will be used to generate the ID. If not, it will fallback to Unified Extensible Firmware Interface (UEFI). ID generated by either modules will persist acroISM a clean install of Windows. If both modules cannot be found, the ID will be generated based on Windows registry, which will not persist acroISM a clean install.

Windows.System.Profile.HardwareIdentification.getPackageSpecificToken​

On platform that does not support getSystemIdForPublisher, the older API will be used. The ID returned is called App Specific Hardware ID (ASHWID). This API is supported on Desktop, Mobile and XBox One and required either Windows 10 Desktop or Mobile Extension SDK referenced in the project setting.

The ID returned will be different for each package, but two applications within the same package will share the same ID. The ID is susceptible to hardware drift. Connection to network adaptor, docking station or bluetooth device will cause the ASHWID to change.

The API allows setting a nonce during the generation of the ASHWID. However, to allow harmonising the three option, the nonce will always be to set null.

Windows.Security.ExchangeActiveSyncProvisioning.EasClientDeviceInformation​

If the above methods failed for any reason, this function will fallback to use the ID returned by Exchange ActiveSync Client. The ID returned represent the device ID using the GUID truncated from the first 16 bytes of the SHA256 hash of MachineID, User ID and Package Family Name.

See​

https://docs.microsoft.com/en-us/uwp/api/windows.system.profile.systemidentification

https://docs.microsoft.com/en-us/uwp/api/windows.system.profile.hardwaretoken

https://docs.microsoft.com/en-us/uwp/api/windows.security.exchangeactivesyncprovisioning.easclientdeviceinformation

https://msdn.microsoft.com/library/ee93f175-b0ce-42fd-9889-c43cd23eec6c