Interface IProviderManager

Interface IProviderManager

Namespace: MediaBrowser.Controller.Providers

Assembly: MediaBrowser.Controller.dll

Syntax

public interface IProviderManager

Properties

ImageProviders

Declaration

IImageProvider[] ImageProviders { get; }

Property Value

Type	Description
IImageProvider[]

IsProcessingRefreshQueue

Declaration

bool IsProcessingRefreshQueue { get; }

Property Value

Type	Description
System.Boolean

Methods

CacheImage(BaseItem, ItemImageInfo, LibraryOptions, IDirectoryService)

Declaration

void CacheImage(BaseItem item, ItemImageInfo image, LibraryOptions libraryOptions, IDirectoryService directoryService)

Parameters

Type	Name	Description
BaseItem	item
ItemImageInfo	image
LibraryOptions	libraryOptions
IDirectoryService	directoryService

CacheImages(BaseItem)

Declaration

void CacheImages(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item

DeleteCachedImages(BaseItem, ItemImageInfo[], LibraryOptions, IDirectoryService)

Declaration

void DeleteCachedImages(BaseItem item, ItemImageInfo[] images, LibraryOptions libraryOptions, IDirectoryService directoryService)

Parameters

Type	Name	Description
BaseItem	item
ItemImageInfo[]	images
LibraryOptions	libraryOptions
IDirectoryService	directoryService

DequeueRefresh(Int64)

Declaration

void DequeueRefresh(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

GetAllEpisodes(Series, LibraryOptions, CancellationToken)

Declaration

Task<RemoteSearchResult[]> GetAllEpisodes(Series series, LibraryOptions libraryOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Series	series
LibraryOptions	libraryOptions
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<RemoteSearchResult[]>

GetAllMetadataPlugins()

Gets all metadata plugins.

Declaration

MetadataPluginSummary[] GetAllMetadataPlugins()

Returns

Type	Description
MetadataPluginSummary[]

GetAvailableRemoteImages(BaseItem, LibraryOptions, RemoteImageQuery, IDirectoryService, CancellationToken)

Declaration

Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, LibraryOptions libraryOptions, RemoteImageQuery query, IDirectoryService directoryService, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions
RemoteImageQuery	query
IDirectoryService	directoryService
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RemoteImageInfo>>

GetAvailableRemoteImages(BaseItem, LibraryOptions, RemoteImageQuery, CancellationToken)

Gets the available remote images.

Declaration

Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, LibraryOptions libraryOptions, RemoteImageQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item	The item.
LibraryOptions	libraryOptions	The library options.
RemoteImageQuery	query	The query.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RemoteImageInfo>>

GetDefaultLibraryOptions(String)

Declaration

LibraryOptions GetDefaultLibraryOptions(string contentType)

Parameters

Type	Name	Description
System.String	contentType

Returns

Type	Description
LibraryOptions

GetEnabledMetadataProviders(BaseItem, LibraryOptions)

Declaration

IMetadataProvider[] GetEnabledMetadataProviders(BaseItem item, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions

Returns

Type	Description
IMetadataProvider[]

GetExternalIdInfos(IHasProviderIds)

Gets the external identifier infos.

Declaration

IEnumerable<ExternalIdInfo> GetExternalIdInfos(IHasProviderIds item)

Parameters

Type	Name	Description
IHasProviderIds	item	The item.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ExternalIdInfo>

GetExternalUrls(BaseItem)

Gets the external urls.

Declaration

IEnumerable<ExternalUrl> GetExternalUrls(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item	The item.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ExternalUrl>

GetLibraryOptionsInfo(String)

Declaration

LibraryOptionsResult GetLibraryOptionsInfo(string contentType)

Parameters

Type	Name	Description
System.String	contentType

Returns

Type	Description
LibraryOptionsResult

GetRefreshProgress(Int64)

Declaration

double? GetRefreshProgress(long id)

Parameters

Type	Name	Description
System.Int64	id

Returns

Type	Description
System.Nullable<System.Double>

GetRefreshQueue()

Declaration

List<Tuple<long, MetadataRefreshOptions>> GetRefreshQueue()

Returns

Type	Description
System.Collections.Generic.List<System.Tuple<System.Int64, MetadataRefreshOptions>>

GetRemoteImageProviderInfo(BaseItem, LibraryOptions)

Gets the image providers.

Declaration

IEnumerable<ImageProviderInfo> GetRemoteImageProviderInfo(BaseItem item, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
BaseItem	item	The item.
LibraryOptions	libraryOptions

Returns

Type	Description
System.Collections.Generic.IEnumerable<ImageProviderInfo>

GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType>, BaseItem, CancellationToken)

Declaration

Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, BaseItem referenceItem, CancellationToken cancellationToken)
    where TItemType : BaseItem, new()
    where TLookupType : ItemLookupInfo

Parameters

Type	Name	Description
RemoteSearchQuery<TLookupType>	searchInfo
BaseItem	referenceItem
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RemoteSearchResult>>

Type Parameters

Name	Description
TItemType
TLookupType

GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType>, CancellationToken)

Gets the remote search results.

Declaration

Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, CancellationToken cancellationToken)
    where TItemType : BaseItem, new()
    where TLookupType : ItemLookupInfo

Parameters

Type	Name	Description
RemoteSearchQuery<TLookupType>	searchInfo	The search information.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RemoteSearchResult>>

Type Parameters

Name	Description
TItemType	The type of the t item type.
TLookupType	The type of the t lookup type.

GetSearchImage(ReadOnlyMemory<Char>, String, CancellationToken)

Gets the search image.

Declaration

Task<HttpResponseInfo> GetSearchImage(ReadOnlyMemory<char> providerName, string url, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	providerName	Name of the provider.
System.String	url	The URL.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<HttpResponseInfo>	Task{HttpResponseInfo}.

IsUniquelyIdentifiableProviderId(String)

Declaration

bool IsUniquelyIdentifiableProviderId(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsUniquelyIdentifiableProviderId(String, BaseItem)

Declaration

bool IsUniquelyIdentifiableProviderId(string name, BaseItem item)

Parameters

Type	Name	Description
System.String	name
BaseItem	item

Returns

Type	Description
System.Boolean

NormalizeNameForMetadataSearch(String)

Declaration

string NormalizeNameForMetadataSearch(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.String

OnRefreshComplete(BaseItem, BaseItem[])

Declaration

void OnRefreshComplete(BaseItem item, BaseItem[] collectionFolders)

Parameters

Type	Name	Description
BaseItem	item
BaseItem[]	collectionFolders

OnRefreshProgress(BaseItem, Double, BaseItem[])

Declaration

void OnRefreshProgress(BaseItem item, double progress, BaseItem[] collectionFolders)

Parameters

Type	Name	Description
BaseItem	item
System.Double	progress
BaseItem[]	collectionFolders

OnRefreshStart(BaseItem, BaseItem[])

Declaration

void OnRefreshStart(BaseItem item, BaseItem[] collectionFolders)

Parameters

Type	Name	Description
BaseItem	item
BaseItem[]	collectionFolders

QueueRefresh(Int64, MetadataRefreshOptions, RefreshPriority)

Queues the refresh.

Declaration

void QueueRefresh(long itemId, MetadataRefreshOptions options, RefreshPriority priority)

Parameters

Type	Name	Description
System.Int64	itemId
MetadataRefreshOptions	options
RefreshPriority	priority

QueueRefresh(Int64, MetadataRefreshOptions, RefreshPriority, Boolean)

Declaration

void QueueRefresh(long itemId, MetadataRefreshOptions options, RefreshPriority priority, bool dequeueIfAlreadyQueued)

Parameters

Type	Name	Description
System.Int64	itemId
MetadataRefreshOptions	options
RefreshPriority	priority
System.Boolean	dequeueIfAlreadyQueued

RefreshFullItem(BaseItem, MetadataRefreshOptions, CancellationToken)

Refreshes the full item.

Declaration

Task RefreshFullItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item	The item.
MetadataRefreshOptions	options	The options.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

RefreshSingleItem(BaseItem, MetadataRefreshOptions, BaseItem[], LibraryOptions, CancellationToken)

Refreshes the metadata.

Declaration

Task<ItemUpdateType> RefreshSingleItem(BaseItem item, MetadataRefreshOptions options, BaseItem[] collectionFolders, LibraryOptions libraryOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item	The item.
MetadataRefreshOptions	options	The options.
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ItemUpdateType>	Task.

SaveImage(BaseItem, LibraryOptions, Stream, ReadOnlyMemory<Char>, ImageType, Nullable<Int32>, Int64[], IDirectoryService, Boolean, CancellationToken)

Saves the image.

Declaration

Task SaveImage(BaseItem item, LibraryOptions libraryOptions, Stream source, ReadOnlyMemory<char> mimeType, ImageType type, int? imageIndex, long[] generatedFromItemIds, IDirectoryService directoryService, bool updateImageCache, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions
System.IO.Stream	source
System.ReadOnlyMemory<System.Char>	mimeType
ImageType	type
System.Nullable<System.Int32>	imageIndex
System.Int64[]	generatedFromItemIds
IDirectoryService	directoryService
System.Boolean	updateImageCache
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

SaveImage(BaseItem, LibraryOptions, String, ImageType, Nullable<Int32>, Int64[], IDirectoryService, Boolean, CancellationToken)

Saves the image.

Declaration

Task SaveImage(BaseItem item, LibraryOptions libraryOptions, string url, ImageType type, int? imageIndex, long[] generatedFromItemIds, IDirectoryService directoryService, bool updateImageCache, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions
System.String	url
ImageType	type
System.Nullable<System.Int32>	imageIndex
System.Int64[]	generatedFromItemIds
IDirectoryService	directoryService
System.Boolean	updateImageCache
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

SaveImage(BaseItem, LibraryOptions, String, ReadOnlyMemory<Char>, ImageType, Nullable<Int32>, Nullable<Boolean>, Int64[], IDirectoryService, Boolean, CancellationToken)

Saves the image.

Declaration

Task SaveImage(BaseItem item, LibraryOptions libraryOptions, string source, ReadOnlyMemory<char> mimeType, ImageType type, int? imageIndex, bool? saveLocallyWithMedia, long[] generatedFromItemIds, IDirectoryService directoryService, bool updateImageCache, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions
System.String	source
System.ReadOnlyMemory<System.Char>	mimeType
ImageType	type
System.Nullable<System.Int32>	imageIndex
System.Nullable<System.Boolean>	saveLocallyWithMedia
System.Int64[]	generatedFromItemIds
IDirectoryService	directoryService
System.Boolean	updateImageCache
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task	Task.

SaveMetadata(BaseItem, ItemUpdateType)

Saves the metadata.

Declaration

Task SaveMetadata(BaseItem item, ItemUpdateType updateType)

Parameters

Type	Name	Description
BaseItem	item	The item.
ItemUpdateType	updateType	Type of the update.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

SaveMetadata(BaseItem, ItemUpdateType, IEnumerable<String>)

Saves the metadata.

Declaration

Task SaveMetadata(BaseItem item, ItemUpdateType updateType, IEnumerable<string> savers)

Parameters

Type	Name	Description
BaseItem	item
ItemUpdateType	updateType
System.Collections.Generic.IEnumerable<System.String>	savers

Returns

Type	Description
System.Threading.Tasks.Task

SaveMetadata(BaseItem, LibraryOptions, ItemUpdateType)

Declaration

Task SaveMetadata(BaseItem item, LibraryOptions libraryOptions, ItemUpdateType updateType)

Parameters

Type	Name	Description
BaseItem	item
LibraryOptions	libraryOptions
ItemUpdateType	updateType

Returns

Type	Description
System.Threading.Tasks.Task

WaitForRefreshQueue(IProgress<Double>, CancellationToken)

Declaration

Task WaitForRefreshQueue(IProgress<double> progress, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.IProgress<System.Double>	progress
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

Events

RefreshCompleted

Declaration

event EventHandler<GenericEventArgs<RefreshProgressInfo>> RefreshCompleted

Event Type

Type	Description
System.EventHandler<GenericEventArgs<RefreshProgressInfo>>

RefreshProgress

Declaration

event EventHandler<GenericEventArgs<RefreshProgressInfo>> RefreshProgress

Event Type

Type	Description
System.EventHandler<GenericEventArgs<RefreshProgressInfo>>

RefreshStarted

Declaration

event EventHandler<GenericEventArgs<RefreshProgressInfo>> RefreshStarted

Event Type

Type	Description
System.EventHandler<GenericEventArgs<RefreshProgressInfo>>

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)