Platform Requirements
Conviva Windows 10 WinJS library currently supports desktop systems, mobile phones, and tablets that use the following streamers:
For HLS and DASH: HTML5
For Smooth Streaming: HTML5
This library can be integrated with devices running the Windows10 Universal Windows Platform (UWP) with WinJS apps. The library was compiled into separate .dll/.winmd files for x64/x86/ARM CPU architectures. The UWP is supported on desktops, phones, tablets, and Xbox.
The following streaming protocols are supported:
HLS (LIVE and VOD)
DASH (LIVE and VOD)
Smooth Streaming (LIVE and VOD)
Progressive Download
The Conviva library has been tested on the following operating systems:
Windows 10 Pro/Home/Xbox One/Xbox One S
Version 2004
OS Build 10.0.19041.x
Windows Desktop/Phone/Tablets/Xbox One
Microsoft Universal Smooth Streaming Client SDK version 1.0.161101
Packaging
DLL library: This library can be integrated with devices running the Windows10 UWP (Universal Windows Platform) platform. The library was compiled into separate .dll/.winmd files for x64/x86/ARM CPU architectures.
JavaScript library: A JavaScript file (ConvivaUWP_WinJS.js) must be included in the JavaScript project to integrate with < video > element and
AdaptiveMediaSource.
Some streamers may have specific metric limitations or require alternate implementation steps. If your application uses a framework or configuration not listed above, please contact integration@conviva.com before taking any further steps.
Downloads
To integrate Conviva with a Windows 10/Xbox One WinJS HTML5 player include the WinJS Conviva library with your project. Before you start integrating, please download the following ZIP file and extract the DLL and JavaScript libraries. This library provides strong object types in your code to help initialize Conviva and create monitoring sessions. It is intentionally kept as small as possible.
It is important that your app contains only a single instance of the Conviva Windows 10: WinJS library to avoid unexpected conflicts and run-time errors.
| File | Size | Updated | MD5 Checksum |
|---|---|---|---|
| ConvivaUWP_JS_2.176.0.2.zip**Release Notes | 495 KB | 10/NOV/2020 | 140b73df4ff90806140e965c0d1c97ff |
Download ConvivaUWP_JS_2.176.0.2.zip
Library Setup
The ZIP file contains the following:
ConvivaUWP.dll file for each x64/x86/ARM architecture.
ConvivaUWP.winmd file for each x64/x86/ARM architecture.
ConvivaUWP_WinJS.js file for all architectures.
Notes
The DLL library is compiled into separate .dll/.winmd files for x64/x86/ARM CPU architectures.
The JavaScript library is the same file for all architectures.
The DLL and JS libraries must have the same release version or an exception will be thrown from the JS runtime.
The DLL library depends on Visual C++ Runtime for Universal Windows Platform Apps. Add it to the References of your project.
Project Reference
In Visual Studio, add the library to your JavaScript project following these steps:
Right click > Add reference and select the ConvivaUWP.winmd files for your architectures.
Include ConvivaUWP_WinJS.js into your JS project.
Include the correct path to this file in your HTML files, as follows:
<script src="/js/ConvivaUWP_WinJS.js"> </script>
Import Statements
There are no special import statements for JavaScript apps. You can reference ConvivaUWP (DLL lib) and ConvivaUWPJS (JS lib) namespaces directly from your JS code after completing the above steps.
Release Notes
Conviva 2.176.0.2 (10/NOV/2020)
Supports auto collection of screen resolution.
Added API to report dropped frames.
Supports Xbox Series S/X devices.
Enhanced error logging.
Conviva 2.176.0.1 (17/JUL/2020)
Improves device model reporting for Xbox One.
Support to fetch Framework name initially
Introduces setCDNServerIP() API to support setting of CDN Edge Server's IP address.
Enhanced the accuracy of PHT reporting while player state change.
Fixes a stability issue.
Conviva 2.158.0.37075 (09/APR/2019)
Supports DASH VOD and Live.
Supports customer specific gatewayURL using CUSTOMER_KEY.
Implements setSeekStart() API to manually send seek start events.
Introduces new logic for setDuration() API which takes higher precedence over the Conviva library auto-detected content length values.
Introduces new logic for setBitrate() API which takes higher precedence over the Conviva library auto-detected bitrate values.
Enhances auto-detection of content length.
Reduces heartbeat size by removing the default bitrate information from cwsStateChange event.
Conviva 2.142.0.36024 (25/JUN/2018)
Fixes reporting of multiple state change events during content metadata updates.
Removes detection and collection of SSID.
Conviva 2.141.0.35771 (03/MAY/2018)
Improves handling of tags after update content metadata.
Handles Unicode (UTF-8) support for metadata.
Fixes issue with resource leaking.
Conviva 2.122.0.32826 (31/MAR/2017)
Support for new metadata (Connection type, SSID, Link Encryption, PHT).
Support for mutable metadata update.
Added API documentation.
Added WinJS Demo file to demonstrate usage of Conviva functions.
Supported in Windows 10 Anniversary Update build 14393.x and above.
Conviva 2.117.0.31689 (16/NOV/2016)
Support for automatic seek event detection.
Support for Xbox One S.
Support for Conviva CWS 2.2.
Conviva 2.114.0.30984 (19/SEP/2016)
Support for Windows 10 OS (Build 10.0.14393.x).
Support for Xbox One OS.
Improvements were made in Windows 10 core library memory management for reliability and performance.
Conviva 2.114.0.30984 (19/SEP/2016)
Support for Windows 10 OS (Build 10.0.14393.x).
Support for Xbox One OS.
Improvements were made in Windows 10 core library memory management for reliability and performance.
Technical Specifications
| Player/Streamer Framework | Supported Framework Versions | Supported OS | Supported Protocols/Content | Supported Devices | Ad Monitoring | Player Insight |
|---|---|---|---|---|---|---|
| Windows 10: WinJS | • HLS and DASH with HTML5 element tag with optional Windows.Media.Streaming.Adaptive.AdaptiveMediaSource class
• Smooth Streaming with HTML5 element tag with Microsoft Universal Smooth Streaming Client SDK |
• Windows 10 Anniversary Update build 14393.x and above | • HLS (LIVE and VOD) • DASH (LIVE and VOD) • Smooth Streaming (LIVE and VOD) • Progressive Download | • Desktop Systems • Mobile Phones • Tablets • Xbox One • Windows Desktop/Phone/Tablets/Xbox One | Ad Breaks Support See Ad Breaks | Yes |
Supported DASH Live profile:
Tag: urn:mpeg:dash:profile:isoff-live:2011
Manifest Type: Dynamic
Supported Windows 10 Version: 1703
Supported DASH VOD profile:
Tag: urn:mpeg:dash:profile:isoff-live:2011
Manifest Type: Static