Facebook
Twitter
Pinterest
Tumblr
GitHub
RSS
  • DEV Home
  • Documentation
  • Reference
  • Download
Search Results for

    Show / Hide Table of Contents

    Interface ISubtitleManager

    Namespace: MediaBrowser.Controller.Subtitles
    Assembly: MediaBrowser.Controller.dll
    Syntax
    public interface ISubtitleManager

    Methods

    AddParts(IEnumerable<ISubtitleProvider>)

    Adds the parts.

    Declaration
    void AddParts(IEnumerable<ISubtitleProvider> subtitleProviders)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<ISubtitleProvider> subtitleProviders

    The subtitle providers.

    DeleteSubtitles(BaseItem, Int32)

    Deletes the subtitles.

    Declaration
    Task DeleteSubtitles(BaseItem item, int index)
    Parameters
    Type Name Description
    BaseItem item
    System.Int32 index
    Returns
    Type Description
    System.Threading.Tasks.Task

    DownloadSubtitles(BaseItem, String, LibraryOptions, CancellationToken)

    Downloads the subtitles.

    Declaration
    Task<string> DownloadSubtitles(BaseItem item, string subtitleId, LibraryOptions libraryOptions, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    BaseItem item
    System.String subtitleId
    LibraryOptions libraryOptions
    System.Threading.CancellationToken cancellationToken
    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    DownloadSubtitles(BaseItem, String, CancellationToken)

    Downloads the subtitles.

    Declaration
    Task<string> DownloadSubtitles(BaseItem item, string subtitleId, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    BaseItem item
    System.String subtitleId
    System.Threading.CancellationToken cancellationToken
    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    GetRemoteSubtitles(String, CancellationToken)

    Gets the remote subtitles.

    Declaration
    Task<SubtitleResponse> GetRemoteSubtitles(string id, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String id
    System.Threading.CancellationToken cancellationToken
    Returns
    Type Description
    System.Threading.Tasks.Task<SubtitleResponse>

    GetSupportedProviders(BaseItem)

    Gets the providers.

    Declaration
    SubtitleProviderInfo[] GetSupportedProviders(BaseItem item)
    Parameters
    Type Name Description
    BaseItem item
    Returns
    Type Description
    SubtitleProviderInfo[]

    SearchSubtitles(BaseItem, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

    Searches the subtitles.

    Declaration
    Task<RemoteSubtitleInfo[]> SearchSubtitles(BaseItem item, string language, bool? isPerfectMatch, bool? isForced, bool? isHearingImpaired, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    BaseItem item
    System.String language
    System.Nullable<System.Boolean> isPerfectMatch
    System.Nullable<System.Boolean> isForced
    System.Nullable<System.Boolean> isHearingImpaired
    System.Threading.CancellationToken cancellationToken
    Returns
    Type Description
    System.Threading.Tasks.Task<RemoteSubtitleInfo[]>

    SearchSubtitles(SubtitleSearchRequest, CancellationToken)

    Searches the subtitles.

    Declaration
    Task<RemoteSubtitleInfo[]> SearchSubtitles(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<RemoteSubtitleInfo[]>

    Task{IEnumerable{RemoteSubtitleInfo}}.

    Events

    SubtitleDownloadFailure

    Occurs when [subtitle download failure].

    Declaration
    event EventHandler<SubtitleDownloadFailureEventArgs> SubtitleDownloadFailure
    Event Type
    Type Description
    System.EventHandler<SubtitleDownloadFailureEventArgs>

    SubtitlesDownloaded

    Occurs when [subtitles downloaded].

    Declaration
    event EventHandler<SubtitleDownloadEventArgs> SubtitlesDownloaded
    Event Type
    Type Description
    System.EventHandler<SubtitleDownloadEventArgs>

    Extension Methods

    Extensions.JsonClone<T>(T, IJsonSerializer)
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.