ISubtitleEncoder.cs 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. using MediaBrowser.Model.MediaInfo;
  2. using System.IO;
  3. using System.Threading;
  4. using System.Threading.Tasks;
  5. namespace MediaBrowser.Controller.MediaEncoding
  6. {
  7. public interface ISubtitleEncoder
  8. {
  9. /// <summary>
  10. /// Gets the subtitles.
  11. /// </summary>
  12. /// <param name="itemId">The item identifier.</param>
  13. /// <param name="mediaSourceId">The media source identifier.</param>
  14. /// <param name="subtitleStreamIndex">Index of the subtitle stream.</param>
  15. /// <param name="outputFormat">The output format.</param>
  16. /// <param name="startTimeTicks">The start time ticks.</param>
  17. /// <param name="endTimeTicks">The end time ticks.</param>
  18. /// <param name="cancellationToken">The cancellation token.</param>
  19. /// <returns>Task{Stream}.</returns>
  20. Task<Stream> GetSubtitles(string itemId,
  21. string mediaSourceId,
  22. int subtitleStreamIndex,
  23. string outputFormat,
  24. long startTimeTicks,
  25. long? endTimeTicks,
  26. CancellationToken cancellationToken);
  27. /// <summary>
  28. /// Gets the subtitle language encoding parameter.
  29. /// </summary>
  30. /// <param name="path">The path.</param>
  31. /// <param name="protocol">The protocol.</param>
  32. /// <param name="cancellationToken">The cancellation token.</param>
  33. /// <returns>System.String.</returns>
  34. Task<string> GetSubtitleFileCharacterSet(string path, MediaProtocol protocol, CancellationToken cancellationToken);
  35. }
  36. }