CatNoir2006.MediathekViewWebLib 0.1.0

CatNoir2006.MediathekViewWebLib

Standalone .NET client library for the MediathekViewWeb API — the public metadata index for German public broadcasting (ARD, ZDF, ORF, SR, 3Sat, KiKA, …) and the companion Zapp live‑TV API.

Features

• 🔍 Full search query support: filters (title, topic, description, channel), pagination, sorting, broadcast‑date ranges, duration ranges
• 🚫 Local exclusion filters (QueryFieldsDto.IsExclude = true) — applied after the API call
• 📏 Stream size lookup for video URLs (opt‑in via MediathekViewApiClientOptions.FetchStreamSizes)
• 📺 Zapp live‑TV metadata: channel list and current shows
• 🌐 Channels and topics lists with instance‑based TTL cache
• 📝 Smart subtitle URL extraction for ARD, ZDF, KiKA (WebVTT + TTML variants)
• 🔁 Built‑in retry + circuit breaker via Polly v8
• 🧰 DI friendly (AddMediathekViewWeb) or plain new + HttpClient

Targets

• net9.0
• net10.0

Installation

dotnet add package CatNoir2006.MediathekViewWebLib

(Once a NuGet package has been published — for now git clone and reference the project.)

Quick Start

Plain instantiation

using CatNoir2006.MediathekViewWebLib;
using CatNoir2006.MediathekViewWebLib.Models;
using CatNoir2006.MediathekViewWebLib.Models.Enums;

var options = new MediathekViewApiClientOptions
{
    FetchStreamSizes = true,
    MaxPages = 3,
};

var httpClient = new HttpClient();
using var loggerFactory = LoggerFactory.Create(b => b.AddConsole());
var logger = loggerFactory.CreateLogger<MediathekViewApiClient>();

var client = new MediathekViewApiClient(httpClient, options, logger);

var query = new ApiQueryDto
{
    Size = 10,
    Queries = { new QueryFieldsDto { Fields = { QueryFieldType.Topic }, Query = "Tatort" } },
};

var result = await client.SearchAsync(query, CancellationToken.None);
foreach (var item in result.Results)
{
    Console.WriteLine($"{item.Timestamp:yyyy-MM-dd}  {item.Channel,-10}  {item.Title}");
}

Dependency Injection

using CatNoir2006.MediathekViewWebLib;

builder.Services.AddMediathekViewWeb(opts =>
{
    opts.MaxPages = 5;
    opts.FetchStreamSizes = false;
});

Then inject IMediathekViewApiClient wherever you need it.

Errors

All errors thrown by the library derive from MediathekException:

• MediathekApiException — non‑successful HTTP status code (carries the status)
• MediathekConnectionException — network / DNS / timeout
• MediathekParsingException — unparseable response

License

MIT