Interface ISubtitleProvider
Namespace: MediaBrowser.Controller.Subtitles
Assembly: MediaBrowser.Controller.dll
Syntax
public interface ISubtitleProviderProperties
Name
Gets the name.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name. |
SupportedMediaTypes
Gets the supported media types.
Declaration
IEnumerable<VideoContentType> SupportedMediaTypes { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VideoContentType> | The supported media types. |
Methods
GetSubtitles(String, CancellationToken)
Gets the subtitles.
Declaration
Task<SubtitleResponse> GetSubtitles(string id, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The identifier. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SubtitleResponse> | Task{SubtitleResponse}. |
Search(SubtitleSearchRequest, CancellationToken)
Searches the subtitles.
Declaration
Task<IEnumerable<RemoteSubtitleInfo>> Search(SubtitleSearchRequest request, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| SubtitleSearchRequest | request | The request. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RemoteSubtitleInfo>> | Task{IEnumerable{RemoteSubtitleInfo}}. |