Class BaseTunerHost

Inheritance
System.Object
BaseTunerHost
Implements
Namespace: MediaBrowser.Controller.LiveTv
Assembly: MediaBrowser.Controller.dll
Syntax
public abstract class BaseTunerHost : ITunerHost

Constructors

BaseTunerHost(IServerApplicationHost)

Declaration
protected BaseTunerHost(IServerApplicationHost applicationHost)
Parameters
Type Name Description
IServerApplicationHost applicationHost

Fields

AppHost

Declaration
protected readonly IServerApplicationHost AppHost
Field Value
Type Description
IServerApplicationHost

Config

Declaration
protected readonly IServerConfigurationManager Config
Field Value
Type Description
IServerConfigurationManager

FileSystem

Declaration
protected readonly IFileSystem FileSystem
Field Value
Type Description
IFileSystem

JsonSerializer

Declaration
protected readonly IJsonSerializer JsonSerializer
Field Value
Type Description
IJsonSerializer

LiveTvManager

Declaration
protected readonly ILiveTvManager LiveTvManager
Field Value
Type Description
ILiveTvManager

Logger

Declaration
protected readonly ILogger Logger
Field Value
Type Description
ILogger

Properties

IsSupported

Declaration
public virtual bool IsSupported { get; }
Property Value
Type Description
System.Boolean

LegacyChannelIdPrefix

Declaration
protected virtual string LegacyChannelIdPrefix { get; }
Property Value
Type Description
System.String

Name

Declaration
public abstract string Name { get; }
Property Value
Type Description
System.String

SetupUrl

Declaration
public virtual string SetupUrl { get; }
Property Value
Type Description
System.String

Type

Declaration
public abstract string Type { get; }
Property Value
Type Description
System.String

UseTunerHostIdAsPrefix

Declaration
protected virtual bool UseTunerHostIdAsPrefix { get; }
Property Value
Type Description
System.Boolean

Methods

CreateEmbyChannelId(TunerHostInfo, String)

Declaration
protected string CreateEmbyChannelId(TunerHostInfo tuner, string tunerChannelId)
Parameters
Type Name Description
TunerHostInfo tuner
System.String tunerChannelId
Returns
Type Description
System.String

DeserializeChannelsFromFileAsync(String)

Declaration
protected virtual Task<List<ChannelInfo>> DeserializeChannelsFromFileAsync(string file)
Parameters
Type Name Description
System.String file
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ChannelInfo>>

DiscoverDevices(Int32, CancellationToken)

Declaration
public virtual Task<List<TunerHostInfo>> DiscoverDevices(int discoveryDurationMs, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Int32 discoveryDurationMs
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TunerHostInfo>>

GetChannelIdPrefix(TunerHostInfo)

Declaration
public string GetChannelIdPrefix(TunerHostInfo tuner)
Parameters
Type Name Description
TunerHostInfo tuner
Returns
Type Description
System.String

GetChannels(TunerHostInfo, CancellationToken)

Declaration
public async Task<List<ChannelInfo>> GetChannels(TunerHostInfo host, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo host
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ChannelInfo>>

GetChannelsInternal(TunerHostInfo, CancellationToken)

Declaration
protected abstract Task<List<ChannelInfo>> GetChannelsInternal(TunerHostInfo tuner, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ChannelInfo>>

GetChannelStream(TunerHostInfo, BaseItem, ChannelInfo, String, CancellationToken)

Declaration
protected virtual async Task<ILiveStream> GetChannelStream(TunerHostInfo tuner, BaseItem dbChannnel, ChannelInfo tunerChannel, string mediaSourceId, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
BaseItem dbChannnel
ChannelInfo tunerChannel
System.String mediaSourceId
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ILiveStream>

GetChannelStream(TunerHostInfo, BaseItem, String, String, List<ILiveStream>, CancellationToken)

Declaration
public async Task<ILiveStream> GetChannelStream(TunerHostInfo tuner, BaseItem dbChannnel, string tunerChannelId, string mediaSourceId, List<ILiveStream> currentLiveStreams, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
BaseItem dbChannnel
System.String tunerChannelId
System.String mediaSourceId
System.Collections.Generic.List<ILiveStream> currentLiveStreams
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ILiveStream>

GetChannelStreamMediaSources(TunerHostInfo, BaseItem, ChannelInfo, CancellationToken)

Declaration
protected abstract Task<List<MediaSourceInfo>> GetChannelStreamMediaSources(TunerHostInfo tuner, BaseItem dbChannnel, ChannelInfo tunerChannel, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
BaseItem dbChannnel
ChannelInfo tunerChannel
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetChannelStreamMediaSources(TunerHostInfo, BaseItem, String, CancellationToken)

Declaration
public async Task<List<MediaSourceInfo>> GetChannelStreamMediaSources(TunerHostInfo tuner, BaseItem dbChannnel, string tunerChannelId, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
BaseItem dbChannnel
System.String tunerChannelId
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetConfiguration()

Declaration
protected LiveTvOptions GetConfiguration()
Returns
Type Description
LiveTvOptions

GetDefaultConfiguration()

Declaration
public virtual TunerHostInfo GetDefaultConfiguration()
Returns
Type Description
TunerHostInfo

GetProgramEntryId(String, DateTimeOffset, String)

Declaration
protected string GetProgramEntryId(string showId, DateTimeOffset startDateUtc, string channelId)
Parameters
Type Name Description
System.String showId
System.DateTimeOffset startDateUtc
System.String channelId
Returns
Type Description
System.String

GetProgramsAsync(TunerHostInfo, ChannelInfo, DateTimeOffset, DateTimeOffset, CancellationToken)

Declaration
public async Task<List<ProgramInfo>> GetProgramsAsync(TunerHostInfo tuner, ChannelInfo tunerChannel, DateTimeOffset startDateUtc, DateTimeOffset endDateUtc, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
ChannelInfo tunerChannel
System.DateTimeOffset startDateUtc
System.DateTimeOffset endDateUtc
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ProgramInfo>>

GetProgramsInternal(TunerHostInfo, String, DateTimeOffset, DateTimeOffset, CancellationToken)

Declaration
protected virtual Task<List<ProgramInfo>> GetProgramsInternal(TunerHostInfo tuner, string tunerChannelId, DateTimeOffset startDateUtc, DateTimeOffset endDateUtc, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
System.String tunerChannelId
System.DateTimeOffset startDateUtc
System.DateTimeOffset endDateUtc
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ProgramInfo>>

GetProviderOptions<T>(TunerHostInfo)

Declaration
protected T GetProviderOptions<T>(TunerHostInfo info)
    where T : new()
Parameters
Type Name Description
TunerHostInfo info
Returns
Type Description
T
Type Parameters
Name Description
T

GetTunerChannelIdFromEmbyChannelId(TunerHostInfo, String)

Declaration
protected string GetTunerChannelIdFromEmbyChannelId(TunerHostInfo tuner, string channelId)
Parameters
Type Name Description
TunerHostInfo tuner
System.String channelId
Returns
Type Description
System.String

OnDeleted(TunerHostInfo, CancellationToken)

Declaration
public virtual Task OnDeleted(TunerHostInfo tuner, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

OnSaved(TunerHostInfo, Boolean, CancellationToken)

Declaration
public virtual Task OnSaved(TunerHostInfo tuner, bool isNew, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
System.Boolean isNew
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

RefreshChannels(TunerHostInfo, CancellationToken)

Declaration
public async Task<List<ChannelInfo>> RefreshChannels(TunerHostInfo host, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo host
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ChannelInfo>>

SetCustomOptions<T>(TunerHostInfo, T)

Declaration
protected void SetCustomOptions<T>(TunerHostInfo info, T options)
Parameters
Type Name Description
TunerHostInfo info
T options
Type Parameters
Name Description
T

SupportsGuideData(TunerHostInfo)

Declaration
public virtual bool SupportsGuideData(TunerHostInfo tuner)
Parameters
Type Name Description
TunerHostInfo tuner
Returns
Type Description
System.Boolean

SupportsRemappingGuideData(TunerHostInfo)

Declaration
public virtual bool SupportsRemappingGuideData(TunerHostInfo tuner)
Parameters
Type Name Description
TunerHostInfo tuner
Returns
Type Description
System.Boolean

ValdidateOptions(TunerHostInfo, CancellationToken)

Declaration
public virtual Task ValdidateOptions(TunerHostInfo tuner, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo tuner
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

Implements

Extension Methods