Kaaja.TvheadendClient 0.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Kaaja.TvheadendClient --version 0.2.0
NuGet\Install-Package Kaaja.TvheadendClient -Version 0.2.0
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.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Kaaja.TvheadendClient --version 0.2.0
#r "nuget: Kaaja.TvheadendClient, 0.2.0"
#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.0

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

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
There are no supported framework assets in this 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 497 6/15/2020
0.2.0 605 6/12/2020
0.1.0-alpha 374 5/29/2020