To integrate a Windows/Xbox One C# player with Conviva, please include the Conviva library in your project. This library provides strong object types in your code to help initialize Conviva and create monitoring sessions.
Platform Requirements
Conviva Native Windows library currently supports desktop systems, mobile phones and tablets that use the following streamers:
For HLS and DASH: MediaPlayer
(Windows.Media.Playback.MediaPlayer)class and MediaElement(Windows.UI.Xaml.Controls)with optional AdaptiveMediaSource(Windows.Media.Streaming.Adaptive.AdaptiveMediaSource)classFor Smooth Streaming: Microsoft Universal Smooth Streaming SDK
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 11/Windows 10 Pro/Home/Xbox One/Xbox One S
OS Build 10.0.19041.x and 10.0.22000.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 Windows UWP (Universal Windows Platform) platform. The library was compiled into separate .dll/.winmd files for x64/x86/ARM/ARM64 CPU architectures.
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.
For your convenience, we are providing the library both in a nupkg package and in a zip file:
.nupkg: Install into Visual Studio 2017 or above. It copies the library files to your solution and automatically updates your project.
.zip: Manually copy the library files into your solution directory and update your project.
If you are planning your player upgrade or a new release, please consider upgrading the Conviva Windows library as well.
It is important that your application contains only a single instance of the Conviva library to avoid unexpected conflicts and run-time errors.
| File | Size | Updated |
|---|---|---|
| 1450 KB | 10/APR/2023 | |
| ConvivaUWP 2.179.0.1 | 1436 KB | 17/FEB/2023 |
Installation
Add the package into Package Sources at NuGet Package Manager in Options/Tools on your VisualStudio 2017. Then, install "Adaptive Streaming CS" from the "Manage NuGet Packages for Solutions…" menu in the "NuGet Package Manager" menu in Tools.
In Visual Studio, add the library to your XAML/C# project following these steps:
Right click > Add reference and select the ConvivaUWP.winmd files for your architectures.
The ConvivaUWP.dll file for your architecture must reside in the same directory as **ConvivaUWP.winmd.
Import the following namespace:
using ConvivaUWP;
Release Notes
Conviva 2.180.0.3 (10/APR/2023)
- Introduces
reportLanguage()API to report the audio, subtitles, and closed captions language events.
Conviva 2.179.0.1 (17/FEB/2023)
Introduces
setAverageBitrate()API to support setting the average bitrate.Modifies the
setBitrate()API documentation for peak bitrate.
Conviva 2.178.1.0 (09/FEB/2023)
- Fixed
ad.csidtag issue for Ad Session
Conviva 2.178.0.0 (09/SEP/2022)
Support for Ads.
New API for creation of Ad Session.
New API to report Ad Break Start or Ad Break End on the Main Session.
Conviva 2.177.0.0 (20/OCT/2021)
Supports Windows 11.
Supports auto collection of application version.
Supports external error reporting.
Conviva 2.176.0.5 (23/AUG/2021)
- Improved stability during event reporting.
Conviva 2.176.0.4 (27/JUL/2021)
- Added support for ARM64 architecture.
Conviva 2.176.0.3 (15/JAN/2021)
- Enhanced error handling and error logging.
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)
- Fixes a stability issue.
Conviva 2.176.0.0 (8/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.Supports error collection for download failure errors.
Conviva 2.175.0.38205 (28/ARP/2020)
- Fixes issue that occurred when destroying
MediaPlayerProxyobject.
Conviva 2.166.0.37741 (27/SEP/2019)
Fixes issue while recreating
MediaPlayerProxy/MediaElementProxyobject.Introduces new logic for
setDuration()API which takes higher precedence over the Conviva library's auto-detected content length values.Introduces new logic for
setBitrate()API which takes higher precedence over the Conviva library's auto-detected bitrate values.Reduces heartbeat size by removing the default bitrate information from
cwsStateChangeevent.
Conviva 2.156.0.37173 (06/MAR/2019)
Supports customer specific
gatewayUrlusing CUSTOMER_KEY.Enhances auto-detection of content length.
Conviva 2.142.0.36024 (22/JUN/2018)
Supports DASH VOD and Live (update 21/NOV/2018).
Implements
setSeekStartAPI to manually send seek start events.Fixes reporting of multiple state change events during content metadata updates.
Removes detection and collection of SSID.
Conviva 2.141.0.35771 (07/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 mutable metadata update.
Added API documentation.
Added CSharp Demo file to demonstrate usage of Conviva functions.
Supported in Windows 10 Anniversary Update build 14393.x and above.
Conviva 2.119.0.32167 (13/JAN/2017)
Support for MediaPlayer and MediaPlayerElement.
Support for new metadata.
Technical Specifications
| Player/Streamer Framework | Supported Framework Versions | Supported OS | Supported Protocols/Content | Supported Devices | Ad Monitoring | Player Insight |
|---|---|---|---|---|---|---|
| Windows 10 / Windows 11: MediaPlayer, MediaElement | • HLS and DASH with optional Windows.Media.Streaming.Adaptive.AdaptiveMediaSource class **• Smooth Streaming with Microsoft Universal Smooth Streaming Client SDK 1.0.161101 |
• Windows 10 Anniversary Update build 14393.x and above • Windows 11 build 22000.x and above | • HLS (Live and VOD) • DASH (Live and VOD) (supported profiles) • Smooth Streaming (Live and VOD) • Progressive Download | • Desktop Systems • Mobile Phones • Tablets • Xbox One | Pod 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