jellyfin/MediaBrowser.Controller/Library/IMediaSourceManager.cs

100 lines
4.4 KiB
C#
Raw Normal View History

2015-03-07 22:43:53 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;
2015-03-29 16:45:16 +00:00
using MediaBrowser.Model.MediaInfo;
2015-03-03 07:03:17 +00:00
using System;
using System.Collections.Generic;
2015-03-07 22:43:53 +00:00
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Library
{
public interface IMediaSourceManager
{
2015-03-07 22:43:53 +00:00
/// <summary>
/// Adds the parts.
/// </summary>
/// <param name="providers">The providers.</param>
void AddParts(IEnumerable<IMediaSourceProvider> providers);
2015-03-03 07:03:17 +00:00
/// <summary>
/// Gets the media streams.
/// </summary>
/// <param name="itemId">The item identifier.</param>
/// <returns>IEnumerable&lt;MediaStream&gt;.</returns>
IEnumerable<MediaStream> GetMediaStreams(Guid itemId);
/// <summary>
/// Gets the media streams.
/// </summary>
/// <param name="mediaSourceId">The media source identifier.</param>
/// <returns>IEnumerable&lt;MediaStream&gt;.</returns>
IEnumerable<MediaStream> GetMediaStreams(string mediaSourceId);
/// <summary>
/// Gets the media streams.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>IEnumerable&lt;MediaStream&gt;.</returns>
IEnumerable<MediaStream> GetMediaStreams(MediaStreamQuery query);
2015-03-07 22:43:53 +00:00
/// <summary>
/// Gets the playack media sources.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="userId">The user identifier.</param>
/// <param name="enablePathSubstitution">if set to <c>true</c> [enable path substitution].</param>
2015-04-09 05:20:23 +00:00
/// <param name="supportedLiveMediaTypes">The supported live media types.</param>
2015-03-07 22:43:53 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>IEnumerable&lt;MediaSourceInfo&gt;.</returns>
2015-04-09 05:20:23 +00:00
Task<IEnumerable<MediaSourceInfo>> GetPlayackMediaSources(string id, string userId, bool enablePathSubstitution, string[] supportedLiveMediaTypes, CancellationToken cancellationToken);
2015-03-07 22:43:53 +00:00
/// <summary>
/// Gets the static media sources.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="enablePathSubstitution">if set to <c>true</c> [enable path substitution].</param>
/// <param name="user">The user.</param>
/// <returns>IEnumerable&lt;MediaSourceInfo&gt;.</returns>
2015-04-01 21:56:32 +00:00
IEnumerable<MediaSourceInfo> GetStaticMediaSources(IHasMediaSources item, bool enablePathSubstitution, User user = null);
2015-04-09 05:20:23 +00:00
2015-03-07 22:43:53 +00:00
/// <summary>
/// Gets the static media source.
/// </summary>
/// <returns>MediaSourceInfo.</returns>
2016-09-18 20:38:38 +00:00
Task<MediaSourceInfo> GetMediaSource(IHasMediaSources item, string mediaSourceId, string liveStreamId, bool enablePathSubstitution, CancellationToken cancellationToken);
2015-03-28 20:22:27 +00:00
/// <summary>
/// Opens the media source.
/// </summary>
2015-03-29 16:45:16 +00:00
/// <param name="request">The request.</param>
2015-03-29 04:56:39 +00:00
/// <param name="enableAutoClose">if set to <c>true</c> [enable automatic close].</param>
2015-03-28 20:22:27 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task&lt;MediaSourceInfo&gt;.</returns>
2015-03-29 16:45:16 +00:00
Task<LiveStreamResponse> OpenLiveStream(LiveStreamRequest request, bool enableAutoClose, CancellationToken cancellationToken);
2015-03-29 04:56:39 +00:00
/// <summary>
/// Gets the live stream.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task&lt;MediaSourceInfo&gt;.</returns>
Task<MediaSourceInfo> GetLiveStream(string id, CancellationToken cancellationToken);
/// <summary>
/// Pings the media source.
/// </summary>
/// <param name="id">The live stream identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task PingLiveStream(string id, CancellationToken cancellationToken);
2015-03-28 20:22:27 +00:00
/// <summary>
/// Closes the media source.
/// </summary>
2015-03-29 04:56:39 +00:00
/// <param name="id">The live stream identifier.</param>
2015-03-28 20:22:27 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2015-03-29 04:56:39 +00:00
Task CloseLiveStream(string id, CancellationToken cancellationToken);
}
}