mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-07 11:57:55 +02:00
137 lines
5.4 KiB
C#
137 lines
5.4 KiB
C#
using MediaBrowser.Model.Entities;
|
|
using MediaBrowser.Model.MediaInfo;
|
|
using System;
|
|
using System.IO;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Controller.MediaEncoding
|
|
{
|
|
/// <summary>
|
|
/// Interface IMediaEncoder
|
|
/// </summary>
|
|
public interface IMediaEncoder
|
|
{
|
|
/// <summary>
|
|
/// Gets the encoder path.
|
|
/// </summary>
|
|
/// <value>The encoder path.</value>
|
|
string EncoderPath { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the version.
|
|
/// </summary>
|
|
/// <value>The version.</value>
|
|
string Version { get; }
|
|
|
|
/// <summary>
|
|
/// Supportses the decoder.
|
|
/// </summary>
|
|
/// <param name="decoder">The decoder.</param>
|
|
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
|
bool SupportsDecoder(string decoder);
|
|
|
|
/// <summary>
|
|
/// Extracts the audio image.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <param name="imageStreamIndex">Index of the image stream.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{Stream}.</returns>
|
|
Task<Stream> ExtractAudioImage(string path, int? imageStreamIndex, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Extracts the video image.
|
|
/// </summary>
|
|
/// <param name="inputFiles">The input files.</param>
|
|
/// <param name="protocol">The protocol.</param>
|
|
/// <param name="threedFormat">The threed format.</param>
|
|
/// <param name="offset">The offset.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task{Stream}.</returns>
|
|
Task<Stream> ExtractVideoImage(string[] inputFiles, MediaProtocol protocol, Video3DFormat? threedFormat, TimeSpan? offset, CancellationToken cancellationToken);
|
|
|
|
Task<Stream> ExtractVideoImage(string[] inputFiles, MediaProtocol protocol, int? imageStreamIndex, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Extracts the video images on interval.
|
|
/// </summary>
|
|
/// <param name="inputFiles">The input files.</param>
|
|
/// <param name="protocol">The protocol.</param>
|
|
/// <param name="threedFormat">The threed format.</param>
|
|
/// <param name="interval">The interval.</param>
|
|
/// <param name="targetDirectory">The target directory.</param>
|
|
/// <param name="filenamePrefix">The filename prefix.</param>
|
|
/// <param name="maxWidth">The maximum width.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ExtractVideoImagesOnInterval(string[] inputFiles,
|
|
MediaProtocol protocol,
|
|
Video3DFormat? threedFormat,
|
|
TimeSpan interval,
|
|
string targetDirectory,
|
|
string filenamePrefix,
|
|
int? maxWidth,
|
|
CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the media info.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task<MediaInfo> GetMediaInfo(MediaInfoRequest request, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the probe size argument.
|
|
/// </summary>
|
|
/// <param name="inputFiles">The input files.</param>
|
|
/// <param name="protocol">The protocol.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetProbeSizeArgument(string[] inputFiles, MediaProtocol protocol);
|
|
|
|
/// <summary>
|
|
/// Gets the input argument.
|
|
/// </summary>
|
|
/// <param name="inputFiles">The input files.</param>
|
|
/// <param name="protocol">The protocol.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetInputArgument(string[] inputFiles, MediaProtocol protocol);
|
|
|
|
/// <summary>
|
|
/// Gets the time parameter.
|
|
/// </summary>
|
|
/// <param name="ticks">The ticks.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetTimeParameter(long ticks);
|
|
|
|
/// <summary>
|
|
/// Encodes the audio.
|
|
/// </summary>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="progress">The progress.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task<string> EncodeAudio(EncodingJobOptions options,
|
|
IProgress<double> progress,
|
|
CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Encodes the video.
|
|
/// </summary>
|
|
/// <param name="options">The options.</param>
|
|
/// <param name="progress">The progress.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task<System.String>.</returns>
|
|
Task<string> EncodeVideo(EncodingJobOptions options,
|
|
IProgress<double> progress,
|
|
CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Escapes the subtitle filter path.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns>System.String.</returns>
|
|
string EscapeSubtitleFilterPath(string path);
|
|
}
|
|
}
|