XmlTvSharp 1.1.2
dotnet add package XmlTvSharp --version 1.1.2
NuGet\Install-Package XmlTvSharp -Version 1.1.2
<PackageReference Include="XmlTvSharp" Version="1.1.2" />
paket add XmlTvSharp --version 1.1.2
#r "nuget: XmlTvSharp, 1.1.2"
// Install XmlTvSharp as a Cake Addin #addin nuget:?package=XmlTvSharp&version=1.1.2 // Install XmlTvSharp as a Cake Tool #tool nuget:?package=XmlTvSharp&version=1.1.2
XmlTvSharp
A high-performance, asynchronous XMLTV parser for TV program data.
Installation
You can install this library via NuGet Package Manager:
Install-Package XmlTvSharp
Benchmark
We tested the library using an XMLTV file featuring 19,804 channels and 1,979,805 programmes.
AMD Ryzen 5 3600, 1 CPU, 12 logical and 6 physical cores
.NET SDK 7.0.109
[Host] : .NET 7.0.9 (7.0.923.32301), X64 RyuJIT AVX2
DefaultJob : .NET 7.0.9 (7.0.923.32301), X64 RyuJIT AVX2
| Method | Mean | Error | StdDev |
|------------- |--------:|--------:|--------:|
| ReadAllAsync | 20.65 s | 0.293 s | 0.229 s |
Usage
Basic Usage: Reading All XMLTV Elements
// Specify the path to the XML file containing TV program information
var xmlFilePath = "path/to/your/xmltv/file.xml";
// Cancellation token
var cancellationToken = new CancellationToken();
// Customize the parsing behaviour
var settings = new XmlTvReaderSettings();
// Read all TV channels and programmes asynchronously
var result = await XmlTvReader.ReadAllAsync(xmlFilePath, settings, cancellationToken);
// Access the parsed TV channels and programmes
var channels = result.Channels;
var programmes = result.Programmes;
Basic Usage: Reading XMLTV Elements Sequentially
// Specify the path to the XML file containing TV program information
var xmlFilePath = "path/to/your/xmltv/file.xml";
// Cancellation token
var cancellationToken = new CancellationToken();
// Customize the parsing behaviour
var settings = new XmlTvReaderSettings();
using var reader = new XmlTvReader(xmlFilePath, settings);
IXmlTvElement element;
// Read XMLTV elements sequentially asynchronously
while ((element = await reader.ReadAsync(cancellationToken)) != null)
{
if (element is XmlTvChannel channel)
{
// Process the parsed channel element
}
else if (element is XmlTvProgramme programme)
{
// Process the parsed programme element
}
}
XmlTvReaderSettings
XmlTvReaderSettings allows customization of the parsing behavior. Here are the default values:
var settings = new XmlTvReaderSettings
{
FilterByChannelId = null,
FilterByProgrammeChannelId = null,
FilterByProgrammeTime = null,
DefaultLanguage = "en",
TimeZone = TimeZoneInfo.Utc,
IgnoreChannels = false,
IgnoreProgrammes = false,
IncludeOuterXml = false
};
FilterByChannelId
: A function to filter all elements by their channel IDs.FilterByProgrammeChannelId
: A function to filter programme elements by their channel IDs.
Note: When both FilterByChannelId
and FilterByProgrammeChannelId
are set, FilterByProgrammeChannelId
takes
precedence over FilterByChannelId
for filtering programme elements by their channel IDs.
FilterByProgrammeTime
: A function to filter programmes by their start and stop times.DefaultLanguage
: Default language to use if language information is not available in the XML data.TimeZone
: Time zone to convert programme start and stop times. Default is UTC.IgnoreChannels
: Set to true to ignore channel elements during parsing.IgnoreProgrammes
: Set to true to ignore programme elements during parsing.IncludeOuterXml
: Set to true to include the outer XML of elements during parsing.
Warning: Setting IncludeOuterXml
to true
will cause the parser to allocate an extra XmlReader
instance,
potentially impacting performance.
Example Usage:
var settings = new XmlTvReaderSettings
{
FilterByChannelId = channelId => channelId.StartsWith("custom_"),
FilterByProgrammeChannelId = channelId => channelId.StartsWith("custom_programme_"),
FilterByProgrammeTime = (startTime, endTime) => startTime.DayOfWeek == DayOfWeek.Monday && endTime.Hour < 18,
DefaultLanguage = "fr", // Set default language to French
TimeZone = TimeZoneInfo.FindSystemTimeZoneById("Eastern Standard Time"), // Set time zone to EST
IgnoreChannels = false, // Do not ignore channel elements
IgnoreProgrammes = true, // Ignore programme elements during parsing
IncludeOuterXml = true // Include outer XML of elements during parsing
};
Contributing
We welcome your contributions to this project. If you find a bug, have a feature request, or want to contribute in any other way, please open an issue or submit a pull request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.2 | 233 | 1/22/2024 |
1.1.1 | 172 | 10/9/2023 |
1.1.0 | 145 | 10/6/2023 |
1.0.0 | 121 | 10/4/2023 |
1.0.0-alpha.3 | 75 | 10/4/2023 |
1.0.0-alpha.2 | 76 | 10/4/2023 |