Interface ILibraryManager

Interface ILibraryManager

Namespace: MediaBrowser.Controller.Library
Assembly: MediaBrowser.Controller.dll
Syntax
public interface ILibraryManager

Properties

IsScanRunning

Declaration
bool IsScanRunning { get; }
Property Value
Type Description
System.Boolean

RootFolder

Gets the root folder.

Declaration
AggregateFolder RootFolder { get; }
Property Value
Type Description
AggregateFolder

The root folder.

RootFolderId

Declaration
long RootFolderId { get; }
Property Value
Type Description
System.Int64

Methods

AddDatabase(ILibraryDatabase)

Declaration
void AddDatabase(ILibraryDatabase db)
Parameters
Type Name Description
ILibraryDatabase db

AddExternalSubtitleStreams(List<MediaStream>, String, Boolean, FileSystemMetadata[])

Declaration
void AddExternalSubtitleStreams(List<MediaStream> streams, string mediaPath, bool isAudio, FileSystemMetadata[] files)
Parameters
Type Name Description
System.Collections.Generic.List<MediaStream> streams
System.String mediaPath
System.Boolean isAudio
FileSystemMetadata[] files

AddListItems(BaseItem, ListItem[], Boolean)

Declaration
Task<ListItem[]> AddListItems(BaseItem list, ListItem[] items, bool skipDuplicates)
Parameters
Type Name Description
BaseItem list
ListItem[] items
System.Boolean skipDuplicates
Returns
Type Description
System.Threading.Tasks.Task<ListItem[]>

AddMediaPaths(CollectionFolder, MediaPathInfo[], Boolean)

Declaration
void AddMediaPaths(CollectionFolder item, MediaPathInfo[] pathInfos, bool refreshLibrary)
Parameters
Type Name Description
CollectionFolder item
MediaPathInfo[] pathInfos
System.Boolean refreshLibrary

AddParts(IEnumerable<IItemResolver>, IEnumerable<IIntroProvider>, IEnumerable<ILibraryPostScanTask>, IEnumerable<ILazyImageProvider>)

Adds the parts.

Declaration
void AddParts(IEnumerable<IItemResolver> resolvers, IEnumerable<IIntroProvider> introProviders, IEnumerable<ILibraryPostScanTask> postscanTasks, IEnumerable<ILazyImageProvider> lazyImageProviders)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IItemResolver> resolvers
System.Collections.Generic.IEnumerable<IIntroProvider> introProviders
System.Collections.Generic.IEnumerable<ILibraryPostScanTask> postscanTasks
System.Collections.Generic.IEnumerable<ILazyImageProvider> lazyImageProviders

AddVirtualFolder(String, LibraryOptions, Boolean)

Declaration
CollectionFolder AddVirtualFolder(string name, LibraryOptions options, bool refreshLibrary)
Parameters
Type Name Description
System.String name
LibraryOptions options
System.Boolean refreshLibrary
Returns
Type Description
CollectionFolder

AddVirtualFolder(String, String, LibraryOptions, Boolean)

Declaration
CollectionFolder AddVirtualFolder(string name, string sortName, LibraryOptions options, bool refreshLibrary)
Parameters
Type Name Description
System.String name
System.String sortName
LibraryOptions options
System.Boolean refreshLibrary
Returns
Type Description
CollectionFolder

ConvertImageToLocal(BaseItem, ItemImageInfo, Int32, CancellationToken)

Converts the image to local.

Declaration
Task<ItemImageInfo> ConvertImageToLocal(BaseItem item, ItemImageInfo image, int imageIndex, CancellationToken cancellationToken)
Parameters
Type Name Description
BaseItem item
ItemImageInfo image
System.Int32 imageIndex
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ItemImageInfo>

CreateItem(BaseItem, BaseItem)

Declaration
void CreateItem(BaseItem item, BaseItem parent)
Parameters
Type Name Description
BaseItem item
BaseItem parent

CreateItem(BaseItem, BaseItem, BaseItem[])

Creates the item.

Declaration
void CreateItem(BaseItem item, BaseItem parent, BaseItem[] collectionFolders)
Parameters
Type Name Description
BaseItem item
BaseItem parent
BaseItem[] collectionFolders

CreateItems(List<BaseItem>, BaseItem, MetadataRefreshOptions, BaseItem[], Boolean, CancellationToken)

Creates the items.

Declaration
void CreateItems(List<BaseItem> items, BaseItem parent, MetadataRefreshOptions metadataRefreshOptions, BaseItem[] collectionFolders, bool triggerItemAdded, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Collections.Generic.List<BaseItem> items
BaseItem parent
MetadataRefreshOptions metadataRefreshOptions
BaseItem[] collectionFolders
System.Boolean triggerItemAdded
System.Threading.CancellationToken cancellationToken

DeleteItem(BaseItem, DeleteOptions)

Deletes the item.

Declaration
void DeleteItem(BaseItem item, DeleteOptions options)
Parameters
Type Name Description
BaseItem item
DeleteOptions options

DeleteItem(BaseItem, DeleteOptions, BaseItem, Boolean)

Deletes the item.

Declaration
void DeleteItem(BaseItem item, DeleteOptions options, BaseItem parent, bool notifyParentItem)
Parameters
Type Name Description
BaseItem item
DeleteOptions options
BaseItem parent
System.Boolean notifyParentItem

DeleteItem(BaseItem, DeleteOptions, Boolean)

Deletes the item.

Declaration
void DeleteItem(BaseItem item, DeleteOptions options, bool notifyParentItem)
Parameters
Type Name Description
BaseItem item
DeleteOptions options
System.Boolean notifyParentItem

DeleteItems(Int64[])

Declaration
void DeleteItems(long[] ids)
Parameters
Type Name Description
System.Int64[] ids

FileNameMatchesMetadataName(String, String)

Declaration
bool FileNameMatchesMetadataName(string filename, string metadataName)
Parameters
Type Name Description
System.String filename
System.String metadataName
Returns
Type Description
System.Boolean

FillMissingEpisodeNumbersFromPath(Episode, Boolean)

Fills the missing episode numbers from path.

Declaration
bool FillMissingEpisodeNumbersFromPath(Episode episode, bool forceRefresh)
Parameters
Type Name Description
Episode episode
System.Boolean forceRefresh
Returns
Type Description
System.Boolean

FilterItemsToIdsForUser(BaseItem[], User, IDataContext)

Declaration
long[] FilterItemsToIdsForUser(BaseItem[] items, User user, IDataContext dataContext)
Parameters
Type Name Description
BaseItem[] items
User user
IDataContext dataContext
Returns
Type Description
System.Int64[]

FindByPath(String, Nullable<Boolean>)

Finds the by path.

Declaration
BaseItem FindByPath(string path, bool? isFolder)
Parameters
Type Name Description
System.String path

The path.
System.Nullable<System.Boolean> isFolder

The is folder.
Returns
Type Description
BaseItem

BaseItem.

FindIdByPath(String, Nullable<Boolean>)

Declaration
long FindIdByPath(string path, bool? isFolder)
Parameters
Type Name Description
System.String path
System.Nullable<System.Boolean> isFolder
Returns
Type Description
System.Int64

GetAllArtists(BaseItem)

Declaration
List<BaseItem> GetAllArtists(BaseItem item)
Parameters
Type Name Description
BaseItem item
Returns
Type Description
System.Collections.Generic.List<BaseItem>

GetAllGenres(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetAllGenres(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetAllIntroFiles()

Gets all intro files.

Declaration
List<string> GetAllIntroFiles()
Returns
Type Description
System.Collections.Generic.List<System.String>

IEnumerable{System.String}.

GetArtists(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetArtists(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetArtists(InternalItemsQuery, ItemLinkType[])

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetArtists(InternalItemsQuery query, ItemLinkType[] artistTypes)
Parameters
Type Name Description
InternalItemsQuery query
ItemLinkType[] artistTypes
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetAudioCodecs(InternalItemsQuery)

Declaration
QueryResult<string> GetAudioCodecs(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.String>

GetAudioLayouts(InternalItemsQuery)

Declaration
QueryResult<string> GetAudioLayouts(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.String>

GetCachedImage(BaseItem, String)

Declaration
string GetCachedImage(BaseItem item, string originalImagePath)
Parameters
Type Name Description
BaseItem item
System.String originalImagePath
Returns
Type Description
System.String

GetCollectionFolders(BaseItem)

Gets the collection folders.

Declaration
Folder[] GetCollectionFolders(BaseItem item)
Parameters
Type Name Description
BaseItem item

The item.
Returns
Type Description
Folder[]

GetCollectionFolders(BaseItem, IDataContext)

Declaration
Folder[] GetCollectionFolders(BaseItem item, IDataContext dataContext)
Parameters
Type Name Description
BaseItem item
IDataContext dataContext
Returns
Type Description
Folder[]

GetExtendedVideoTypes(InternalItemsQuery)

Declaration
QueryResult<ExtendedVideoTypes> GetExtendedVideoTypes(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<ExtendedVideoTypes>

GetExternalSubtitleFiles(Int64)

Declaration
List<string> GetExternalSubtitleFiles(long itemId)
Parameters
Type Name Description
System.Int64 itemId
Returns
Type Description
System.Collections.Generic.List<System.String>

GetExtraTypes(InternalItemsQuery)

Declaration
ExtraType[] GetExtraTypes(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
ExtraType[]

GetGameGenres(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetGameGenres(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetGenres(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetGenres(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetGuidAndPath(Int64)

Declaration
Tuple<Guid, string> GetGuidAndPath(long itemId)
Parameters
Type Name Description
System.Int64 itemId
Returns
Type Description
System.Tuple<System.Guid, System.String>

GetIdGuidPairs(InternalItemsQuery)

Declaration
(long, Guid)[] GetIdGuidPairs(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.ValueTuple<System.Int64, System.Guid>[]

GetImageInfo(Int64, ImageType, Int32)

Declaration
ItemImageInfo GetImageInfo(long itemId, ImageType imageType, int index)
Parameters
Type Name Description
System.Int64 itemId
ImageType imageType
System.Int32 index
Returns
Type Description
ItemImageInfo

GetImportedCollections(Int64)

Declaration
LinkedItemInfo[] GetImportedCollections(long itemId)
Parameters
Type Name Description
System.Int64 itemId
Returns
Type Description
LinkedItemInfo[]

GetInternalId(Guid)

Declaration
long GetInternalId(Guid id)
Parameters
Type Name Description
System.Guid id
Returns
Type Description
System.Int64

GetInternalId(ReadOnlySpan<Char>)

Declaration
long GetInternalId(ReadOnlySpan<char> id)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> id
Returns
Type Description
System.Int64

GetInternalId(String)

Declaration
long GetInternalId(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Int64

GetInternalId(String, String)

Declaration
long GetInternalId(string itemId, string mediaSourceId)
Parameters
Type Name Description
System.String itemId
System.String mediaSourceId
Returns
Type Description
System.Int64

GetInternalItemIds(InternalItemsQuery)

Declaration
long[] GetInternalItemIds(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.Int64[]

GetInternalItemIds(InternalItemsQuery, IDataContext)

Declaration
long[] GetInternalItemIds(InternalItemsQuery query, IDataContext dataContext)
Parameters
Type Name Description
InternalItemsQuery query
IDataContext dataContext
Returns
Type Description
System.Int64[]

GetIntros(BaseItem, User)

Gets the intros.

Declaration
Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
Parameters
Type Name Description
BaseItem item

The item.
User user

The user.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Video>>

GetItemById(Guid)

Gets the item by id.

Declaration
BaseItem GetItemById(Guid id)
Parameters
Type Name Description
System.Guid id

The id.
Returns
Type Description
BaseItem

BaseItem.

GetItemById(Int64)

Declaration
BaseItem GetItemById(long id)
Parameters
Type Name Description
System.Int64 id
Returns
Type Description
BaseItem

GetItemById(Int64, IDataContext)

Declaration
BaseItem GetItemById(long id, IDataContext dataContext)
Parameters
Type Name Description
System.Int64 id
IDataContext dataContext
Returns
Type Description
BaseItem

GetItemById(String, String)

Declaration
BaseItem GetItemById(string itemId, string mediaSourceId)
Parameters
Type Name Description
System.String itemId
System.String mediaSourceId
Returns
Type Description
BaseItem

GetItemIds(InternalItemsQuery)

Gets the item ids.

Declaration
Guid[] GetItemIds(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query

The query.
Returns
Type Description
System.Guid[]

List<Guid>.

GetItemLinks(Int64, List<ItemLinkType>)

Declaration
List<(ItemLinkType, string, long)> GetItemLinks(long itemId, List<ItemLinkType> types)
Parameters
Type Name Description
System.Int64 itemId
System.Collections.Generic.List<ItemLinkType> types
Returns
Type Description
System.Collections.Generic.List<System.ValueTuple<ItemLinkType, System.String, System.Int64>>

GetItemLinks(Int64, List<ItemLinkType>, IDataContext)

Declaration
List<(ItemLinkType, string, long)> GetItemLinks(long itemId, List<ItemLinkType> types, IDataContext dataContext)
Parameters
Type Name Description
System.Int64 itemId
System.Collections.Generic.List<ItemLinkType> types
IDataContext dataContext
Returns
Type Description
System.Collections.Generic.List<System.ValueTuple<ItemLinkType, System.String, System.Int64>>

GetItemList(InternalItemsQuery)

Gets the items.

Declaration
BaseItem[] GetItemList(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query

The query.
Returns
Type Description
BaseItem[]

QueryResult<BaseItem>.

GetItemList(InternalItemsQuery, Boolean)

Declaration
BaseItem[] GetItemList(InternalItemsQuery query, bool obsoleteParam)
Parameters
Type Name Description
InternalItemsQuery query
System.Boolean obsoleteParam
Returns
Type Description
BaseItem[]

GetItemPeople(BaseItem)

Gets the people.

Declaration
List<PersonInfo> GetItemPeople(BaseItem item)
Parameters
Type Name Description
BaseItem item
Returns
Type Description
System.Collections.Generic.List<PersonInfo>

GetItemPeople(InternalPeopleQuery)

Gets the people.

Declaration
List<PersonInfo> GetItemPeople(InternalPeopleQuery query)
Parameters
Type Name Description
InternalPeopleQuery query
Returns
Type Description
System.Collections.Generic.List<PersonInfo>

GetItemsResult(InternalItemsQuery)

Gets the items result.

Declaration
QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query

The query.
Returns
Type Description
QueryResult<BaseItem>

QueryResult<BaseItem>.

GetItemsResult(InternalItemsQuery, IDataContext)

Declaration
QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query, IDataContext dataContext)
Parameters
Type Name Description
InternalItemsQuery query
IDataContext dataContext
Returns
Type Description
QueryResult<BaseItem>

GetItemTypes(InternalItemsQuery)

Declaration
string[] GetItemTypes(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.String[]

GetLibraryOptions(BaseItem)

Declaration
LibraryOptions GetLibraryOptions(BaseItem item)
Parameters
Type Name Description
BaseItem item
Returns
Type Description
LibraryOptions

GetLibraryOptions(BaseItem, BaseItem[])

Declaration
LibraryOptions GetLibraryOptions(BaseItem item, BaseItem[] collectionFolders)
Parameters
Type Name Description
BaseItem item
BaseItem[] collectionFolders
Returns
Type Description
LibraryOptions

GetLibraryOptions(BaseItem, BaseItem[], IDataContext)

Declaration
LibraryOptions GetLibraryOptions(BaseItem item, BaseItem[] collectionFolders, IDataContext dataContext)
Parameters
Type Name Description
BaseItem item
BaseItem[] collectionFolders
IDataContext dataContext
Returns
Type Description
LibraryOptions

GetMusicAlbums(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetMusicAlbums(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetMusicGenres(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetMusicGenres(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetNamedView(String, String, Boolean, IDataContext)

Declaration
Folder GetNamedView(string name, string viewType, bool createIfNotFound, IDataContext dataContext)
Parameters
Type Name Description
System.String name
System.String viewType
System.Boolean createIfNotFound
IDataContext dataContext
Returns
Type Description
Folder

GetNameIdPairs(InternalItemsQuery)

Declaration
(string, long)[] GetNameIdPairs(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.ValueTuple<System.String, System.Int64>[]

GetNamingOptions()

Declaration
NamingOptions GetNamingOptions()
Returns
Type Description
NamingOptions

GetNewItemId(String, Type)

Gets the new item identifier.

Declaration
Guid GetNewItemId(string key, Type type)
Parameters
Type Name Description
System.String key

The key.
System.Type type

The type.
Returns
Type Description
System.Guid

Guid.

GetNewItemIdFromName(String, Type)

Declaration
Guid GetNewItemIdFromName(string name, Type type)
Parameters
Type Name Description
System.String name
System.Type type
Returns
Type Description
System.Guid

GetPathAfterNetworkSubstitution(ReadOnlySpan<Char>, LibraryOptions)

Declaration
string GetPathAfterNetworkSubstitution(ReadOnlySpan<char> path, LibraryOptions libraryOptions)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path
LibraryOptions libraryOptions
Returns
Type Description
System.String

GetPaths(InternalItemsQuery)

Declaration
string[] GetPaths(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.String[]

GetPeople(InternalItemsQuery)

Declaration
QueryResult<BaseItem> GetPeople(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<BaseItem>

GetPrefixes(BaseItem[])

Declaration
string[] GetPrefixes(BaseItem[] items)
Parameters
Type Name Description
BaseItem[] items
Returns
Type Description
System.String[]

GetProviderIds(Int64)

Declaration
ProviderIdDictionary GetProviderIds(long itemId)
Parameters
Type Name Description
System.Int64 itemId
Returns
Type Description
ProviderIdDictionary

GetSeasonNumberFromPath(ReadOnlySpan<Char>)

Gets the season number from path.

Declaration
int? GetSeasonNumberFromPath(ReadOnlySpan<char> path)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path

The path.
Returns
Type Description
System.Nullable<System.Int32>

System.Nullable<System.Int32>.

GetShareLevels(InternalItemsQuery)

Declaration
QueryResult<UserItemShareLevel?> GetShareLevels(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Nullable<UserItemShareLevel>>

GetStreamLanguages(InternalItemsQuery, MediaStreamType)

Declaration
QueryResult<string> GetStreamLanguages(InternalItemsQuery query, MediaStreamType streamType)
Parameters
Type Name Description
InternalItemsQuery query
MediaStreamType streamType
Returns
Type Description
QueryResult<System.String>

GetStudios(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetStudios(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetSubtitleCodecs(InternalItemsQuery)

Declaration
QueryResult<string> GetSubtitleCodecs(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.String>

GetSubviews(InternalItemsQuery, String)

Declaration
List<string> GetSubviews(InternalItemsQuery query, string contentType)
Parameters
Type Name Description
InternalItemsQuery query
System.String contentType
Returns
Type Description
System.Collections.Generic.List<System.String>

GetSyncTargetId(String, Boolean)

Declaration
long GetSyncTargetId(string reportedDeviceId, bool createIfNotFound)
Parameters
Type Name Description
System.String reportedDeviceId
System.Boolean createIfNotFound
Returns
Type Description
System.Int64

GetTags(InternalItemsQuery)

Declaration
QueryResult<Tuple<BaseItem, ItemCounts>> GetTags(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetTypeAndImageInfo(Int64, ImageType, Int32)

Declaration
Tuple<Type, ItemImageInfo> GetTypeAndImageInfo(long itemId, ImageType imageType, int index)
Parameters
Type Name Description
System.Int64 itemId
ImageType imageType
System.Int32 index
Returns
Type Description
System.Tuple<System.Type, ItemImageInfo>

GetUserRootFolder()

Gets the user root folder.

Declaration
Folder GetUserRootFolder()
Returns
Type Description
Folder

UserRootFolder.

GetVideoCodecs(InternalItemsQuery)

Declaration
QueryResult<string> GetVideoCodecs(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<System.String>

GetVirtualFolders()

Gets the default view.

Declaration
List<VirtualFolderInfo> GetVirtualFolders()
Returns
Type Description
System.Collections.Generic.List<VirtualFolderInfo>

GetVirtualFolders(User, Boolean)

Declaration
List<VirtualFolderInfo> GetVirtualFolders(User user, bool includeRefreshState)
Parameters
Type Name Description
User user
System.Boolean includeRefreshState
Returns
Type Description
System.Collections.Generic.List<VirtualFolderInfo>

IgnoreFile(FileSystemMetadata, BaseItem, LibraryOptions)

Ignores the file.

Declaration
bool IgnoreFile(FileSystemMetadata file, BaseItem parent, LibraryOptions libraryOptions)
Parameters
Type Name Description
FileSystemMetadata file
BaseItem parent
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean

IsAlphaNumericallyEquivalent(String, String)

Declaration
bool IsAlphaNumericallyEquivalent(string str1, string str2)
Parameters
Type Name Description
System.String str1
System.String str2
Returns
Type Description
System.Boolean

IsAudioFile(FileSystemMetadata, LibraryOptions)

Declaration
bool IsAudioFile(FileSystemMetadata file, LibraryOptions libraryOptions)
Parameters
Type Name Description
FileSystemMetadata file
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean

IsAudioFile(ReadOnlySpan<Char>)

Determines whether [is audio file] [the specified path].

Declaration
bool IsAudioFile(ReadOnlySpan<char> path)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path

The path.
Returns
Type Description
System.Boolean

true if [is audio file] [the specified path]; otherwise, false.

IsAudioFile(ReadOnlySpan<Char>, LibraryOptions)

Declaration
bool IsAudioFile(ReadOnlySpan<char> path, LibraryOptions libraryOptions)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean

IsLyricsFile(FileSystemMetadata)

Declaration
bool IsLyricsFile(FileSystemMetadata file)
Parameters
Type Name Description
FileSystemMetadata file
Returns
Type Description
System.Boolean

IsMultiDiscAlbumFolder(String)

Declaration
bool IsMultiDiscAlbumFolder(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.Boolean

IsSubtitleFile(String)

Declaration
bool IsSubtitleFile(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.Boolean

IsTVSpecialsFolder(String)

Declaration
bool IsTVSpecialsFolder(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.Boolean

IsVideoFile(FileSystemMetadata, LibraryOptions)

Declaration
bool IsVideoFile(FileSystemMetadata file, LibraryOptions libraryOptions)
Parameters
Type Name Description
FileSystemMetadata file
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean

IsVideoFile(ReadOnlySpan<Char>)

Determines whether [is video file] [the specified path].

Declaration
bool IsVideoFile(ReadOnlySpan<char> path)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path

The path.
Returns
Type Description
System.Boolean

true if [is video file] [the specified path]; otherwise, false.

IsVideoFile(ReadOnlySpan<Char>, LibraryOptions)

Declaration
bool IsVideoFile(ReadOnlySpan<char> path, LibraryOptions libraryOptions)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean

MakePrivate(BaseItem, User)

Declaration
void MakePrivate(BaseItem item, User user)
Parameters
Type Name Description
BaseItem item
User user

MakePublic(BaseItem, User)

Declaration
void MakePublic(BaseItem item, User user)
Parameters
Type Name Description
BaseItem item
User user

MergeItems(BaseItem[])

Declaration
void MergeItems(BaseItem[] items)
Parameters
Type Name Description
BaseItem[] items

MoveListItem(BaseItem, Int64, Int32)

Declaration
Task MoveListItem(BaseItem list, long entryId, int newIndex)
Parameters
Type Name Description
BaseItem list
System.Int64 entryId
System.Int32 newIndex
Returns
Type Description
System.Threading.Tasks.Task

ParseName(ReadOnlySpan<Char>)

Parses the name.

Declaration
ItemLookupInfo ParseName(ReadOnlySpan<char> name)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> name

The name.
Returns
Type Description
ItemLookupInfo

ItemInfo.

ParseName(String)

Declaration
ItemLookupInfo ParseName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
ItemLookupInfo

ParseSxxExxEpisodeNumberSystem(String)

Declaration
Tuple<int?, int?, int?> ParseSxxExxEpisodeNumberSystem(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
System.Tuple<System.Nullable<System.Int32>, System.Nullable<System.Int32>, System.Nullable<System.Int32>>

QueryItems(InternalItemsQuery)

Queries the items.

Declaration
QueryResult<BaseItem> QueryItems(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query

The query.
Returns
Type Description
QueryResult<BaseItem>

QueryResult<BaseItem>.

QueueLibraryScan()

Queues the library scan.

Declaration
void QueueLibraryScan()

RefreshThumbnailImages(Video, MediaStream, LibraryOptions, MetadataRefreshOptions, List<ChapterInfo>, Boolean, Boolean, CancellationToken)

Declaration
Task<bool> RefreshThumbnailImages(Video item, MediaStream videoStream, LibraryOptions libraryOptions, MetadataRefreshOptions metadataRefreshOptions, List<ChapterInfo> chapters, bool extractImages, bool saveChapters, CancellationToken cancellationToken)
Parameters
Type Name Description
Video item
MediaStream videoStream
LibraryOptions libraryOptions
MetadataRefreshOptions metadataRefreshOptions
System.Collections.Generic.List<ChapterInfo> chapters
System.Boolean extractImages
System.Boolean saveChapters
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

RemoveListItemsByListItemEntryIds(BaseItem, Int64[])

Declaration
Task RemoveListItemsByListItemEntryIds(BaseItem list, long[] listItemIds)
Parameters
Type Name Description
BaseItem list
System.Int64[] listItemIds
Returns
Type Description
System.Threading.Tasks.Task

RemoveMediaPath(Int64, String)

Declaration
void RemoveMediaPath(long virtualFolderId, string path)
Parameters
Type Name Description
System.Int64 virtualFolderId
System.String path

RemoveVirtualFolder(Int64)

Declaration
void RemoveVirtualFolder(long id)
Parameters
Type Name Description
System.Int64 id

RemoveVirtualFolder(Int64, Boolean)

Declaration
void RemoveVirtualFolder(long id, bool refreshLibrary)
Parameters
Type Name Description
System.Int64 id
System.Boolean refreshLibrary

ResolvePath(FileSystemMetadata, Folder)

Declaration
BaseItem ResolvePath(FileSystemMetadata fileInfo, Folder parent = null)
Parameters
Type Name Description
FileSystemMetadata fileInfo
Folder parent
Returns
Type Description
BaseItem

ResolvePaths(FileSystemMetadata[], IDirectoryService, Folder, LibraryOptions)

Resolves a set of files into a list of BaseItem

Declaration
List<BaseItem> ResolvePaths(FileSystemMetadata[] files, IDirectoryService directoryService, Folder parent, LibraryOptions libraryOptions)
Parameters
Type Name Description
FileSystemMetadata[] files
IDirectoryService directoryService
Folder parent
LibraryOptions libraryOptions
Returns
Type Description
System.Collections.Generic.List<BaseItem>

SaveUserItemShares(UserItemShare[])

Declaration
void SaveUserItemShares(UserItemShare[] shares)
Parameters
Type Name Description
UserItemShare[] shares

SetSortIndexNumbers(List<Tuple<Int64, Int32>>)

Declaration
void SetSortIndexNumbers(List<Tuple<long, int>> values)
Parameters
Type Name Description
System.Collections.Generic.List<System.Tuple<System.Int64, System.Int32>> values

SplitItems(BaseItem)

Declaration
void SplitItems(BaseItem item)
Parameters
Type Name Description
BaseItem item

SubstitutePath(ReadOnlySpan<Char>, ReadOnlySpan<Char>, ReadOnlySpan<Char>)

Substitutes the path.

Declaration
string SubstitutePath(ReadOnlySpan<char> path, ReadOnlySpan<char> from, ReadOnlySpan<char> to)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> path

The path.
System.ReadOnlySpan<System.Char> from

From.
System.ReadOnlySpan<System.Char> to

To.
Returns
Type Description
System.String

System.String.

TriggerItemAdded(BaseItem, BaseItem, BaseItem[])

Declaration
void TriggerItemAdded(BaseItem item, BaseItem parent, BaseItem[] collectionFolders)
Parameters
Type Name Description
BaseItem item
BaseItem parent
BaseItem[] collectionFolders

UpdateImages(BaseItem)

Declaration
void UpdateImages(BaseItem item)
Parameters
Type Name Description
BaseItem item

UpdateItem(BaseItem, BaseItem, ItemUpdateType)

Declaration
void UpdateItem(BaseItem item, BaseItem parent, ItemUpdateType updateReason)
Parameters
Type Name Description
BaseItem item
BaseItem parent
ItemUpdateType updateReason

UpdateItem(BaseItem, BaseItem, ItemUpdateType, MetadataRefreshOptions)

Declaration
void UpdateItem(BaseItem item, BaseItem parent, ItemUpdateType updateReason, MetadataRefreshOptions metadataRefreshOptions)
Parameters
Type Name Description
BaseItem item
BaseItem parent
ItemUpdateType updateReason
MetadataRefreshOptions metadataRefreshOptions

UpdateItems(List<BaseItem>, BaseItem, ItemUpdateType, MetadataRefreshOptions, CancellationToken)

Updates the item.

Declaration
void UpdateItems(List<BaseItem> items, BaseItem parent, ItemUpdateType updateReason, MetadataRefreshOptions metadataRefreshOptions, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Collections.Generic.List<BaseItem> items
BaseItem parent
ItemUpdateType updateReason
MetadataRefreshOptions metadataRefreshOptions
System.Threading.CancellationToken cancellationToken

UpdateItems(List<BaseItem>, BaseItem, ItemUpdateType, Boolean, Boolean, MetadataRefreshOptions, CancellationToken)

Declaration
void UpdateItems(List<BaseItem> items, BaseItem parent, ItemUpdateType updateReason, bool setDateLastSaved, bool saveMetadata, MetadataRefreshOptions metadataRefreshOptions, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Collections.Generic.List<BaseItem> items
BaseItem parent
ItemUpdateType updateReason
System.Boolean setDateLastSaved
System.Boolean saveMetadata
MetadataRefreshOptions metadataRefreshOptions
System.Threading.CancellationToken cancellationToken

UpdateListItems(BaseItem, LinkedChild[])

Declaration
void UpdateListItems(BaseItem list, LinkedChild[] items)
Parameters
Type Name Description
BaseItem list
LinkedChild[] items

UpdateMediaPath(Int64, MediaPathInfo)

Declaration
void UpdateMediaPath(long virtualFolderId, MediaPathInfo path)
Parameters
Type Name Description
System.Int64 virtualFolderId
MediaPathInfo path

UpdatePeople(BaseItem, List<PersonInfo>, Boolean)

Updates the people.

Declaration
void UpdatePeople(BaseItem item, List<PersonInfo> people, bool isNewItem = false)
Parameters
Type Name Description
BaseItem item
System.Collections.Generic.List<PersonInfo> people
System.Boolean isNewItem

ValidateMediaLibrary(IProgress<Double>, CancellationToken)

Reloads the root media folder

Declaration
Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
Parameters
Type Name Description
System.IProgress<System.Double> progress

The progress.
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
System.Threading.Tasks.Task

Task.

ValidatePeople(CancellationToken, IProgress<Double>)

Validate and refresh the People sub-set of the IBN. The items are stored in the db but not loaded into memory until actually requested by an operation.

Declaration
Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token.
System.IProgress<System.Double> progress

The progress.
Returns
Type Description
System.Threading.Tasks.Task

Task.

Events

ItemAdded

Occurs when [item added].

Declaration
event EventHandler<ItemChangeEventArgs> ItemAdded
Event Type
Type Description
System.EventHandler<ItemChangeEventArgs>

ItemAdding

Declaration
event EventHandler<ItemChangeEventArgs> ItemAdding
Event Type
Type Description
System.EventHandler<ItemChangeEventArgs>

ItemRemoved

Occurs when [item removed].

Declaration
event EventHandler<ItemChangeEventArgs> ItemRemoved
Event Type
Type Description
System.EventHandler<ItemChangeEventArgs>

ItemUpdated

Occurs when [item updated].

Declaration
event EventHandler<ItemChangeEventArgs> ItemUpdated
Event Type
Type Description
System.EventHandler<ItemChangeEventArgs>

Extension Methods