jellyfin-server/MediaBrowser.Controller/MediaEncoding/ISubtitleEncoder.cs

49 lines
1.9 KiB
C#
Raw Normal View History

#nullable disable
#pragma warning disable CS1591
using System.IO;
2018-12-27 23:27:57 +00:00
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;
2018-12-27 23:27:57 +00:00
namespace MediaBrowser.Controller.MediaEncoding
{
public interface ISubtitleEncoder
{
/// <summary>
/// Gets the subtitles.
/// </summary>
/// <param name="item">Item to use.</param>
/// <param name="mediaSourceId">Media source.</param>
/// <param name="subtitleStreamIndex">Subtitle stream to use.</param>
/// <param name="outputFormat">Output format to use.</param>
/// <param name="startTimeTicks">Start time.</param>
/// <param name="endTimeTicks">End time.</param>
/// <param name="preserveOriginalTimestamps">Option to preserve original timestamps.</param>
/// <param name="cancellationToken">The cancellation token for the operation.</param>
2018-12-27 23:27:57 +00:00
/// <returns>Task{Stream}.</returns>
Task<Stream> GetSubtitles(
BaseItem item,
2018-12-27 23:27:57 +00:00
string mediaSourceId,
int subtitleStreamIndex,
string outputFormat,
long startTimeTicks,
long endTimeTicks,
bool preserveOriginalTimestamps,
CancellationToken cancellationToken);
/// <summary>
/// Gets the subtitle language encoding parameter.
/// </summary>
/// <param name="subtitleStream">The subtitle stream.</param>
/// <param name="language">The language.</param>
/// <param name="mediaSource">The media source.</param>
2018-12-27 23:27:57 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>System.String.</returns>
Task<string> GetSubtitleFileCharacterSet(MediaStream subtitleStream, string language, MediaSourceInfo mediaSource, CancellationToken cancellationToken);
2018-12-27 23:27:57 +00:00
}
}