Interface ISubtitleEncoder
Namespace: MediaBrowser.Controller.MediaEncoding
Assembly: MediaBrowser.Controller.dll
Syntax
public interface ISubtitleEncoder
Methods
GetSubtitleFileCharacterSet(String, CultureDto, MediaProtocol, IDictionary<String, String>, CancellationToken)
Gets the subtitle language encoding parameter.
Declaration
Task<string> GetSubtitleFileCharacterSet(string path, CultureDto language, MediaProtocol protocol, IDictionary<string, string> requestHeaders, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path. |
| CultureDto | language | The language. |
| MediaProtocol | protocol | The protocol. |
| System.Collections.Generic.IDictionary<System.String, System.String> | requestHeaders | The request headers. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | System.String. |
GetSubtitleJob(MediaSourceInfo, Boolean, MediaStream, String, Int64, Int64, Boolean, Boolean, Boolean, EncodingContext, CancellationToken)
Declaration
Task<ISubtitleConversionJob> GetSubtitleJob(MediaSourceInfo mediaSource, bool isAudio, MediaStream subtitleStream, string outputFormat, long startTimeTicks, long endTimeTicks, bool preserveOriginalTimestamps, bool shiftTimeStampsByContainerStartTime, bool enableChunkedResponse, EncodingContext encodingContext, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| MediaSourceInfo | mediaSource | |
| System.Boolean | isAudio | |
| MediaStream | subtitleStream | |
| System.String | outputFormat | |
| System.Int64 | startTimeTicks | |
| System.Int64 | endTimeTicks | |
| System.Boolean | preserveOriginalTimestamps | |
| System.Boolean | shiftTimeStampsByContainerStartTime | |
| System.Boolean | enableChunkedResponse | |
| EncodingContext | encodingContext | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ISubtitleConversionJob> |
GetSubtitles(MediaSourceInfo, Boolean, MediaStream, String, Int64, Int64, Boolean, Boolean, EncodingContext, CancellationToken)
Gets the subtitles.
Declaration
Task<string> GetSubtitles(MediaSourceInfo mediaSource, bool isAudio, MediaStream subtitleStream, string outputFormat, long startTimeTicks, long endTimeTicks, bool preserveOriginalTimestamps, bool shiftTimeStampsByContainerStartTime, EncodingContext encodingContext, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| MediaSourceInfo | mediaSource | |
| System.Boolean | isAudio | |
| MediaStream | subtitleStream | |
| System.String | outputFormat | |
| System.Int64 | startTimeTicks | |
| System.Int64 | endTimeTicks | |
| System.Boolean | preserveOriginalTimestamps | |
| System.Boolean | shiftTimeStampsByContainerStartTime | |
| EncodingContext | encodingContext | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | Task{Stream}. |