mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-07-05 13:23:03 +02:00
2dcb2f8a9f
If the calling function can't be made async easily you can still use .GetAwaiter().GetResult(), which is way easier to find in the future
314 lines
13 KiB
C#
314 lines
13 KiB
C#
#nullable disable
|
|
|
|
#pragma warning disable CS1591
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Jellyfin.Data.Entities;
|
|
using Jellyfin.Data.Events;
|
|
using MediaBrowser.Controller.Dto;
|
|
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Controller.Library;
|
|
using MediaBrowser.Model.Dto;
|
|
using MediaBrowser.Model.LiveTv;
|
|
using MediaBrowser.Model.Querying;
|
|
|
|
namespace MediaBrowser.Controller.LiveTv
|
|
{
|
|
/// <summary>
|
|
/// Manages all live tv services installed on the server.
|
|
/// </summary>
|
|
public interface ILiveTvManager
|
|
{
|
|
event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCancelled;
|
|
|
|
event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCancelled;
|
|
|
|
event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCreated;
|
|
|
|
event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCreated;
|
|
|
|
/// <summary>
|
|
/// Gets the services.
|
|
/// </summary>
|
|
/// <value>The services.</value>
|
|
IReadOnlyList<ILiveTvService> Services { get; }
|
|
|
|
IListingsProvider[] ListingProviders { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the new timer defaults asynchronous.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{TimerInfo}.</returns>
|
|
Task<SeriesTimerInfoDto> GetNewTimerDefaults(CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the new timer defaults.
|
|
/// </summary>
|
|
/// <param name="programId">The program identifier.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{SeriesTimerInfoDto}.</returns>
|
|
Task<SeriesTimerInfoDto> GetNewTimerDefaults(string programId, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Cancels the timer.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CancelTimer(string id);
|
|
|
|
/// <summary>
|
|
/// Cancels the series timer.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CancelSeriesTimer(string id);
|
|
|
|
/// <summary>
|
|
/// Adds the parts.
|
|
/// </summary>
|
|
/// <param name="services">The services.</param>
|
|
/// <param name="tunerHosts">The tuner hosts.</param>
|
|
/// <param name="listingProviders">The listing providers.</param>
|
|
void AddParts(IEnumerable<ILiveTvService> services, IEnumerable<ITunerHost> tunerHosts, IEnumerable<IListingsProvider> listingProviders);
|
|
|
|
/// <summary>
|
|
/// Gets the timer.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{TimerInfoDto}.</returns>
|
|
Task<TimerInfoDto> GetTimer(string id, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the series timer.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{TimerInfoDto}.</returns>
|
|
Task<SeriesTimerInfoDto> GetSeriesTimer(string id, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the recordings.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <returns>A recording.</returns>
|
|
QueryResult<BaseItemDto> GetRecordings(RecordingQuery query, DtoOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets the timers.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{QueryResult{TimerInfoDto}}.</returns>
|
|
Task<QueryResult<TimerInfoDto>> GetTimers(TimerQuery query, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the series timers.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{QueryResult{SeriesTimerInfoDto}}.</returns>
|
|
Task<QueryResult<SeriesTimerInfoDto>> GetSeriesTimers(SeriesTimerQuery query, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the channel stream.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <param name="mediaSourceId">The media source identifier.</param>
|
|
/// <param name="currentLiveStreams">The current live streams.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{StreamResponseInfo}.</returns>
|
|
Task<Tuple<MediaSourceInfo, ILiveStream>> GetChannelStream(string id, string mediaSourceId, List<ILiveStream> currentLiveStreams, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the program.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <param name="user">The user.</param>
|
|
/// <returns>Task{ProgramInfoDto}.</returns>
|
|
Task<BaseItemDto> GetProgram(string id, CancellationToken cancellationToken, User user = null);
|
|
|
|
/// <summary>
|
|
/// Gets the programs.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>IEnumerable{ProgramInfo}.</returns>
|
|
Task<QueryResult<BaseItemDto>> GetPrograms(InternalItemsQuery query, DtoOptions options, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Updates the timer.
|
|
/// </summary>
|
|
/// <param name="timer">The timer.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task UpdateTimer(TimerInfoDto timer, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Updates the timer.
|
|
/// </summary>
|
|
/// <param name="timer">The timer.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task UpdateSeriesTimer(SeriesTimerInfoDto timer, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Creates the timer.
|
|
/// </summary>
|
|
/// <param name="timer">The timer.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CreateTimer(TimerInfoDto timer, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Creates the series timer.
|
|
/// </summary>
|
|
/// <param name="timer">The timer.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CreateSeriesTimer(SeriesTimerInfoDto timer, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the guide information.
|
|
/// </summary>
|
|
/// <returns>GuideInfo.</returns>
|
|
GuideInfo GetGuideInfo();
|
|
|
|
/// <summary>
|
|
/// Gets the recommended programs.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Recommended programs.</returns>
|
|
Task<QueryResult<BaseItemDto>> GetRecommendedProgramsAsync(InternalItemsQuery query, DtoOptions options, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the recommended programs internal.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Recommended programs.</returns>
|
|
QueryResult<BaseItem> GetRecommendedProgramsInternal(InternalItemsQuery query, DtoOptions options, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the live tv information.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{LiveTvInfo}.</returns>
|
|
LiveTvInfo GetLiveTvInfo(CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Resets the tuner.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ResetTuner(string id, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the live tv folder.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Live TV folder.</returns>
|
|
Folder GetInternalLiveTvFolder(CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the enabled users.
|
|
/// </summary>
|
|
/// <returns>IEnumerable{User}.</returns>
|
|
IEnumerable<User> GetEnabledUsers();
|
|
|
|
/// <summary>
|
|
/// Gets the internal channels.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <param name="dtoOptions">The options.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Internal channels.</returns>
|
|
QueryResult<BaseItem> GetInternalChannels(LiveTvChannelQuery query, DtoOptions dtoOptions, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the channel media sources.
|
|
/// </summary>
|
|
/// <param name="item">Item to search for.</param>
|
|
/// <param name="cancellationToken">CancellationToken to use for operation.</param>
|
|
/// <returns>Channel media sources wrapped in a task.</returns>
|
|
Task<IEnumerable<MediaSourceInfo>> GetChannelMediaSources(BaseItem item, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Adds the information to program dto.
|
|
/// </summary>
|
|
/// <param name="programs">The programs.</param>
|
|
/// <param name="fields">The fields.</param>
|
|
/// <param name="user">The user.</param>
|
|
/// <returns>Task.</returns>
|
|
Task AddInfoToProgramDto(IReadOnlyCollection<(BaseItem Item, BaseItemDto ItemDto)> programs, IReadOnlyList<ItemFields> fields, User user = null);
|
|
|
|
/// <summary>
|
|
/// Saves the tuner host.
|
|
/// </summary>
|
|
/// <param name="info">Turner host to save.</param>
|
|
/// <param name="dataSourceChanged">Option to specify that data source has changed.</param>
|
|
/// <returns>Tuner host information wrapped in a task.</returns>
|
|
Task<TunerHostInfo> SaveTunerHost(TunerHostInfo info, bool dataSourceChanged = true);
|
|
|
|
/// <summary>
|
|
/// Saves the listing provider.
|
|
/// </summary>
|
|
/// <param name="info">The information.</param>
|
|
/// <param name="validateLogin">if set to <c>true</c> [validate login].</param>
|
|
/// <param name="validateListings">if set to <c>true</c> [validate listings].</param>
|
|
/// <returns>Task.</returns>
|
|
Task<ListingsProviderInfo> SaveListingProvider(ListingsProviderInfo info, bool validateLogin, bool validateListings);
|
|
|
|
void DeleteListingsProvider(string id);
|
|
|
|
Task<TunerChannelMapping> SetChannelMapping(string providerId, string tunerChannelNumber, string providerChannelNumber);
|
|
|
|
TunerChannelMapping GetTunerChannelMapping(ChannelInfo tunerChannel, NameValuePair[] mappings, List<ChannelInfo> providerChannels);
|
|
|
|
/// <summary>
|
|
/// Gets the lineups.
|
|
/// </summary>
|
|
/// <param name="providerType">Type of the provider.</param>
|
|
/// <param name="providerId">The provider identifier.</param>
|
|
/// <param name="country">The country.</param>
|
|
/// <param name="location">The location.</param>
|
|
/// <returns>Task<List<NameIdPair>>.</returns>
|
|
Task<List<NameIdPair>> GetLineups(string providerType, string providerId, string country, string location);
|
|
|
|
/// <summary>
|
|
/// Adds the channel information.
|
|
/// </summary>
|
|
/// <param name="items">The items.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="user">The user.</param>
|
|
void AddChannelInfo(IReadOnlyCollection<(BaseItemDto ItemDto, LiveTvChannel Channel)> items, DtoOptions options, User user);
|
|
|
|
Task<List<ChannelInfo>> GetChannelsForListingsProvider(string id, CancellationToken cancellationToken);
|
|
|
|
Task<List<ChannelInfo>> GetChannelsFromListingsProviderData(string id, CancellationToken cancellationToken);
|
|
|
|
List<NameIdPair> GetTunerHostTypes();
|
|
|
|
Task<List<TunerHostInfo>> DiscoverTuners(bool newDevicesOnly, CancellationToken cancellationToken);
|
|
|
|
string GetEmbyTvActiveRecordingPath(string id);
|
|
|
|
ActiveRecordingInfo GetActiveRecordingInfo(string path);
|
|
|
|
void AddInfoToRecordingDto(BaseItem item, BaseItemDto dto, ActiveRecordingInfo activeRecordingInfo, User user = null);
|
|
|
|
List<BaseItem> GetRecordingFolders(User user);
|
|
}
|
|
}
|