jellyfin/MediaBrowser.Controller/MediaEncoding/ISubtitleEncoder.cs

39 lines
1.5 KiB
C#
Raw Normal View History

2015-03-31 16:24:16 +00:00
using MediaBrowser.Model.MediaInfo;
using System.IO;
2014-06-10 17:36:06 +00:00
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.MediaEncoding
{
public interface ISubtitleEncoder
{
2014-06-11 19:31:33 +00:00
/// <summary>
/// Gets the subtitles.
/// </summary>
/// <param name="itemId">The item identifier.</param>
/// <param name="mediaSourceId">The media source identifier.</param>
/// <param name="subtitleStreamIndex">Index of the subtitle stream.</param>
/// <param name="outputFormat">The output format.</param>
/// <param name="startTimeTicks">The start time ticks.</param>
/// <param name="endTimeTicks">The end time ticks.</param>
2014-06-11 19:31:33 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{Stream}.</returns>
Task<Stream> GetSubtitles(string itemId,
string mediaSourceId,
int subtitleStreamIndex,
string outputFormat,
2014-06-11 19:31:33 +00:00
long startTimeTicks,
long? endTimeTicks,
CancellationToken cancellationToken);
2014-06-11 19:31:33 +00:00
/// <summary>
/// Gets the subtitle language encoding parameter.
/// </summary>
/// <param name="path">The path.</param>
2015-03-31 16:24:16 +00:00
/// <param name="protocol">The protocol.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2014-06-11 19:31:33 +00:00
/// <returns>System.String.</returns>
2015-03-31 16:24:16 +00:00
Task<string> GetSubtitleFileCharacterSet(string path, MediaProtocol protocol, CancellationToken cancellationToken);
2014-06-10 17:36:06 +00:00
}
}