Kaaja.TvheadendClient 0.2.1

dotnet add package Kaaja.TvheadendClient --version 0.2.1                
NuGet\Install-Package Kaaja.TvheadendClient -Version 0.2.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Kaaja.TvheadendClient" Version="0.2.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Kaaja.TvheadendClient --version 0.2.1                
#r "nuget: Kaaja.TvheadendClient, 0.2.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Kaaja.TvheadendClient as a Cake Addin
#addin nuget:?package=Kaaja.TvheadendClient&version=0.2.1

// Install Kaaja.TvheadendClient as a Cake Tool
#tool nuget:?package=Kaaja.TvheadendClient&version=0.2.1                

TvheadendClient

Client library for connecting to tvheadend. Reads EPG and recording data

Connecting

var options = new ClientOptions(){
    Host = "192.168.1.5", //required
    Port = 9982, //default 9985
    UserName = "me", //optional
    Password = "myPassword" //optional
}
var loggerFactory = LoggerFactory.Create(builder => );
var client = new Client(options, loggerFactory);
client.Connect();

After connecting client will start receiving data from server (EPG, recordings, ...)

Reading data

All avaiable data are stored on client.Data using ITvheadendData

    public interface ITvheadendData
    {
        ITagStorage Tags { get; } 
        IChannelStorage Channels { get; }
        IEpgEventStorage Events { get; }
        IAutoRecordStorage AutoRecords { get; }
        IDvrEntryStorage DvrEntries { get; }
        event EventHandler LoadComplete;
        bool Ready { get; }
        IReadOnlyCollection<string> ContentTypes { get; }
    }

After reading all data event LoadComplete is fired. All data are stored on appropriate Storage in dictionary using ids.

///example reading Channels
var allChannels = client.Data.Channels.Values;
/// read channel by id
var channel = client.Data.Channels[id];
///read epgEvents for Channel
var events = client.Data.Events.ByChannels[channelId];

When are data changed events are fired

//listen event
client.Data.Channels.ItemAdded += (sender, eventData) => { ...};

API

Can be found here

TODO

  1. Improve storing data from message do data object
  2. Prepare methods for modifiing recordings and autorecordings
  3. Fix bugs
Product 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 is compatible.  netcoreapp3.1 is compatible. 
.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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
0.2.1 537 6/15/2020
0.2.0 642 6/12/2020 0.2.0 is deprecated because it has critical bugs.
0.1.0-alpha 407 5/29/2020