3e5d29225a
- Removed unused classes and files related to SQLite database provider, including SqliteDesignTimeJellyfinDbFactory, ModelBuilderExtensions, PragmaConnectionInterceptor, AssemblyInfo, SqliteDatabaseProvider, DateTimeKindValueConverter. - Updated tests to remove dependencies on removed classes and adjusted mocking for configuration sections. - Added Microsoft.EntityFrameworkCore.Sqlite package reference to test project. - Improved string handling in tests for better consistency and clarity. - Refactored logging methods in JellyfinApplicationFactory for better readability and maintainability.
12328 lines
653 KiB
XML
12328 lines
653 KiB
XML
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>MediaBrowser.Controller</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:MediaBrowser.Controller.Authentication.AuthenticationException">
|
||
<summary>
|
||
The exception that is thrown when an attempt to authenticate fails.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Authentication.AuthenticationException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Authentication.AuthenticationException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Authentication.AuthenticationException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Authentication.AuthenticationException"/> class.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Authentication.AuthenticationException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Authentication.AuthenticationException"/> class.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Authentication.AuthenticationResult">
|
||
<summary>
|
||
A class representing an authentication result.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Authentication.AuthenticationResult.User">
|
||
<summary>
|
||
Gets or sets the user.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Authentication.AuthenticationResult.SessionInfo">
|
||
<summary>
|
||
Gets or sets the session info.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Authentication.AuthenticationResult.AccessToken">
|
||
<summary>
|
||
Gets or sets the access token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Authentication.AuthenticationResult.ServerId">
|
||
<summary>
|
||
Gets or sets the server id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.BaseItemManager.BaseItemManager">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.BaseItemManager.BaseItemManager.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.BaseItemManager.BaseItemManager"/> class.
|
||
</summary>
|
||
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.BaseItemManager.BaseItemManager.IsMetadataFetcherEnabled(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.TypeOptions,System.String)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.BaseItemManager.BaseItemManager.IsImageFetcherEnabled(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.TypeOptions,System.String)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.BaseItemManager.IBaseItemManager">
|
||
<summary>
|
||
The <c>BaseItem</c> manager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.BaseItemManager.IBaseItemManager.IsMetadataFetcherEnabled(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.TypeOptions,System.String)">
|
||
<summary>
|
||
Is metadata fetcher enabled.
|
||
</summary>
|
||
<param name="baseItem">The base item.</param>
|
||
<param name="libraryTypeOptions">The type options for <c>baseItem</c> from the library (if defined).</param>
|
||
<param name="name">The metadata fetcher name.</param>
|
||
<returns><c>true</c> if metadata fetcher is enabled, else false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.BaseItemManager.IBaseItemManager.IsImageFetcherEnabled(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.TypeOptions,System.String)">
|
||
<summary>
|
||
Is image fetcher enabled.
|
||
</summary>
|
||
<param name="baseItem">The base item.</param>
|
||
<param name="libraryTypeOptions">The type options for <c>baseItem</c> from the library (if defined).</param>
|
||
<param name="name">The image fetcher name.</param>
|
||
<returns><c>true</c> if image fetcher is enabled, else false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.IsVisible(Jellyfin.Database.Implementations.Entities.User,System.Boolean)">
|
||
<summary>
|
||
Determines whether this channel is visible to the specified user.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="skipAllowedTagsCheck">Whether to skip the allowed tags check.</param>
|
||
<returns>True if visible; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.GetItemsInternal(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets items from the channel.
|
||
</summary>
|
||
<param name="query">The items query.</param>
|
||
<returns>The query result.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.GetInternalMetadataPath(System.String)">
|
||
<summary>
|
||
Gets the internal metadata path for this channel.
|
||
</summary>
|
||
<param name="basePath">The base path.</param>
|
||
<returns>The internal metadata path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.GetInternalMetadataPath(System.String,System.Guid)">
|
||
<summary>
|
||
Gets the internal metadata path for a channel with the specified ID.
|
||
</summary>
|
||
<param name="basePath">The base path.</param>
|
||
<param name="id">The channel ID.</param>
|
||
<returns>The internal metadata path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.CanDelete">
|
||
<summary>
|
||
Determines whether this channel can be deleted.
|
||
</summary>
|
||
<returns>True if deletable; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.Channel.IsChannelVisible(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Determines whether the channel item is visible to the specified user.
|
||
</summary>
|
||
<param name="channelItem">The channel item.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>True if visible; otherwise, false.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.IChannel.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.IChannel.Description">
|
||
<summary>
|
||
Gets the description.
|
||
</summary>
|
||
<value>The description.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.IChannel.DataVersion">
|
||
<summary>
|
||
Gets the data version.
|
||
</summary>
|
||
<value>The data version.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.IChannel.HomePageUrl">
|
||
<summary>
|
||
Gets the home page URL.
|
||
</summary>
|
||
<value>The home page URL.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.IChannel.ParentalRating">
|
||
<summary>
|
||
Gets the parental rating.
|
||
</summary>
|
||
<value>The parental rating.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannel.GetChannelFeatures">
|
||
<summary>
|
||
Gets the channel information.
|
||
</summary>
|
||
<returns>ChannelFeatures.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannel.IsEnabledFor(System.String)">
|
||
<summary>
|
||
Determines whether [is enabled for] [the specified user].
|
||
</summary>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns><c>true</c> if [is enabled for] [the specified user]; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannel.GetChannelItems(MediaBrowser.Controller.Channels.InternalChannelItemQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{ChannelItem}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannel.GetChannelImage(MediaBrowser.Model.Entities.ImageType,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel image.
|
||
</summary>
|
||
<param name="type">The type.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{DynamicImageResponse}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannel.GetSupportedChannelImages">
|
||
<summary>
|
||
Gets the supported channel images.
|
||
</summary>
|
||
<returns>IEnumerable{ImageType}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannelFeatures(System.Nullable{System.Guid})">
|
||
<summary>
|
||
Gets the channel features.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>ChannelFeatures.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetAllChannelFeatures">
|
||
<summary>
|
||
Gets all channel features.
|
||
</summary>
|
||
<returns>IEnumerable{ChannelFeatures}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannel(System.String)">
|
||
<summary>
|
||
Gets the channel.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>Channel.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannelsInternalAsync(MediaBrowser.Model.Channels.ChannelQuery)">
|
||
<summary>
|
||
Gets the channels internal.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>The channels.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannelsAsync(MediaBrowser.Model.Channels.ChannelQuery)">
|
||
<summary>
|
||
Gets the channels.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>The channels.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetLatestChannelItems(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest channel items.
|
||
</summary>
|
||
<param name="query">The item query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The latest channels.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetLatestChannelItemsInternal(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest channel items.
|
||
</summary>
|
||
<param name="query">The item query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The latest channels.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannelItems(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The channel items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetChannelItemsInternal(MediaBrowser.Controller.Entities.InternalItemsQuery,System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="progress">The progress to report to.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The channel items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IChannelManager.GetStaticMediaSources(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel item media sources.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The item media sources.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Channels.IDisableMediaSourceDisplay">
|
||
<summary>
|
||
Disable media source display.
|
||
</summary>
|
||
<remarks>
|
||
<see cref="T:MediaBrowser.Controller.Channels.Channel"/> can inherit this interface to disable being displayed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IHasCacheKey.GetCacheKey(System.String)">
|
||
<summary>
|
||
Gets the cache key.
|
||
</summary>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.MediaTypes">
|
||
<summary>
|
||
Gets or sets the media types.
|
||
</summary>
|
||
<value>The media types.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.ContentTypes">
|
||
<summary>
|
||
Gets or sets the content types.
|
||
</summary>
|
||
<value>The content types.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.MaxPageSize">
|
||
<summary>
|
||
Gets or sets the maximum number of records the channel allows retrieving at a time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.DefaultSortFields">
|
||
<summary>
|
||
Gets or sets the default sort orders.
|
||
</summary>
|
||
<value>The default sort orders.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.SupportsSortOrderToggle">
|
||
<summary>
|
||
Gets or sets a value indicating whether a sort ascending/descending toggle is supported or not.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.AutoRefreshLevels">
|
||
<summary>
|
||
Gets or sets the automatic refresh levels.
|
||
</summary>
|
||
<value>The automatic refresh levels.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.DailyDownloadLimit">
|
||
<summary>
|
||
Gets or sets the daily download limit.
|
||
</summary>
|
||
<value>The daily download limit.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Channels.InternalChannelFeatures.SupportsContentDownloading">
|
||
<summary>
|
||
Gets or sets a value indicating whether [supports downloading].
|
||
</summary>
|
||
<value><c>true</c> if [supports downloading]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Channels.IRequiresMediaInfoCallback">
|
||
<summary>
|
||
The channel requires a media info callback.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.IRequiresMediaInfoCallback.GetChannelItemMediaInfo(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel item media information.
|
||
</summary>
|
||
<param name="id">The channel item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The enumerable of media source info.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Channels.ISupportsLatestMedia.GetLatestMedia(MediaBrowser.Controller.Channels.ChannelLatestMediaSearch,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest media.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The latest media.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Channels.ISupportsMediaProbe">
|
||
<summary>
|
||
Channel supports media probe.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Chapters.IChapterManager">
|
||
<summary>
|
||
Interface IChapterManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.SaveChapters(MediaBrowser.Controller.Entities.Video,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.ChapterInfo})">
|
||
<summary>
|
||
Saves the chapters.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="chapters">The set of chapters.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.SaveChaptersAsync(MediaBrowser.Controller.Entities.Video,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.ChapterInfo},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the chapters asynchronously.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="chapters">The set of chapters.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.GetChapter(System.Guid,System.Int32)">
|
||
<summary>
|
||
Gets a single chapter of a BaseItem on a specific index.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<param name="index">The index of that chapter.</param>
|
||
<returns>A chapter instance.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.GetChapterAsync(System.Guid,System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets a single chapter of a BaseItem on a specific index asynchronously.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<param name="index">The index of that chapter.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A chapter instance.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.GetChapters(System.Guid)">
|
||
<summary>
|
||
Gets all chapters associated with the baseItem.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<returns>A readonly list of chapter instances.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.GetChaptersAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets all chapters associated with the baseItem asynchronously.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A readonly list of chapter instances.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.RefreshChapterImages(MediaBrowser.Controller.Entities.Video,MediaBrowser.Controller.Providers.IDirectoryService,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.ChapterInfo},System.Boolean,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes the chapter images.
|
||
</summary>
|
||
<param name="video">Video to use.</param>
|
||
<param name="directoryService">Directory service to use.</param>
|
||
<param name="chapters">Set of chapters to refresh.</param>
|
||
<param name="extractImages">Option to extract images.</param>
|
||
<param name="saveChapters">Option to save chapters.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns><c>true</c> if successful, <c>false</c> if not.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Chapters.IChapterManager.DeleteChapterDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes the chapter data.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.ClientEvent.ClientEventLogger">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ClientEvent.ClientEventLogger.#ctor(MediaBrowser.Controller.IServerApplicationPaths)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.ClientEvent.ClientEventLogger"/> class.
|
||
</summary>
|
||
<param name="applicationPaths">Instance of the <see cref="T:MediaBrowser.Controller.IServerApplicationPaths"/> interface.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ClientEvent.ClientEventLogger.WriteDocumentAsync(System.String,System.String,System.IO.Stream)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.ClientEvent.IClientEventLogger">
|
||
<summary>
|
||
The client event logger.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ClientEvent.IClientEventLogger.WriteDocumentAsync(System.String,System.String,System.IO.Stream)">
|
||
<summary>
|
||
Writes a file to the log directory.
|
||
</summary>
|
||
<param name="clientName">The client name writing the document.</param>
|
||
<param name="clientVersion">The client version writing the document.</param>
|
||
<param name="fileContents">The file contents to write.</param>
|
||
<returns>The created file name.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Collections.CollectionCreatedEventArgs.Collection">
|
||
<summary>
|
||
Gets or sets the collection.
|
||
</summary>
|
||
<value>The collection.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Collections.CollectionCreatedEventArgs.Options">
|
||
<summary>
|
||
Gets or sets the options.
|
||
</summary>
|
||
<value>The options.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Collections.CollectionModifiedEventArgs.Collection">
|
||
<summary>
|
||
Gets or sets the collection.
|
||
</summary>
|
||
<value>The collection.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Collections.CollectionModifiedEventArgs.ItemsChanged">
|
||
<summary>
|
||
Gets or sets the items changed.
|
||
</summary>
|
||
<value>The items changed.</value>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Collections.ICollectionManager.CollectionCreated">
|
||
<summary>
|
||
Occurs when [collection created].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Collections.ICollectionManager.ItemsAddedToCollection">
|
||
<summary>
|
||
Occurs when [items added to collection].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Collections.ICollectionManager.ItemsRemovedFromCollection">
|
||
<summary>
|
||
Occurs when [items removed from collection].
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Collections.ICollectionManager.CreateCollectionAsync(MediaBrowser.Controller.Collections.CollectionCreationOptions)">
|
||
<summary>
|
||
Creates the collection.
|
||
</summary>
|
||
<param name="options">The options.</param>
|
||
<returns>BoxSet wrapped in an awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Collections.ICollectionManager.AddToCollectionAsync(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||
<summary>
|
||
Adds to collection.
|
||
</summary>
|
||
<param name="collectionId">The collection identifier.</param>
|
||
<param name="itemIds">The item ids.</param>
|
||
<returns><see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Collections.ICollectionManager.RemoveFromCollectionAsync(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||
<summary>
|
||
Removes from collection.
|
||
</summary>
|
||
<param name="collectionId">The collection identifier.</param>
|
||
<param name="itemIds">The item ids.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Collections.ICollectionManager.CollapseItemsWithinBoxSets(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.BaseItem},Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Collapses the items within box sets.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Collections.ICollectionManager.GetCollectionsFolder(System.Boolean)">
|
||
<summary>
|
||
Gets the folder where collections are stored.
|
||
</summary>
|
||
<param name="createIfNeeded">Will create the collection folder on the storage if set to true.</param>
|
||
<returns>The folder instance referencing the collection storage.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager">
|
||
<summary>
|
||
Interface IServerConfigurationManager.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Configuration.IServerConfigurationManager.ApplicationPaths">
|
||
<summary>
|
||
Gets the application paths.
|
||
</summary>
|
||
<value>The application paths.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Configuration.IServerConfigurationManager.Configuration">
|
||
<summary>
|
||
Gets the configuration.
|
||
</summary>
|
||
<value>The configuration.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Devices.IDeviceManager">
|
||
<summary>
|
||
Device manager interface.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Devices.IDeviceManager.DeviceOptionsUpdated">
|
||
<summary>
|
||
Event handler for updated device options.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.CreateDevice(Jellyfin.Database.Implementations.Entities.Security.Device)">
|
||
<summary>
|
||
Creates a new device.
|
||
</summary>
|
||
<param name="device">The device to create.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the creation of the device.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.SaveCapabilities(System.String,MediaBrowser.Model.Session.ClientCapabilities)">
|
||
<summary>
|
||
Saves the capabilities.
|
||
</summary>
|
||
<param name="deviceId">The device id.</param>
|
||
<param name="capabilities">The capabilities.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetCapabilities(System.String)">
|
||
<summary>
|
||
Gets the capabilities.
|
||
</summary>
|
||
<param name="deviceId">The device id.</param>
|
||
<returns>ClientCapabilities.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetDevice(System.String)">
|
||
<summary>
|
||
Gets the device information.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>DeviceInfoDto.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetDevices(Jellyfin.Data.Queries.DeviceQuery)">
|
||
<summary>
|
||
Gets devices based on the provided query.
|
||
</summary>
|
||
<param name="query">The device query.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the retrieval of the devices.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetDeviceInfos(Jellyfin.Data.Queries.DeviceQuery)">
|
||
<summary>
|
||
Gets device information based on the provided query.
|
||
</summary>
|
||
<param name="query">The device query.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the retrieval of the device information.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetDevicesForUser(System.Nullable{System.Guid})">
|
||
<summary>
|
||
Gets the device information.
|
||
</summary>
|
||
<param name="userId">The user's id, or <c>null</c>.</param>
|
||
<returns>IEnumerable<DeviceInfoDto>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.DeleteDevice(Jellyfin.Database.Implementations.Entities.Security.Device)">
|
||
<summary>
|
||
Deletes a device.
|
||
</summary>
|
||
<param name="device">The device.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the deletion of the device.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.UpdateDevice(Jellyfin.Database.Implementations.Entities.Security.Device)">
|
||
<summary>
|
||
Updates a device.
|
||
</summary>
|
||
<param name="device">The device.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the update of the device.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.CanAccessDevice(Jellyfin.Database.Implementations.Entities.User,System.String)">
|
||
<summary>
|
||
Determines whether this instance [can access device] the specified user identifier.
|
||
</summary>
|
||
<param name="user">The user to test.</param>
|
||
<param name="deviceId">The device id to test.</param>
|
||
<returns>Whether the user can access the device.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.UpdateDeviceOptions(System.String,System.String)">
|
||
<summary>
|
||
Updates the options of a device.
|
||
</summary>
|
||
<param name="deviceId">The device id.</param>
|
||
<param name="deviceName">The device name.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the update of the device options.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.GetDeviceOptions(System.String)">
|
||
<summary>
|
||
Gets the options of a device.
|
||
</summary>
|
||
<param name="deviceId">The device id.</param>
|
||
<returns><see cref="T:Jellyfin.Database.Implementations.Entities.Security.DeviceOptions"/> of the device.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Devices.IDeviceManager.ToClientCapabilitiesDto(MediaBrowser.Model.Session.ClientCapabilities)">
|
||
<summary>
|
||
Gets the dto for client capabilities.
|
||
</summary>
|
||
<param name="capabilities">The client capabilities.</param>
|
||
<returns><see cref="T:MediaBrowser.Model.Dto.ClientCapabilitiesDto"/> of the device.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageEncoder.SupportedInputFormats">
|
||
<summary>
|
||
Gets the supported input formats.
|
||
</summary>
|
||
<value>The supported input formats.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageEncoder.SupportedOutputFormats">
|
||
<summary>
|
||
Gets the supported output formats.
|
||
</summary>
|
||
<value>The supported output formats.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageEncoder.Name">
|
||
<summary>
|
||
Gets the display name for the encoder.
|
||
</summary>
|
||
<value>The display name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageEncoder.SupportsImageCollageCreation">
|
||
<summary>
|
||
Gets a value indicating whether [supports image collage creation].
|
||
</summary>
|
||
<value><c>true</c> if [supports image collage creation]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageEncoder.SupportsImageEncoding">
|
||
<summary>
|
||
Gets a value indicating whether [supports image encoding].
|
||
</summary>
|
||
<value><c>true</c> if [supports image encoding]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.GetImageSize(System.String)">
|
||
<summary>
|
||
Get the dimensions of an image from the filesystem.
|
||
</summary>
|
||
<param name="path">The filepath of the image.</param>
|
||
<returns>The image dimensions.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.GetImageBlurHash(System.Int32,System.Int32,System.String)">
|
||
<summary>
|
||
Gets the blurhash of an image.
|
||
</summary>
|
||
<param name="xComp">Amount of X components of DCT to take.</param>
|
||
<param name="yComp">Amount of Y components of DCT to take.</param>
|
||
<param name="path">The filepath of the image.</param>
|
||
<returns>The blurhash.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.EncodeImage(System.String,System.DateTime,System.String,System.Boolean,System.Nullable{MediaBrowser.Model.Drawing.ImageOrientation},System.Int32,MediaBrowser.Controller.Drawing.ImageProcessingOptions,MediaBrowser.Model.Drawing.ImageFormat)">
|
||
<summary>
|
||
Encode an image.
|
||
</summary>
|
||
<param name="inputPath">Input path of image.</param>
|
||
<param name="dateModified">Date modified.</param>
|
||
<param name="outputPath">Output path of image.</param>
|
||
<param name="autoOrient">Auto-orient image.</param>
|
||
<param name="orientation">Desired orientation of image.</param>
|
||
<param name="quality">Quality of encoded image.</param>
|
||
<param name="options">Image processing options.</param>
|
||
<param name="outputFormat">Image format of output.</param>
|
||
<returns>Path of encoded image.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.CreateImageCollage(MediaBrowser.Controller.Drawing.ImageCollageOptions,System.String)">
|
||
<summary>
|
||
Create an image collage.
|
||
</summary>
|
||
<param name="options">The options to use when creating the collage.</param>
|
||
<param name="libraryName">Optional. </param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.CreateSplashscreen(System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyList{System.String})">
|
||
<summary>
|
||
Creates a new splashscreen image.
|
||
</summary>
|
||
<param name="posters">The list of poster paths.</param>
|
||
<param name="backdrops">The list of backdrop paths.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageEncoder.CreateTrickplayTile(MediaBrowser.Controller.Drawing.ImageCollageOptions,System.Int32,System.Int32,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Creates a new trickplay tile image.
|
||
</summary>
|
||
<param name="options">The options to use when creating the image. Width and Height are a quantity of thumbnails in this case, not pixels.</param>
|
||
<param name="quality">The image encode quality.</param>
|
||
<param name="imgWidth">The width of a single trickplay thumbnail.</param>
|
||
<param name="imgHeight">Optional height of a single trickplay thumbnail, if it is known.</param>
|
||
<returns>Height of single decoded trickplay thumbnail.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Drawing.IImageProcessor">
|
||
<summary>
|
||
Interface IImageProcessor.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageProcessor.SupportedInputFormats">
|
||
<summary>
|
||
Gets the supported input formats.
|
||
</summary>
|
||
<value>The supported input formats.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.IImageProcessor.SupportsImageCollageCreation">
|
||
<summary>
|
||
Gets a value indicating whether [supports image collage creation].
|
||
</summary>
|
||
<value><c>true</c> if [supports image collage creation]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageDimensions(System.String)">
|
||
<summary>
|
||
Gets the dimensions of the image.
|
||
</summary>
|
||
<param name="path">Path to the image file.</param>
|
||
<returns>ImageDimensions.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageDimensions(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.ItemImageInfo)">
|
||
<summary>
|
||
Gets the dimensions of the image.
|
||
</summary>
|
||
<param name="item">The base item.</param>
|
||
<param name="info">The information.</param>
|
||
<returns>ImageDimensions.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageBlurHash(System.String)">
|
||
<summary>
|
||
Gets the blurhash of the image.
|
||
</summary>
|
||
<param name="path">Path to the image file.</param>
|
||
<returns>BlurHash.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageBlurHash(System.String,MediaBrowser.Model.Drawing.ImageDimensions)">
|
||
<summary>
|
||
Gets the blurhash of the image.
|
||
</summary>
|
||
<param name="path">Path to the image file.</param>
|
||
<param name="imageDimensions">The image dimensions.</param>
|
||
<returns>BlurHash.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageCacheTag(System.String,System.DateTime)">
|
||
<summary>
|
||
Gets the image cache tag.
|
||
</summary>
|
||
<param name="baseItemPath">The items basePath.</param>
|
||
<param name="imageDateModified">The image last modification date.</param>
|
||
<returns>Guid.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageCacheTag(MediaBrowser.Model.Dto.BaseItemDto,MediaBrowser.Model.Entities.ChapterInfo)">
|
||
<summary>
|
||
Gets the image cache tag.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="image">The image.</param>
|
||
<returns>Guid.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageCacheTag(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.ItemImageInfo)">
|
||
<summary>
|
||
Gets the image cache tag.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="image">The image.</param>
|
||
<returns>Guid.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetImageCacheTag(MediaBrowser.Model.Dto.BaseItemDto,MediaBrowser.Controller.Entities.ItemImageInfo)">
|
||
<summary>
|
||
Gets the image cache tag.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="image">The image.</param>
|
||
<returns>Guid.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.ProcessImage(MediaBrowser.Controller.Drawing.ImageProcessingOptions)">
|
||
<summary>
|
||
Processes the image.
|
||
</summary>
|
||
<param name="options">The options.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.GetSupportedImageOutputFormats">
|
||
<summary>
|
||
Gets the supported image output formats.
|
||
</summary>
|
||
<returns><see cref="T:System.Collections.Generic.IReadOnlyCollection`1" />.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Drawing.IImageProcessor.CreateImageCollage(MediaBrowser.Controller.Drawing.ImageCollageOptions,System.String)">
|
||
<summary>
|
||
Creates the image collage.
|
||
</summary>
|
||
<param name="options">The options.</param>
|
||
<param name="libraryName">The library name to draw onto the collage.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.ImageCollageOptions.InputPaths">
|
||
<summary>
|
||
Gets or sets the input paths.
|
||
</summary>
|
||
<value>The input paths.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.ImageCollageOptions.OutputPath">
|
||
<summary>
|
||
Gets or sets the output path.
|
||
</summary>
|
||
<value>The output path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.ImageCollageOptions.Width">
|
||
<summary>
|
||
Gets or sets the width.
|
||
</summary>
|
||
<value>The width.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Drawing.ImageCollageOptions.Height">
|
||
<summary>
|
||
Gets or sets the height.
|
||
</summary>
|
||
<value>The height.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Dto.IDtoService">
|
||
<summary>
|
||
Interface IDtoService.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Dto.IDtoService.GetPrimaryImageAspectRatio(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the primary image aspect ratio.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.Nullable<System.Double>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Dto.IDtoService.GetBaseItemDto(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the base item dto.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="user">The user.</param>
|
||
<param name="owner">The owner.</param>
|
||
<returns>BaseItemDto.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Dto.IDtoService.GetBaseItemDtos(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the base item dtos.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="user">The user.</param>
|
||
<param name="owner">The owner.</param>
|
||
<returns>The <see cref="T:System.Collections.Generic.IReadOnlyList`1"/> of <see cref="T:MediaBrowser.Model.Dto.BaseItemDto"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Dto.IDtoService.GetItemByNameDto(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Dto.DtoOptions,System.Collections.Generic.List{MediaBrowser.Controller.Entities.BaseItem},Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the item by name dto.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="options">The dto options.</param>
|
||
<param name="taggedItems">The list of tagged items.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>The item dto.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.AggregateFolder">
|
||
<summary>
|
||
Specialized folder that can have items added to it's children by external entities.
|
||
Used for our RootFolder so plugins can add items.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.AggregateFolder._virtualChildren">
|
||
<summary>
|
||
The _virtual children.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.AggregateFolder.VirtualChildren">
|
||
<summary>
|
||
Gets the virtual children.
|
||
</summary>
|
||
<value>The virtual children.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AggregateFolder.AddVirtualChild(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Adds the virtual child.
|
||
</summary>
|
||
<param name="child">The child.</param>
|
||
<exception cref="T:System.ArgumentNullException">Throws if child is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AggregateFolder.FindVirtualChild(System.Guid)">
|
||
<summary>
|
||
Finds the virtual child.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<returns>BaseItem.</returns>
|
||
<exception cref="T:System.ArgumentNullException">The id is empty.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.FindSeriesSortName">
|
||
<summary>
|
||
Finds the series sort name.
|
||
</summary>
|
||
<returns>The series sort name.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.FindSeriesName">
|
||
<summary>
|
||
Finds the series name.
|
||
</summary>
|
||
<returns>The series name.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.FindSeriesPresentationUniqueKey">
|
||
<summary>
|
||
Finds the series presentation unique key.
|
||
</summary>
|
||
<returns>The series presentation unique key.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.GetDefaultPrimaryImageAspectRatio">
|
||
<summary>
|
||
Gets the default primary image aspect ratio.
|
||
</summary>
|
||
<returns>The default primary image aspect ratio.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.FindSeriesId">
|
||
<summary>
|
||
Finds the series identifier.
|
||
</summary>
|
||
<returns>The series identifier.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.CanDownload">
|
||
<summary>
|
||
Determines whether this audiobook can be downloaded.
|
||
</summary>
|
||
<returns>True if downloadable; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.AudioBook.GetBlockUnratedType">
|
||
<summary>
|
||
Gets the unrated type for blocking purposes.
|
||
</summary>
|
||
<returns>The unrated item type.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Audio.Audio">
|
||
<summary>
|
||
Class Audio.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.Audio.Artists">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.Audio.AlbumArtists">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.Audio.MediaType">
|
||
<summary>
|
||
Gets the type of the media.
|
||
</summary>
|
||
<value>The type of the media.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.Audio.HasLyrics">
|
||
<summary>
|
||
Gets or sets a value indicating whether this audio has lyrics.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.Audio.LyricFiles">
|
||
<summary>
|
||
Gets or sets the list of lyric paths.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Audio.Audio.CreateSortName">
|
||
<summary>
|
||
Creates the name of the sort.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.IHasArtist.Artists">
|
||
<summary>
|
||
Gets or sets the artists.
|
||
</summary>
|
||
<value>The artists.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Audio.MusicAlbum">
|
||
<summary>
|
||
Class MusicAlbum.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.MusicAlbum.AlbumArtists">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.MusicAlbum.Artists">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.MusicAlbum.Tracks">
|
||
<summary>
|
||
Gets the tracks.
|
||
</summary>
|
||
<value>The tracks.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Audio.MusicArtist">
|
||
<summary>
|
||
Class MusicArtist.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.MusicArtist.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Audio.MusicArtist.GetUserDataKeys(MediaBrowser.Controller.Entities.Audio.MusicArtist)">
|
||
<summary>
|
||
Gets the user data key.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Audio.MusicArtist.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata">Option to replace metadata.</param>
|
||
<returns>True if metadata changed.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Audio.MusicGenre">
|
||
<summary>
|
||
Class MusicGenre.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Audio.MusicGenre.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Audio.MusicGenre.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata">Option to replace metadata.</param>
|
||
<returns>True if metadata changed.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.BaseItem">
|
||
<summary>
|
||
Class BaseItem.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.BaseItem.SupportedImageExtensions">
|
||
<summary>
|
||
The supported image extensions.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.BaseItem.DisplayExtraTypes">
|
||
<summary>
|
||
Extra types that should be counted and displayed as "Special Features" in the UI.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.UserData">
|
||
<summary>
|
||
Gets or Sets the user data collection as cached from the last Db query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Album">
|
||
<summary>
|
||
Gets or sets the album.
|
||
</summary>
|
||
<value>The album.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.LUFS">
|
||
<summary>
|
||
Gets or sets the LUFS value.
|
||
</summary>
|
||
<value>The LUFS Value.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.NormalizationGain">
|
||
<summary>
|
||
Gets or sets the gain required for audio normalization.
|
||
</summary>
|
||
<value>The gain required for audio normalization.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ChannelId">
|
||
<summary>
|
||
Gets or sets the channel identifier.
|
||
</summary>
|
||
<value>The channel identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.IsInMixedFolder">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is in mixed folder.
|
||
</summary>
|
||
<value><c>true</c> if this instance is in mixed folder; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Name">
|
||
<summary>
|
||
Gets or sets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Id">
|
||
<summary>
|
||
Gets or sets the id.
|
||
</summary>
|
||
<value>The id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Audio">
|
||
<summary>
|
||
Gets or sets the audio.
|
||
</summary>
|
||
<value>The audio.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.DisplayPreferencesId">
|
||
<summary>
|
||
Gets the id that should be used to key display prefs for this item.
|
||
Default is based on the type for everything except actual generic folders.
|
||
</summary>
|
||
<value>The display prefs id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Path">
|
||
<summary>
|
||
Gets or sets the path.
|
||
</summary>
|
||
<value>The path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ServiceName">
|
||
<summary>
|
||
Gets or sets the name of the service.
|
||
</summary>
|
||
<value>The name of the service.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ExternalId">
|
||
<summary>
|
||
Gets or sets the external id.
|
||
</summary>
|
||
<remarks>
|
||
If this content came from an external service, the id of the content on that service.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.LocationType">
|
||
<summary>
|
||
Gets the type of the location.
|
||
</summary>
|
||
<value>The type of the location.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.PrimaryImagePath">
|
||
<summary>
|
||
Gets the primary image path.
|
||
</summary>
|
||
<remarks>
|
||
This is just a helper for convenience.
|
||
</remarks>
|
||
<value>The primary image path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.DateCreated">
|
||
<summary>
|
||
Gets or sets the date created.
|
||
</summary>
|
||
<value>The date created.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.DateModified">
|
||
<summary>
|
||
Gets or sets the date modified.
|
||
</summary>
|
||
<value>The date modified.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.LockedFields">
|
||
<summary>
|
||
Gets or sets the locked fields.
|
||
</summary>
|
||
<value>The locked fields.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.MediaType">
|
||
<summary>
|
||
Gets the type of the media.
|
||
</summary>
|
||
<value>The type of the media.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Logger">
|
||
<summary>
|
||
Gets or sets the logger.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ForcedSortName">
|
||
<summary>
|
||
Gets or sets the name of the forced sort.
|
||
</summary>
|
||
<value>The name of the forced sort.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.SortName">
|
||
<summary>
|
||
Gets or sets the name of the sort.
|
||
</summary>
|
||
<value>The name of the sort.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.PremiereDate">
|
||
<summary>
|
||
Gets or sets the date that the item first debuted. For movies this could be premiere date, episodes would be first aired.
|
||
</summary>
|
||
<value>The premiere date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.EndDate">
|
||
<summary>
|
||
Gets or sets the end date.
|
||
</summary>
|
||
<value>The end date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.OfficialRating">
|
||
<summary>
|
||
Gets or sets the official rating.
|
||
</summary>
|
||
<value>The official rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.CriticRating">
|
||
<summary>
|
||
Gets or sets the critic rating.
|
||
</summary>
|
||
<value>The critic rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.CustomRating">
|
||
<summary>
|
||
Gets or sets the custom rating.
|
||
</summary>
|
||
<value>The custom rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Overview">
|
||
<summary>
|
||
Gets or sets the overview.
|
||
</summary>
|
||
<value>The overview.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Studios">
|
||
<summary>
|
||
Gets or sets the studios.
|
||
</summary>
|
||
<value>The studios.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Genres">
|
||
<summary>
|
||
Gets or sets the genres.
|
||
</summary>
|
||
<value>The genres.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.Tags">
|
||
<summary>
|
||
Gets or sets the tags.
|
||
</summary>
|
||
<value>The tags.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.HomePageUrl">
|
||
<summary>
|
||
Gets or sets the home page URL.
|
||
</summary>
|
||
<value>The home page URL.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.CommunityRating">
|
||
<summary>
|
||
Gets or sets the community rating.
|
||
</summary>
|
||
<value>The community rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.RunTimeTicks">
|
||
<summary>
|
||
Gets or sets the run time ticks.
|
||
</summary>
|
||
<value>The run time ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ProductionYear">
|
||
<summary>
|
||
Gets or sets the production year.
|
||
</summary>
|
||
<value>The production year.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.IndexNumber">
|
||
<summary>
|
||
Gets or sets the index number. If the item is part of a series, this is it's number in the series.
|
||
This could be episode number, album track number, etc.
|
||
</summary>
|
||
<value>The index number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ParentIndexNumber">
|
||
<summary>
|
||
Gets or sets the parent index number. For an episode this could be the season number, or for a song this could be the disc number.
|
||
</summary>
|
||
<value>The parent index number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.ProviderIds">
|
||
<summary>
|
||
Gets or sets the provider ids.
|
||
</summary>
|
||
<value>The provider ids.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.IsFolder">
|
||
<summary>
|
||
Gets a value indicating whether this instance is folder.
|
||
</summary>
|
||
<value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.BaseItem.RemoteTrailers">
|
||
<summary>
|
||
Gets or sets the remote trailers.
|
||
</summary>
|
||
<value>The remote trailers.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.ToString">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.CreateSortName">
|
||
<summary>
|
||
Creates the name of the sort.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.FindParent``1">
|
||
<summary>
|
||
Finds a parent of a given type.
|
||
</summary>
|
||
<typeparam name="T">Type of parent.</typeparam>
|
||
<returns>``0.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetPlayAccess(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the play access.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<returns>PlayAccess.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.RefreshMetadata(MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
The base implementation to refresh metadata.
|
||
</summary>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>true if a provider reports we changed.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.RefreshedOwnedItems(MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.IO.FileSystemMetadata},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes owned items such as trailers, theme videos, special features, etc.
|
||
Returns true or false indicating if changes were found.
|
||
</summary>
|
||
<param name="options">The metadata refresh options.</param>
|
||
<param name="fileSystemChildren">The list of filesystem children.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns><c>true</c> if any items have changed, else <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetPreferredMetadataLanguage">
|
||
<summary>
|
||
Gets the preferred metadata language.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetPreferredMetadataCountryCode">
|
||
<summary>
|
||
Gets the preferred metadata language.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.IsParentalAllowed(Jellyfin.Database.Implementations.Entities.User,System.Boolean)">
|
||
<summary>
|
||
Determines if a given user has access to this item.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="skipAllowedTagsCheck">Don't check for allowed tags.</param>
|
||
<returns><c>true</c> if [is parental allowed] [the specified user]; otherwise, <c>false</c>.</returns>
|
||
<exception cref="T:System.ArgumentNullException">If user is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetBlockUnratedValue(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets a bool indicating if access to the unrated item is blocked or not.
|
||
</summary>
|
||
<param name="user">The configuration.</param>
|
||
<returns><c>true</c> if blocked, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.IsVisible(Jellyfin.Database.Implementations.Entities.User,System.Boolean)">
|
||
<summary>
|
||
Determines if this folder should be visible to a given user.
|
||
Default is just parental allowed. Can be overridden for more functionality.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="skipAllowedTagsCheck">Don't check for allowed tags.</param>
|
||
<returns><c>true</c> if the specified user is visible; otherwise, <c>false</c>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="user" /> is <c>null</c>.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetLinkedChild(MediaBrowser.Controller.Entities.LinkedChild)">
|
||
<summary>
|
||
Gets the linked child.
|
||
</summary>
|
||
<param name="info">The info.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.AddStudio(System.String)">
|
||
<summary>
|
||
Adds a studio to the item.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<exception cref="T:System.ArgumentNullException">Throws if name is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.AddGenre(System.String)">
|
||
<summary>
|
||
Adds a genre to the item.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<exception cref="T:System.ArgumentNullException">Throws if name is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.MarkPlayed(Jellyfin.Database.Implementations.Entities.User,System.Nullable{System.DateTime},System.Boolean)">
|
||
<summary>
|
||
Marks the played.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="datePlayed">The date played.</param>
|
||
<param name="resetPosition">if set to <c>true</c> [reset position].</param>
|
||
<exception cref="T:System.ArgumentNullException">Throws if user is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.MarkUnplayed(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Marks the unplayed.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<exception cref="T:System.ArgumentNullException">Throws if user is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.ChangedExternally">
|
||
<summary>
|
||
Do whatever refreshing is necessary when the filesystem pertaining to this item has changed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.HasImage(MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
||
<summary>
|
||
Gets an image.
|
||
</summary>
|
||
<param name="type">The type.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<returns><c>true</c> if the specified type has image; otherwise, <c>false</c>.</returns>
|
||
<exception cref="T:System.ArgumentException">Backdrops should be accessed using Item.Backdrops.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.DeleteImageAsync(MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
||
<summary>
|
||
Deletes the image.
|
||
</summary>
|
||
<param name="type">The type.</param>
|
||
<param name="index">The index.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.ValidateImages">
|
||
<summary>
|
||
Validates that images within the item are still on the filesystem.
|
||
</summary>
|
||
<returns><c>true</c> if the images validate, <c>false</c> if not.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetImagePath(MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
||
<summary>
|
||
Gets the image path.
|
||
</summary>
|
||
<param name="imageType">Type of the image.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<returns>System.String.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Item is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetImageInfo(MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
||
<summary>
|
||
Gets the image information.
|
||
</summary>
|
||
<param name="imageType">Type of the image.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<returns>ItemImageInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetImageIndex(MediaBrowser.Controller.Entities.ItemImageInfo)">
|
||
<summary>
|
||
Computes image index for given image or raises if no matching image found.
|
||
</summary>
|
||
<param name="image">Image to compute index for.</param>
|
||
<exception cref="T:System.ArgumentException">Image index cannot be computed as no matching image found.
|
||
</exception>
|
||
<returns>Image index.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.AddImages(MediaBrowser.Model.Entities.ImageType,System.Collections.Generic.List{MediaBrowser.Model.IO.FileSystemMetadata})">
|
||
<summary>
|
||
Adds the images, updating metadata if they already are part of this item.
|
||
</summary>
|
||
<param name="imageType">Type of the image.</param>
|
||
<param name="images">The images.</param>
|
||
<returns><c>true</c> if images were added or updated, <c>false</c> otherwise.</returns>
|
||
<exception cref="T:System.ArgumentException">Cannot call AddImages with chapter images.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetDeletePaths">
|
||
<summary>
|
||
Gets the file system path to delete when the item is to be deleted.
|
||
</summary>
|
||
<returns>The metadata for the deleted paths.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata">Whether to replace all metadata.</param>
|
||
<returns>true if the item has change, else false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.UpdateRatingToItems(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem})">
|
||
<summary>
|
||
Updates the official rating based on content and returns true or false indicating if it changed.
|
||
</summary>
|
||
<param name="children">Media children.</param>
|
||
<returns><c>true</c> if the rating was updated; otherwise <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetExtras">
|
||
<summary>
|
||
Get all extras associated with this item, sorted by <see cref="P:MediaBrowser.Controller.Entities.BaseItem.SortName"/>.
|
||
</summary>
|
||
<returns>An enumerable containing the items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetExtras(System.Collections.Generic.IReadOnlyCollection{MediaBrowser.Model.Entities.ExtraType})">
|
||
<summary>
|
||
Get all extras with specific types that are associated with this item.
|
||
</summary>
|
||
<param name="extraTypes">The types of extras to retrieve.</param>
|
||
<returns>An enumerable containing the extras.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.Equals(System.Object)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.Equals(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItem.GetHashCode">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.GetImagePath(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Entities.ImageType)">
|
||
<summary>
|
||
Gets the image path.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="imageType">Type of the image.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.SetImagePath(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Entities.ImageType,MediaBrowser.Model.IO.FileSystemMetadata)">
|
||
<summary>
|
||
Sets the image path.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="imageType">Type of the image.</param>
|
||
<param name="file">The file.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.SetImagePath(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Entities.ImageType,System.String)">
|
||
<summary>
|
||
Sets the image path.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="imageType">Type of the image.</param>
|
||
<param name="file">The file.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.DeepCopy``2(``0,``1)">
|
||
<summary>
|
||
Copies all properties on object. Skips properties that do not exist.
|
||
</summary>
|
||
<param name="source">The source object.</param>
|
||
<param name="dest">The destination object.</param>
|
||
<typeparam name="T">Source type.</typeparam>
|
||
<typeparam name="TU">Destination type.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.DeepCopy``2(``0)">
|
||
<summary>
|
||
Copies all properties on newly created object. Skips properties that do not exist.
|
||
</summary>
|
||
<param name="source">The source object.</param>
|
||
<typeparam name="T">Source type.</typeparam>
|
||
<typeparam name="TU">Destination type.</typeparam>
|
||
<returns>Destination object.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.BaseItemExtensions.HasChanged``1(``0,System.DateTime)">
|
||
<summary>
|
||
Determines if the item has changed.
|
||
</summary>
|
||
<param name="source">The source object.</param>
|
||
<param name="asOf">The timestamp to detect changes as of.</param>
|
||
<typeparam name="T">Source type.</typeparam>
|
||
<returns>Whether the item has changed.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.BasePluginFolder">
|
||
<summary>
|
||
Plugins derive from and export this class to create a folder that will appear in the root along
|
||
with all the other actual physical folders in the system.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Book.CanDownload">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Book.GetBlockUnratedType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.CollectionFolder">
|
||
<summary>
|
||
Specialized Folder class that points to a subset of the physical folders in the system.
|
||
It is created from the user-specific folders within the system root.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.CollectionFolder.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Entities.CollectionFolder"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.CollectionFolder.DisplayPreferencesId">
|
||
<summary>
|
||
Gets the display preferences id.
|
||
</summary>
|
||
<remarks>
|
||
Allow different display preferences for each collection folder.
|
||
</remarks>
|
||
<value>The display prefs id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.CollectionFolder.Children">
|
||
<summary>
|
||
Gets the item's children.
|
||
</summary>
|
||
<remarks>
|
||
Our children are actually just references to the ones in the physical root...
|
||
</remarks>
|
||
<value>The actual children.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.CollectionFolder.ValidateChildrenInternal(System.IProgress{System.Double},System.Boolean,System.Boolean,System.Boolean,MediaBrowser.Controller.Providers.MetadataRefreshOptions,MediaBrowser.Controller.Providers.IDirectoryService,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Compare our current children (presumably just read from the repo) with the current state of the file system and adjust for any changes
|
||
***Currently does not contain logic to maintain items that are unavailable in the file system***.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="recursive">if set to <c>true</c> [recursive].</param>
|
||
<param name="refreshChildMetadata">if set to <c>true</c> [refresh child metadata].</param>
|
||
<param name="allowRemoveRoot">remove item even this folder is root.</param>
|
||
<param name="refreshOptions">The refresh options.</param>
|
||
<param name="directoryService">The directory service.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Extensions">
|
||
<summary>
|
||
Class Extensions.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Extensions.AddTrailerUrl(MediaBrowser.Controller.Entities.BaseItem,System.String)">
|
||
<summary>
|
||
Adds the trailer URL.
|
||
</summary>
|
||
<param name="item">Media item.</param>
|
||
<param name="url">Trailer URL.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Folder">
|
||
<summary>
|
||
Class Folder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Folder.IsRoot">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is root.
|
||
</summary>
|
||
<value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Folder.IsFolder">
|
||
<summary>
|
||
Gets a value indicating whether this instance is folder.
|
||
</summary>
|
||
<value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Folder.Children">
|
||
<summary>
|
||
Gets or Sets the actual children.
|
||
</summary>
|
||
<value>The actual children.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Folder.RecursiveChildren">
|
||
<summary>
|
||
Gets thread-safe access to all recursive children of this folder - without regard to user.
|
||
</summary>
|
||
<value>The recursive children.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.AddChild(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Adds the child.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<exception cref="T:System.InvalidOperationException">Unable to add + item.Name.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.LoadChildren">
|
||
<summary>
|
||
Loads our children. Validation will occur externally.
|
||
We want this synchronous.
|
||
</summary>
|
||
<returns>Returns children.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.ValidateChildren(System.IProgress{System.Double},MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Validates that the children of the folder still exist.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="metadataRefreshOptions">The metadata refresh options.</param>
|
||
<param name="recursive">if set to <c>true</c> [recursive].</param>
|
||
<param name="allowRemoveRoot">remove item even this folder is root.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.ValidateChildrenInternal(System.IProgress{System.Double},System.Boolean,System.Boolean,System.Boolean,MediaBrowser.Controller.Providers.MetadataRefreshOptions,MediaBrowser.Controller.Providers.IDirectoryService,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Validates the children internal.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="recursive">if set to <c>true</c> [recursive].</param>
|
||
<param name="refreshChildMetadata">if set to <c>true</c> [refresh child metadata].</param>
|
||
<param name="allowRemoveRoot">remove item even this folder is root.</param>
|
||
<param name="refreshOptions">The refresh options.</param>
|
||
<param name="directoryService">The directory service.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.ValidateSubFolders(System.Collections.Generic.IList{MediaBrowser.Controller.Entities.Folder},MediaBrowser.Controller.Providers.IDirectoryService,System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes the children.
|
||
</summary>
|
||
<param name="children">The children.</param>
|
||
<param name="directoryService">The directory service.</param>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.RunTasks``1(System.Func{``0,System.IProgress{System.Double},System.Threading.Tasks.Task},System.Collections.Generic.IList{``0},System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Runs an action block on a list of children.
|
||
</summary>
|
||
<param name="task">The task to run for each child.</param>
|
||
<param name="children">The list of children.</param>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.GetNonCachedChildren(MediaBrowser.Controller.Providers.IDirectoryService)">
|
||
<summary>
|
||
Get the children of this folder from the actual file system.
|
||
</summary>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
<param name="directoryService">The directory service to use for operation.</param>
|
||
<returns>Returns set of base items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.GetCachedChildren">
|
||
<summary>
|
||
Get our children from the repo - stubbed for now.
|
||
</summary>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.AddChildren(Jellyfin.Database.Implementations.Entities.User,System.Boolean,System.Collections.Generic.Dictionary{System.Guid,MediaBrowser.Controller.Entities.BaseItem},System.Boolean,MediaBrowser.Controller.Entities.InternalItemsQuery,System.Collections.Generic.HashSet{MediaBrowser.Controller.Entities.Folder})">
|
||
<summary>
|
||
Adds the children to list.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.GetRecursiveChildren">
|
||
<summary>
|
||
Gets the recursive children.
|
||
</summary>
|
||
<returns>IList{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.AddChildrenToList(System.Collections.Generic.Dictionary{System.Guid,MediaBrowser.Controller.Entities.BaseItem},System.Boolean,System.Boolean,System.Func{MediaBrowser.Controller.Entities.BaseItem,System.Boolean})">
|
||
<summary>
|
||
Adds the children to list.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.GetLinkedChildren">
|
||
<summary>
|
||
Gets the linked children.
|
||
</summary>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.GetLinkedChildrenInfos">
|
||
<summary>
|
||
Gets the linked children.
|
||
</summary>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.RefreshLinkedChildren(System.Collections.Generic.IEnumerable{MediaBrowser.Model.IO.FileSystemMetadata})">
|
||
<summary>
|
||
Refreshes the linked children.
|
||
</summary>
|
||
<param name="fileSystemChildren">The enumerable of file system metadata.</param>
|
||
<returns><c>true</c> if the linked children were updated, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.MarkPlayed(Jellyfin.Database.Implementations.Entities.User,System.Nullable{System.DateTime},System.Boolean)">
|
||
<summary>
|
||
Marks the played.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="datePlayed">The date played.</param>
|
||
<param name="resetPosition">if set to <c>true</c> [reset position].</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.MarkUnplayed(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Marks the unplayed.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Folder.ProgressHelpers">
|
||
<summary>
|
||
Contains constants used when reporting scan progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.Folder.ProgressHelpers.RetrievedChildren">
|
||
<summary>
|
||
Reported after the folders immediate children are retrieved.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.Folder.ProgressHelpers.UpdatedChildItems">
|
||
<summary>
|
||
Reported after add, updating, or deleting child items from the LibraryManager.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.Folder.ProgressHelpers.ScannedSubfolders">
|
||
<summary>
|
||
Reported once subfolders are scanned.
|
||
When scanning subfolders, the progress will be between [UpdatedItems, ScannedSubfolders].
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.Folder.ProgressHelpers.RefreshedMetadata">
|
||
<summary>
|
||
Reported once metadata is refreshed.
|
||
When refreshing metadata, the progress will be between [ScannedSubfolders, MetadataRefreshed].
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Folder.ProgressHelpers.GetProgress(System.Int32,System.Int32,System.Double)">
|
||
<summary>
|
||
Gets the current progress given the previous step, next step, and progress in between.
|
||
</summary>
|
||
<param name="previousProgressStep">The previous progress step.</param>
|
||
<param name="nextProgressStep">The next progress step.</param>
|
||
<param name="currentProgress">The current progress step.</param>
|
||
<returns>The progress.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Genre">
|
||
<summary>
|
||
Class Genre.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Genre.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Genre.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata">Whether to replace all metadata.</param>
|
||
<returns>true if the item has change, else false.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.ICollectionFolder">
|
||
<summary>
|
||
This is just a marker interface to denote top level folders.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.IHasAspectRatio">
|
||
<summary>
|
||
Interface IHasAspectRatio.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasAspectRatio.AspectRatio">
|
||
<summary>
|
||
Gets or sets the aspect ratio.
|
||
</summary>
|
||
<value>The aspect ratio.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.IHasDisplayOrder">
|
||
<summary>
|
||
Interface IHasDisplayOrder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasDisplayOrder.DisplayOrder">
|
||
<summary>
|
||
Gets or sets the display order.
|
||
</summary>
|
||
<value>The display order.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.IHasMediaSources.GetMediaSources(System.Boolean)">
|
||
<summary>
|
||
Gets the media sources.
|
||
</summary>
|
||
<param name="enablePathSubstitution"><c>true</c> to enable path substitution, <c>false</c> to not.</param>
|
||
<returns>A list of media sources.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasSeries.SeriesName">
|
||
<summary>
|
||
Gets or sets the name of the series.
|
||
</summary>
|
||
<value>The name of the series.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasSpecialFeatures.SpecialFeatureIds">
|
||
<summary>
|
||
Gets the special feature ids.
|
||
</summary>
|
||
<value>The special feature ids.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasTrailers.RemoteTrailers">
|
||
<summary>
|
||
Gets or sets the remote trailers.
|
||
</summary>
|
||
<value>The remote trailers.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.IHasTrailers.LocalTrailers">
|
||
<summary>
|
||
Gets the local trailers.
|
||
</summary>
|
||
<value>The local trailers.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.HasTrailerExtensions">
|
||
<summary>
|
||
Class providing extension methods for working with <see cref="T:MediaBrowser.Controller.Entities.IHasTrailers" />.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.HasTrailerExtensions.GetTrailerCount(MediaBrowser.Controller.Entities.IHasTrailers)">
|
||
<summary>
|
||
Gets the trailer count.
|
||
</summary>
|
||
<param name="item">Media item.</param>
|
||
<returns><see cref="T:System.Collections.Generic.IReadOnlyList`1" />.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.IItemByName">
|
||
<summary>
|
||
Marker interface.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.IMetadataContainer.RefreshAllMetadata(MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes all metadata.
|
||
</summary>
|
||
<param name="refreshOptions">The refresh options.</param>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.InternalItemsQuery.MinParentAndIndexNumber">
|
||
<summary>
|
||
Gets or sets the minimum ParentIndexNumber and IndexNumber.
|
||
</summary>
|
||
<remarks>
|
||
It produces this where clause:
|
||
<para>(ParentIndexNumber = X and IndexNumber >= Y) or ParentIndexNumber > X.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.InternalItemsQuery.DisplayAlbumFolders">
|
||
<summary>
|
||
Gets or sets a value indicating whether album sub-folders should be returned if they exist.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.InternalPeopleQuery.Limit">
|
||
<summary>
|
||
Gets or sets the maximum number of items the query should return.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.ISupportsBoxSetGrouping">
|
||
<summary>
|
||
Marker interface to denote a class that supports being hidden underneath it's boxset.
|
||
Just about anything can be placed into a boxset,
|
||
but movies should also only appear underneath and not outside separately (subject to configuration).
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.ISupportsPlaceHolders.IsPlaceHolder">
|
||
<summary>
|
||
Gets a value indicating whether this instance is place holder.
|
||
</summary>
|
||
<value><c>true</c> if this instance is place holder; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.ItemImageInfo.Path">
|
||
<summary>
|
||
Gets or sets the path.
|
||
</summary>
|
||
<value>The path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.ItemImageInfo.Type">
|
||
<summary>
|
||
Gets or sets the type.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.ItemImageInfo.DateModified">
|
||
<summary>
|
||
Gets or sets the date modified.
|
||
</summary>
|
||
<value>The date modified.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.ItemImageInfo.BlurHash">
|
||
<summary>
|
||
Gets or sets the blurhash.
|
||
</summary>
|
||
<value>The blurhash.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.LinkedChild.ItemId">
|
||
<summary>
|
||
Gets or sets the linked item id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.LinkedChildType">
|
||
<summary>
|
||
The linked child type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.LinkedChildType.Manual">
|
||
<summary>
|
||
Manually linked child.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.LinkedChildType.Shortcut">
|
||
<summary>
|
||
Shortcut linked child.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.MediaSourceWidthComparator">
|
||
<summary>
|
||
Compare MediaSource of the same file by Video width <see cref="T:System.Collections.Generic.IComparer`1" />.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.MediaSourceWidthComparator.Compare(MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Dto.MediaSourceInfo)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Movies.BoxSet">
|
||
<summary>
|
||
Class BoxSet.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Movies.BoxSet.LocalTrailers">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Movies.BoxSet.DisplayOrder">
|
||
<summary>
|
||
Gets or sets the display order.
|
||
</summary>
|
||
<value>The display order.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Movies.Movie">
|
||
<summary>
|
||
Class Movie.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Movies.Movie.SpecialFeatureIds">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Movies.Movie.LocalTrailers">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Movies.Movie.TmdbCollectionName">
|
||
<summary>
|
||
Gets or sets the name of the TMDb collection.
|
||
</summary>
|
||
<value>The name of the TMDb collection.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Movies.Movie.GetBlockUnratedType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Movies.Movie.BeforeMetadataRefresh(System.Boolean)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.MusicVideo.Artists">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Person">
|
||
<summary>
|
||
This is the full Person object that can be retrieved with all of it's data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Person.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Person.EnableAlphaNumericSorting">
|
||
<summary>
|
||
Gets a value indicating whether to enable alpha numeric sorting.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Person.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata"><c>true</c> to replace all metadata, <c>false</c> to not.</param>
|
||
<returns><c>true</c> if changes were made, <c>false</c> if not.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.PersonInfo">
|
||
<summary>
|
||
This is a small Person stub that is attached to BaseItems.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.PersonInfo.Id">
|
||
<summary>
|
||
Gets or Sets the PersonId.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.PersonInfo.Name">
|
||
<summary>
|
||
Gets or sets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.PersonInfo.Role">
|
||
<summary>
|
||
Gets or sets the role.
|
||
</summary>
|
||
<value>The role.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.PersonInfo.Type">
|
||
<summary>
|
||
Gets or sets the type.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.PersonInfo.SortOrder">
|
||
<summary>
|
||
Gets or sets the ascending sort order.
|
||
</summary>
|
||
<value>The sort order.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.PersonInfo.ToString">
|
||
<summary>
|
||
Returns a <see cref="T:System.String" /> that represents this instance.
|
||
</summary>
|
||
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Studio">
|
||
<summary>
|
||
Class Studio.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Studio.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Studio.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata"><c>true</c> to replace all metadata, <c>false</c> to not.</param>
|
||
<returns><c>true</c> if changes were made, <c>false</c> if not.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Trailer">
|
||
<summary>
|
||
Class Trailer.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.TV.Episode">
|
||
<summary>
|
||
Class Episode.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Episode.LocalTrailers">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Episode.AirsBeforeSeasonNumber">
|
||
<summary>
|
||
Gets or sets the season in which it aired.
|
||
</summary>
|
||
<value>The aired season.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Episode.IndexNumberEnd">
|
||
<summary>
|
||
Gets or sets the ending episode number for double episodes.
|
||
</summary>
|
||
<value>The index number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Episode.Series">
|
||
<summary>
|
||
Gets the Episode's Series Instance.
|
||
</summary>
|
||
<value>The series.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Episode.CreateSortName">
|
||
<summary>
|
||
Creates the name of the sort.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Episode.ContainsEpisodeNumber(System.Int32)">
|
||
<summary>
|
||
Determines whether [contains episode number] [the specified number].
|
||
</summary>
|
||
<param name="number">The number.</param>
|
||
<returns><c>true</c> if [contains episode number] [the specified number]; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.TV.Season">
|
||
<summary>
|
||
Class Season.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Season.Series">
|
||
<summary>
|
||
Gets this Episode's Series Instance.
|
||
</summary>
|
||
<value>The series.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Season.CreateSortName">
|
||
<summary>
|
||
Creates the name of the sort.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Season.GetEpisodes(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions,System.Boolean)">
|
||
<summary>
|
||
Gets the episodes.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="options">The options to use.</param>
|
||
<param name="shouldIncludeMissingEpisodes">If missing episodes should be included.</param>
|
||
<returns>Set of episodes.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Season.GetLookupInfo">
|
||
<summary>
|
||
Gets the lookup information.
|
||
</summary>
|
||
<returns>SeasonInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Season.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata"><c>true</c> to replace metadata, <c>false</c> to not.</param>
|
||
<returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.TV.Series">
|
||
<summary>
|
||
Class Series.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Series.LocalTrailers">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Series.DisplayOrder">
|
||
<summary>
|
||
Gets or sets the display order.
|
||
</summary>
|
||
<remarks>
|
||
Valid options are airdate, dvd or absolute.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.TV.Series.Status">
|
||
<summary>
|
||
Gets or sets the status.
|
||
</summary>
|
||
<value>The status.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Series.GetUserDataKeys">
|
||
<summary>
|
||
Gets the user data key.
|
||
</summary>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Series.FilterEpisodesBySeason(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.BaseItem},MediaBrowser.Controller.Entities.TV.Season,System.Boolean)">
|
||
<summary>
|
||
Filters the episodes by season.
|
||
</summary>
|
||
<param name="episodes">The episodes.</param>
|
||
<param name="parentSeason">The season.</param>
|
||
<param name="includeSpecials"><c>true</c> to include special, <c>false</c> to not.</param>
|
||
<returns>The set of episodes.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.TV.Series.FilterEpisodesBySeason(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.TV.Episode},System.Int32,System.Boolean)">
|
||
<summary>
|
||
Filters the episodes by season.
|
||
</summary>
|
||
<param name="episodes">The episodes.</param>
|
||
<param name="seasonNumber">The season.</param>
|
||
<param name="includeSpecials"><c>true</c> to include special, <c>false</c> to not.</param>
|
||
<returns>The set of episodes.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.UserItemData">
|
||
<summary>
|
||
Class UserItemData.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Entities.UserItemData._rating">
|
||
<summary>
|
||
The _rating.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.Key">
|
||
<summary>
|
||
Gets or sets the key.
|
||
</summary>
|
||
<value>The key.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.Rating">
|
||
<summary>
|
||
Gets or sets the users 0-10 rating.
|
||
</summary>
|
||
<value>The rating.</value>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Rating;A 0 to 10 rating is required for UserItemData.</exception>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.PlaybackPositionTicks">
|
||
<summary>
|
||
Gets or sets the playback position ticks.
|
||
</summary>
|
||
<value>The playback position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.PlayCount">
|
||
<summary>
|
||
Gets or sets the play count.
|
||
</summary>
|
||
<value>The play count.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.IsFavorite">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is favorite.
|
||
</summary>
|
||
<value><c>true</c> if this instance is favorite; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.LastPlayedDate">
|
||
<summary>
|
||
Gets or sets the last played date.
|
||
</summary>
|
||
<value>The last played date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.Played">
|
||
<summary>
|
||
Gets or sets a value indicating whether this <see cref="T:MediaBrowser.Controller.Entities.UserItemData" /> is played.
|
||
</summary>
|
||
<value><c>true</c> if played; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.AudioStreamIndex">
|
||
<summary>
|
||
Gets or sets the index of the audio stream.
|
||
</summary>
|
||
<value>The index of the audio stream.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.SubtitleStreamIndex">
|
||
<summary>
|
||
Gets or sets the index of the subtitle stream.
|
||
</summary>
|
||
<value>The index of the subtitle stream.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserItemData.Likes">
|
||
<summary>
|
||
Gets or sets a value indicating whether the item is liked or not.
|
||
This should never be serialized.
|
||
</summary>
|
||
<value><c>null</c> if [likes] contains no value, <c>true</c> if [likes]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.UserRootFolder">
|
||
<summary>
|
||
Special class used for User Roots. Children contain actual ones defined for this user
|
||
PLUS the virtual folders from the physical root (added by plug-ins).
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserRootFolder.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Entities.UserRootFolder"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.ViewType">
|
||
<summary>
|
||
Gets or sets the view type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.DisplayParentId">
|
||
<summary>
|
||
Gets or sets the display parent id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.UserId">
|
||
<summary>
|
||
Gets or sets the user id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.CollectionType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.SupportsInheritedParentImages">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.SupportsPlayedStatus">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.UserView.SupportsPeople">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetIdsForAncestorQuery">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetChildCount(Jellyfin.Database.Implementations.Entities.User)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetItemsInternal(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetChildren(Jellyfin.Database.Implementations.Entities.User,System.Boolean,MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.CanDelete">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.IsSaveLocalMetadataEnabled">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetRecursiveChildren(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.InternalItemsQuery,System.Int32@)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.UserView.GetEligibleChildrenForRecursiveChildren(Jellyfin.Database.Implementations.Entities.User)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Video">
|
||
<summary>
|
||
Class Video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.Timestamp">
|
||
<summary>
|
||
Gets or sets the timestamp.
|
||
</summary>
|
||
<value>The timestamp.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.SubtitleFiles">
|
||
<summary>
|
||
Gets or sets the subtitle paths.
|
||
</summary>
|
||
<value>The subtitle paths.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.AudioFiles">
|
||
<summary>
|
||
Gets or sets the audio paths.
|
||
</summary>
|
||
<value>The audio paths.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.HasSubtitles">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance has subtitles.
|
||
</summary>
|
||
<value><c>true</c> if this instance has subtitles; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.DefaultVideoStreamIndex">
|
||
<summary>
|
||
Gets or sets the default index of the video stream.
|
||
</summary>
|
||
<value>The default index of the video stream.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.VideoType">
|
||
<summary>
|
||
Gets or sets the type of the video.
|
||
</summary>
|
||
<value>The type of the video.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.IsoType">
|
||
<summary>
|
||
Gets or sets the type of the iso.
|
||
</summary>
|
||
<value>The type of the iso.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.Video3DFormat">
|
||
<summary>
|
||
Gets or sets the video3 D format.
|
||
</summary>
|
||
<value>The video3 D format.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.AspectRatio">
|
||
<summary>
|
||
Gets or sets the aspect ratio.
|
||
</summary>
|
||
<value>The aspect ratio.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.Is3D">
|
||
<summary>
|
||
Gets a value indicating whether [is3 D].
|
||
</summary>
|
||
<value><c>true</c> if [is3 D]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Video.MediaType">
|
||
<summary>
|
||
Gets the type of the media.
|
||
</summary>
|
||
<value>The type of the media.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Video.GetAdditionalParts">
|
||
<summary>
|
||
Gets the additional parts.
|
||
</summary>
|
||
<returns>IEnumerable{Video}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Video.UpdateToRepositoryAsync(MediaBrowser.Controller.Library.ItemUpdateType,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Entities.Year">
|
||
<summary>
|
||
Class Year.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Entities.Year.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Entities.Year.BeforeMetadataRefresh(System.Boolean)">
|
||
<summary>
|
||
This is called before any metadata refresh and returns true if changes were made.
|
||
</summary>
|
||
<param name="replaceAllMetadata">Whether to replace all metadata.</param>
|
||
<returns>true if the item has change, else false.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs">
|
||
<summary>
|
||
A class representing an authentication result event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.#ctor(MediaBrowser.Controller.Session.AuthenticationRequest)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs"/> class.
|
||
</summary>
|
||
<param name="request">The <see cref="T:MediaBrowser.Controller.Session.AuthenticationRequest"/>.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.Username">
|
||
<summary>
|
||
Gets or sets the user name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.UserId">
|
||
<summary>
|
||
Gets or sets the user id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.App">
|
||
<summary>
|
||
Gets or sets the app.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.AppVersion">
|
||
<summary>
|
||
Gets or sets the app version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.DeviceId">
|
||
<summary>
|
||
Gets or sets the device id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.DeviceName">
|
||
<summary>
|
||
Gets or sets the device name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationRequestEventArgs.RemoteEndPoint">
|
||
<summary>
|
||
Gets or sets the remote endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs">
|
||
<summary>
|
||
A class representing an authentication result event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs.#ctor(MediaBrowser.Controller.Authentication.AuthenticationResult)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs"/> class.
|
||
</summary>
|
||
<param name="result">The <see cref="T:MediaBrowser.Controller.Authentication.AuthenticationResult"/>.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs.User">
|
||
<summary>
|
||
Gets or sets the user.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs.SessionInfo">
|
||
<summary>
|
||
Gets or sets the session information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Events.Authentication.AuthenticationResultEventArgs.ServerId">
|
||
<summary>
|
||
Gets or sets the server id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.IEventConsumer`1">
|
||
<summary>
|
||
An interface representing a type that consumes events of type <c>T</c>.
|
||
</summary>
|
||
<typeparam name="T">The type of events this consumes.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.IEventConsumer`1.OnEvent(`0)">
|
||
<summary>
|
||
A method that is called when an event of type <c>T</c> is fired.
|
||
</summary>
|
||
<param name="eventArgs">The event.</param>
|
||
<returns>A task representing the consumption of the event.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.IEventManager">
|
||
<summary>
|
||
An interface that handles eventing.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.IEventManager.Publish``1(``0)">
|
||
<summary>
|
||
Publishes an event.
|
||
</summary>
|
||
<param name="eventArgs">the event arguments.</param>
|
||
<typeparam name="T">The type of event.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.IEventManager.PublishAsync``1(``0)">
|
||
<summary>
|
||
Publishes an event asynchronously.
|
||
</summary>
|
||
<param name="eventArgs">The event arguments.</param>
|
||
<typeparam name="T">The type of event.</typeparam>
|
||
<returns>A task representing the publishing of the event.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Session.SessionEndedEventArgs">
|
||
<summary>
|
||
An event that fires when a session is ended.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Session.SessionEndedEventArgs.#ctor(MediaBrowser.Controller.Session.SessionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Session.SessionEndedEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The session info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Session.SessionStartedEventArgs">
|
||
<summary>
|
||
An event that fires when a session is started.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Session.SessionStartedEventArgs.#ctor(MediaBrowser.Controller.Session.SessionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Session.SessionStartedEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The session info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Updates.PluginInstallationCancelledEventArgs">
|
||
<summary>
|
||
An event that occurs when a plugin installation is cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Updates.PluginInstallationCancelledEventArgs.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Updates.PluginInstallationCancelledEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The installation info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Updates.PluginInstalledEventArgs">
|
||
<summary>
|
||
An event that occurs when a plugin is installed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Updates.PluginInstalledEventArgs.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Updates.PluginInstalledEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The installation info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Updates.PluginInstallingEventArgs">
|
||
<summary>
|
||
An event that occurs when a plugin is installing.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Updates.PluginInstallingEventArgs.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Updates.PluginInstallingEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The installation info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Updates.PluginUninstalledEventArgs">
|
||
<summary>
|
||
An event that occurs when a plugin is uninstalled.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Updates.PluginUninstalledEventArgs.#ctor(MediaBrowser.Model.Plugins.PluginInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Updates.PluginUninstalledEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The plugin.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Events.Updates.PluginUpdatedEventArgs">
|
||
<summary>
|
||
An event that occurs when a plugin is updated.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Events.Updates.PluginUpdatedEventArgs.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Events.Updates.PluginUpdatedEventArgs"/> class.
|
||
</summary>
|
||
<param name="arg">The installation info.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Extensions.ConfigurationExtensions">
|
||
<summary>
|
||
Configuration extensions for <c>MediaBrowser.Controller</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.DefaultRedirectKey">
|
||
<summary>
|
||
The key for a setting that specifies the default redirect path
|
||
to use for requests where the URL base prefix is invalid or missing..
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.AddressOverrideKey">
|
||
<summary>
|
||
The key for the address override option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.HostWebClientKey">
|
||
<summary>
|
||
The key for a setting that indicates whether the application should host web client content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.FfmpegProbeSizeKey">
|
||
<summary>
|
||
The key for the FFmpeg probe size option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.FfmpegSkipValidationKey">
|
||
<summary>
|
||
The key for the skipping FFmpeg validation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.FfmpegAnalyzeDurationKey">
|
||
<summary>
|
||
The key for the FFmpeg analyze duration option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.FfmpegImgExtractPerfTradeoffKey">
|
||
<summary>
|
||
The key for the FFmpeg image extraction performance tradeoff option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.FfmpegPathKey">
|
||
<summary>
|
||
The key for the FFmpeg path option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.BindToUnixSocketKey">
|
||
<summary>
|
||
The key for a setting that indicates whether kestrel should bind to a unix socket.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.UnixSocketPathKey">
|
||
<summary>
|
||
The key for the unix socket path.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.UnixSocketPermissionsKey">
|
||
<summary>
|
||
The permissions for the unix socket.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Extensions.ConfigurationExtensions.DetectNetworkChangeKey">
|
||
<summary>
|
||
The key for a setting that indicates whether the application should detect network status change.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.HostWebClient(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets a value indicating whether the application should host static web content from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||
</summary>
|
||
<param name="configuration">The configuration to retrieve the value from.</param>
|
||
<returns>The parsed config value.</returns>
|
||
<exception cref="T:System.FormatException">The config value is not a valid bool string. See <see cref="M:System.Boolean.Parse(System.String)"/>.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetFFmpegProbeSize(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets the FFmpeg probe size from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns>The FFmpeg probe size option.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetFFmpegAnalyzeDuration(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets the FFmpeg analyze duration from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns>The FFmpeg analyze duration option.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetFFmpegSkipValidation(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets a value indicating whether the server should validate FFmpeg during startup.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns><c>true</c> if the server should validate FFmpeg during startup, otherwise <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetFFmpegImgExtractPerfTradeoff(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets a value indicating whether the server should trade off for performance during FFmpeg image extraction.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns><c>true</c> if the server should trade off for performance during FFmpeg image extraction, otherwise <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.UseUnixSocket(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets a value indicating whether kestrel should bind to a unix socket from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns><c>true</c> if kestrel should bind to a unix socket, otherwise <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetUnixSocketPath(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets the path for the unix socket from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns>The unix socket path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.ConfigurationExtensions.GetUnixSocketPermissions(Microsoft.Extensions.Configuration.IConfiguration)">
|
||
<summary>
|
||
Gets the permissions for the unix socket from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||
</summary>
|
||
<param name="configuration">The configuration to read the setting from.</param>
|
||
<returns>The unix socket permissions.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Extensions.XmlReaderExtensions">
|
||
<summary>
|
||
Provides extension methods for <see cref="T:System.Xml.XmlReader"/> to parse <see cref="T:MediaBrowser.Controller.Entities.BaseItem"/>'s.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.ReadNormalizedString(System.Xml.XmlReader)">
|
||
<summary>
|
||
Reads a trimmed string from the current node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<returns>The trimmed content.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.TryReadInt(System.Xml.XmlReader,System.Int32@)">
|
||
<summary>
|
||
Reads an int from the current node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<param name="value">The parsed <c>int</c>.</param>
|
||
<returns>A value indicating whether the parsing succeeded.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.TryReadDateTime(System.Xml.XmlReader,System.DateTime@)">
|
||
<summary>
|
||
Parses a <see cref="T:System.DateTime"/> from the current node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<param name="value">The parsed <see cref="T:System.DateTime"/>.</param>
|
||
<returns>A value indicating whether the parsing succeeded.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.TryReadDateTimeExact(System.Xml.XmlReader,System.String,System.DateTime@)">
|
||
<summary>
|
||
Parses a <see cref="T:System.DateTime"/> from the current node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<param name="formatString">The date format string.</param>
|
||
<param name="value">The parsed <see cref="T:System.DateTime"/>.</param>
|
||
<returns>A value indicating whether the parsing succeeded.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.GetPersonFromXmlNode(System.Xml.XmlReader)">
|
||
<summary>
|
||
Parses a <see cref="T:MediaBrowser.Controller.Entities.PersonInfo"/> from the xml node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<returns>A <see cref="T:MediaBrowser.Controller.Entities.PersonInfo"/>, or <c>null</c> if none is found.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.GetStringArray(System.Xml.XmlReader)">
|
||
<summary>
|
||
Used to split names of comma or pipe delimited genres and people.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<returns>IEnumerable{System.String}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Extensions.XmlReaderExtensions.GetPersonArray(System.Xml.XmlReader,Jellyfin.Data.Enums.PersonKind)">
|
||
<summary>
|
||
Parses a <see cref="T:MediaBrowser.Controller.Entities.PersonInfo"/> array from the xml node.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Xml.XmlReader"/>.</param>
|
||
<param name="personKind">The <see cref="T:Jellyfin.Data.Enums.PersonKind"/>.</param>
|
||
<returns>The <see cref="T:System.Collections.Generic.IEnumerable`1"/>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IDisplayPreferencesManager">
|
||
<summary>
|
||
Manages the storage and retrieval of display preferences.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.GetDisplayPreferences(System.Guid,System.Guid,System.String)">
|
||
<summary>
|
||
Gets the display preferences for the user and client.
|
||
</summary>
|
||
<remarks>
|
||
This will create the display preferences if it does not exist, but it will not save automatically.
|
||
</remarks>
|
||
<param name="userId">The user's id.</param>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="client">The client string.</param>
|
||
<returns>The associated display preferences.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.GetItemDisplayPreferences(System.Guid,System.Guid,System.String)">
|
||
<summary>
|
||
Gets the default item display preferences for the user and client.
|
||
</summary>
|
||
<remarks>
|
||
This will create the item display preferences if it does not exist, but it will not save automatically.
|
||
</remarks>
|
||
<param name="userId">The user id.</param>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="client">The client string.</param>
|
||
<returns>The item display preferences.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.ListItemDisplayPreferences(System.Guid,System.String)">
|
||
<summary>
|
||
Gets all of the item display preferences for the user and client.
|
||
</summary>
|
||
<param name="userId">The user id.</param>
|
||
<param name="client">The client string.</param>
|
||
<returns>A list of item display preferences.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.ListCustomItemDisplayPreferences(System.Guid,System.Guid,System.String)">
|
||
<summary>
|
||
Gets all of the custom item display preferences for the user and client.
|
||
</summary>
|
||
<param name="userId">The user id.</param>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="client">The client string.</param>
|
||
<returns>The dictionary of custom item display preferences.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.SetCustomItemDisplayPreferences(System.Guid,System.Guid,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
||
<summary>
|
||
Sets the custom item display preference for the user and client.
|
||
</summary>
|
||
<param name="userId">The user id.</param>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="client">The client id.</param>
|
||
<param name="customPreferences">A dictionary of custom item display preferences.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.UpdateDisplayPreferences(Jellyfin.Database.Implementations.Entities.DisplayPreferences)">
|
||
<summary>
|
||
Updates or Creates the display preferences.
|
||
</summary>
|
||
<param name="displayPreferences">The entity to update or create.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IDisplayPreferencesManager.UpdateItemDisplayPreferences(Jellyfin.Database.Implementations.Entities.ItemDisplayPreferences)">
|
||
<summary>
|
||
Updates or Creates the display preferences for the given item.
|
||
</summary>
|
||
<param name="itemDisplayPreferences">The entity to update or create.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IO.FileData">
|
||
<summary>
|
||
Provides low level File access that is much faster than the File/Directory api's.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileData.GetFilteredFileSystemEntries(MediaBrowser.Controller.Providers.IDirectoryService,System.String,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.IServerApplicationHost,Microsoft.Extensions.Logging.ILogger,MediaBrowser.Controller.Library.ItemResolveArgs,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Gets the filtered file system entries.
|
||
</summary>
|
||
<param name="directoryService">The directory service.</param>
|
||
<param name="path">The path.</param>
|
||
<param name="fileSystem">The file system.</param>
|
||
<param name="appHost">The application host.</param>
|
||
<param name="logger">The logger.</param>
|
||
<param name="args">The args.</param>
|
||
<param name="flattenFolderDepth">The flatten folder depth.</param>
|
||
<param name="resolveShortcuts">if set to <c>true</c> [resolve shortcuts].</param>
|
||
<returns>Dictionary{System.StringFileSystemInfo}.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <c>null</c> or empty.</exception>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IO.FileSystemHelper">
|
||
<summary>
|
||
Helper methods for file system management.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileSystemHelper.DeleteFile(MediaBrowser.Model.IO.IFileSystem,System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Deletes the file.
|
||
</summary>
|
||
<param name="fileSystem">The fileSystem.</param>
|
||
<param name="path">The path.</param>
|
||
<param name="logger">The logger.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileSystemHelper.DeleteEmptyFolders(MediaBrowser.Model.IO.IFileSystem,System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Recursively delete empty folders.
|
||
</summary>
|
||
<param name="fileSystem">The fileSystem.</param>
|
||
<param name="path">The path.</param>
|
||
<param name="logger">The logger.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileSystemHelper.Resolve(System.String)">
|
||
<summary>
|
||
Resolves a single link hop for the specified path.
|
||
</summary>
|
||
<remarks>
|
||
Returns <c>null</c> if the path is not a symbolic link or the filesystem does not support link resolution (e.g., exFAT).
|
||
</remarks>
|
||
<param name="path">The file path to resolve.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.FileInfo"/> representing the next link target if the path is a link; otherwise, <c>null</c>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileSystemHelper.ResolveLinkTarget(System.String,System.Boolean)">
|
||
<summary>
|
||
Gets the target of the specified file link.
|
||
</summary>
|
||
<remarks>
|
||
This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128.
|
||
</remarks>
|
||
<param name="linkPath">The path of the file link.</param>
|
||
<param name="returnFinalTarget">true to follow links to the final target; false to return the immediate next link.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.FileInfo"/> if the <paramref name="linkPath"/> is a link, regardless of if the target exists; otherwise, <c>null</c>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.FileSystemHelper.ResolveLinkTarget(System.IO.FileInfo,System.Boolean)">
|
||
<summary>
|
||
Gets the target of the specified file link.
|
||
</summary>
|
||
<remarks>
|
||
This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128.
|
||
</remarks>
|
||
<param name="fileInfo">The file info of the file link.</param>
|
||
<param name="returnFinalTarget">true to follow links to the final target; false to return the immediate next link.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.FileInfo"/> if the <paramref name="fileInfo"/> is a link, regardless of if the target exists; otherwise, <c>null</c>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IO.IExternalDataManager">
|
||
<summary>
|
||
Interface IPathManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IExternalDataManager.DeleteExternalItemDataAsync(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes all external item data.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IO.IPathManager">
|
||
<summary>
|
||
Interface IPathManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetTrickplayDirectory(MediaBrowser.Controller.Entities.BaseItem,System.Boolean)">
|
||
<summary>
|
||
Gets the path to the trickplay image base folder.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="saveWithMedia">Whether or not the tile should be saved next to the media file.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetSubtitlePath(System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Gets the path to the subtitle file.
|
||
</summary>
|
||
<param name="mediaSourceId">The media source id.</param>
|
||
<param name="streamIndex">The stream index.</param>
|
||
<param name="extension">The subtitle file extension.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetSubtitleFolderPath(System.String)">
|
||
<summary>
|
||
Gets the path to the subtitle file.
|
||
</summary>
|
||
<param name="mediaSourceId">The media source id.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetAttachmentPath(System.String,System.String)">
|
||
<summary>
|
||
Gets the path to the attachment file.
|
||
</summary>
|
||
<param name="mediaSourceId">The media source id.</param>
|
||
<param name="fileName">The attachmentFileName index.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetAttachmentFolderPath(System.String)">
|
||
<summary>
|
||
Gets the path to the attachment folder.
|
||
</summary>
|
||
<param name="mediaSourceId">The media source id.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetChapterImageFolderPath(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the chapter images data path.
|
||
</summary>
|
||
<param name="item">The base item.</param>
|
||
<returns>The chapter images data path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetChapterImagePath(MediaBrowser.Controller.Entities.BaseItem,System.Int64)">
|
||
<summary>
|
||
Gets the chapter images path.
|
||
</summary>
|
||
<param name="item">The base item.</param>
|
||
<param name="chapterPositionTicks">The chapter position.</param>
|
||
<returns>The chapter images data path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IPathManager.GetExtractedDataPaths(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the paths of extracted data folders.
|
||
</summary>
|
||
<param name="item">The base item.</param>
|
||
<returns>The absolute paths.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IO.IKeyframeManager">
|
||
<summary>
|
||
Interface IKeyframeManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IKeyframeManager.GetKeyframeDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the keyframe data asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The keyframe data.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IKeyframeManager.SaveKeyframeDataAsync(System.Guid,Jellyfin.MediaEncoding.Keyframes.KeyframeData,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the keyframe data.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="data">The keyframe data.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IO.IKeyframeManager.DeleteKeyframeDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes the keyframe data.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.IServerApplicationHost">
|
||
<summary>
|
||
Interface IServerApplicationHost.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationHost.HttpPort">
|
||
<summary>
|
||
Gets the HTTP server port.
|
||
</summary>
|
||
<value>The HTTP server port.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationHost.HttpsPort">
|
||
<summary>
|
||
Gets the HTTPS port.
|
||
</summary>
|
||
<value>The HTTPS port.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationHost.ListenWithHttps">
|
||
<summary>
|
||
Gets a value indicating whether the server should listen on an HTTPS port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationHost.FriendlyName">
|
||
<summary>
|
||
Gets the name of the friendly.
|
||
</summary>
|
||
<value>The name of the friendly.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationHost.RestoreBackupPath">
|
||
<summary>
|
||
Gets or sets the path to the backup archive used to restore upon restart.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IServerApplicationHost.GetSmartApiUrl(Microsoft.AspNetCore.Http.HttpRequest)">
|
||
<summary>
|
||
Gets a URL specific for the request.
|
||
</summary>
|
||
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/> instance.</param>
|
||
<returns>An accessible URL.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IServerApplicationHost.GetSmartApiUrl(System.Net.IPAddress)">
|
||
<summary>
|
||
Gets a URL specific for the request.
|
||
</summary>
|
||
<param name="remoteAddr">The remote <see cref="T:System.Net.IPAddress"/> of the connection.</param>
|
||
<returns>An accessible URL.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IServerApplicationHost.GetSmartApiUrl(System.String)">
|
||
<summary>
|
||
Gets a URL specific for the request.
|
||
</summary>
|
||
<param name="hostname">The hostname used in the connection.</param>
|
||
<returns>An accessible URL.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IServerApplicationHost.GetApiUrlForLocalAccess(System.Net.IPAddress,System.Boolean)">
|
||
<summary>
|
||
Gets an URL that can be used to access the API over LAN.
|
||
</summary>
|
||
<param name="ipAddress">An optional IP address to use.</param>
|
||
<param name="allowHttps">A value indicating whether to allow HTTPS.</param>
|
||
<returns>The API URL.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.IServerApplicationHost.GetLocalApiUrl(System.String,System.String,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Gets a local (LAN) URL that can be used to access the API.
|
||
Note: if passing non-null scheme or port it is up to the caller to ensure they form the correct pair.
|
||
</summary>
|
||
<param name="hostname">The hostname to use in the URL.</param>
|
||
<param name="scheme">
|
||
The scheme to use for the URL. If null, the scheme will be selected automatically,
|
||
preferring HTTPS, if available.
|
||
</param>
|
||
<param name="port">
|
||
The port to use for the URL. If null, the port will be selected automatically,
|
||
preferring the HTTPS port, if available.
|
||
</param>
|
||
<returns>The API URL.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.RootFolderPath">
|
||
<summary>
|
||
Gets the path to the base root media directory.
|
||
</summary>
|
||
<value>The root folder path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.DefaultUserViewsPath">
|
||
<summary>
|
||
Gets the path to the default user view directory. Used if no specific user view is defined.
|
||
</summary>
|
||
<value>The default user views path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.PeoplePath">
|
||
<summary>
|
||
Gets the path to the People directory.
|
||
</summary>
|
||
<value>The people path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.GenrePath">
|
||
<summary>
|
||
Gets the path to the Genre directory.
|
||
</summary>
|
||
<value>The genre path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.MusicGenrePath">
|
||
<summary>
|
||
Gets the music genre path.
|
||
</summary>
|
||
<value>The music genre path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.StudioPath">
|
||
<summary>
|
||
Gets the path to the Studio directory.
|
||
</summary>
|
||
<value>The studio path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.YearPath">
|
||
<summary>
|
||
Gets the path to the Year directory.
|
||
</summary>
|
||
<value>The year path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.UserConfigurationDirectoryPath">
|
||
<summary>
|
||
Gets the path to the user configuration directory.
|
||
</summary>
|
||
<value>The user configuration directory path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.DefaultInternalMetadataPath">
|
||
<summary>
|
||
Gets the default internal metadata path.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.InternalMetadataPath">
|
||
<summary>
|
||
Gets the internal metadata path, either a custom path or the default.
|
||
</summary>
|
||
<value>The internal metadata path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.VirtualInternalMetadataPath">
|
||
<summary>
|
||
Gets the virtual internal metadata path, either a custom path or the default.
|
||
</summary>
|
||
<value>The virtual internal metadata path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.IServerApplicationPaths.ArtistsPath">
|
||
<summary>
|
||
Gets the path to the artists directory.
|
||
</summary>
|
||
<value>The artists path.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.ISystemManager">
|
||
<summary>
|
||
A service for managing the application instance.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ISystemManager.GetSystemInfo(Microsoft.AspNetCore.Http.HttpRequest)">
|
||
<summary>
|
||
Gets the system info.
|
||
</summary>
|
||
<param name="request">The HTTP request.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Model.System.SystemInfo"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ISystemManager.GetPublicSystemInfo(Microsoft.AspNetCore.Http.HttpRequest)">
|
||
<summary>
|
||
Gets the public system info.
|
||
</summary>
|
||
<param name="request">The HTTP request.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Model.System.PublicSystemInfo"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ISystemManager.Restart">
|
||
<summary>
|
||
Starts the application restart process.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ISystemManager.Shutdown">
|
||
<summary>
|
||
Starts the application shutdown process.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.ISystemManager.GetSystemStorageInfo">
|
||
<summary>
|
||
Gets the systems storage resources.
|
||
</summary>
|
||
<returns>The <see cref="T:MediaBrowser.Model.System.SystemStorageInfo"/>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LibraryTaskScheduler.ILimitedConcurrencyLibraryScheduler">
|
||
<summary>
|
||
Provides a shared scheduler to run library related tasks based on the <see cref="P:MediaBrowser.Model.Configuration.ServerConfiguration.LibraryScanFanoutConcurrency"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LibraryTaskScheduler.ILimitedConcurrencyLibraryScheduler.Enqueue``1(``0[],System.Func{``0,System.IProgress{System.Double},System.Threading.Tasks.Task},System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Enqueues an action that will be invoked with the set data.
|
||
</summary>
|
||
<typeparam name="T">The data Type.</typeparam>
|
||
<param name="data">The data.</param>
|
||
<param name="worker">The callback to process the data.</param>
|
||
<param name="progress">A progress reporter.</param>
|
||
<param name="cancellationToken">Stop token.</param>
|
||
<returns>A task that finishes when all data has been processed by the worker.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler">
|
||
<summary>
|
||
Provides Parallel action interface to process tasks with a set concurrency level.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler._taskLock">
|
||
<summary>
|
||
Gets used to lock all operations on the Tasks queue and creating workers.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler.#ctor(Microsoft.Extensions.Hosting.IHostApplicationLifetime,Microsoft.Extensions.Logging.ILogger{MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler},MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler"/> class.
|
||
</summary>
|
||
<param name="hostApplicationLifetime">The hosting lifetime.</param>
|
||
<param name="logger">The logger.</param>
|
||
<param name="serverConfigurationManager">The server configuration manager.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler.Enqueue``1(``0[],System.Func{``0,System.IProgress{System.Double},System.Threading.Tasks.Task},System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LibraryTaskScheduler.LimitedConcurrencyLibraryScheduler.DisposeAsync">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.IDirectStreamProvider">
|
||
<summary>
|
||
The direct live TV stream provider.
|
||
</summary>
|
||
<remarks>
|
||
Deprecated.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IDirectStreamProvider.GetStream">
|
||
<summary>
|
||
Gets the live stream, shared streams seek to the end of the file first.
|
||
</summary>
|
||
<returns>The stream.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.IIntroProvider">
|
||
<summary>
|
||
Class BaseIntroProvider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IIntroProvider.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IIntroProvider.GetIntros(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the intros.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>IEnumerable{System.String}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ILibraryManager">
|
||
<summary>
|
||
Interface ILibraryManager.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Library.ILibraryManager.ItemAdded">
|
||
<summary>
|
||
Occurs when [item added].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Library.ILibraryManager.ItemUpdated">
|
||
<summary>
|
||
Occurs when [item updated].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Library.ILibraryManager.ItemRemoved">
|
||
<summary>
|
||
Occurs when [item removed].
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ILibraryManager.RootFolder">
|
||
<summary>
|
||
Gets the root folder.
|
||
</summary>
|
||
<value>The root folder.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ResolvePath(MediaBrowser.Model.IO.FileSystemMetadata,MediaBrowser.Controller.Entities.Folder,MediaBrowser.Controller.Providers.IDirectoryService)">
|
||
<summary>
|
||
Resolves the path.
|
||
</summary>
|
||
<param name="fileInfo">The file information.</param>
|
||
<param name="parent">The parent.</param>
|
||
<param name="directoryService">An instance of <see cref="T:MediaBrowser.Controller.Providers.IDirectoryService"/>.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ResolvePaths(System.Collections.Generic.IEnumerable{MediaBrowser.Model.IO.FileSystemMetadata},MediaBrowser.Controller.Providers.IDirectoryService,MediaBrowser.Controller.Entities.Folder,MediaBrowser.Model.Configuration.LibraryOptions,System.Nullable{Jellyfin.Data.Enums.CollectionType})">
|
||
<summary>
|
||
Resolves a set of files into a list of BaseItem.
|
||
</summary>
|
||
<param name="files">The list of tiles.</param>
|
||
<param name="directoryService">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IDirectoryService"/> interface.</param>
|
||
<param name="parent">The parent folder.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<param name="collectionType">The collection type.</param>
|
||
<returns>The items resolved from the paths.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetPerson(System.String)">
|
||
<summary>
|
||
Gets a Person.
|
||
</summary>
|
||
<param name="name">The name of the person.</param>
|
||
<returns>Task{Person}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.FindByPath(System.String,System.Nullable{System.Boolean})">
|
||
<summary>
|
||
Finds the by path.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="isFolder"><c>true</c> is the path is a directory; otherwise <c>false</c>.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetArtist(System.String)">
|
||
<summary>
|
||
Gets the artist.
|
||
</summary>
|
||
<param name="name">The name of the artist.</param>
|
||
<returns>Task{Artist}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetStudio(System.String)">
|
||
<summary>
|
||
Gets a Studio.
|
||
</summary>
|
||
<param name="name">The name of the studio.</param>
|
||
<returns>Task{Studio}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetGenre(System.String)">
|
||
<summary>
|
||
Gets a Genre.
|
||
</summary>
|
||
<param name="name">The name of the genre.</param>
|
||
<returns>Task{Genre}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetMusicGenre(System.String)">
|
||
<summary>
|
||
Gets the genre.
|
||
</summary>
|
||
<param name="name">The name of the music genre.</param>
|
||
<returns>Task{MusicGenre}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetYear(System.Int32)">
|
||
<summary>
|
||
Gets a Year.
|
||
</summary>
|
||
<param name="value">The value.</param>
|
||
<returns>Task{Year}.</returns>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Throws if year is invalid.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ValidatePeopleAsync(System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ValidateMediaLibrary(System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Reloads the root media folder.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ValidateTopLibraryFolders(System.Threading.CancellationToken,System.Boolean)">
|
||
<summary>
|
||
Reloads the root media folder.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<param name="removeRoot">Is remove the library itself allowed.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetVirtualFolders">
|
||
<summary>
|
||
Gets the default view.
|
||
</summary>
|
||
<returns>IEnumerable{VirtualFolderInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemById(System.Guid)">
|
||
<summary>
|
||
Gets the item by id.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<returns>BaseItem.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="id"/> is <c>null</c>.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemById``1(System.Guid)">
|
||
<summary>
|
||
Gets the item by id, as T.
|
||
</summary>
|
||
<param name="id">The item id.</param>
|
||
<typeparam name="T">The type of item.</typeparam>
|
||
<returns>The item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemById``1(System.Guid,System.Guid)">
|
||
<summary>
|
||
Gets the item by id, as T, and validates user access.
|
||
</summary>
|
||
<param name="id">The item id.</param>
|
||
<param name="userId">The user id to validate against.</param>
|
||
<typeparam name="T">The type of item.</typeparam>
|
||
<returns>The item if found.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemById``1(System.Guid,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the item by id, as T, and validates user access.
|
||
</summary>
|
||
<param name="id">The item id.</param>
|
||
<param name="user">The user to validate against.</param>
|
||
<typeparam name="T">The type of item.</typeparam>
|
||
<returns>The item if found.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetIntros(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the intros.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>IEnumerable{System.String}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.AddParts(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Resolvers.IResolverIgnoreRule},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Resolvers.IItemResolver},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Library.IIntroProvider},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Sorting.IBaseItemComparer},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Library.ILibraryPostScanTask})">
|
||
<summary>
|
||
Adds the parts.
|
||
</summary>
|
||
<param name="rules">The rules.</param>
|
||
<param name="resolvers">The resolvers.</param>
|
||
<param name="introProviders">The intro providers.</param>
|
||
<param name="itemComparers">The item comparers.</param>
|
||
<param name="postScanTasks">The post scan tasks.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.Sort(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.BaseItem},Jellyfin.Database.Implementations.Entities.User,System.Collections.Generic.IEnumerable{Jellyfin.Data.Enums.ItemSortBy},Jellyfin.Database.Implementations.Enums.SortOrder)">
|
||
<summary>
|
||
Sorts the specified items.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="user">The user.</param>
|
||
<param name="sortBy">The sort by.</param>
|
||
<param name="sortOrder">The sort order.</param>
|
||
<returns>IEnumerable{BaseItem}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetUserRootFolder">
|
||
<summary>
|
||
Gets the user root folder.
|
||
</summary>
|
||
<returns>UserRootFolder.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.CreateItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Creates the item.
|
||
</summary>
|
||
<param name="item">Item to create.</param>
|
||
<param name="parent">Parent of new item.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.CreateItems(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the items.
|
||
</summary>
|
||
<param name="items">Items to create.</param>
|
||
<param name="parent">Parent of new items.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.UpdateItemsAsync(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.ItemUpdateType,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the item.
|
||
</summary>
|
||
<param name="items">Items to update.</param>
|
||
<param name="parent">Parent of updated items.</param>
|
||
<param name="updateReason">Reason for update.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>Returns a Task that can be awaited.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.UpdateItemAsync(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.ItemUpdateType,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="parent">The parent item.</param>
|
||
<param name="updateReason">The update reason.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Returns a Task that can be awaited.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ReattachUserDataAsync(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Reattaches the user data to the item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task that represents the asynchronous reattachment operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.RetrieveItem(System.Guid)">
|
||
<summary>
|
||
Retrieves the item.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.RetrieveItemAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Retrieves the item asynchronously.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetContentType(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Finds the type of the collection.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetInheritedContentType(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the type of the inherited content.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetConfiguredContentType(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the type of the configured content.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetConfiguredContentType(System.String)">
|
||
<summary>
|
||
Gets the type of the configured content.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.NormalizeRootPathList(System.Collections.Generic.IEnumerable{MediaBrowser.Model.IO.FileSystemMetadata})">
|
||
<summary>
|
||
Normalizes the root path list.
|
||
</summary>
|
||
<param name="paths">The paths.</param>
|
||
<returns>IEnumerable{System.String}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.RegisterItem(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Registers the item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.DeleteItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.DeleteOptions)">
|
||
<summary>
|
||
Deletes the item.
|
||
</summary>
|
||
<param name="item">Item to delete.</param>
|
||
<param name="options">Options to use for deletion.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.DeleteItemsUnsafeFast(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.BaseItem})">
|
||
<summary>
|
||
Deletes items that are not having any children like Actors.
|
||
</summary>
|
||
<param name="items">Items to delete.</param>
|
||
<remarks>In comparison to <see cref="M:MediaBrowser.Controller.Library.ILibraryManager.DeleteItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.DeleteOptions,MediaBrowser.Controller.Entities.BaseItem,System.Boolean)"/> this method skips a lot of steps assuming there are no children to recusively delete nor does it define the special handling for channels and alike.</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.DeleteItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.DeleteOptions,System.Boolean)">
|
||
<summary>
|
||
Deletes the item.
|
||
</summary>
|
||
<param name="item">Item to delete.</param>
|
||
<param name="options">Options to use for deletion.</param>
|
||
<param name="notifyParentItem">Notify parent of deletion.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.DeleteItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.DeleteOptions,MediaBrowser.Controller.Entities.BaseItem,System.Boolean)">
|
||
<summary>
|
||
Deletes the item.
|
||
</summary>
|
||
<param name="item">Item to delete.</param>
|
||
<param name="options">Options to use for deletion.</param>
|
||
<param name="parent">Parent of item.</param>
|
||
<param name="notifyParentItem">Notify parent of deletion.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNamedView(Jellyfin.Database.Implementations.Entities.User,System.String,System.Guid,System.Nullable{Jellyfin.Data.Enums.CollectionType},System.String)">
|
||
<summary>
|
||
Gets the named view.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="name">The name.</param>
|
||
<param name="parentId">The parent identifier.</param>
|
||
<param name="viewType">Type of the view.</param>
|
||
<param name="sortName">Name of the sort.</param>
|
||
<returns>The named view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNamedView(Jellyfin.Database.Implementations.Entities.User,System.String,System.Nullable{Jellyfin.Data.Enums.CollectionType},System.String)">
|
||
<summary>
|
||
Gets the named view.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="name">The name.</param>
|
||
<param name="viewType">Type of the view.</param>
|
||
<param name="sortName">Name of the sort.</param>
|
||
<returns>The named view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNamedView(System.String,Jellyfin.Data.Enums.CollectionType,System.String)">
|
||
<summary>
|
||
Gets the named view.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<param name="viewType">Type of the view.</param>
|
||
<param name="sortName">Name of the sort.</param>
|
||
<returns>The named view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNamedView(System.String,System.Guid,System.Nullable{Jellyfin.Data.Enums.CollectionType},System.String,System.String)">
|
||
<summary>
|
||
Gets the named view.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<param name="parentId">The parent identifier.</param>
|
||
<param name="viewType">Type of the view.</param>
|
||
<param name="sortName">Name of the sort.</param>
|
||
<param name="uniqueId">The unique identifier.</param>
|
||
<returns>The named view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetShadowView(MediaBrowser.Controller.Entities.BaseItem,System.Nullable{Jellyfin.Data.Enums.CollectionType},System.String)">
|
||
<summary>
|
||
Gets the shadow view.
|
||
</summary>
|
||
<param name="parent">The parent.</param>
|
||
<param name="viewType">Type of the view.</param>
|
||
<param name="sortName">Name of the sort.</param>
|
||
<returns>The shadow view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetSeasonNumberFromPath(System.String,System.Nullable{System.Guid})">
|
||
<summary>
|
||
Gets the season number from path.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="parentId">The parent id.</param>
|
||
<returns>System.Nullable<System.Int32>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.FillMissingEpisodeNumbersFromPath(MediaBrowser.Controller.Entities.TV.Episode,System.Boolean)">
|
||
<summary>
|
||
Fills the missing episode numbers from path.
|
||
</summary>
|
||
<param name="episode">Episode to use.</param>
|
||
<param name="forceRefresh">Option to force refresh of episode numbers.</param>
|
||
<returns>True if successful.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ParseName(System.String)">
|
||
<summary>
|
||
Parses the name.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<returns>ItemInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNewItemId(System.String,System.Type)">
|
||
<summary>
|
||
Gets the new item identifier.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="type">The type.</param>
|
||
<returns>Guid.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.FindExtras(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.IO.FileSystemMetadata},MediaBrowser.Controller.Providers.IDirectoryService)">
|
||
<summary>
|
||
Finds the extras.
|
||
</summary>
|
||
<param name="owner">The owner.</param>
|
||
<param name="fileSystemChildren">The file system children.</param>
|
||
<param name="directoryService">An instance of <see cref="T:MediaBrowser.Controller.Providers.IDirectoryService"/>.</param>
|
||
<returns>IEnumerable<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetCollectionFolders(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the collection folders.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>The folders that contain the item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetCollectionFolders(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.Folder})">
|
||
<summary>
|
||
Gets the collection folders.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="allUserRootChildren">The root folders to consider.</param>
|
||
<returns>The folders that contain the item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetPeople(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the people.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>List<PersonInfo>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetPeople(MediaBrowser.Controller.Entities.InternalPeopleQuery)">
|
||
<summary>
|
||
Gets the people.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>List<PersonInfo>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetPeopleItems(MediaBrowser.Controller.Entities.InternalPeopleQuery)">
|
||
<summary>
|
||
Gets the people items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>List<Person>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.UpdatePeople(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.List{MediaBrowser.Controller.Entities.PersonInfo})">
|
||
<summary>
|
||
Updates the people.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="people">The people.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.UpdatePeopleAsync(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.PersonInfo},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously updates the people.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="people">The people.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The async task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemIds(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the item ids.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>List<Guid>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetPeopleNames(MediaBrowser.Controller.Entities.InternalPeopleQuery)">
|
||
<summary>
|
||
Gets the people names.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>List<System.String>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.QueryItems(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Queries the items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>QueryResult<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.ConvertImageToLocal(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.ItemImageInfo,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Converts the image to local.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="image">The image.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<param name="removeOnFailure">Whether to remove the image from the item on failure.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemList(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the items.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>QueryResult<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemList(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Collections.Generic.List{MediaBrowser.Controller.Entities.BaseItem})">
|
||
<summary>
|
||
Gets the items.
|
||
</summary>
|
||
<param name="query">The query to use.</param>
|
||
<param name="parents">Items to use for query.</param>
|
||
<returns>List of items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetLatestItemList(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},Jellyfin.Data.Enums.CollectionType)">
|
||
<summary>
|
||
Gets the TVShow/Album items for Latest api.
|
||
</summary>
|
||
<param name="query">The query to use.</param>
|
||
<param name="parents">Items to use for query.</param>
|
||
<param name="collectionType">Collection Type.</param>
|
||
<returns>List of items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetNextUpSeriesKeys(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Collections.Generic.IReadOnlyCollection{MediaBrowser.Controller.Entities.BaseItem},System.DateTime)">
|
||
<summary>
|
||
Gets the list of series presentation keys for next up.
|
||
</summary>
|
||
<param name="query">The query to use.</param>
|
||
<param name="parents">Items to use for query.</param>
|
||
<param name="dateCutoff">The minimum date for a series to have been most recently watched.</param>
|
||
<returns>List of series presentation keys.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.GetItemsResult(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the items result.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>QueryResult<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.IgnoreFile(MediaBrowser.Model.IO.FileSystemMetadata,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Checks if the file is ignored.
|
||
</summary>
|
||
<param name="file">The file.</param>
|
||
<param name="parent">The parent.</param>
|
||
<returns><c>true</c> if ignored, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.QueueLibraryScan">
|
||
<summary>
|
||
Queue a library scan.
|
||
</summary>
|
||
<remarks>
|
||
This exists so plugins can trigger a library scan.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryManager.CreateShortcut(System.String,MediaBrowser.Model.Configuration.MediaPathInfo)">
|
||
<summary>
|
||
Add mblink file for a media path.
|
||
</summary>
|
||
<param name="virtualFolderPath">The path to the virtualfolder.</param>
|
||
<param name="pathInfo">The new virtualfolder.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ILibraryMonitor">
|
||
<summary>
|
||
Service responsible for monitoring library filesystems for changes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryMonitor.Start">
|
||
<summary>
|
||
Starts this instance.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryMonitor.Stop">
|
||
<summary>
|
||
Stops this instance.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryMonitor.ReportFileSystemChangeBeginning(System.String)">
|
||
<summary>
|
||
Reports the file system change beginning.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryMonitor.ReportFileSystemChangeComplete(System.String,System.Boolean)">
|
||
<summary>
|
||
Reports the file system change complete.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="refreshPath">if set to <c>true</c> [refresh path].</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryMonitor.ReportFileSystemChanged(System.String)">
|
||
<summary>
|
||
Reports the file system changed.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ILibraryPostScanTask">
|
||
<summary>
|
||
An interface for tasks that run after the media library scan.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ILibraryPostScanTask.Run(System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Runs the specified progress.
|
||
</summary>
|
||
<param name="progress">The progress.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.AddParts(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Library.IMediaSourceProvider})">
|
||
<summary>
|
||
Adds the parts.
|
||
</summary>
|
||
<param name="providers">The providers.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaStreams(System.Guid)">
|
||
<summary>
|
||
Gets the media streams.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<returns>IEnumerable<MediaStream>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaStreams(MediaBrowser.Controller.Persistence.MediaStreamQuery)">
|
||
<summary>
|
||
Gets the media streams.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>IEnumerable<MediaStream>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaStreamsAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media streams asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList<MediaStream>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaStreamsAsync(MediaBrowser.Controller.Persistence.MediaStreamQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media streams asynchronously.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList<MediaStream>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaAttachments(System.Guid)">
|
||
<summary>
|
||
Gets the media attachments.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<returns>IEnumerable<MediaAttachment>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaAttachments(MediaBrowser.Controller.Persistence.MediaAttachmentQuery)">
|
||
<summary>
|
||
Gets the media attachments.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>IEnumerable<MediaAttachment>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaAttachmentsAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media attachments asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList<MediaAttachment>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaAttachmentsAsync(MediaBrowser.Controller.Persistence.MediaAttachmentQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media attachments asynchronously.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList<MediaAttachment>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetPlaybackMediaSources(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the playback media sources.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="user">User to use for operation.</param>
|
||
<param name="allowMediaProbe">Option to allow media probe.</param>
|
||
<param name="enablePathSubstitution">Option to enable path substitution.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>List of media sources wrapped in an awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetStaticMediaSources(MediaBrowser.Controller.Entities.BaseItem,System.Boolean,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the static media sources.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="enablePathSubstitution">Option to enable path substitution.</param>
|
||
<param name="user">User to use for operation.</param>
|
||
<returns>List of media sources.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetMediaSource(MediaBrowser.Controller.Entities.BaseItem,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the static media source.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="mediaSourceId">Media source to get.</param>
|
||
<param name="liveStreamId">Live stream to use.</param>
|
||
<param name="enablePathSubstitution">Option to enable path substitution.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>The static media source wrapped in an awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.OpenLiveStream(MediaBrowser.Model.MediaInfo.LiveStreamRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Opens the media source.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task<MediaSourceInfo>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetLiveStream(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the live stream.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task<MediaSourceInfo>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetLiveStreamInfo(System.String)">
|
||
<summary>
|
||
Gets the live stream info.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>An instance of <see cref="T:MediaBrowser.Controller.Library.ILiveStream"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetLiveStreamInfoByUniqueId(System.String)">
|
||
<summary>
|
||
Gets the live stream info using the stream's unique id.
|
||
</summary>
|
||
<param name="uniqueId">The unique identifier.</param>
|
||
<returns>An instance of <see cref="T:MediaBrowser.Controller.Library.ILiveStream"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.GetRecordingStreamMediaSources(MediaBrowser.Controller.LiveTv.ActiveRecordingInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media sources for an active recording.
|
||
</summary>
|
||
<param name="info">The <see cref="T:MediaBrowser.Controller.LiveTv.ActiveRecordingInfo"/>.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||
<returns>A task containing the <see cref="T:MediaBrowser.Model.Dto.MediaSourceInfo"/>'s for the recording.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceManager.CloseLiveStream(System.String)">
|
||
<summary>
|
||
Closes the media source.
|
||
</summary>
|
||
<param name="id">The live stream identifier.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceProvider.GetMediaSources(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media sources.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task<IEnumerable<MediaSourceInfo>>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMediaSourceProvider.OpenMediaSource(System.String,System.Collections.Generic.List{MediaBrowser.Controller.Library.ILiveStream},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Opens the media source.
|
||
</summary>
|
||
<param name="openToken">Token to use.</param>
|
||
<param name="currentLiveStreams">List of live streams.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>The media source wrapped as an awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMetadataFileSaver.GetSavePath(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the save path.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.IMetadataSaver">
|
||
<summary>
|
||
Interface IMetadataSaver.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IMetadataSaver.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMetadataSaver.IsEnabledFor(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.ItemUpdateType)">
|
||
<summary>
|
||
Determines whether [is enabled for] [the specified item].
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="updateType">Type of the update.</param>
|
||
<returns><c>true</c> if [is enabled for] [the specified item]; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMetadataSaver.SaveAsync(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the specified item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMusicManager.GetInstantMixFromItem(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the instant mix from song.
|
||
</summary>
|
||
<param name="item">The item to use.</param>
|
||
<param name="user">The user to use.</param>
|
||
<param name="dtoOptions">The options to use.</param>
|
||
<returns>List of items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMusicManager.GetInstantMixFromArtist(MediaBrowser.Controller.Entities.Audio.MusicArtist,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the instant mix from artist.
|
||
</summary>
|
||
<param name="artist">The artist to use.</param>
|
||
<param name="user">The user to use.</param>
|
||
<param name="dtoOptions">The options to use.</param>
|
||
<returns>List of items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IMusicManager.GetInstantMixFromGenres(System.Collections.Generic.IEnumerable{System.String},Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the instant mix from genre.
|
||
</summary>
|
||
<param name="genres">The genres to use.</param>
|
||
<param name="user">The user to use.</param>
|
||
<param name="dtoOptions">The options to use.</param>
|
||
<returns>List of items.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IntroInfo.Path">
|
||
<summary>
|
||
Gets or sets the path.
|
||
</summary>
|
||
<value>The path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IntroInfo.ItemId">
|
||
<summary>
|
||
Gets or sets the item id.
|
||
</summary>
|
||
<value>The item id.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ISearchEngine">
|
||
<summary>
|
||
Interface ILibrarySearchEngine.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ISearchEngine.GetSearchHints(MediaBrowser.Model.Search.SearchQuery)">
|
||
<summary>
|
||
Gets the search hints.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<returns>Task{IEnumerable{SearchHintInfo}}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ItemChangeEventArgs">
|
||
<summary>
|
||
Class ItemChangeEventArgs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemChangeEventArgs.Item">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
<value>The item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemChangeEventArgs.UpdateReason">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
<value>The item.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.ItemResolveArgs">
|
||
<summary>
|
||
These are arguments relating to the file system that are collected once and then referred to
|
||
whenever needed. Primarily for entity resolution.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Library.ItemResolveArgs._appPaths">
|
||
<summary>
|
||
The _app paths.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.#ctor(MediaBrowser.Controller.IServerApplicationPaths,MediaBrowser.Controller.Library.ILibraryManager)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Library.ItemResolveArgs" /> class.
|
||
</summary>
|
||
<param name="appPaths">The app paths.</param>
|
||
<param name="libraryManager">The library manager.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.FileSystemChildren">
|
||
<summary>
|
||
Gets or sets the file system children.
|
||
</summary>
|
||
<value>The file system children.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.Parent">
|
||
<summary>
|
||
Gets or sets the parent.
|
||
</summary>
|
||
<value>The parent.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.FileInfo">
|
||
<summary>
|
||
Gets or sets the file info.
|
||
</summary>
|
||
<value>The file info.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.Path">
|
||
<summary>
|
||
Gets the path.
|
||
</summary>
|
||
<value>The path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.IsDirectory">
|
||
<summary>
|
||
Gets a value indicating whether this instance is directory.
|
||
</summary>
|
||
<value><c>true</c> if this instance is directory; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.IsVf">
|
||
<summary>
|
||
Gets a value indicating whether this instance is vf.
|
||
</summary>
|
||
<value><c>true</c> if this instance is vf; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.IsPhysicalRoot">
|
||
<summary>
|
||
Gets a value indicating whether this instance is physical root.
|
||
</summary>
|
||
<value><c>true</c> if this instance is physical root; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.AdditionalLocations">
|
||
<summary>
|
||
Gets or sets the additional locations.
|
||
</summary>
|
||
<value>The additional locations.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.ItemResolveArgs.PhysicalLocations">
|
||
<summary>
|
||
Gets the physical locations.
|
||
</summary>
|
||
<value>The physical locations.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.Equals(System.Object)">
|
||
<summary>
|
||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||
</summary>
|
||
<param name="obj">The object to compare with the current object.</param>
|
||
<returns><c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.AddAdditionalLocation(System.String)">
|
||
<summary>
|
||
Adds the additional location.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <c>null</c> or empty.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.GetFileSystemEntryByName(System.String)">
|
||
<summary>
|
||
Gets the name of the file system entry by.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<returns>FileSystemInfo.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c> or empty.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.GetFileSystemEntryByPath(System.String)">
|
||
<summary>
|
||
Gets the file system entry by path.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>FileSystemInfo.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Throws if path is invalid.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.ContainsFileSystemEntryByName(System.String)">
|
||
<summary>
|
||
Determines whether [contains file system entry by name] [the specified name].
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<returns><c>true</c> if [contains file system entry by name] [the specified name]; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.GetConfiguredContentType">
|
||
<summary>
|
||
Gets the configured content type for the path.
|
||
</summary>
|
||
<returns>The configured content type.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.GetActualFileSystemChildren">
|
||
<summary>
|
||
Gets the file system children that do not hit the ignore file check.
|
||
</summary>
|
||
<returns>The file system children that are not ignored.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.GetHashCode">
|
||
<summary>
|
||
Returns a hash code for this instance.
|
||
</summary>
|
||
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.ItemResolveArgs.Equals(MediaBrowser.Controller.Library.ItemResolveArgs)">
|
||
<summary>
|
||
Equals the specified args.
|
||
</summary>
|
||
<param name="args">The args.</param>
|
||
<returns><c>true</c> if the arguments are the same, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.IUserDataManager">
|
||
<summary>
|
||
Interface IUserDataManager.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Library.IUserDataManager.UserDataSaved">
|
||
<summary>
|
||
Occurs when [user data saved].
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.SaveUserData(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.UserItemData,MediaBrowser.Model.Entities.UserDataSaveReason,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the user data.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="item">The item.</param>
|
||
<param name="userData">The user data.</param>
|
||
<param name="reason">The reason.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.SaveUserData(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Dto.UpdateUserItemDataDto,MediaBrowser.Model.Entities.UserDataSaveReason)">
|
||
<summary>
|
||
Save the provided user data for the given user.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="item">The item.</param>
|
||
<param name="userDataDto">The reason for updating the user data.</param>
|
||
<param name="reason">The reason.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.GetUserData(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the user data.
|
||
</summary>
|
||
<param name="user">User to use.</param>
|
||
<param name="item">Item to use.</param>
|
||
<returns>User data.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.GetUserDataDto(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the user data dto.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="user">User to use.</param>
|
||
<returns>User data dto.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.GetUserDataDto(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Dto.BaseItemDto,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the user data dto.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="itemDto">Item dto to use.</param>
|
||
<param name="user">User to use.</param>
|
||
<param name="options">Dto options to use.</param>
|
||
<returns>User data dto.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserDataManager.UpdatePlayState(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Entities.UserItemData,System.Nullable{System.Int64})">
|
||
<summary>
|
||
Updates playstate for an item and returns true or false indicating if it was played to completion.
|
||
</summary>
|
||
<param name="item">Item to update.</param>
|
||
<param name="data">Data to update.</param>
|
||
<param name="reportedPositionTicks">New playstate.</param>
|
||
<returns>True if playstate was updated.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.IUserManager">
|
||
<summary>
|
||
Interface IUserManager.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Library.IUserManager.OnUserUpdated">
|
||
<summary>
|
||
Occurs when a user is updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IUserManager.Users">
|
||
<summary>
|
||
Gets the users.
|
||
</summary>
|
||
<value>The users.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.IUserManager.UsersIds">
|
||
<summary>
|
||
Gets the user ids.
|
||
</summary>
|
||
<value>The users ids.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.InitializeAsync">
|
||
<summary>
|
||
Initializes the user manager and ensures that a user exists.
|
||
</summary>
|
||
<returns>Awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.GetUserById(System.Guid)">
|
||
<summary>
|
||
Gets a user by Id.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<returns>The user with the specified Id, or <c>null</c> if the user doesn't exist.</returns>
|
||
<exception cref="T:System.ArgumentException"><c>id</c> is an empty Guid.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.GetUserByName(System.String)">
|
||
<summary>
|
||
Gets the name of the user by.
|
||
</summary>
|
||
<param name="name">The name.</param>
|
||
<returns>User.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.RenameUser(Jellyfin.Database.Implementations.Entities.User,System.String)">
|
||
<summary>
|
||
Renames the user.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="newName">The new name.</param>
|
||
<returns>Task.</returns>
|
||
<exception cref="T:System.ArgumentNullException">If user is <c>null</c>.</exception>
|
||
<exception cref="T:System.ArgumentException">If the provided user doesn't exist.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.UpdateUserAsync(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Updates the user.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<exception cref="T:System.ArgumentNullException">If user is <c>null</c>.</exception>
|
||
<exception cref="T:System.ArgumentException">If the provided user doesn't exist.</exception>
|
||
<returns>A task representing the update of the user.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.CreateUserAsync(System.String)">
|
||
<summary>
|
||
Creates a user with the specified name.
|
||
</summary>
|
||
<param name="name">The name of the new user.</param>
|
||
<returns>The created user.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="name"/> already exists.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.DeleteUserAsync(System.Guid)">
|
||
<summary>
|
||
Deletes the specified user.
|
||
</summary>
|
||
<param name="userId">The id of the user to be deleted.</param>
|
||
<returns>A task representing the deletion of the user.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.ResetPassword(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Resets the password.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.ChangePassword(Jellyfin.Database.Implementations.Entities.User,System.String)">
|
||
<summary>
|
||
Changes the password.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="newPassword">New password to use.</param>
|
||
<returns>Awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.GetUserDto(Jellyfin.Database.Implementations.Entities.User,System.String)">
|
||
<summary>
|
||
Gets the user dto.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<param name="remoteEndPoint">The remote end point.</param>
|
||
<returns>UserDto.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.AuthenticateUser(System.String,System.String,System.String,System.Boolean)">
|
||
<summary>
|
||
Authenticates the user.
|
||
</summary>
|
||
<param name="username">The user.</param>
|
||
<param name="password">The password to use.</param>
|
||
<param name="remoteEndPoint">Remove endpoint to use.</param>
|
||
<param name="isUserSession">Specifies if a user session.</param>
|
||
<returns>User wrapped in awaitable task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.StartForgotPasswordProcess(System.String,System.Boolean)">
|
||
<summary>
|
||
Starts the forgot password process.
|
||
</summary>
|
||
<param name="enteredUsername">The entered username.</param>
|
||
<param name="isInNetwork">if set to <c>true</c> [is in network].</param>
|
||
<returns>ForgotPasswordResult.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.RedeemPasswordResetPin(System.String)">
|
||
<summary>
|
||
Redeems the password reset pin.
|
||
</summary>
|
||
<param name="pin">The pin.</param>
|
||
<returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.UpdateConfigurationAsync(System.Guid,MediaBrowser.Model.Configuration.UserConfiguration)">
|
||
<summary>
|
||
This method updates the user's configuration.
|
||
This is only included as a stopgap until the new API, using this internally is not recommended.
|
||
Instead, modify the user object directly, then call <see cref="M:MediaBrowser.Controller.Library.IUserManager.UpdateUserAsync(Jellyfin.Database.Implementations.Entities.User)"/>.
|
||
</summary>
|
||
<param name="userId">The user's Id.</param>
|
||
<param name="config">The request containing the new user configuration.</param>
|
||
<returns>A task representing the update.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.UpdatePolicyAsync(System.Guid,MediaBrowser.Model.Users.UserPolicy)">
|
||
<summary>
|
||
This method updates the user's policy.
|
||
This is only included as a stopgap until the new API, using this internally is not recommended.
|
||
Instead, modify the user object directly, then call <see cref="M:MediaBrowser.Controller.Library.IUserManager.UpdateUserAsync(Jellyfin.Database.Implementations.Entities.User)"/>.
|
||
</summary>
|
||
<param name="userId">The user's Id.</param>
|
||
<param name="policy">The request containing the new user policy.</param>
|
||
<returns>A task representing the update.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserManager.ClearProfileImageAsync(Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Clears the user's profile image.
|
||
</summary>
|
||
<param name="user">The user.</param>
|
||
<returns>A task representing the clearing of the profile image.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserViewManager.GetUserViews(MediaBrowser.Model.Library.UserViewQuery)">
|
||
<summary>
|
||
Gets user views.
|
||
</summary>
|
||
<param name="query">Query to use.</param>
|
||
<returns>Set of folders.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserViewManager.GetUserSubView(System.Guid,System.Nullable{Jellyfin.Data.Enums.CollectionType},System.String,System.String)">
|
||
<summary>
|
||
Gets user sub views.
|
||
</summary>
|
||
<param name="parentId">Parent to use.</param>
|
||
<param name="type">Type to use.</param>
|
||
<param name="localizationKey">Localization key to use.</param>
|
||
<param name="sortName">Sort to use.</param>
|
||
<returns>User view.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.IUserViewManager.GetLatestItems(MediaBrowser.Model.Querying.LatestItemsQuery,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets latest items.
|
||
</summary>
|
||
<param name="request">Query to use.</param>
|
||
<param name="options">Options to use.</param>
|
||
<returns>Set of items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.MetadataConfigurationExtensions.GetMetadataOptionsForType(MediaBrowser.Controller.Configuration.IServerConfigurationManager,System.String)">
|
||
<summary>
|
||
Gets the <see cref="T:MediaBrowser.Model.Configuration.MetadataOptions" /> for the specified type.
|
||
</summary>
|
||
<param name="config">The <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/>.</param>
|
||
<param name="type">The type to get the <see cref="T:MediaBrowser.Model.Configuration.MetadataOptions" /> for.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Model.Configuration.MetadataOptions" /> for the specified type or <c>null</c>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.PlaybackProgressEventArgs">
|
||
<summary>
|
||
Holds information about a playback progress event.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.PlaybackStartEventArgs">
|
||
<summary>
|
||
An event that occurs when playback is started.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.PlaybackStopEventArgs.PlayedToCompletion">
|
||
<summary>
|
||
Gets or sets a value indicating whether [played to completion].
|
||
</summary>
|
||
<value><c>true</c> if [played to completion]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.SearchHintInfo">
|
||
<summary>
|
||
Class SearchHintInfo.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.SearchHintInfo.Item">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
<value>The item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.SearchHintInfo.MatchedTerm">
|
||
<summary>
|
||
Gets or sets the matched term.
|
||
</summary>
|
||
<value>The matched term.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.TVUtils">
|
||
<summary>
|
||
Class TVUtils.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Library.TVUtils.GetAirDays(System.String)">
|
||
<summary>
|
||
Gets the air days.
|
||
</summary>
|
||
<param name="day">The day.</param>
|
||
<returns>List{DayOfWeek}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Library.UserDataSaveEventArgs">
|
||
<summary>
|
||
Class UserDataSaveEventArgs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.UserDataSaveEventArgs.UserId">
|
||
<summary>
|
||
Gets or sets the user id.
|
||
</summary>
|
||
<value>The user id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.UserDataSaveEventArgs.SaveReason">
|
||
<summary>
|
||
Gets or sets the save reason.
|
||
</summary>
|
||
<value>The save reason.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.UserDataSaveEventArgs.UserData">
|
||
<summary>
|
||
Gets or sets the user data.
|
||
</summary>
|
||
<value>The user data.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Library.UserDataSaveEventArgs.Item">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
<value>The item.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.ChannelInfo">
|
||
<summary>
|
||
Class ChannelInfo.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.Name">
|
||
<summary>
|
||
Gets or sets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.Number">
|
||
<summary>
|
||
Gets or sets the number.
|
||
</summary>
|
||
<value>The number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.Id">
|
||
<summary>
|
||
Gets or sets the Id.
|
||
</summary>
|
||
<value>The id of the channel.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.TunerHostId">
|
||
<summary>
|
||
Gets or sets the tuner host identifier.
|
||
</summary>
|
||
<value>The tuner host identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.ChannelType">
|
||
<summary>
|
||
Gets or sets the type of the channel.
|
||
</summary>
|
||
<value>The type of the channel.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.ChannelGroup">
|
||
<summary>
|
||
Gets or sets the group of the channel.
|
||
</summary>
|
||
<value>The group of the channel.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.ImagePath">
|
||
<summary>
|
||
Gets or sets the image path if it can be accessed directly from the file system.
|
||
</summary>
|
||
<value>The image path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.ImageUrl">
|
||
<summary>
|
||
Gets or sets the image url if it can be downloaded.
|
||
</summary>
|
||
<value>The image URL.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.HasImage">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance has image.
|
||
</summary>
|
||
<value><c>null</c> if [has image] contains no value, <c>true</c> if [has image]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ChannelInfo.IsFavorite">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is favorite.
|
||
</summary>
|
||
<value><c>null</c> if [is favorite] contains no value, <c>true</c> if [is favorite]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.IGuideManager">
|
||
<summary>
|
||
Service responsible for managing the Live TV guide.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IGuideManager.GetGuideInfo">
|
||
<summary>
|
||
Gets the guide information.
|
||
</summary>
|
||
<returns>The <see cref="T:MediaBrowser.Model.LiveTv.GuideInfo"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IGuideManager.RefreshGuide(System.IProgress{System.Double},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refresh the guide.
|
||
</summary>
|
||
<param name="progress">The <see cref="T:System.IProgress`1"/> to use.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||
<returns>Task representing the refresh operation.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.IListingsManager">
|
||
<summary>
|
||
Service responsible for managing <see cref="T:MediaBrowser.Controller.LiveTv.IListingsProvider"/>s and mapping
|
||
their channels to channels provided by <see cref="T:MediaBrowser.Controller.LiveTv.ITunerHost"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.SaveListingProvider(MediaBrowser.Model.LiveTv.ListingsProviderInfo,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
Saves the listing provider.
|
||
</summary>
|
||
<param name="info">The listing provider information.</param>
|
||
<param name="validateLogin">A value indicating whether to validate login.</param>
|
||
<param name="validateListings">A value indicating whether to validate listings..</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.DeleteListingsProvider(System.String)">
|
||
<summary>
|
||
Deletes the listing provider.
|
||
</summary>
|
||
<param name="id">The listing provider's id.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.GetLineups(System.String,System.String,System.String,System.String)">
|
||
<summary>
|
||
Gets the lineups.
|
||
</summary>
|
||
<param name="providerType">Type of the provider.</param>
|
||
<param name="providerId">The provider identifier.</param>
|
||
<param name="country">The country.</param>
|
||
<param name="location">The location.</param>
|
||
<returns>The available lineups.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.GetProgramsAsync(MediaBrowser.Controller.LiveTv.ChannelInfo,System.DateTime,System.DateTime,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the programs for a provided channel.
|
||
</summary>
|
||
<param name="channel">The channel to retrieve programs for.</param>
|
||
<param name="startDateUtc">The earliest date to retrieve programs for.</param>
|
||
<param name="endDateUtc">The latest date to retrieve programs for.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||
<returns>The available programs.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.AddProviderMetadata(System.Collections.Generic.IList{MediaBrowser.Controller.LiveTv.ChannelInfo},System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Adds metadata from the <see cref="T:MediaBrowser.Controller.LiveTv.IListingsProvider"/>s to the provided channels.
|
||
</summary>
|
||
<param name="channels">The channels.</param>
|
||
<param name="enableCache">A value indicating whether to use the EPG channel cache.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||
<returns>A task representing the metadata population.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.GetChannelMappingOptions(System.String)">
|
||
<summary>
|
||
Gets the channel mapping options for a provider.
|
||
</summary>
|
||
<param name="providerId">The id of the provider to use.</param>
|
||
<returns>The channel mapping options.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IListingsManager.SetChannelMapping(System.String,System.String,System.String)">
|
||
<summary>
|
||
Sets the channel mapping.
|
||
</summary>
|
||
<param name="providerId">The id of the provider for the mapping.</param>
|
||
<param name="tunerChannelNumber">The tuner channel number.</param>
|
||
<param name="providerChannelNumber">The provider channel number.</param>
|
||
<returns>The updated channel mapping.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.ILiveTvManager">
|
||
<summary>
|
||
Manages all live tv services installed on the server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ILiveTvManager.Services">
|
||
<summary>
|
||
Gets the services.
|
||
</summary>
|
||
<value>The services.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetNewTimerDefaults(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the new timer defaults asynchronous.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{TimerInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetNewTimerDefaults(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the new timer defaults.
|
||
</summary>
|
||
<param name="programId">The program identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{SeriesTimerInfoDto}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.CancelTimer(System.String)">
|
||
<summary>
|
||
Cancels the timer.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.CancelSeriesTimer(System.String)">
|
||
<summary>
|
||
Cancels the series timer.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetTimer(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the timer.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{TimerInfoDto}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetSeriesTimer(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the series timer.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{TimerInfoDto}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetRecordingsAsync(MediaBrowser.Model.LiveTv.RecordingQuery,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the recordings.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="options">The options.</param>
|
||
<returns>A recording.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetTimers(MediaBrowser.Model.LiveTv.TimerQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the timers.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{QueryResult{TimerInfoDto}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetSeriesTimers(MediaBrowser.Model.LiveTv.SeriesTimerQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the series timers.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{QueryResult{SeriesTimerInfoDto}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetProgram(System.String,System.Threading.CancellationToken,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Gets the program.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>Task{ProgramInfoDto}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetPrograms(MediaBrowser.Controller.Entities.InternalItemsQuery,MediaBrowser.Controller.Dto.DtoOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the programs.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IEnumerable{ProgramInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.UpdateTimer(MediaBrowser.Model.LiveTv.TimerInfoDto,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the timer.
|
||
</summary>
|
||
<param name="timer">The timer.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.UpdateSeriesTimer(MediaBrowser.Model.LiveTv.SeriesTimerInfoDto,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the timer.
|
||
</summary>
|
||
<param name="timer">The timer.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.CreateTimer(MediaBrowser.Model.LiveTv.TimerInfoDto,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the timer.
|
||
</summary>
|
||
<param name="timer">The timer.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.CreateSeriesTimer(MediaBrowser.Model.LiveTv.SeriesTimerInfoDto,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the series timer.
|
||
</summary>
|
||
<param name="timer">The timer.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetRecommendedProgramsAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,MediaBrowser.Controller.Dto.DtoOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the recommended programs.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Recommended programs.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetRecommendedProgramsInternal(MediaBrowser.Controller.Entities.InternalItemsQuery,MediaBrowser.Controller.Dto.DtoOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the recommended programs internal.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Recommended programs.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetLiveTvInfo(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the live tv information.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{LiveTvInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.ResetTuner(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Resets the tuner.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetInternalLiveTvFolder(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the live tv folder.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Live TV folder.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetEnabledUsers">
|
||
<summary>
|
||
Gets the enabled users.
|
||
</summary>
|
||
<returns>IEnumerable{User}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.GetInternalChannels(MediaBrowser.Model.LiveTv.LiveTvChannelQuery,MediaBrowser.Controller.Dto.DtoOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the internal channels.
|
||
</summary>
|
||
<param name="query">The query.</param>
|
||
<param name="dtoOptions">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Internal channels.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.AddInfoToProgramDto(System.Collections.Generic.IReadOnlyCollection{System.ValueTuple{MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Dto.BaseItemDto}},System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Querying.ItemFields},Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Adds the information to program dto.
|
||
</summary>
|
||
<param name="programs">The programs.</param>
|
||
<param name="fields">The fields.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvManager.AddChannelInfo(System.Collections.Generic.IReadOnlyCollection{System.ValueTuple{MediaBrowser.Model.Dto.BaseItemDto,MediaBrowser.Controller.LiveTv.LiveTvChannel}},MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Adds the channel information.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="user">The user.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.ILiveTvService">
|
||
<summary>
|
||
Represents a single live tv back end (next pvr, media portal, etc).
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ILiveTvService.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ILiveTvService.HomePageUrl">
|
||
<summary>
|
||
Gets the home page URL.
|
||
</summary>
|
||
<value>The home page URL.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetChannelsAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channels async.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{ChannelInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.CancelTimerAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Cancels the timer asynchronous.
|
||
</summary>
|
||
<param name="timerId">The timer identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.CancelSeriesTimerAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Cancels the series timer asynchronous.
|
||
</summary>
|
||
<param name="timerId">The timer identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.CreateTimerAsync(MediaBrowser.Controller.LiveTv.TimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the timer asynchronous.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.CreateSeriesTimerAsync(MediaBrowser.Controller.LiveTv.SeriesTimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the series timer asynchronous.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.UpdateTimerAsync(MediaBrowser.Controller.LiveTv.TimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the timer asynchronous.
|
||
</summary>
|
||
<param name="updatedTimer">The updated timer information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.UpdateSeriesTimerAsync(MediaBrowser.Controller.LiveTv.SeriesTimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the series timer asynchronous.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetTimersAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the recordings asynchronous.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{RecordingInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetNewTimerDefaultsAsync(System.Threading.CancellationToken,MediaBrowser.Controller.LiveTv.ProgramInfo)">
|
||
<summary>
|
||
Gets the new timer defaults asynchronous.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<param name="program">The program.</param>
|
||
<returns>Task{SeriesTimerInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetSeriesTimersAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the series timers asynchronous.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{SeriesTimerInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetProgramsAsync(System.String,System.DateTime,System.DateTime,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the programs asynchronous.
|
||
</summary>
|
||
<param name="channelId">The channel identifier.</param>
|
||
<param name="startDateUtc">The start date UTC.</param>
|
||
<param name="endDateUtc">The end date UTC.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{ProgramInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetChannelStream(System.String,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel stream.
|
||
</summary>
|
||
<param name="channelId">The channel identifier.</param>
|
||
<param name="streamId">The stream identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{Stream}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.GetChannelStreamMediaSources(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel stream media sources.
|
||
</summary>
|
||
<param name="channelId">The channel identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task<List<MediaSourceInfo>>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.CloseLiveStream(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Closes the live stream.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ILiveTvService.ResetTuner(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Resets the tuner.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ISupportsNewTimerIds.CreateTimer(MediaBrowser.Controller.LiveTv.TimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the timer asynchronous.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ISupportsNewTimerIds.CreateSeriesTimer(MediaBrowser.Controller.LiveTv.SeriesTimerInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates the series timer asynchronous.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.IRecordingsManager">
|
||
<summary>
|
||
Service responsible for managing LiveTV recordings.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.GetActiveRecordingPath(System.String)">
|
||
<summary>
|
||
Gets the path for the provided timer id.
|
||
</summary>
|
||
<param name="id">The timer id.</param>
|
||
<returns>The recording path, or <c>null</c> if none exists.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.GetActiveRecordingInfo(System.String)">
|
||
<summary>
|
||
Gets the information for an active recording.
|
||
</summary>
|
||
<param name="path">The recording path.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Controller.LiveTv.ActiveRecordingInfo"/>, or <c>null</c> if none exists.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.GetRecordingFolders">
|
||
<summary>
|
||
Gets the recording folders.
|
||
</summary>
|
||
<returns>The <see cref="T:MediaBrowser.Model.Entities.VirtualFolderInfo"/> for each recording folder.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.CreateRecordingFolders">
|
||
<summary>
|
||
Ensures that the recording folders all exist, and removes unused folders.
|
||
</summary>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.CancelRecording(System.String,MediaBrowser.Controller.LiveTv.TimerInfo)">
|
||
<summary>
|
||
Cancels the recording with the provided timer id, if one is active.
|
||
</summary>
|
||
<param name="timerId">The timer id.</param>
|
||
<param name="timer">The timer.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IRecordingsManager.RecordStream(MediaBrowser.Controller.LiveTv.ActiveRecordingInfo,MediaBrowser.Controller.Entities.BaseItem,System.DateTime)">
|
||
<summary>
|
||
Records a stream.
|
||
</summary>
|
||
<param name="recordingInfo">The recording info.</param>
|
||
<param name="channel">The channel associated with the recording timer.</param>
|
||
<param name="recordingEndDate">The time to stop recording.</param>
|
||
<returns>Task representing the recording process.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ITunerHost.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ITunerHost.Type">
|
||
<summary>
|
||
Gets the type.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHost.GetChannels(System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channels.
|
||
</summary>
|
||
<param name="enableCache">Option to enable using cache.</param>
|
||
<param name="cancellationToken">The CancellationToken for this operation.</param>
|
||
<returns>Task<IEnumerable<ChannelInfo>>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHost.GetChannelStream(System.String,System.String,System.Collections.Generic.IList{MediaBrowser.Controller.Library.ILiveStream},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel stream.
|
||
</summary>
|
||
<param name="channelId">The channel identifier.</param>
|
||
<param name="streamId">The stream identifier.</param>
|
||
<param name="currentLiveStreams">The current live streams.</param>
|
||
<param name="cancellationToken">The cancellation token to cancel operation.</param>
|
||
<returns>Live stream wrapped in a task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHost.GetChannelStreamMediaSources(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the channel stream media sources.
|
||
</summary>
|
||
<param name="channelId">The channel identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task<List<MediaSourceInfo>>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.IConfigurableTunerHost.Validate(MediaBrowser.Model.LiveTv.TunerHostInfo)">
|
||
<summary>
|
||
Validates the specified information.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.ITunerHostManager">
|
||
<summary>
|
||
Service responsible for managing the <see cref="T:MediaBrowser.Controller.LiveTv.ITunerHost"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ITunerHostManager.TunerHosts">
|
||
<summary>
|
||
Gets the available <see cref="T:MediaBrowser.Controller.LiveTv.ITunerHost"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHostManager.GetTunerHostTypes">
|
||
<summary>
|
||
Gets the <see cref="T:MediaBrowser.Model.Dto.NameIdPair"/>s for the available <see cref="T:MediaBrowser.Controller.LiveTv.ITunerHost"/>s.
|
||
</summary>
|
||
<returns>The <see cref="T:MediaBrowser.Model.Dto.NameIdPair"/>s.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHostManager.SaveTunerHost(MediaBrowser.Model.LiveTv.TunerHostInfo,System.Boolean)">
|
||
<summary>
|
||
Saves the tuner host.
|
||
</summary>
|
||
<param name="info">Turner host to save.</param>
|
||
<param name="dataSourceChanged">Option to specify that data source has changed.</param>
|
||
<returns>Tuner host information wrapped in a task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHostManager.DiscoverTuners(System.Boolean)">
|
||
<summary>
|
||
Discovers the available tuners.
|
||
</summary>
|
||
<param name="newDevicesOnly">A value indicating whether to only return new devices.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Model.LiveTv.TunerHostInfo"/>s.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.LiveTv.ITunerHostManager.ScanForTunerDeviceChanges(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Scans for tuner devices that have changed URLs.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||
<returns>A task that represents the scanning operation.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.Number">
|
||
<summary>
|
||
Gets or sets the number.
|
||
</summary>
|
||
<value>The number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.ChannelType">
|
||
<summary>
|
||
Gets or sets the type of the channel.
|
||
</summary>
|
||
<value>The type of the channel.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.IsSports">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is sports.
|
||
</summary>
|
||
<value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.IsSeries">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is series.
|
||
</summary>
|
||
<value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.IsNews">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is news.
|
||
</summary>
|
||
<value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.IsKids">
|
||
<summary>
|
||
Gets a value indicating whether this instance is kids.
|
||
</summary>
|
||
<value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvChannel.EpisodeTitle">
|
||
<summary>
|
||
Gets or sets the episode title.
|
||
</summary>
|
||
<value>The episode title.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.LiveTv.LiveTvConflictException">
|
||
<summary>
|
||
Class LiveTvConflictException.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.StartDate">
|
||
<summary>
|
||
Gets or sets start date of the program, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsRepeat">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is repeat.
|
||
</summary>
|
||
<value><c>true</c> if this instance is repeat; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.EpisodeTitle">
|
||
<summary>
|
||
Gets or sets the episode title.
|
||
</summary>
|
||
<value>The episode title.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsMovie">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is movie.
|
||
</summary>
|
||
<value><c>true</c> if this instance is movie; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsSports">
|
||
<summary>
|
||
Gets a value indicating whether this instance is sports.
|
||
</summary>
|
||
<value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsSeries">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is series.
|
||
</summary>
|
||
<value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsLive">
|
||
<summary>
|
||
Gets a value indicating whether this instance is live.
|
||
</summary>
|
||
<value><c>true</c> if this instance is live; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsNews">
|
||
<summary>
|
||
Gets a value indicating whether this instance is news.
|
||
</summary>
|
||
<value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsKids">
|
||
<summary>
|
||
Gets a value indicating whether this instance is kids.
|
||
</summary>
|
||
<value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.IsPremiere">
|
||
<summary>
|
||
Gets a value indicating whether this instance is premiere.
|
||
</summary>
|
||
<value><c>true</c> if this instance is premiere; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.LiveTvProgram.ContainingFolderPath">
|
||
<summary>
|
||
Gets the folder containing the item.
|
||
If the item is a folder, it returns the folder itself.
|
||
</summary>
|
||
<value>The containing folder path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Id">
|
||
<summary>
|
||
Gets or sets the id of the program.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ChannelId">
|
||
<summary>
|
||
Gets or sets the channel identifier.
|
||
</summary>
|
||
<value>The channel identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Name">
|
||
<summary>
|
||
Gets or sets the name of the program.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.OfficialRating">
|
||
<summary>
|
||
Gets or sets the official rating.
|
||
</summary>
|
||
<value>The official rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Overview">
|
||
<summary>
|
||
Gets or sets the overview.
|
||
</summary>
|
||
<value>The overview.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ShortOverview">
|
||
<summary>
|
||
Gets or sets the short overview.
|
||
</summary>
|
||
<value>The short overview.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.StartDate">
|
||
<summary>
|
||
Gets or sets the start date of the program, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.EndDate">
|
||
<summary>
|
||
Gets or sets the end date of the program, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Genres">
|
||
<summary>
|
||
Gets or sets the genre of the program.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.OriginalAirDate">
|
||
<summary>
|
||
Gets or sets the original air date.
|
||
</summary>
|
||
<value>The original air date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsHD">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is hd.
|
||
</summary>
|
||
<value><c>true</c> if this instance is hd; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Is3D">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is 3d.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Audio">
|
||
<summary>
|
||
Gets or sets the audio.
|
||
</summary>
|
||
<value>The audio.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.CommunityRating">
|
||
<summary>
|
||
Gets or sets the community rating.
|
||
</summary>
|
||
<value>The community rating.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsRepeat">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is repeat.
|
||
</summary>
|
||
<value><c>true</c> if this instance is repeat; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.EpisodeTitle">
|
||
<summary>
|
||
Gets or sets the episode title.
|
||
</summary>
|
||
<value>The episode title.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ImagePath">
|
||
<summary>
|
||
Gets or sets the image path if it can be accessed directly from the file system.
|
||
</summary>
|
||
<value>The image path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ImageUrl">
|
||
<summary>
|
||
Gets or sets the image url if it can be downloaded.
|
||
</summary>
|
||
<value>The image URL.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.HasImage">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance has image.
|
||
</summary>
|
||
<value><c>null</c> if [has image] contains no value, <c>true</c> if [has image]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsMovie">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is movie.
|
||
</summary>
|
||
<value><c>true</c> if this instance is movie; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsSports">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is sports.
|
||
</summary>
|
||
<value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsSeries">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is series.
|
||
</summary>
|
||
<value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsLive">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is live.
|
||
</summary>
|
||
<value><c>true</c> if this instance is live; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsNews">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is news.
|
||
</summary>
|
||
<value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsKids">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is kids.
|
||
</summary>
|
||
<value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.IsPremiere">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is premiere.
|
||
</summary>
|
||
<value><c>true</c> if this instance is premiere; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ProductionYear">
|
||
<summary>
|
||
Gets or sets the production year.
|
||
</summary>
|
||
<value>The production year.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.HomePageUrl">
|
||
<summary>
|
||
Gets or sets the home page URL.
|
||
</summary>
|
||
<value>The home page URL.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.SeriesId">
|
||
<summary>
|
||
Gets or sets the series identifier.
|
||
</summary>
|
||
<value>The series identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.ShowId">
|
||
<summary>
|
||
Gets or sets the show identifier.
|
||
</summary>
|
||
<value>The show identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.SeasonNumber">
|
||
<summary>
|
||
Gets or sets the season number.
|
||
</summary>
|
||
<value>The season number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.EpisodeNumber">
|
||
<summary>
|
||
Gets or sets the episode number.
|
||
</summary>
|
||
<value>The episode number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.ProgramInfo.Etag">
|
||
<summary>
|
||
Gets or sets the etag.
|
||
</summary>
|
||
<value>The etag.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.Id">
|
||
<summary>
|
||
Gets or sets the id of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.ChannelId">
|
||
<summary>
|
||
Gets or sets the channelId of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.ProgramId">
|
||
<summary>
|
||
Gets or sets the program identifier.
|
||
</summary>
|
||
<value>The program identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.Name">
|
||
<summary>
|
||
Gets or sets the name of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.ServiceName">
|
||
<summary>
|
||
Gets or sets the service name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.Overview">
|
||
<summary>
|
||
Gets or sets the description of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.StartDate">
|
||
<summary>
|
||
Gets or sets the start date of the recording, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.EndDate">
|
||
<summary>
|
||
Gets or sets the end date of the recording, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.RecordAnyTime">
|
||
<summary>
|
||
Gets or sets a value indicating whether [record any time].
|
||
</summary>
|
||
<value><c>true</c> if [record any time]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.RecordAnyChannel">
|
||
<summary>
|
||
Gets or sets a value indicating whether [record any channel].
|
||
</summary>
|
||
<value><c>true</c> if [record any channel]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.RecordNewOnly">
|
||
<summary>
|
||
Gets or sets a value indicating whether [record new only].
|
||
</summary>
|
||
<value><c>true</c> if [record new only]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.Days">
|
||
<summary>
|
||
Gets or sets the days.
|
||
</summary>
|
||
<value>The days.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.Priority">
|
||
<summary>
|
||
Gets or sets the priority.
|
||
</summary>
|
||
<value>The priority.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.PrePaddingSeconds">
|
||
<summary>
|
||
Gets or sets the pre padding seconds.
|
||
</summary>
|
||
<value>The pre padding seconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.PostPaddingSeconds">
|
||
<summary>
|
||
Gets or sets the post padding seconds.
|
||
</summary>
|
||
<value>The post padding seconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.IsPrePaddingRequired">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is pre padding required.
|
||
</summary>
|
||
<value><c>true</c> if this instance is pre padding required; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.IsPostPaddingRequired">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is post padding required.
|
||
</summary>
|
||
<value><c>true</c> if this instance is post padding required; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.SeriesTimerInfo.SeriesId">
|
||
<summary>
|
||
Gets or sets the series identifier.
|
||
</summary>
|
||
<value>The series identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.Id">
|
||
<summary>
|
||
Gets or sets the id of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.SeriesTimerId">
|
||
<summary>
|
||
Gets or sets the series timer identifier.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.ChannelId">
|
||
<summary>
|
||
Gets or sets the channelId of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.ProgramId">
|
||
<summary>
|
||
Gets or sets the program identifier.
|
||
</summary>
|
||
<value>The program identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.Name">
|
||
<summary>
|
||
Gets or sets the name of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.Overview">
|
||
<summary>
|
||
Gets or sets the description of the recording.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.StartDate">
|
||
<summary>
|
||
Gets or sets the start date of the recording, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.EndDate">
|
||
<summary>
|
||
Gets or sets the end date of the recording, in UTC.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.Status">
|
||
<summary>
|
||
Gets or sets the status.
|
||
</summary>
|
||
<value>The status.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.PrePaddingSeconds">
|
||
<summary>
|
||
Gets or sets the pre padding seconds.
|
||
</summary>
|
||
<value>The pre padding seconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.PostPaddingSeconds">
|
||
<summary>
|
||
Gets or sets the post padding seconds.
|
||
</summary>
|
||
<value>The post padding seconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.IsPrePaddingRequired">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is pre padding required.
|
||
</summary>
|
||
<value><c>true</c> if this instance is pre padding required; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.IsPostPaddingRequired">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is post padding required.
|
||
</summary>
|
||
<value><c>true</c> if this instance is post padding required; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.Priority">
|
||
<summary>
|
||
Gets or sets the priority.
|
||
</summary>
|
||
<value>The priority.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.EpisodeNumber">
|
||
<summary>
|
||
Gets or sets the episode number.
|
||
</summary>
|
||
<value>The episode number.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.LiveTv.TimerInfo.IsLive">
|
||
<summary>
|
||
Gets a value indicating whether this instance is live.
|
||
</summary>
|
||
<value><c>true</c> if this instance is live; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Lyrics.ILyricManager">
|
||
<summary>
|
||
Interface ILyricManager.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Lyrics.ILyricManager.LyricDownloadFailure">
|
||
<summary>
|
||
Occurs when a lyric download fails.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.SearchLyricsAsync(MediaBrowser.Controller.Entities.Audio.Audio,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Search for lyrics for the specified song.
|
||
</summary>
|
||
<param name="audio">The song.</param>
|
||
<param name="isAutomated">Whether the request is automated.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>The list of lyrics.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.SearchLyricsAsync(MediaBrowser.Model.Lyrics.LyricSearchRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Search for lyrics.
|
||
</summary>
|
||
<param name="request">The search request.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>The list of lyrics.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.DownloadLyricsAsync(MediaBrowser.Controller.Entities.Audio.Audio,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Download the lyrics.
|
||
</summary>
|
||
<param name="audio">The audio.</param>
|
||
<param name="lyricId">The remote lyric id.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>The downloaded lyrics.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.DownloadLyricsAsync(MediaBrowser.Controller.Entities.Audio.Audio,MediaBrowser.Model.Configuration.LibraryOptions,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Download the lyrics.
|
||
</summary>
|
||
<param name="audio">The audio.</param>
|
||
<param name="libraryOptions">The library options to use.</param>
|
||
<param name="lyricId">The remote lyric id.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>The downloaded lyrics.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.SaveLyricAsync(MediaBrowser.Controller.Entities.Audio.Audio,System.String,System.String)">
|
||
<summary>
|
||
Saves new lyrics.
|
||
</summary>
|
||
<param name="audio">The audio file the lyrics belong to.</param>
|
||
<param name="format">The lyrics format.</param>
|
||
<param name="lyrics">The lyrics.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.SaveLyricAsync(MediaBrowser.Controller.Entities.Audio.Audio,System.String,System.IO.Stream)">
|
||
<summary>
|
||
Saves new lyrics.
|
||
</summary>
|
||
<param name="audio">The audio file the lyrics belong to.</param>
|
||
<param name="format">The lyrics format.</param>
|
||
<param name="lyrics">The lyrics.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.GetRemoteLyricsAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Get the remote lyrics.
|
||
</summary>
|
||
<param name="id">The remote lyrics id.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>The lyric response.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.DeleteLyricsAsync(MediaBrowser.Controller.Entities.Audio.Audio)">
|
||
<summary>
|
||
Deletes the lyrics.
|
||
</summary>
|
||
<param name="audio">The audio file to remove lyrics from.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.GetSupportedProviders(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Get the list of lyric providers.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>Lyric providers.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricManager.GetLyricsAsync(MediaBrowser.Controller.Entities.Audio.Audio,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Get the existing lyric for the audio.
|
||
</summary>
|
||
<param name="audio">The audio item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The parsed lyric model.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Lyrics.ILyricParser">
|
||
<summary>
|
||
Interface ILyricParser.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.ILyricParser.Name">
|
||
<summary>
|
||
Gets a value indicating the provider name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.ILyricParser.Priority">
|
||
<summary>
|
||
Gets the priority.
|
||
</summary>
|
||
<value>The priority.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricParser.ParseLyrics(MediaBrowser.Model.Lyrics.LyricFile)">
|
||
<summary>
|
||
Parses the raw lyrics into a response.
|
||
</summary>
|
||
<param name="lyrics">The raw lyrics content.</param>
|
||
<returns>The parsed lyrics or null if invalid.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Lyrics.ILyricProvider">
|
||
<summary>
|
||
Interface ILyricsProvider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.ILyricProvider.Name">
|
||
<summary>
|
||
Gets the provider name.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricProvider.SearchAsync(MediaBrowser.Model.Lyrics.LyricSearchRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Search for lyrics.
|
||
</summary>
|
||
<param name="request">The search request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The list of remote lyrics.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Lyrics.ILyricProvider.GetLyricsAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Get the lyrics.
|
||
</summary>
|
||
<param name="id">The remote lyric id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The lyric response.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Lyrics.LyricDownloadFailureEventArgs">
|
||
<summary>
|
||
An event that occurs when subtitle downloading fails.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.LyricDownloadFailureEventArgs.Item">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.LyricDownloadFailureEventArgs.Provider">
|
||
<summary>
|
||
Gets or sets the provider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Lyrics.LyricDownloadFailureEventArgs.Exception">
|
||
<summary>
|
||
Gets or sets the exception.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Id">
|
||
<summary>
|
||
Gets or sets the id.
|
||
</summary>
|
||
<value>The id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.AudioCodec">
|
||
<summary>
|
||
Gets or sets the audio codec.
|
||
</summary>
|
||
<value>The audio codec.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.AudioSampleRate">
|
||
<summary>
|
||
Gets or sets the audio sample rate.
|
||
</summary>
|
||
<value>The audio sample rate.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.AudioBitRate">
|
||
<summary>
|
||
Gets or sets the audio bit rate.
|
||
</summary>
|
||
<value>The audio bit rate.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.AudioChannels">
|
||
<summary>
|
||
Gets or sets the audio channels.
|
||
</summary>
|
||
<value>The audio channels.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Profile">
|
||
<summary>
|
||
Gets or sets the profile.
|
||
</summary>
|
||
<value>The profile.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.VideoRangeType">
|
||
<summary>
|
||
Gets or sets the video range type.
|
||
</summary>
|
||
<value>The video range type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Level">
|
||
<summary>
|
||
Gets or sets the level.
|
||
</summary>
|
||
<value>The level.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.CodecTag">
|
||
<summary>
|
||
Gets or sets the codec tag.
|
||
</summary>
|
||
<value>The codec tag.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Framerate">
|
||
<summary>
|
||
Gets or sets the framerate.
|
||
</summary>
|
||
<value>The framerate.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.StartTimeTicks">
|
||
<summary>
|
||
Gets or sets the start time ticks.
|
||
</summary>
|
||
<value>The start time ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Width">
|
||
<summary>
|
||
Gets or sets the width.
|
||
</summary>
|
||
<value>The width.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.Height">
|
||
<summary>
|
||
Gets or sets the height.
|
||
</summary>
|
||
<value>The height.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.MaxWidth">
|
||
<summary>
|
||
Gets or sets the width of the max.
|
||
</summary>
|
||
<value>The width of the max.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.MaxHeight">
|
||
<summary>
|
||
Gets or sets the height of the max.
|
||
</summary>
|
||
<value>The height of the max.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.VideoBitRate">
|
||
<summary>
|
||
Gets or sets the video bit rate.
|
||
</summary>
|
||
<value>The video bit rate.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.SubtitleStreamIndex">
|
||
<summary>
|
||
Gets or sets the index of the subtitle stream.
|
||
</summary>
|
||
<value>The index of the subtitle stream.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.VideoCodec">
|
||
<summary>
|
||
Gets or sets the video codec.
|
||
</summary>
|
||
<value>The video codec.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.AudioStreamIndex">
|
||
<summary>
|
||
Gets or sets the index of the audio stream.
|
||
</summary>
|
||
<value>The index of the audio stream.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.BaseEncodingJobOptions.VideoStreamIndex">
|
||
<summary>
|
||
Gets or sets the index of the video stream.
|
||
</summary>
|
||
<value>The index of the video stream.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType">
|
||
<summary>
|
||
Enum BitStreamFilterOptionType.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType.HevcMetadataRemoveDovi">
|
||
<summary>
|
||
hevc_metadata bsf with remove_dovi option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType.HevcMetadataRemoveHdr10Plus">
|
||
<summary>
|
||
hevc_metadata bsf with remove_hdr10plus option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType.Av1MetadataRemoveDovi">
|
||
<summary>
|
||
av1_metadata bsf with remove_dovi option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType.Av1MetadataRemoveHdr10Plus">
|
||
<summary>
|
||
av1_metadata bsf with remove_hdr10plus option.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType.DoviRpuStrip">
|
||
<summary>
|
||
dovi_rpu bsf with strip option.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.DownMixAlgorithmsHelper">
|
||
<summary>
|
||
Describes the downmix algorithms capabilities.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.DownMixAlgorithmsHelper.AlgorithmFilterStrings">
|
||
<summary>
|
||
The filter string of the DownMixStereoAlgorithms.
|
||
The index is the tuple of (algorithm, layout).
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.DownMixAlgorithmsHelper.InferChannelLayout(MediaBrowser.Model.Entities.MediaStream)">
|
||
<summary>
|
||
Get the audio channel layout string from the audio stream
|
||
If the input audio string does not have a valid layout string, guess from channel count.
|
||
</summary>
|
||
<param name="audioStream">The audio stream to get layout.</param>
|
||
<returns>Channel Layout string.</returns>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.EncodingHelper.ContainerValidationRegex">
|
||
<summary>
|
||
The codec validation regex.
|
||
This regular expression matches strings that consist of alphanumeric characters, hyphens,
|
||
periods, underscores, commas, and vertical bars, with a length between 0 and 40 characters.
|
||
This should matches all common valid codecs.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.EncodingHelper.LevelValidationRegex">
|
||
<summary>
|
||
The level validation regex.
|
||
This regular expression matches strings representing a double.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.WhiteSpaceRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>\s+</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match a whitespace character atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetVideoEncoder(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions)">
|
||
<summary>
|
||
Gets the name of the output video codec.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="encodingOptions">Encoding options.</param>
|
||
<returns>Encoder string.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetUserAgentParam(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Gets the user agent param.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetRefererParam(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Gets the referer param.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetDecoderFromCodec(System.String)">
|
||
<summary>
|
||
Gets decoder from a codec.
|
||
</summary>
|
||
<param name="codec">Codec to use.</param>
|
||
<returns>Decoder string.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.InferAudioCodec(System.String)">
|
||
<summary>
|
||
Infers the audio codec based on the url.
|
||
</summary>
|
||
<param name="container">Container to use.</param>
|
||
<returns>Codec string.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.InferVideoCodec(System.String)">
|
||
<summary>
|
||
Infers the video codec.
|
||
</summary>
|
||
<param name="url">The URL.</param>
|
||
<returns>System.Nullable{VideoCodecs}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetAudioEncoder(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Gets the audio encoder.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetInputVideoHwaccelArgs(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions)">
|
||
<summary>
|
||
Gets the input video hwaccel argument.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<returns>Input video hwaccel arguments.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetInputArgument(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the input argument.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="segmentContainer">Segment Container.</param>
|
||
<returns>Input arguments.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.IsH264(MediaBrowser.Model.Entities.MediaStream)">
|
||
<summary>
|
||
Determines whether the specified stream is H264.
|
||
</summary>
|
||
<param name="stream">The stream.</param>
|
||
<returns><c>true</c> if the specified stream is H264; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.ShouldRemoveDynamicHdrMetadata(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Check if dynamic HDR metadata should be removed during stream copy.
|
||
Please note this check assumes the range check has already been done
|
||
and trivial fallbacks like HDR10+ to HDR10, DOVIWithHDR10 to HDR10 is already checked.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetTextSubtitlesFilter(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
Gets the text subtitle param.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<param name="enableAlpha">Enable alpha processing.</param>
|
||
<param name="enableSub2video">Enable sub2video mode.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetVideoQualityParam(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,System.String,MediaBrowser.Model.Configuration.EncodingOptions,MediaBrowser.Model.Entities.EncoderPreset)">
|
||
<summary>
|
||
Gets the video bitrate to specify on the command line.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="videoEncoder">Video encoder to use.</param>
|
||
<param name="encodingOptions">Encoding options.</param>
|
||
<param name="defaultPreset">Default present to use for encoding.</param>
|
||
<returns>Video bitrate.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetNumAudioChannelsParam(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Entities.MediaStream,System.String)">
|
||
<summary>
|
||
Gets the number of audio channels to specify on the command line.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<param name="audioStream">The audio stream.</param>
|
||
<param name="outputAudioCodec">The output audio codec.</param>
|
||
<returns>System.Nullable{System.Int32}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.EnforceResolutionLimit(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Enforces the resolution limit.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetFastSeekCommandLineParameter(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the fast seek command line parameter.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="segmentContainer">Segment Container.</param>
|
||
<returns>System.String.</returns>
|
||
<value>The fast seek command line parameter.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetMapArgs(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Gets the map args.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetNegativeMapArgsByFilters(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,System.String)">
|
||
<summary>
|
||
Gets the negative map args by filters.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<param name="videoProcessFilters">The videoProcessFilters.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetMediaStream(System.Collections.Generic.IEnumerable{MediaBrowser.Model.Entities.MediaStream},System.Nullable{System.Int32},MediaBrowser.Model.Entities.MediaStreamType,System.Boolean)">
|
||
<summary>
|
||
Determines which stream will be used for playback.
|
||
</summary>
|
||
<param name="allStream">All stream.</param>
|
||
<param name="desiredIndex">Index of the desired.</param>
|
||
<param name="type">The type.</param>
|
||
<param name="returnFirstIfNoIndex">if set to <c>true</c> [return first if no index].</param>
|
||
<returns>MediaStream.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetSwVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of software filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetNvidiaVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of Nvidia NVENC filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetAmdVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of AMD AMF filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetIntelVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of Intel QSV filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetVaapiVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of Intel/AMD VAAPI filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetAppleVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of Apple VideoToolBox filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetRkmppVidFilterChain(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of Rockchip RKMPP/RKRGA filter chain.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="vidEncoder">Video encoder to use.</param>
|
||
<returns>The tuple contains three lists: main, sub and overlay filters.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetVideoProcessingFilterParam(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the parameter of video processing filters.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="outputVideoCodec">Video codec to use.</param>
|
||
<returns>The video processing filters parameter.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetHardwareVideoDecoder(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions)">
|
||
<summary>
|
||
Gets the ffmpeg option string for the hardware accelerated video decoder.
|
||
</summary>
|
||
<param name="state">The encoding job info.</param>
|
||
<param name="options">The encoding options.</param>
|
||
<returns>The option string or null if none available.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetHwDecoderName(MediaBrowser.Model.Configuration.EncodingOptions,System.String,System.String,System.String,System.Int32)">
|
||
<summary>
|
||
Gets a hw decoder name.
|
||
</summary>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="decoderPrefix">Decoder prefix.</param>
|
||
<param name="decoderSuffix">Decoder suffix.</param>
|
||
<param name="videoCodec">Video codec to use.</param>
|
||
<param name="bitDepth">Video color bit depth.</param>
|
||
<returns>Hardware decoder name.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetHwaccelType(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Gets a hwaccel type to use as a hardware decoder depending on the system.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="options">Encoding options.</param>
|
||
<param name="videoCodec">Video codec to use.</param>
|
||
<param name="bitDepth">Video color bit depth.</param>
|
||
<param name="outputHwSurface">Specifies if output hw surface.</param>
|
||
<returns>Hardware accelerator type.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetNumberOfThreads(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,System.String)">
|
||
<summary>
|
||
Gets the number of threads.
|
||
</summary>
|
||
<param name="state">Encoding state.</param>
|
||
<param name="encodingOptions">Encoding options.</param>
|
||
<param name="outputVideoCodec">Video codec to use.</param>
|
||
<returns>Number of threads.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.AttachMediaSourceInfo(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo,MediaBrowser.Model.Configuration.EncodingOptions,MediaBrowser.Model.Dto.MediaSourceInfo,System.String)">
|
||
<summary>
|
||
Attaches media source information to the encoding job state.
|
||
</summary>
|
||
<param name="state">The encoding job state.</param>
|
||
<param name="encodingOptions">The encoding options.</param>
|
||
<param name="mediaSource">The media source information.</param>
|
||
<param name="requestedUrl">The requested URL.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.EncodingHelper.GetVideoSyncOption(System.String,System.Version)">
|
||
<summary>
|
||
Gets the video sync option based on the encoder version.
|
||
</summary>
|
||
<param name="videoSync">The video sync parameter.</param>
|
||
<param name="encoderVersion">The encoder version.</param>
|
||
<returns>The video sync option string.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetVideoLevel">
|
||
<summary>
|
||
Gets the target video level.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetVideoBitDepth">
|
||
<summary>
|
||
Gets the target video bit depth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetRefFrames">
|
||
<summary>
|
||
Gets the target reference frames.
|
||
</summary>
|
||
<value>The target reference frames.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetFramerate">
|
||
<summary>
|
||
Gets the target framerate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetPacketLength">
|
||
<summary>
|
||
Gets the target packet length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetVideoProfile">
|
||
<summary>
|
||
Gets the target video profile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo.TargetVideoRangeType">
|
||
<summary>
|
||
Gets the target video range type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.FilterOptionType">
|
||
<summary>
|
||
Enum FilterOptionType.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.ScaleCudaFormat">
|
||
<summary>
|
||
The scale_cuda_format.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.TonemapCudaName">
|
||
<summary>
|
||
The tonemap_cuda_name.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.TonemapOpenclBt2390">
|
||
<summary>
|
||
The tonemap_opencl_bt2390.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.OverlayOpenclFrameSync">
|
||
<summary>
|
||
The overlay_opencl_framesync.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.OverlayVaapiFrameSync">
|
||
<summary>
|
||
The overlay_vaapi_framesync.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.OverlayVulkanFrameSync">
|
||
<summary>
|
||
The overlay_vulkan_framesync.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.TransposeOpenclReversal">
|
||
<summary>
|
||
The transpose_opencl_reversal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.OverlayOpenclAlphaFormat">
|
||
<summary>
|
||
The overlay_opencl_alpha_format.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.FilterOptionType.OverlayCudaAlphaFormat">
|
||
<summary>
|
||
The overlay_cuda_alpha_format.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IAttachmentExtractor.GetAttachment(MediaBrowser.Controller.Entities.BaseItem,System.String,System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the path to the attachment file.
|
||
</summary>
|
||
<param name="item">The <see cref="T:MediaBrowser.Controller.Entities.BaseItem"/>.</param>
|
||
<param name="mediaSourceId">The media source id.</param>
|
||
<param name="attachmentStreamIndex">The attachment index.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The async task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IAttachmentExtractor.ExtractAllAttachments(System.String,MediaBrowser.Model.Dto.MediaSourceInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the path to the attachment file.
|
||
</summary>
|
||
<param name="inputFile">The input file path.</param>
|
||
<param name="mediaSource">The <see cref="T:MediaBrowser.Model.Dto.MediaSourceInfo" /> source id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The async task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder">
|
||
<summary>
|
||
Interface IMediaEncoder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.EncoderPath">
|
||
<summary>
|
||
Gets the encoder path.
|
||
</summary>
|
||
<value>The encoder path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.ProbePath">
|
||
<summary>
|
||
Gets the probe path.
|
||
</summary>
|
||
<value>The probe path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.EncoderVersion">
|
||
<summary>
|
||
Gets the version of encoder.
|
||
</summary>
|
||
<returns>The version of encoder.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsPkeyPauseSupported">
|
||
<summary>
|
||
Gets a value indicating whether p key pausing is supported.
|
||
</summary>
|
||
<value><c>true</c> if p key pausing is supported, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVaapiDeviceAmd">
|
||
<summary>
|
||
Gets a value indicating whether the configured Vaapi device is from AMD(radeonsi/r600 Mesa driver).
|
||
</summary>
|
||
<value><c>true</c> if the Vaapi device is an AMD(radeonsi/r600 Mesa driver) GPU, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVaapiDeviceInteliHD">
|
||
<summary>
|
||
Gets a value indicating whether the configured Vaapi device is from Intel(iHD driver).
|
||
</summary>
|
||
<value><c>true</c> if the Vaapi device is an Intel(iHD driver) GPU, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVaapiDeviceInteli965">
|
||
<summary>
|
||
Gets a value indicating whether the configured Vaapi device is from Intel(legacy i965 driver).
|
||
</summary>
|
||
<value><c>true</c> if the Vaapi device is an Intel(legacy i965 driver) GPU, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVaapiDeviceSupportVulkanDrmModifier">
|
||
<summary>
|
||
Gets a value indicating whether the configured Vaapi device supports vulkan drm format modifier.
|
||
</summary>
|
||
<value><c>true</c> if the Vaapi device supports vulkan drm format modifier, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVaapiDeviceSupportVulkanDrmInterop">
|
||
<summary>
|
||
Gets a value indicating whether the configured Vaapi device supports vulkan drm interop via dma-buf.
|
||
</summary>
|
||
<value><c>true</c> if the Vaapi device supports vulkan drm interop, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.IsVideoToolboxAv1DecodeAvailable">
|
||
<summary>
|
||
Gets a value indicating whether av1 decoding is available via VideoToolbox.
|
||
</summary>
|
||
<value><c>true</c> if the av1 is available via VideoToolbox, <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsEncoder(System.String)">
|
||
<summary>
|
||
Whether given encoder codec is supported.
|
||
</summary>
|
||
<param name="encoder">The encoder.</param>
|
||
<returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsDecoder(System.String)">
|
||
<summary>
|
||
Whether given decoder codec is supported.
|
||
</summary>
|
||
<param name="decoder">The decoder.</param>
|
||
<returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsHwaccel(System.String)">
|
||
<summary>
|
||
Whether given hardware acceleration type is supported.
|
||
</summary>
|
||
<param name="hwaccel">The hwaccel.</param>
|
||
<returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsFilter(System.String)">
|
||
<summary>
|
||
Whether given filter is supported.
|
||
</summary>
|
||
<param name="filter">The filter.</param>
|
||
<returns><c>true</c> if the filter is supported, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsFilterWithOption(MediaBrowser.Controller.MediaEncoding.FilterOptionType)">
|
||
<summary>
|
||
Whether filter is supported with the given option.
|
||
</summary>
|
||
<param name="option">The option.</param>
|
||
<returns><c>true</c> if the filter is supported, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SupportsBitStreamFilterWithOption(MediaBrowser.Controller.MediaEncoding.BitStreamFilterOptionType)">
|
||
<summary>
|
||
Whether the bitstream filter is supported with the given option.
|
||
</summary>
|
||
<param name="option">The option.</param>
|
||
<returns><c>true</c> if the bitstream filter is supported, <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.ExtractAudioImage(System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Extracts the audio image.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="imageStreamIndex">Index of the image stream.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{Stream}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.ExtractVideoImage(System.String,System.String,MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Entities.MediaStream,System.Nullable{MediaBrowser.Model.Entities.Video3DFormat},System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Extracts the video image.
|
||
</summary>
|
||
<param name="inputFile">Input file.</param>
|
||
<param name="container">Video container type.</param>
|
||
<param name="mediaSource">Media source information.</param>
|
||
<param name="videoStream">Media stream information.</param>
|
||
<param name="threedFormat">Video 3D format.</param>
|
||
<param name="offset">Time offset.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>Location of video image.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.ExtractVideoImage(System.String,System.String,MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Entities.MediaStream,System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Extracts the video image.
|
||
</summary>
|
||
<param name="inputFile">Input file.</param>
|
||
<param name="container">Video container type.</param>
|
||
<param name="mediaSource">Media source information.</param>
|
||
<param name="imageStream">Media stream information.</param>
|
||
<param name="imageStreamIndex">Index of the stream to extract from.</param>
|
||
<param name="targetFormat">The format of the file to write.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>Location of video image.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.ExtractVideoImagesOnIntervalAccelerated(System.String,System.String,MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Entities.MediaStream,System.Int32,System.TimeSpan,System.Boolean,System.Boolean,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Diagnostics.ProcessPriorityClass},System.Boolean,MediaBrowser.Controller.MediaEncoding.EncodingHelper,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Extracts the video images on interval.
|
||
</summary>
|
||
<param name="inputFile">Input file.</param>
|
||
<param name="container">Video container type.</param>
|
||
<param name="mediaSource">Media source information.</param>
|
||
<param name="imageStream">Media stream information.</param>
|
||
<param name="maxWidth">The maximum width.</param>
|
||
<param name="interval">The interval.</param>
|
||
<param name="allowHwAccel">Allow for hardware acceleration.</param>
|
||
<param name="enableHwEncoding">Use hardware mjpeg encoder.</param>
|
||
<param name="threads">The input/output thread count for ffmpeg.</param>
|
||
<param name="qualityScale">The qscale value for ffmpeg.</param>
|
||
<param name="priority">The process priority for the ffmpeg process.</param>
|
||
<param name="enableKeyFrameOnlyExtraction">Whether to only extract key frames.</param>
|
||
<param name="encodingHelper">EncodingHelper instance.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Directory where images where extracted. A given image made before another will always be named with a lower number.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetMediaInfo(MediaBrowser.Controller.MediaEncoding.MediaInfoRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media info.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetInputArgument(System.String,MediaBrowser.Model.Dto.MediaSourceInfo)">
|
||
<summary>
|
||
Gets the input argument.
|
||
</summary>
|
||
<param name="inputFile">The input file.</param>
|
||
<param name="mediaSource">The mediaSource.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetInputArgument(System.Collections.Generic.IReadOnlyList{System.String},MediaBrowser.Model.Dto.MediaSourceInfo)">
|
||
<summary>
|
||
Gets the input argument.
|
||
</summary>
|
||
<param name="inputFiles">The input files.</param>
|
||
<param name="mediaSource">The mediaSource.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetExternalSubtitleInputArgument(System.String)">
|
||
<summary>
|
||
Gets the input argument for an external subtitle file.
|
||
</summary>
|
||
<param name="inputFile">The input file.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetTimeParameter(System.Int64)">
|
||
<summary>
|
||
Gets the time parameter.
|
||
</summary>
|
||
<param name="ticks">The ticks.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.EscapeSubtitleFilterPath(System.String)">
|
||
<summary>
|
||
Escapes the subtitle filter path.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.SetFFmpegPath">
|
||
<summary>
|
||
Sets the path to find FFmpeg.
|
||
</summary>
|
||
<returns>bool indicates whether a valid ffmpeg is found.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetPrimaryPlaylistVobFiles(System.String,System.Nullable{System.UInt32})">
|
||
<summary>
|
||
Gets the primary playlist of .vob files.
|
||
</summary>
|
||
<param name="path">The to the .vob files.</param>
|
||
<param name="titleNumber">The title number to start with.</param>
|
||
<returns>A playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetPrimaryPlaylistM2tsFiles(System.String)">
|
||
<summary>
|
||
Gets the primary playlist of .m2ts files.
|
||
</summary>
|
||
<param name="path">The to the .m2ts files.</param>
|
||
<returns>A playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetInputPathArgument(MediaBrowser.Controller.MediaEncoding.EncodingJobInfo)">
|
||
<summary>
|
||
Gets the input path argument from <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo"/>.
|
||
</summary>
|
||
<param name="state">The <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingJobInfo"/>.</param>
|
||
<returns>The input path argument.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GetInputPathArgument(System.String,MediaBrowser.Model.Dto.MediaSourceInfo)">
|
||
<summary>
|
||
Gets the input path argument.
|
||
</summary>
|
||
<param name="path">The item path.</param>
|
||
<param name="mediaSource">The <see cref="T:MediaBrowser.Model.Dto.MediaSourceInfo"/>.</param>
|
||
<returns>The input path argument.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.IMediaEncoder.GenerateConcatConfig(MediaBrowser.Model.Dto.MediaSourceInfo,System.String)">
|
||
<summary>
|
||
Generates a FFmpeg concat config for the source.
|
||
</summary>
|
||
<param name="source">The <see cref="T:MediaBrowser.Model.Dto.MediaSourceInfo"/>.</param>
|
||
<param name="concatFilePath">The path the config should be written to.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder.GetSubtitles(MediaBrowser.Controller.Entities.BaseItem,System.String,System.Int32,System.String,System.Int64,System.Int64,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the subtitles.
|
||
</summary>
|
||
<param name="item">Item to use.</param>
|
||
<param name="mediaSourceId">Media source.</param>
|
||
<param name="subtitleStreamIndex">Subtitle stream to use.</param>
|
||
<param name="outputFormat">Output format to use.</param>
|
||
<param name="startTimeTicks">Start time.</param>
|
||
<param name="endTimeTicks">End time.</param>
|
||
<param name="preserveOriginalTimestamps">Option to preserve original timestamps.</param>
|
||
<param name="cancellationToken">The cancellation token for the operation.</param>
|
||
<returns>Task{Stream}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder.GetSubtitleFileCharacterSet(MediaBrowser.Model.Entities.MediaStream,System.String,MediaBrowser.Model.Dto.MediaSourceInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the subtitle language encoding parameter.
|
||
</summary>
|
||
<param name="subtitleStream">The subtitle stream.</param>
|
||
<param name="language">The language.</param>
|
||
<param name="mediaSource">The media source.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder.GetSubtitleFilePath(MediaBrowser.Model.Entities.MediaStream,MediaBrowser.Model.Dto.MediaSourceInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the path to a subtitle file.
|
||
</summary>
|
||
<param name="subtitleStream">The subtitle stream.</param>
|
||
<param name="mediaSource">The media source.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>System.String.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder.ExtractAllExtractableSubtitles(MediaBrowser.Model.Dto.MediaSourceInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Extracts all extractable subtitles (text and pgs).
|
||
</summary>
|
||
<param name="mediaSource">The mediaSource.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager">
|
||
<summary>
|
||
A service for managing media transcoding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.GetTranscodingJob(System.String)">
|
||
<summary>
|
||
Get transcoding job.
|
||
</summary>
|
||
<param name="playSessionId">Playback session id.</param>
|
||
<returns>The transcoding job.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.GetTranscodingJob(System.String,MediaBrowser.Controller.MediaEncoding.TranscodingJobType)">
|
||
<summary>
|
||
Get transcoding job.
|
||
</summary>
|
||
<param name="path">Path to the transcoding file.</param>
|
||
<param name="type">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType"/>.</param>
|
||
<returns>The transcoding job.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.PingTranscodingJob(System.String,System.Nullable{System.Boolean})">
|
||
<summary>
|
||
Ping transcoding job.
|
||
</summary>
|
||
<param name="playSessionId">Play session id.</param>
|
||
<param name="isUserPaused">Is user paused.</param>
|
||
<exception cref="T:System.ArgumentNullException">Play session id is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.KillTranscodingJobs(System.String,System.String,System.Func{System.String,System.Boolean})">
|
||
<summary>
|
||
Kills the single transcoding job.
|
||
</summary>
|
||
<param name="deviceId">The device id.</param>
|
||
<param name="playSessionId">The play session identifier.</param>
|
||
<param name="deleteFiles">The delete files.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.ReportTranscodingProgress(MediaBrowser.Controller.MediaEncoding.TranscodingJob,MediaBrowser.Controller.Streaming.StreamState,System.Nullable{System.TimeSpan},System.Nullable{System.Single},System.Nullable{System.Double},System.Nullable{System.Int64},System.Nullable{System.Int32})">
|
||
<summary>
|
||
Report the transcoding progress to the session manager.
|
||
</summary>
|
||
<param name="job">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJob"/> of which the progress will be reported.</param>
|
||
<param name="state">The <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/> of the current transcoding job.</param>
|
||
<param name="transcodingPosition">The current transcoding position.</param>
|
||
<param name="framerate">The framerate of the transcoding job.</param>
|
||
<param name="percentComplete">The completion percentage of the transcode.</param>
|
||
<param name="bytesTranscoded">The number of bytes transcoded.</param>
|
||
<param name="bitRate">The bitrate of the transcoding job.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.StartFfMpeg(MediaBrowser.Controller.Streaming.StreamState,System.String,System.String,System.Guid,MediaBrowser.Controller.MediaEncoding.TranscodingJobType,System.Threading.CancellationTokenSource,System.String)">
|
||
<summary>
|
||
Starts FFMpeg.
|
||
</summary>
|
||
<param name="state">The state.</param>
|
||
<param name="outputPath">The output path.</param>
|
||
<param name="commandLineArguments">The command line arguments for FFmpeg.</param>
|
||
<param name="userId">The user id.</param>
|
||
<param name="transcodingJobType">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType"/>.</param>
|
||
<param name="cancellationTokenSource">The cancellation token source.</param>
|
||
<param name="workingDirectory">The working directory.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.OnTranscodeBeginRequest(System.String,MediaBrowser.Controller.MediaEncoding.TranscodingJobType)">
|
||
<summary>
|
||
Called when [transcode begin request].
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="type">The type.</param>
|
||
<returns>The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJob"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.OnTranscodeEndRequest(MediaBrowser.Controller.MediaEncoding.TranscodingJob)">
|
||
<summary>
|
||
Called when [transcode end].
|
||
</summary>
|
||
<param name="job">The transcode job.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.ITranscodeManager.LockAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Transcoding lock.
|
||
</summary>
|
||
<param name="outputPath">The output path of the transcoded file.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>An <see cref="T:System.IDisposable"/>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.TranscodingJob">
|
||
<summary>
|
||
Class TranscodingJob.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.#ctor(Microsoft.Extensions.Logging.ILogger{MediaBrowser.Controller.MediaEncoding.TranscodingJob})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJob"/> class.
|
||
</summary>
|
||
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.PlaySessionId">
|
||
<summary>
|
||
Gets or sets the play session identifier.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.LiveStreamId">
|
||
<summary>
|
||
Gets or sets the live stream identifier.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.IsLiveOutput">
|
||
<summary>
|
||
Gets or sets a value indicating whether is live output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.MediaSource">
|
||
<summary>
|
||
Gets or sets the path.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Path">
|
||
<summary>
|
||
Gets or sets path.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Type">
|
||
<summary>
|
||
Gets or sets the type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Process">
|
||
<summary>
|
||
Gets or sets the process.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.ActiveRequestCount">
|
||
<summary>
|
||
Gets or sets the active request count.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.DeviceId">
|
||
<summary>
|
||
Gets or sets device id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.CancellationTokenSource">
|
||
<summary>
|
||
Gets or sets cancellation token source.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.HasExited">
|
||
<summary>
|
||
Gets or sets a value indicating whether has exited.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.ExitCode">
|
||
<summary>
|
||
Gets or sets exit code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.IsUserPaused">
|
||
<summary>
|
||
Gets or sets a value indicating whether is user paused.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Id">
|
||
<summary>
|
||
Gets or sets id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Framerate">
|
||
<summary>
|
||
Gets or sets framerate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.CompletionPercentage">
|
||
<summary>
|
||
Gets or sets completion percentage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.BytesDownloaded">
|
||
<summary>
|
||
Gets or sets bytes downloaded.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.BytesTranscoded">
|
||
<summary>
|
||
Gets or sets bytes transcoded.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.BitRate">
|
||
<summary>
|
||
Gets or sets bit rate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.TranscodingPositionTicks">
|
||
<summary>
|
||
Gets or sets transcoding position ticks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.DownloadPositionTicks">
|
||
<summary>
|
||
Gets or sets download position ticks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.TranscodingThrottler">
|
||
<summary>
|
||
Gets or sets transcoding throttler.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.TranscodingSegmentCleaner">
|
||
<summary>
|
||
Gets or sets transcoding segment cleaner.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.LastPingDate">
|
||
<summary>
|
||
Gets or sets last ping date.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaEncoding.TranscodingJob.PingTimeout">
|
||
<summary>
|
||
Gets or sets ping timeout.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.StopKillTimer">
|
||
<summary>
|
||
Stop kill timer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.DisposeKillTimer">
|
||
<summary>
|
||
Dispose kill timer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.StartKillTimer(System.Action{System.Object})">
|
||
<summary>
|
||
Start kill timer.
|
||
</summary>
|
||
<param name="callback">Callback action.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.StartKillTimer(System.Action{System.Object},System.Int32)">
|
||
<summary>
|
||
Start kill timer.
|
||
</summary>
|
||
<param name="callback">Callback action.</param>
|
||
<param name="intervalMs">Callback interval.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.ChangeKillTimerIfStarted">
|
||
<summary>
|
||
Change kill timer if started.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Stop">
|
||
<summary>
|
||
Stops the transcoding job.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingJob.Dispose">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType">
|
||
<summary>
|
||
Enum TranscodingJobType.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.TranscodingJobType.Progressive">
|
||
<summary>
|
||
The progressive.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.TranscodingJobType.Hls">
|
||
<summary>
|
||
The HLS.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.MediaEncoding.TranscodingJobType.Dash">
|
||
<summary>
|
||
The dash.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner">
|
||
<summary>
|
||
Transcoding segment cleaner.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner.#ctor(MediaBrowser.Controller.MediaEncoding.TranscodingJob,Microsoft.Extensions.Logging.ILogger{MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner},MediaBrowser.Common.Configuration.IConfigurationManager,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner"/> class.
|
||
</summary>
|
||
<param name="job">Transcoding job dto.</param>
|
||
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
||
<param name="config">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IConfigurationManager"/> interface.</param>
|
||
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
||
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
||
<param name="segmentLength">The segment length of this transcoding job.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner.Start">
|
||
<summary>
|
||
Start timer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner.Stop">
|
||
<summary>
|
||
Stop cleaner.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner.Dispose">
|
||
<summary>
|
||
Dispose cleaner.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingSegmentCleaner.Dispose(System.Boolean)">
|
||
<summary>
|
||
Dispose cleaner.
|
||
</summary>
|
||
<param name="disposing">Disposing.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler">
|
||
<summary>
|
||
Transcoding throttler.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.#ctor(MediaBrowser.Controller.MediaEncoding.TranscodingJob,Microsoft.Extensions.Logging.ILogger{MediaBrowser.Controller.MediaEncoding.TranscodingThrottler},MediaBrowser.Common.Configuration.IConfigurationManager,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.MediaEncoding.IMediaEncoder)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler"/> class.
|
||
</summary>
|
||
<param name="job">Transcoding job dto.</param>
|
||
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
||
<param name="config">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IConfigurationManager"/> interface.</param>
|
||
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
||
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.Start">
|
||
<summary>
|
||
Start timer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.UnpauseTranscoding">
|
||
<summary>
|
||
Unpause transcoding.
|
||
</summary>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.Stop">
|
||
<summary>
|
||
Stop throttler.
|
||
</summary>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.Dispose">
|
||
<summary>
|
||
Dispose throttler.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaEncoding.TranscodingThrottler.Dispose(System.Boolean)">
|
||
<summary>
|
||
Dispose throttler.
|
||
</summary>
|
||
<param name="disposing">Disposing.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager">
|
||
<summary>
|
||
Defines methods for interacting with media segments.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.RunSegmentPluginProviders(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.LibraryOptions,System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Uses all segment providers enabled for the <see cref="T:MediaBrowser.Controller.Entities.BaseItem"/>'s library to get the Media Segments.
|
||
</summary>
|
||
<param name="baseItem">The Item to evaluate.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<param name="forceOverwrite">If set, will force to remove existing segments and replace it with new ones otherwise will check for existing segments and if found any that should not be deleted, stops.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task that indicates the Operation is finished.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.IsTypeSupported(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Returns if this item supports media segments.
|
||
</summary>
|
||
<param name="baseItem">The base Item to check.</param>
|
||
<returns>True if supported otherwise false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.CreateSegmentAsync(MediaBrowser.Model.MediaSegments.MediaSegmentDto,System.String)">
|
||
<summary>
|
||
Creates a new Media Segment associated with an Item.
|
||
</summary>
|
||
<param name="mediaSegment">The segment to create.</param>
|
||
<param name="segmentProviderId">The id of the Provider who created this segment.</param>
|
||
<returns>The created Segment entity.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.DeleteSegmentAsync(System.Guid)">
|
||
<summary>
|
||
Deletes a single media segment.
|
||
</summary>
|
||
<param name="segmentId">The <see cref="P:Jellyfin.Database.Implementations.Entities.MediaSegment.Id"/> to delete.</param>
|
||
<returns>a task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.DeleteSegmentsAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes all media segments of an item.
|
||
</summary>
|
||
<param name="itemId">The <see cref="P:MediaBrowser.Controller.Entities.BaseItem.Id"/> to delete all segments for.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>a task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.GetSegmentsAsync(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.IEnumerable{Jellyfin.Database.Implementations.Enums.MediaSegmentType},MediaBrowser.Model.Configuration.LibraryOptions,System.Boolean)">
|
||
<summary>
|
||
Obtains all segments associated with the itemId.
|
||
</summary>
|
||
<param name="item">The <see cref="T:MediaBrowser.Controller.Entities.BaseItem"/>.</param>
|
||
<param name="typeFilter">filters all media segments of the given type to be included. If null all types are included.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<param name="filterByProvider">When set filters the segments to only return those that which providers are currently enabled on their library.</param>
|
||
<returns>An enumerator of <see cref="T:MediaBrowser.Model.MediaSegments.MediaSegmentDto"/>'s.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.HasSegments(System.Guid)">
|
||
<summary>
|
||
Gets information about any media segments stored for the given itemId.
|
||
</summary>
|
||
<param name="itemId">The id of the <see cref="T:MediaBrowser.Controller.Entities.BaseItem"/>.</param>
|
||
<returns>True if there are any segments stored for the item, otherwise false.</returns>
|
||
TODO: this should be async but as the only caller BaseItem.GetVersionInfo isn't async, this is also not. Venson.
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentManager.GetSupportedProviders(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets a list of all registered Segment Providers and their IDs.
|
||
</summary>
|
||
<param name="item">The media item that should be tested for providers.</param>
|
||
<returns>A list of all providers for the tested item.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.MediaSegments.IMediaSegmentProvider">
|
||
<summary>
|
||
Provides methods for Obtaining the Media Segments from an Item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.MediaSegments.IMediaSegmentProvider.Name">
|
||
<summary>
|
||
Gets the provider name.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentProvider.GetMediaSegments(MediaBrowser.Model.MediaSegmentGenerationRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Enumerates all Media Segments from an Media Item.
|
||
</summary>
|
||
<param name="request">Arguments to enumerate MediaSegments.</param>
|
||
<param name="cancellationToken">Abort token.</param>
|
||
<returns>A list of all MediaSegments found from this provider.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.MediaSegments.IMediaSegmentProvider.Supports(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Should return support state for the given item.
|
||
</summary>
|
||
<param name="item">The base item to extract segments from.</param>
|
||
<returns>True if item is supported, otherwise false.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.AuthorizationInfo">
|
||
<summary>
|
||
The request authorization info.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.UserId">
|
||
<summary>
|
||
Gets the user identifier.
|
||
</summary>
|
||
<value>The user identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.DeviceId">
|
||
<summary>
|
||
Gets or sets the device identifier.
|
||
</summary>
|
||
<value>The device identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.Device">
|
||
<summary>
|
||
Gets or sets the device.
|
||
</summary>
|
||
<value>The device.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.Client">
|
||
<summary>
|
||
Gets or sets the client.
|
||
</summary>
|
||
<value>The client.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.Version">
|
||
<summary>
|
||
Gets or sets the version.
|
||
</summary>
|
||
<value>The version.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.Token">
|
||
<summary>
|
||
Gets or sets the token.
|
||
</summary>
|
||
<value>The token.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.IsApiKey">
|
||
<summary>
|
||
Gets or sets a value indicating whether the authorization is from an api key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.User">
|
||
<summary>
|
||
Gets or sets the user making the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.IsAuthenticated">
|
||
<summary>
|
||
Gets or sets a value indicating whether the token is authenticated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.AuthorizationInfo.HasToken">
|
||
<summary>
|
||
Gets a value indicating whether the request has a token.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2">
|
||
<summary>
|
||
Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received.
|
||
</summary>
|
||
<typeparam name="TReturnDataType">The type of the T return data type.</typeparam>
|
||
<typeparam name="TStateType">The type of the T state type.</typeparam>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2._activeConnections">
|
||
<summary>
|
||
The _active connections.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.Logger">
|
||
<summary>
|
||
The logger.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.Type">
|
||
<summary>
|
||
Gets the type used for the messages sent to the client.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.StartType">
|
||
<summary>
|
||
Gets the message type received from the client to start sending messages.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.StopType">
|
||
<summary>
|
||
Gets the message type received from the client to stop sending messages.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.GetDataToSend">
|
||
<summary>
|
||
Gets the data to send.
|
||
</summary>
|
||
<returns>Task{`1}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.GetDataToSendForConnection(MediaBrowser.Controller.Net.IWebSocketConnection)">
|
||
<summary>
|
||
Gets the data to send for a specific connection.
|
||
</summary>
|
||
<param name="connection">The connection.</param>
|
||
<returns>Task{`1}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.ProcessMessageAsync(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
||
<summary>
|
||
Processes the message.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.ProcessWebSocketConnectedAsync(MediaBrowser.Controller.Net.IWebSocketConnection,Microsoft.AspNetCore.Http.HttpContext)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.Start(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
||
<summary>
|
||
Starts sending messages over a web socket.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.Stop(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
||
<summary>
|
||
Stops sending messages over a web socket.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.DisposeConnection(System.ValueTuple{MediaBrowser.Controller.Net.IWebSocketConnection,System.Threading.CancellationTokenSource,`1})">
|
||
<summary>
|
||
Disposes the connection.
|
||
</summary>
|
||
<param name="connection">The connection.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.BasePeriodicWebSocketListener`2.DisposeAsync">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.IAuthorizationContext">
|
||
<summary>
|
||
IAuthorization context.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IAuthorizationContext.GetAuthorizationInfo(Microsoft.AspNetCore.Http.HttpContext)">
|
||
<summary>
|
||
Gets the authorization information.
|
||
</summary>
|
||
<param name="requestContext">The request context.</param>
|
||
<returns>A task containing the authorization info.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IAuthorizationContext.GetAuthorizationInfo(Microsoft.AspNetCore.Http.HttpRequest)">
|
||
<summary>
|
||
Gets the authorization information.
|
||
</summary>
|
||
<param name="requestContext">The request context.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the authorization info.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.IAuthService">
|
||
<summary>
|
||
IAuthService.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IAuthService.Authenticate(Microsoft.AspNetCore.Http.HttpRequest)">
|
||
<summary>
|
||
Authenticate request.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<returns>Authorization information. Null if unauthenticated.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.IWebSocketConnection">
|
||
<summary>
|
||
Interface for WebSocket connections.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Net.IWebSocketConnection.Closed">
|
||
<summary>
|
||
Occurs when [closed].
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.LastActivityDate">
|
||
<summary>
|
||
Gets the last activity date.
|
||
</summary>
|
||
<value>The last activity date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.LastKeepAliveDate">
|
||
<summary>
|
||
Gets or sets the date of last Keepalive received.
|
||
</summary>
|
||
<value>The date of last Keepalive received.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.OnReceive">
|
||
<summary>
|
||
Gets or sets the receive action.
|
||
</summary>
|
||
<value>The receive action.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.State">
|
||
<summary>
|
||
Gets the state.
|
||
</summary>
|
||
<value>The state.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.AuthorizationInfo">
|
||
<summary>
|
||
Gets the authorization information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.IWebSocketConnection.RemoteEndPoint">
|
||
<summary>
|
||
Gets the remote end point.
|
||
</summary>
|
||
<value>The remote end point.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketConnection.SendAsync(MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a message asynchronously.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
<exception cref="T:System.ArgumentNullException">The message is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketConnection.SendAsync``1(MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage{``0},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a message asynchronously.
|
||
</summary>
|
||
<typeparam name="T">The type of websocket message data.</typeparam>
|
||
<param name="message">The message.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
<exception cref="T:System.ArgumentNullException">The message is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketConnection.ReceiveAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Receives a message asynchronously.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.IWebSocketListener">
|
||
<summary>
|
||
Interface for listening to messages coming through a web socket connection.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketListener.ProcessMessageAsync(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
||
<summary>
|
||
Processes the message.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketListener.ProcessWebSocketConnectedAsync(MediaBrowser.Controller.Net.IWebSocketConnection,Microsoft.AspNetCore.Http.HttpContext)">
|
||
<summary>
|
||
Processes a new web socket connection.
|
||
</summary>
|
||
<param name="connection">An instance of the <see cref="T:MediaBrowser.Controller.Net.IWebSocketConnection"/> interface.</param>
|
||
<param name="httpContext">The current http context.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.IWebSocketManager">
|
||
<summary>
|
||
Interface IHttpServer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.IWebSocketManager.WebSocketRequestHandler(Microsoft.AspNetCore.Http.HttpContext)">
|
||
<summary>
|
||
The HTTP request handler.
|
||
</summary>
|
||
<param name="context">The current HTTP context.</param>
|
||
<returns>The task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.SecurityException">
|
||
<summary>
|
||
The exception that is thrown when a user is authenticated, but not authorized to access a requested resource.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.SecurityException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.SecurityException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.SecurityException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.SecurityException"/> class.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.SecurityException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.SecurityException"/> class.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessage">
|
||
<summary>
|
||
Websocket message without data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessage.MessageType">
|
||
<summary>
|
||
Gets or sets the type of the message.
|
||
TODO make this abstract and get only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessage.ServerId">
|
||
<summary>
|
||
Gets or sets the server id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessageInfo">
|
||
<summary>
|
||
Class WebSocketMessageInfo.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessageInfo.Connection">
|
||
<summary>
|
||
Gets or sets the connection.
|
||
</summary>
|
||
<value>The connection.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessage`1">
|
||
<summary>
|
||
Class WebSocketMessage.
|
||
</summary>
|
||
<typeparam name="T">The type of the data.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessage`1.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessage`1"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessage`1.#ctor(`0)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessage`1"/> class.
|
||
</summary>
|
||
<param name="data">The data to send.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessage`1.Data">
|
||
<summary>
|
||
Gets or sets the data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.IInboundWebSocketMessage">
|
||
<summary>
|
||
Interface representing that the websocket message is inbound.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage">
|
||
<summary>
|
||
Inbound websocket message.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage`1">
|
||
<summary>
|
||
Inbound websocket message with data.
|
||
</summary>
|
||
<typeparam name="T">The data type.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage`1.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage`1"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage`1.#ctor(`0)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.InboundWebSocketMessage`1"/> class.
|
||
</summary>
|
||
<param name="data">The data to send.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStartMessage">
|
||
<summary>
|
||
Activity log entry start message.
|
||
Data is the timing data encoded as "$initialDelay,$interval" in ms.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStartMessage.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStartMessage"/> class.
|
||
Data is the timing data encoded as "$initialDelay,$interval" in ms.
|
||
</summary>
|
||
<param name="data">The timing data encoded as "$initialDelay,$interval".</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStartMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStopMessage">
|
||
<summary>
|
||
Activity log entry stop message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ActivityLogEntryStopMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.InboundKeepAliveMessage">
|
||
<summary>
|
||
Keep alive websocket messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.InboundKeepAliveMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStartMessage">
|
||
<summary>
|
||
Scheduled tasks info start message.
|
||
Data is the timing data encoded as "$initialDelay,$interval" in ms.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStartMessage.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStartMessage"/> class.
|
||
</summary>
|
||
<param name="data">The timing data encoded as $initialDelay,$interval.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStartMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStopMessage">
|
||
<summary>
|
||
Scheduled tasks info stop message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.ScheduledTasksInfoStopMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStartMessage">
|
||
<summary>
|
||
Sessions start message.
|
||
Data is the timing data encoded as "$initialDelay,$interval" in ms.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStartMessage.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStartMessage"/> class.
|
||
</summary>
|
||
<param name="data">The timing data encoded as $initialDelay,$interval.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStartMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStopMessage">
|
||
<summary>
|
||
Sessions stop message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Inbound.SessionsStopMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.IOutboundWebSocketMessage">
|
||
<summary>
|
||
Interface representing that the websocket message is outbound.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage">
|
||
<summary>
|
||
Outbound websocket message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage.MessageId">
|
||
<summary>
|
||
Gets or sets the message id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1">
|
||
<summary>
|
||
Outbound websocket message with data.
|
||
</summary>
|
||
<typeparam name="T">The data type.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1.#ctor(`0)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1"/> class.
|
||
</summary>
|
||
<param name="data">The data to send.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.OutboundWebSocketMessage`1.MessageId">
|
||
<summary>
|
||
Gets or sets the message id.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ActivityLogEntryMessage">
|
||
<summary>
|
||
Activity log created message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ActivityLogEntryMessage.#ctor(System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Activity.ActivityLogEntry})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ActivityLogEntryMessage"/> class.
|
||
</summary>
|
||
<param name="data">List of activity log entries.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ActivityLogEntryMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ForceKeepAliveMessage">
|
||
<summary>
|
||
Force keep alive websocket messages.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ForceKeepAliveMessage.#ctor(System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ForceKeepAliveMessage"/> class.
|
||
</summary>
|
||
<param name="data">The timeout in seconds.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ForceKeepAliveMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.GeneralCommandMessage">
|
||
<summary>
|
||
General command websocket message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.GeneralCommandMessage.#ctor(MediaBrowser.Model.Session.GeneralCommand)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.GeneralCommandMessage"/> class.
|
||
</summary>
|
||
<param name="data">The general command.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.GeneralCommandMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.LibraryChangedMessage">
|
||
<summary>
|
||
Library changed message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.LibraryChangedMessage.#ctor(MediaBrowser.Model.Entities.LibraryUpdateInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.LibraryChangedMessage"/> class.
|
||
</summary>
|
||
<param name="data">The library update info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.LibraryChangedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.OutboundKeepAliveMessage">
|
||
<summary>
|
||
Keep alive websocket messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.OutboundKeepAliveMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlayMessage">
|
||
<summary>
|
||
Play command websocket message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlayMessage.#ctor(MediaBrowser.Model.Session.PlayRequest)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlayMessage"/> class.
|
||
</summary>
|
||
<param name="data">The play request.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlayMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlaystateMessage">
|
||
<summary>
|
||
Playstate message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlaystateMessage.#ctor(MediaBrowser.Model.Session.PlaystateRequest)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlaystateMessage"/> class.
|
||
</summary>
|
||
<param name="data">Playstate request data.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PlaystateMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCancelledMessage">
|
||
<summary>
|
||
Plugin installation cancelled message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCancelledMessage.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCancelledMessage"/> class.
|
||
</summary>
|
||
<param name="data">Installation info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCancelledMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCompletedMessage">
|
||
<summary>
|
||
Plugin installation completed message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCompletedMessage.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCompletedMessage"/> class.
|
||
</summary>
|
||
<param name="data">Installation info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationCompletedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationFailedMessage">
|
||
<summary>
|
||
Plugin installation failed message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationFailedMessage.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationFailedMessage"/> class.
|
||
</summary>
|
||
<param name="data">Installation info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallationFailedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallingMessage">
|
||
<summary>
|
||
Package installing message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallingMessage.#ctor(MediaBrowser.Model.Updates.InstallationInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallingMessage"/> class.
|
||
</summary>
|
||
<param name="data">Installation info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginInstallingMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginUninstalledMessage">
|
||
<summary>
|
||
Plugin uninstalled message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginUninstalledMessage.#ctor(MediaBrowser.Model.Plugins.PluginInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginUninstalledMessage"/> class.
|
||
</summary>
|
||
<param name="data">Plugin info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.PluginUninstalledMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RefreshProgressMessage">
|
||
<summary>
|
||
Refresh progress message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RefreshProgressMessage.#ctor(System.Collections.Generic.Dictionary{System.String,System.String})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RefreshProgressMessage"/> class.
|
||
</summary>
|
||
<param name="data">Refresh progress data.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RefreshProgressMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RestartRequiredMessage">
|
||
<summary>
|
||
Restart required.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.RestartRequiredMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTaskEndedMessage">
|
||
<summary>
|
||
Scheduled task ended message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTaskEndedMessage.#ctor(MediaBrowser.Model.Tasks.TaskResult)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTaskEndedMessage"/> class.
|
||
</summary>
|
||
<param name="data">Task result.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTaskEndedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTasksInfoMessage">
|
||
<summary>
|
||
Scheduled tasks info message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTasksInfoMessage.#ctor(System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Tasks.TaskInfo})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTasksInfoMessage"/> class.
|
||
</summary>
|
||
<param name="data">List of task infos.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ScheduledTasksInfoMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCancelledMessage">
|
||
<summary>
|
||
Series timer cancelled message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCancelledMessage.#ctor(MediaBrowser.Controller.LiveTv.TimerEventInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCancelledMessage"/> class.
|
||
</summary>
|
||
<param name="data">The timer event info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCancelledMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCreatedMessage">
|
||
<summary>
|
||
Series timer created message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCreatedMessage.#ctor(MediaBrowser.Controller.LiveTv.TimerEventInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCreatedMessage"/> class.
|
||
</summary>
|
||
<param name="data">timer event info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SeriesTimerCreatedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ServerRestartingMessage">
|
||
<summary>
|
||
Server restarting down message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ServerRestartingMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ServerShuttingDownMessage">
|
||
<summary>
|
||
Server shutting down message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.ServerShuttingDownMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SessionsMessage">
|
||
<summary>
|
||
Sessions message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SessionsMessage.#ctor(System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Dto.SessionInfoDto})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SessionsMessage"/> class.
|
||
</summary>
|
||
<param name="data">Session info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SessionsMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SyncPlayCommandMessage">
|
||
<summary>
|
||
Sync play command.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SyncPlayCommandMessage.#ctor(MediaBrowser.Model.SyncPlay.SendCommand)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SyncPlayCommandMessage"/> class.
|
||
</summary>
|
||
<param name="data">The send command.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.SyncPlayCommandMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCancelledMessage">
|
||
<summary>
|
||
Timer cancelled message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCancelledMessage.#ctor(MediaBrowser.Controller.LiveTv.TimerEventInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCancelledMessage"/> class.
|
||
</summary>
|
||
<param name="data">Timer event info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCancelledMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCreatedMessage">
|
||
<summary>
|
||
Timer created message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCreatedMessage.#ctor(MediaBrowser.Controller.LiveTv.TimerEventInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCreatedMessage"/> class.
|
||
</summary>
|
||
<param name="data">Timer event info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.TimerCreatedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDataChangedMessage">
|
||
<summary>
|
||
User data changed message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDataChangedMessage.#ctor(MediaBrowser.Model.Session.UserDataChangeInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDataChangedMessage"/> class.
|
||
</summary>
|
||
<param name="data">The data change info.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDataChangedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDeletedMessage">
|
||
<summary>
|
||
User deleted message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDeletedMessage.#ctor(System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDeletedMessage"/> class.
|
||
</summary>
|
||
<param name="data">The user id.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserDeletedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserUpdatedMessage">
|
||
<summary>
|
||
User updated message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserUpdatedMessage.#ctor(MediaBrowser.Model.Dto.UserDto)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserUpdatedMessage"/> class.
|
||
</summary>
|
||
<param name="data">The user dto.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Net.WebSocketMessages.Outbound.UserUpdatedMessage.MessageType">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Persistence.IChapterRepository">
|
||
<summary>
|
||
Interface IChapterRepository.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IChapterRepository.DeleteChaptersAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes the chapters.
|
||
</summary>
|
||
<param name="itemId">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IChapterRepository.SaveChaptersAsync(System.Guid,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.ChapterInfo},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the chapters asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item.</param>
|
||
<param name="chapters">The set of chapters.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IChapterRepository.GetChaptersAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets all chapters associated with the baseItem asynchronously.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A readonly list of chapter instances.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IChapterRepository.GetChapterAsync(System.Guid,System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets a single chapter of a BaseItem on a specific index asynchronously.
|
||
</summary>
|
||
<param name="baseItemId">The BaseItems id.</param>
|
||
<param name="index">The index of that chapter.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A chapter instance.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Persistence.IItemRepository">
|
||
<summary>
|
||
Provides an interface to implement an Item repository.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.DeleteItem(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Deletes the item.
|
||
</summary>
|
||
<param name="ids">The identifier to delete.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.DeleteItemAsync(System.Collections.Generic.IReadOnlyList{System.Guid},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes the item asynchronously.
|
||
</summary>
|
||
<param name="ids">The identifier to delete.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.SaveItems(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the items.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.SaveItemsAsync(System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.BaseItem},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the items asynchronously.
|
||
</summary>
|
||
<param name="items">The items.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.ReattachUserDataAsync(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Reattaches the user data to the item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task that represents the asynchronous reattachment operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.RetrieveItem(System.Guid)">
|
||
<summary>
|
||
Retrieves the item.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.RetrieveItemAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Retrieves the item asynchronously.
|
||
</summary>
|
||
<param name="id">The id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItems(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the items.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<returns>QueryResult<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemsAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the items asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>QueryResult<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemIdsList(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the item ids list.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<returns>List<Guid>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemIdsListAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the item ids list asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>List<Guid>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemList(MediaBrowser.Controller.Entities.InternalItemsQuery)">
|
||
<summary>
|
||
Gets the item list.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<returns>List<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemListAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the item list asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>List<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetLatestItemList(MediaBrowser.Controller.Entities.InternalItemsQuery,Jellyfin.Data.Enums.CollectionType)">
|
||
<summary>
|
||
Gets the item list. Used mainly by the Latest api endpoint.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="collectionType">Collection Type.</param>
|
||
<returns>List<BaseItem>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetLatestItemListAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,Jellyfin.Data.Enums.CollectionType,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the item list asynchronously. Used mainly by the Latest api endpoint.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="collectionType">Collection Type.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetNextUpSeriesKeys(MediaBrowser.Controller.Entities.InternalItemsQuery,System.DateTime)">
|
||
<summary>
|
||
Gets the list of series presentation keys for next up.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="dateCutoff">The minimum date for a series to have been most recently watched.</param>
|
||
<returns>The list of keys.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetNextUpSeriesKeysAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.DateTime,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the list of series presentation keys for next up asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="dateCutoff">The minimum date for a series to have been most recently watched.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the async operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.UpdateInheritedValues">
|
||
<summary>
|
||
Updates the inherited values.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetCountAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the count of items asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The count.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetItemCountsAsync(MediaBrowser.Controller.Entities.InternalItemsQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the item counts asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The item counts.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.ItemExistsAsync(System.Guid)">
|
||
<summary>
|
||
Checks if an item has been persisted to the database.
|
||
</summary>
|
||
<param name="id">The id to check.</param>
|
||
<returns>True if the item exists, otherwise false.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.GetIsPlayed(Jellyfin.Database.Implementations.Entities.User,System.Guid,System.Boolean)">
|
||
<summary>
|
||
Gets a value indicating wherever all children of the requested Id has been played.
|
||
</summary>
|
||
<param name="user">The userdata to check against.</param>
|
||
<param name="id">The Top id to check.</param>
|
||
<param name="recursive">Whever the check should be done recursive. Warning expensive operation.</param>
|
||
<returns>A value indicating whever all children has been played.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IItemRepository.FindArtists(System.Collections.Generic.IReadOnlyList{System.String})">
|
||
<summary>
|
||
Gets all artist matches from the db.
|
||
</summary>
|
||
<param name="artistNames">The names of the artists.</param>
|
||
<returns>A map of the artist name and the potential matches.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Persistence.IItemTypeLookup">
|
||
<summary>
|
||
Provides static lookup data for <see cref="T:MediaBrowser.Model.Querying.ItemFields"/> and <see cref="T:Jellyfin.Data.Enums.BaseItemKind"/> for the domain.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.IItemTypeLookup.MusicGenreTypes">
|
||
<summary>
|
||
Gets all serialisation target types for music related kinds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.IItemTypeLookup.BaseItemKindNames">
|
||
<summary>
|
||
Gets mapping for all BaseItemKinds and their expected serialization target.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Persistence.IKeyframeRepository">
|
||
<summary>
|
||
Provides methods for accessing keyframe data.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IKeyframeRepository.GetKeyframeDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the keyframe data asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The keyframe data.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IKeyframeRepository.SaveKeyframeDataAsync(System.Guid,Jellyfin.MediaEncoding.Keyframes.KeyframeData,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the keyframe data.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="data">The keyframe data.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IKeyframeRepository.DeleteKeyframeDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes the keyframe data.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IMediaAttachmentRepository.GetMediaAttachmentsAsync(MediaBrowser.Controller.Persistence.MediaAttachmentQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media attachments asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList{MediaAttachment}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IMediaAttachmentRepository.SaveMediaAttachmentsAsync(System.Guid,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.MediaAttachment},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the media attachments asynchronously.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="attachments">The attachments.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Persistence.IMediaStreamRepository">
|
||
<summary>
|
||
Provides methods for accessing MediaStreams.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IMediaStreamRepository.GetMediaStreamsAsync(MediaBrowser.Controller.Persistence.MediaStreamQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the media streams asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>IReadOnlyList{MediaStream}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IMediaStreamRepository.SaveMediaStreamsAsync(System.Guid,System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.MediaStream},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the media streams asynchronously.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="streams">The streams.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.GetPeople(MediaBrowser.Controller.Entities.InternalPeopleQuery)">
|
||
<summary>
|
||
Gets the people.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<returns>The list of people matching the filter.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.GetPeopleAsync(MediaBrowser.Controller.Entities.InternalPeopleQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the people asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The list of people matching the filter.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.UpdatePeople(System.Guid,System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.PersonInfo})">
|
||
<summary>
|
||
Updates the people.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<param name="people">The people.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.UpdatePeopleAsync(System.Guid,System.Collections.Generic.IReadOnlyList{MediaBrowser.Controller.Entities.PersonInfo},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the people asynchronously.
|
||
</summary>
|
||
<param name="itemId">The item identifier.</param>
|
||
<param name="people">The people.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>A task representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.GetPeopleNames(MediaBrowser.Controller.Entities.InternalPeopleQuery)">
|
||
<summary>
|
||
Gets the people names.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<returns>The list of people names matching the filter.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Persistence.IPeopleRepository.GetPeopleNamesAsync(MediaBrowser.Controller.Entities.InternalPeopleQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the people names asynchronously.
|
||
</summary>
|
||
<param name="filter">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The list of people names matching the filter.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.MediaAttachmentQuery.Index">
|
||
<summary>
|
||
Gets or sets the index.
|
||
</summary>
|
||
<value>The index.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.MediaAttachmentQuery.ItemId">
|
||
<summary>
|
||
Gets or sets the item identifier.
|
||
</summary>
|
||
<value>The item identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.MediaStreamQuery.Type">
|
||
<summary>
|
||
Gets or sets the type.
|
||
</summary>
|
||
<value>The type.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.MediaStreamQuery.Index">
|
||
<summary>
|
||
Gets or sets the index.
|
||
</summary>
|
||
<value>The index.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Persistence.MediaStreamQuery.ItemId">
|
||
<summary>
|
||
Gets or sets the item identifier.
|
||
</summary>
|
||
<value>The item identifier.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.GetPlaylistForUser(System.Guid,System.Guid)">
|
||
<summary>
|
||
Gets the playlist.
|
||
</summary>
|
||
<param name="playlistId">The playlist identifier.</param>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns>Playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.CreatePlaylist(MediaBrowser.Model.Playlists.PlaylistCreationRequest)">
|
||
<summary>
|
||
Creates the playlist.
|
||
</summary>
|
||
<param name="request">The <see cref="T:MediaBrowser.Model.Playlists.PlaylistCreationRequest"/>.</param>
|
||
<returns>The created playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.UpdatePlaylist(MediaBrowser.Model.Playlists.PlaylistUpdateRequest)">
|
||
<summary>
|
||
Updates a playlist.
|
||
</summary>
|
||
<param name="request">The <see cref="T:MediaBrowser.Model.Playlists.PlaylistUpdateRequest"/>.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.GetPlaylists(System.Guid)">
|
||
<summary>
|
||
Gets all playlists a user has access to.
|
||
</summary>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns>IEnumerable<Playlist>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.AddUserToShares(MediaBrowser.Model.Playlists.PlaylistUserUpdateRequest)">
|
||
<summary>
|
||
Adds a share to the playlist.
|
||
</summary>
|
||
<param name="request">The <see cref="T:MediaBrowser.Model.Playlists.PlaylistUserUpdateRequest"/>.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.RemoveUserFromShares(System.Guid,System.Guid,MediaBrowser.Model.Entities.PlaylistUserPermissions)">
|
||
<summary>
|
||
Removes a share from the playlist.
|
||
</summary>
|
||
<param name="playlistId">The playlist identifier.</param>
|
||
<param name="userId">The user identifier.</param>
|
||
<param name="share">The share.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.AddItemToPlaylistAsync(System.Guid,System.Collections.Generic.IReadOnlyCollection{System.Guid},System.Nullable{System.Int32},System.Guid)">
|
||
<summary>
|
||
Adds to playlist.
|
||
</summary>
|
||
<param name="playlistId">The playlist identifier.</param>
|
||
<param name="itemIds">The item ids.</param>
|
||
<param name="position">Optional. 0-based index where to place the items or at the end if null.</param>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.RemoveItemFromPlaylistAsync(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Removes from playlist.
|
||
</summary>
|
||
<param name="playlistId">The playlist identifier.</param>
|
||
<param name="entryIds">The entry ids.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.GetPlaylistsFolder">
|
||
<summary>
|
||
Gets the playlists folder.
|
||
</summary>
|
||
<returns>Folder.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.GetPlaylistsFolder(System.Guid)">
|
||
<summary>
|
||
Gets the playlists folder for a user.
|
||
</summary>
|
||
<param name="userId">The user identifier.</param>
|
||
<returns>Folder.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.MoveItemAsync(System.String,System.String,System.Int32,System.Guid)">
|
||
<summary>
|
||
Moves the item.
|
||
</summary>
|
||
<param name="playlistId">The playlist identifier.</param>
|
||
<param name="entryId">The entry identifier.</param>
|
||
<param name="newIndex">The new index.</param>
|
||
<param name="callingUserId">The calling user.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.RemovePlaylistsAsync(System.Guid)">
|
||
<summary>
|
||
Removed all playlists of a user.
|
||
If the playlist is shared, ownership is transferred.
|
||
</summary>
|
||
<param name="userId">The user id.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Playlists.IPlaylistManager.SavePlaylistFile(MediaBrowser.Controller.Playlists.Playlist)">
|
||
<summary>
|
||
Saves a playlist.
|
||
</summary>
|
||
<param name="item">The playlist.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Plugins.IPluginServiceRegistrator">
|
||
<summary>
|
||
Defines the <see cref="T:MediaBrowser.Controller.Plugins.IPluginServiceRegistrator" />.
|
||
</summary>
|
||
<remarks>
|
||
This interface is only used for service registration and requires a parameterless constructor.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Plugins.IPluginServiceRegistrator.RegisterServices(Microsoft.Extensions.DependencyInjection.IServiceCollection,MediaBrowser.Controller.IServerApplicationHost)">
|
||
<summary>
|
||
Registers the plugin's services with the service collection.
|
||
</summary>
|
||
<param name="serviceCollection">The service collection.</param>
|
||
<param name="applicationHost">The server application host.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.AlbumInfo.AlbumArtists">
|
||
<summary>
|
||
Gets or sets the album artist.
|
||
</summary>
|
||
<value>The album artist.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.AlbumInfo.ArtistProviderIds">
|
||
<summary>
|
||
Gets or sets the artist provider ids.
|
||
</summary>
|
||
<value>The artist provider ids.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.ICustomMetadataProvider`1.FetchAsync(`0,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Fetches the metadata asynchronously.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="options">The <see cref="T:MediaBrowser.Controller.Providers.MetadataRefreshOptions"/>.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> fetching the <see cref="T:MediaBrowser.Controller.Library.ItemUpdateType"/>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IDynamicImageProvider.GetSupportedImages(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the supported images.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>IEnumerable{ImageType}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IDynamicImageProvider.GetImage(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Entities.ImageType,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the image.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="type">The type.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{DynamicImageResponse}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IExternalId">
|
||
<summary>
|
||
Represents an identifier for an external provider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IExternalId.ProviderName">
|
||
<summary>
|
||
Gets the display name of the provider associated with this ID type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IExternalId.Key">
|
||
<summary>
|
||
Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IExternalId.Type">
|
||
<summary>
|
||
Gets the specific media type for this id. This is used to distinguish between the different
|
||
external id types for providers with multiple ids.
|
||
A null value indicates there is no specific media type associated with the external id, or this is the
|
||
default id for the external provider so there is no need to specify a type.
|
||
</summary>
|
||
<remarks>
|
||
This can be used along with the <see cref="P:MediaBrowser.Controller.Providers.IExternalId.ProviderName"/> to localize the external id on the client.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IExternalId.Supports(MediaBrowser.Model.Entities.IHasProviderIds)">
|
||
<summary>
|
||
Determines whether this id supports a given item type.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>True if this item is supported, otherwise false.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IExternalUrlProvider">
|
||
<summary>
|
||
Interface to include related urls for an item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IExternalUrlProvider.Name">
|
||
<summary>
|
||
Gets the external service name.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IExternalUrlProvider.GetExternalUrls(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Get the list of external urls.
|
||
</summary>
|
||
<param name="item">The item to get external urls for.</param>
|
||
<returns>The list of external urls.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IForcedProvider">
|
||
<summary>
|
||
This is a marker interface that will cause a provider to run even if an item is locked from changes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IHasItemChangeMonitor.HasChanged(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.IDirectoryService)">
|
||
<summary>
|
||
Determines whether the specified item has changed.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="directoryService">The directory service.</param>
|
||
<returns><c>true</c> if the specified item has changed; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IHasOrder">
|
||
<summary>
|
||
Interface IHasOrder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IHasOrder.Order">
|
||
<summary>
|
||
Gets the order.
|
||
</summary>
|
||
<value>The order.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IImageProvider">
|
||
<summary>
|
||
Interface IImageProvider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IImageProvider.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IImageProvider.Supports(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Supports the specified item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns><c>true</c> if the provider supports the item.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.ILocalImageProvider">
|
||
<summary>
|
||
This is just a marker interface.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.ILocalMetadataProvider`1.GetMetadata(MediaBrowser.Controller.Providers.ItemInfo,MediaBrowser.Controller.Providers.IDirectoryService,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the metadata.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="directoryService">The directory service.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{MetadataResult{0}}.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ImageRefreshOptions.RemoveOldMetadata">
|
||
<summary>
|
||
Gets or sets a value indicating whether old metadata should be removed if it isn't replaced.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IMetadataProvider">
|
||
<summary>
|
||
Marker interface.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IMetadataProvider.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.IMetadataService.Order">
|
||
<summary>
|
||
Gets the order.
|
||
</summary>
|
||
<value>The order.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IMetadataService.CanRefresh(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Determines whether this instance can refresh the specified item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns><c>true</c> if this instance can refresh the specified item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IMetadataService.CanRefreshPrimary(System.Type)">
|
||
<summary>
|
||
Determines whether this instance primarily targets the specified type.
|
||
</summary>
|
||
<param name="type">The type.</param>
|
||
<returns><c>true</c> if this instance primarily targets the specified type.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IMetadataService.RefreshMetadata(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes the metadata.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="refreshOptions">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IProviderManager">
|
||
<summary>
|
||
Interface IProviderManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.QueueRefresh(System.Guid,MediaBrowser.Controller.Providers.MetadataRefreshOptions,MediaBrowser.Controller.Providers.RefreshPriority)">
|
||
<summary>
|
||
Queues the refresh.
|
||
</summary>
|
||
<param name="itemId">Item ID.</param>
|
||
<param name="options">MetadataRefreshOptions for operation.</param>
|
||
<param name="priority">RefreshPriority for operation.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.RefreshFullItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes the full item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.RefreshSingleItem(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Refreshes the metadata.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="options">The options.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.SaveImage(MediaBrowser.Controller.Entities.BaseItem,System.String,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the image.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="url">The URL.</param>
|
||
<param name="type">The type.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.SaveImage(MediaBrowser.Controller.Entities.BaseItem,System.IO.Stream,System.String,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the image.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="source">The source.</param>
|
||
<param name="mimeType">Type of the MIME.</param>
|
||
<param name="type">The type.</param>
|
||
<param name="imageIndex">Index of the image.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.SaveImage(MediaBrowser.Controller.Entities.BaseItem,System.String,System.String,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Saves the image by giving the image path on filesystem.
|
||
This method will remove the image on the source path after saving it to the destination.
|
||
</summary>
|
||
<param name="item">Image to save.</param>
|
||
<param name="source">Source of image.</param>
|
||
<param name="mimeType">Mime type image.</param>
|
||
<param name="type">Type of image.</param>
|
||
<param name="imageIndex">Index of image.</param>
|
||
<param name="saveLocallyWithMedia">Option to save locally.</param>
|
||
<param name="cancellationToken">CancellationToken to use with operation.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.AddParts(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Providers.IImageProvider},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Providers.IMetadataService},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Providers.IMetadataProvider},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Library.IMetadataSaver},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Providers.IExternalId},System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Providers.IExternalUrlProvider})">
|
||
<summary>
|
||
Adds the metadata providers.
|
||
</summary>
|
||
<param name="imageProviders">Image providers to use.</param>
|
||
<param name="metadataServices">Metadata services to use.</param>
|
||
<param name="metadataProviders">Metadata providers to use.</param>
|
||
<param name="metadataSavers">Metadata savers to use.</param>
|
||
<param name="externalIds">External IDs to use.</param>
|
||
<param name="externalUrlProviders">The list of external url providers.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetAvailableRemoteImages(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Providers.RemoteImageQuery,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the available remote images.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="query">The query.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetRemoteImageProviderInfo(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the image providers.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>IEnumerable{ImageProviderInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetImageProviders(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.ImageRefreshOptions)">
|
||
<summary>
|
||
Gets the image providers for the provided item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="refreshOptions">The image refresh options.</param>
|
||
<returns>The image providers for the item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetMetadataProviders``1(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.LibraryOptions)">
|
||
<summary>
|
||
Gets the metadata providers for the provided item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<typeparam name="T">The type of metadata provider.</typeparam>
|
||
<returns>The metadata providers.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetMetadataSavers(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Configuration.LibraryOptions)">
|
||
<summary>
|
||
Gets the metadata savers for the provided item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<returns>The metadata savers.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetAllMetadataPlugins">
|
||
<summary>
|
||
Gets all metadata plugins.
|
||
</summary>
|
||
<returns>IEnumerable{MetadataPlugin}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetExternalUrls(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the external urls.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>IEnumerable{ExternalUrl}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetExternalIdInfos(MediaBrowser.Model.Entities.IHasProviderIds)">
|
||
<summary>
|
||
Gets the external identifier infos.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>IEnumerable{ExternalIdInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.SaveMetadataAsync(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.ItemUpdateType)">
|
||
<summary>
|
||
Saves the metadata.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="updateType">Type of the update.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.SaveMetadataAsync(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Library.ItemUpdateType,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Saves the metadata.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="updateType">Type of the update.</param>
|
||
<param name="savers">The metadata savers.</param>
|
||
<returns>The task object representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetMetadataOptions(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the metadata options.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>MetadataOptions.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IProviderManager.GetRemoteSearchResults``2(MediaBrowser.Controller.Providers.RemoteSearchQuery{``1},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the remote search results.
|
||
</summary>
|
||
<typeparam name="TItemType">The type of the t item type.</typeparam>
|
||
<typeparam name="TLookupType">The type of the t lookup type.</typeparam>
|
||
<param name="searchInfo">The search information.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{SearchResult{``1}}}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IRemoteImageProvider">
|
||
<summary>
|
||
Interface IImageProvider.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteImageProvider.GetSupportedImages(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the supported images.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>IEnumerable{ImageType}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteImageProvider.GetImages(MediaBrowser.Controller.Entities.BaseItem,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the images.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteImageProvider.GetImageResponse(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the image response.
|
||
</summary>
|
||
<param name="url">The URL.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{HttpResponseInfo}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IRemoteMetadataProvider">
|
||
<summary>
|
||
Interface IRemoteMetadataProvider.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IRemoteMetadataProvider`2">
|
||
<summary>
|
||
Interface IRemoteMetadataProvider.
|
||
</summary>
|
||
<typeparam name="TItemType">The type of <see cref="T:MediaBrowser.Controller.Entities.BaseItem" />.</typeparam>
|
||
<typeparam name="TLookupInfoType">The type of <see cref="T:MediaBrowser.Controller.Providers.ItemLookupInfo" />.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteMetadataProvider`2.GetMetadata(`1,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the metadata for a specific LookupInfoType.
|
||
</summary>
|
||
<param name="info">The LookupInfoType to get metadata for.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||
<returns>A task returning a MetadataResult for the specific LookupInfoType.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.IRemoteSearchProvider`1">
|
||
<summary>
|
||
Interface IRemoteMetadataProvider.
|
||
</summary>
|
||
<typeparam name="TLookupInfoType">The type of <see cref="T:MediaBrowser.Controller.Providers.ItemLookupInfo" />.</typeparam>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteSearchProvider`1.GetSearchResults(`0,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the list of <see cref="T:MediaBrowser.Model.Providers.RemoteSearchResult"/> for a specific LookupInfoType.
|
||
</summary>
|
||
<param name="searchInfo">The LookupInfoType to search for.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||
<returns>A task returning RemoteSearchResults for the searchInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.IRemoteSearchProvider.GetImageResponse(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the image response.
|
||
</summary>
|
||
<param name="url">The URL.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{HttpResponseInfo}.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.Name">
|
||
<summary>
|
||
Gets or sets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.OriginalTitle">
|
||
<summary>
|
||
Gets or sets the original title.
|
||
</summary>
|
||
<value>The original title of the item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.Path">
|
||
<summary>
|
||
Gets or sets the path.
|
||
</summary>
|
||
<value>The path.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.MetadataLanguage">
|
||
<summary>
|
||
Gets or sets the metadata language.
|
||
</summary>
|
||
<value>The metadata language.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.MetadataCountryCode">
|
||
<summary>
|
||
Gets or sets the metadata country code.
|
||
</summary>
|
||
<value>The metadata country code.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.ProviderIds">
|
||
<summary>
|
||
Gets or sets the provider ids.
|
||
</summary>
|
||
<value>The provider ids.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.ItemLookupInfo.Year">
|
||
<summary>
|
||
Gets or sets the year.
|
||
</summary>
|
||
<value>The year.</value>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.MetadataRefreshMode.None">
|
||
<summary>
|
||
The none.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.MetadataRefreshMode.ValidationOnly">
|
||
<summary>
|
||
The validation only.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.MetadataRefreshMode.Default">
|
||
<summary>
|
||
Providers will be executed based on default rules.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.MetadataRefreshMode.FullRefresh">
|
||
<summary>
|
||
All providers will be executed to search for new metadata.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.MetadataRefreshOptions.ReplaceAllMetadata">
|
||
<summary>
|
||
Gets or sets a value indicating whether all existing data should be overwritten with new data from providers
|
||
when paired with MetadataRefreshMode=FullRefresh.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.MetadataRefreshOptions.RegenerateTrickplay">
|
||
<summary>
|
||
Gets or sets a value indicating whether all existing trickplay images should be overwritten
|
||
when paired with MetadataRefreshMode=FullRefresh.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Providers.MetadataResult`1.ResetPeople">
|
||
<summary>
|
||
Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.RefreshPriority">
|
||
<summary>
|
||
Provider refresh priority.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.RefreshPriority.High">
|
||
<summary>
|
||
High priority.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.RefreshPriority.Normal">
|
||
<summary>
|
||
Normal priority.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.RefreshPriority.Low">
|
||
<summary>
|
||
Low priority.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.RemoteSearchQuery`1.SearchProviderName">
|
||
<summary>
|
||
Gets or sets the provider name to search within if set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Providers.RemoteSearchQuery`1.IncludeDisabledProviders">
|
||
<summary>
|
||
Gets or sets a value indicating whether disabled providers should be included.
|
||
</summary>
|
||
<value><c>true</c> if disabled providers should be included.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Providers.VideoContentType">
|
||
<summary>
|
||
Enum VideoContentType.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.VideoContentType.Episode">
|
||
<summary>
|
||
The episode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Providers.VideoContentType.Movie">
|
||
<summary>
|
||
The movie.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.QuickConnect.IQuickConnect">
|
||
<summary>
|
||
Quick connect standard interface.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.QuickConnect.IQuickConnect.IsEnabled">
|
||
<summary>
|
||
Gets a value indicating whether quick connect is enabled or not.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.QuickConnect.IQuickConnect.TryConnect(MediaBrowser.Controller.Net.AuthorizationInfo)">
|
||
<summary>
|
||
Initiates a new quick connect request.
|
||
</summary>
|
||
<param name="authorizationInfo">The initiator authorization info.</param>
|
||
<returns>A quick connect result with tokens to proceed or throws an exception if not active.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.QuickConnect.IQuickConnect.CheckRequestStatus(System.String)">
|
||
<summary>
|
||
Checks the status of an individual request.
|
||
</summary>
|
||
<param name="secret">Unique secret identifier of the request.</param>
|
||
<returns>Quick connect result.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.QuickConnect.IQuickConnect.AuthorizeRequest(System.Guid,System.String)">
|
||
<summary>
|
||
Authorizes a quick connect request to connect as the calling user.
|
||
</summary>
|
||
<param name="userId">User id.</param>
|
||
<param name="code">Identifying code for the request.</param>
|
||
<returns>A boolean indicating if the authorization completed successfully.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.QuickConnect.IQuickConnect.GetAuthorizedRequest(System.String)">
|
||
<summary>
|
||
Gets the authorized request for the secret.
|
||
</summary>
|
||
<param name="secret">The secret.</param>
|
||
<returns>The authentication result.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Resolvers.IItemResolver">
|
||
<summary>
|
||
Interface IItemResolver.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Resolvers.IItemResolver.Priority">
|
||
<summary>
|
||
Gets the priority.
|
||
</summary>
|
||
<value>The priority.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Resolvers.IItemResolver.ResolvePath(MediaBrowser.Controller.Library.ItemResolveArgs)">
|
||
<summary>
|
||
Resolves the path.
|
||
</summary>
|
||
<param name="args">The args.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Resolvers.IResolverIgnoreRule">
|
||
<summary>
|
||
Provides a base "rule" that anyone can use to have paths ignored by the resolver.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Resolvers.IResolverIgnoreRule.ShouldIgnore(MediaBrowser.Model.IO.FileSystemMetadata,MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Checks whether or not the file should be ignored.
|
||
</summary>
|
||
<param name="fileInfo">The file information.</param>
|
||
<param name="parent">The parent BaseItem.</param>
|
||
<returns>True if the file should be ignored.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Resolvers.ItemResolver`1">
|
||
<summary>
|
||
Class ItemResolver.
|
||
</summary>
|
||
<typeparam name="T">The type of BaseItem.</typeparam>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Resolvers.ItemResolver`1.Priority">
|
||
<summary>
|
||
Gets the priority.
|
||
</summary>
|
||
<value>The priority.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Resolvers.ItemResolver`1.Resolve(MediaBrowser.Controller.Library.ItemResolveArgs)">
|
||
<summary>
|
||
Resolves the specified args.
|
||
</summary>
|
||
<param name="args">The args.</param>
|
||
<returns>`0.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Resolvers.ItemResolver`1.SetInitialItemValues(`0,MediaBrowser.Controller.Library.ItemResolveArgs)">
|
||
<summary>
|
||
Sets initial values on the newly resolved item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="args">The args.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Resolvers.ItemResolver`1.ResolvePath(MediaBrowser.Controller.Library.ItemResolveArgs)">
|
||
<summary>
|
||
Resolves the path.
|
||
</summary>
|
||
<param name="args">The args.</param>
|
||
<returns>BaseItem.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Resolvers.ResolverPriority">
|
||
<summary>
|
||
Enum ResolverPriority.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Plugin">
|
||
<summary>
|
||
The highest priority. Used by plugins to bypass the default server resolvers.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.First">
|
||
<summary>
|
||
The first.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Second">
|
||
<summary>
|
||
The second.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Third">
|
||
<summary>
|
||
The third.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Fourth">
|
||
<summary>
|
||
The Fourth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Fifth">
|
||
<summary>
|
||
The Fifth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.Resolvers.ResolverPriority.Last">
|
||
<summary>
|
||
The last.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.Id">
|
||
<summary>
|
||
Gets or sets the identifier.
|
||
</summary>
|
||
<value>The identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.AccessToken">
|
||
<summary>
|
||
Gets or sets the access token.
|
||
</summary>
|
||
<value>The access token.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.DeviceId">
|
||
<summary>
|
||
Gets or sets the device identifier.
|
||
</summary>
|
||
<value>The device identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.AppName">
|
||
<summary>
|
||
Gets or sets the name of the application.
|
||
</summary>
|
||
<value>The name of the application.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.AppVersion">
|
||
<summary>
|
||
Gets or sets the application version.
|
||
</summary>
|
||
<value>The application version.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.DeviceName">
|
||
<summary>
|
||
Gets or sets the name of the device.
|
||
</summary>
|
||
<value>The name of the device.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.UserId">
|
||
<summary>
|
||
Gets or sets the user identifier.
|
||
</summary>
|
||
<value>The user identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.IsActive">
|
||
<summary>
|
||
Gets or sets a value indicating whether this instance is active.
|
||
</summary>
|
||
<value><c>true</c> if this instance is active; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.DateCreated">
|
||
<summary>
|
||
Gets or sets the date created.
|
||
</summary>
|
||
<value>The date created.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Security.AuthenticationInfo.DateRevoked">
|
||
<summary>
|
||
Gets or sets the date revoked.
|
||
</summary>
|
||
<value>The date revoked.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Security.IAuthenticationManager">
|
||
<summary>
|
||
Handles the retrieval and storage of API keys.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Security.IAuthenticationManager.CreateApiKey(System.String)">
|
||
<summary>
|
||
Creates an API key.
|
||
</summary>
|
||
<param name="name">The name of the key.</param>
|
||
<returns>A task representing the creation of the key.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Security.IAuthenticationManager.GetApiKeys">
|
||
<summary>
|
||
Gets the API keys.
|
||
</summary>
|
||
<returns>A task representing the retrieval of the API keys.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Security.IAuthenticationManager.DeleteApiKey(System.String)">
|
||
<summary>
|
||
Deletes an API key with the provided access token.
|
||
</summary>
|
||
<param name="accessToken">The access token.</param>
|
||
<returns>A task representing the deletion of the API key.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.ISessionController.IsSessionActive">
|
||
<summary>
|
||
Gets a value indicating whether this instance is session active.
|
||
</summary>
|
||
<value><c>true</c> if this instance is session active; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.ISessionController.SupportsMediaControl">
|
||
<summary>
|
||
Gets a value indicating whether [supports media remote control].
|
||
</summary>
|
||
<value><c>true</c> if [supports media remote control]; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionController.SendMessage``1(MediaBrowser.Model.Session.SessionMessageType,System.Guid,``0,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message.
|
||
</summary>
|
||
<typeparam name="T">The type of data.</typeparam>
|
||
<param name="name">Name of message type.</param>
|
||
<param name="messageId">Message ID.</param>
|
||
<param name="data">Data to send.</param>
|
||
<param name="cancellationToken">CancellationToken for operation.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Session.ISessionManager">
|
||
<summary>
|
||
Interface ISessionManager.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.PlaybackStart">
|
||
<summary>
|
||
Occurs when [playback start].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.PlaybackProgress">
|
||
<summary>
|
||
Occurs when [playback progress].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.PlaybackStopped">
|
||
<summary>
|
||
Occurs when [playback stopped].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.SessionStarted">
|
||
<summary>
|
||
Occurs when [session started].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.SessionEnded">
|
||
<summary>
|
||
Occurs when [session ended].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.SessionControllerConnected">
|
||
<summary>
|
||
Occurs when [session controller connected].
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Session.ISessionManager.CapabilitiesChanged">
|
||
<summary>
|
||
Occurs when [capabilities changed].
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.ISessionManager.Sessions">
|
||
<summary>
|
||
Gets the sessions.
|
||
</summary>
|
||
<value>The sessions.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.LogSessionActivity(System.String,System.String,System.String,System.String,System.String,Jellyfin.Database.Implementations.Entities.User)">
|
||
<summary>
|
||
Logs the user activity.
|
||
</summary>
|
||
<param name="appName">Type of the client.</param>
|
||
<param name="appVersion">The app version.</param>
|
||
<param name="deviceId">The device id.</param>
|
||
<param name="deviceName">Name of the device.</param>
|
||
<param name="remoteEndPoint">The remote end point.</param>
|
||
<param name="user">The user.</param>
|
||
<returns>A task containing the session information.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.OnSessionControllerConnected(MediaBrowser.Controller.Session.SessionInfo)">
|
||
<summary>
|
||
Used to report that a session controller has connected.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.OnPlaybackStart(MediaBrowser.Model.Session.PlaybackStartInfo)">
|
||
<summary>
|
||
Used to report that playback has started for an item.
|
||
</summary>
|
||
<param name="info">The info.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.OnPlaybackProgress(MediaBrowser.Model.Session.PlaybackProgressInfo)">
|
||
<summary>
|
||
Used to report playback progress for an item.
|
||
</summary>
|
||
<param name="info">The info.</param>
|
||
<returns>Task.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Throws if an argument is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.OnPlaybackStopped(MediaBrowser.Model.Session.PlaybackStopInfo)">
|
||
<summary>
|
||
Used to report that playback has ended for an item.
|
||
</summary>
|
||
<param name="info">The info.</param>
|
||
<returns>Task.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Throws if an argument is null.</exception>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ReportSessionEnded(System.String)">
|
||
<summary>
|
||
Reports the session ended.
|
||
</summary>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendGeneralCommand(System.String,System.String,MediaBrowser.Model.Session.GeneralCommand,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the general command.
|
||
</summary>
|
||
<param name="controllingSessionId">The controlling session identifier.</param>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendMessageCommand(System.String,System.String,MediaBrowser.Model.Session.MessageCommand,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message command.
|
||
</summary>
|
||
<param name="controllingSessionId">The controlling session identifier.</param>
|
||
<param name="sessionId">The session id.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendPlayCommand(System.String,System.String,MediaBrowser.Model.Session.PlayRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the play command.
|
||
</summary>
|
||
<param name="controllingSessionId">The controlling session identifier.</param>
|
||
<param name="sessionId">The session id.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendSyncPlayCommand(System.String,MediaBrowser.Model.SyncPlay.SendCommand,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a SyncPlayCommand to a session.
|
||
</summary>
|
||
<param name="sessionId">The identifier of the session.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendSyncPlayGroupUpdate``1(System.String,MediaBrowser.Model.SyncPlay.GroupUpdate{``0},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a SyncPlayGroupUpdate to a session.
|
||
</summary>
|
||
<param name="sessionId">The identifier of the session.</param>
|
||
<param name="command">The group update.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<typeparam name="T">The group update type.</typeparam>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendBrowseCommand(System.String,System.String,MediaBrowser.Model.Session.BrowseRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the browse command.
|
||
</summary>
|
||
<param name="controllingSessionId">The controlling session identifier.</param>
|
||
<param name="sessionId">The session id.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendPlaystateCommand(System.String,System.String,MediaBrowser.Model.Session.PlaystateRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the playstate command.
|
||
</summary>
|
||
<param name="controllingSessionId">The controlling session identifier.</param>
|
||
<param name="sessionId">The session id.</param>
|
||
<param name="command">The command.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendMessageToAdminSessions``1(MediaBrowser.Model.Session.SessionMessageType,``0,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message to admin sessions.
|
||
</summary>
|
||
<typeparam name="T">Type of data.</typeparam>
|
||
<param name="name">Message type name.</param>
|
||
<param name="data">The data.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendMessageToUserSessions``1(System.Collections.Generic.List{System.Guid},MediaBrowser.Model.Session.SessionMessageType,``0,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message to user sessions.
|
||
</summary>
|
||
<typeparam name="T">Type of data.</typeparam>
|
||
<param name="userIds">Users to send messages to.</param>
|
||
<param name="name">Message type name.</param>
|
||
<param name="data">The data.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendMessageToUserSessions``1(System.Collections.Generic.List{System.Guid},MediaBrowser.Model.Session.SessionMessageType,System.Func{``0},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message to user sessions.
|
||
</summary>
|
||
<typeparam name="T">Type of data.</typeparam>
|
||
<param name="userIds">Users to send messages to.</param>
|
||
<param name="name">Message type name.</param>
|
||
<param name="dataFn">Data function.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendMessageToUserDeviceSessions``1(System.String,MediaBrowser.Model.Session.SessionMessageType,``0,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the message to user device sessions.
|
||
</summary>
|
||
<typeparam name="T">Type of data.</typeparam>
|
||
<param name="deviceId">The device identifier.</param>
|
||
<param name="name">Message type name.</param>
|
||
<param name="data">The data.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.SendRestartRequiredNotification(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the restart required message.
|
||
</summary>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.AddAdditionalUser(System.String,System.Guid)">
|
||
<summary>
|
||
Adds the additional user.
|
||
</summary>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<param name="userId">The user identifier.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.RemoveAdditionalUser(System.String,System.Guid)">
|
||
<summary>
|
||
Removes the additional user.
|
||
</summary>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<param name="userId">The user identifier.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ReportNowViewingItem(System.String,System.String)">
|
||
<summary>
|
||
Reports the now viewing item.
|
||
</summary>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<param name="itemId">The item identifier.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.AuthenticateNewSession(MediaBrowser.Controller.Session.AuthenticationRequest)">
|
||
<summary>
|
||
Authenticates the new session.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<returns>Task{SessionInfo}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ReportCapabilities(System.String,MediaBrowser.Model.Session.ClientCapabilities)">
|
||
<summary>
|
||
Reports the capabilities.
|
||
</summary>
|
||
<param name="sessionId">The session identifier.</param>
|
||
<param name="capabilities">The capabilities.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ReportTranscodingInfo(System.String,MediaBrowser.Model.Session.TranscodingInfo)">
|
||
<summary>
|
||
Reports the transcoding information.
|
||
</summary>
|
||
<param name="deviceId">The device identifier.</param>
|
||
<param name="info">The information.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ClearTranscodingInfo(System.String)">
|
||
<summary>
|
||
Clears the transcoding information.
|
||
</summary>
|
||
<param name="deviceId">The device identifier.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.GetSession(System.String,System.String,System.String)">
|
||
<summary>
|
||
Gets the session.
|
||
</summary>
|
||
<param name="deviceId">The device identifier.</param>
|
||
<param name="client">The client.</param>
|
||
<param name="version">The version.</param>
|
||
<returns>SessionInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.GetSessions(System.Guid,System.String,System.Nullable{System.Int32},System.Nullable{System.Guid},System.Boolean)">
|
||
<summary>
|
||
Gets all sessions available to a user.
|
||
</summary>
|
||
<param name="userId">The session identifier.</param>
|
||
<param name="deviceId">The device id.</param>
|
||
<param name="activeWithinSeconds">Active within session limit.</param>
|
||
<param name="controllableUserToCheck">Filter for sessions remote controllable for this user.</param>
|
||
<param name="isApiKey">Is the request authenticated with API key.</param>
|
||
<returns>IReadOnlyList{SessionInfoDto}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.GetSessionByAuthenticationToken(System.String,System.String,System.String)">
|
||
<summary>
|
||
Gets the session by authentication token.
|
||
</summary>
|
||
<param name="token">The token.</param>
|
||
<param name="deviceId">The device identifier.</param>
|
||
<param name="remoteEndpoint">The remote endpoint.</param>
|
||
<returns>SessionInfo.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.GetSessionByAuthenticationToken(Jellyfin.Database.Implementations.Entities.Security.Device,System.String,System.String,System.String)">
|
||
<summary>
|
||
Gets the session by authentication token.
|
||
</summary>
|
||
<param name="info">The information.</param>
|
||
<param name="deviceId">The device identifier.</param>
|
||
<param name="remoteEndpoint">The remote endpoint.</param>
|
||
<param name="appVersion">The application version.</param>
|
||
<returns>Task<SessionInfo>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.Logout(System.String)">
|
||
<summary>
|
||
Logs out the specified access token.
|
||
</summary>
|
||
<param name="accessToken">The access token.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the log out process.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.RevokeUserTokens(System.Guid,System.String)">
|
||
<summary>
|
||
Revokes the user tokens.
|
||
</summary>
|
||
<param name="userId">The user's id.</param>
|
||
<param name="currentAccessToken">The current access token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.CloseLiveStreamIfNeededAsync(System.String,System.String)">
|
||
<summary>
|
||
Used to close the livestream if needed.
|
||
</summary>
|
||
<param name="liveStreamId">The livestream id.</param>
|
||
<param name="sessionIdOrPlaySessionId">The session id or playsession id.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.ISessionManager.ToSessionInfoDto(MediaBrowser.Controller.Session.SessionInfo)">
|
||
<summary>
|
||
Gets the dto for session info.
|
||
</summary>
|
||
<param name="sessionInfo">The session info.</param>
|
||
<returns><see cref="T:MediaBrowser.Model.Dto.SessionInfoDto"/> of the session.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Session.SessionInfo">
|
||
<summary>
|
||
Class SessionInfo.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.#ctor(MediaBrowser.Controller.Session.ISessionManager,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Session.SessionInfo"/> class.
|
||
</summary>
|
||
<param name="sessionManager">Instance of <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
||
<param name="logger">Instance of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.PlayState">
|
||
<summary>
|
||
Gets or sets the play state.
|
||
</summary>
|
||
<value>The play state.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.AdditionalUsers">
|
||
<summary>
|
||
Gets or sets the additional users.
|
||
</summary>
|
||
<value>The additional users.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.Capabilities">
|
||
<summary>
|
||
Gets or sets the client capabilities.
|
||
</summary>
|
||
<value>The client capabilities.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.RemoteEndPoint">
|
||
<summary>
|
||
Gets or sets the remote end point.
|
||
</summary>
|
||
<value>The remote end point.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.PlayableMediaTypes">
|
||
<summary>
|
||
Gets the playable media types.
|
||
</summary>
|
||
<value>The playable media types.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.Id">
|
||
<summary>
|
||
Gets or sets the id.
|
||
</summary>
|
||
<value>The id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.UserId">
|
||
<summary>
|
||
Gets or sets the user id.
|
||
</summary>
|
||
<value>The user id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.UserName">
|
||
<summary>
|
||
Gets or sets the username.
|
||
</summary>
|
||
<value>The username.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.Client">
|
||
<summary>
|
||
Gets or sets the type of the client.
|
||
</summary>
|
||
<value>The type of the client.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.LastActivityDate">
|
||
<summary>
|
||
Gets or sets the last activity date.
|
||
</summary>
|
||
<value>The last activity date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.LastPlaybackCheckIn">
|
||
<summary>
|
||
Gets or sets the last playback check in.
|
||
</summary>
|
||
<value>The last playback check in.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.LastPausedDate">
|
||
<summary>
|
||
Gets or sets the last paused date.
|
||
</summary>
|
||
<value>The last paused date.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.DeviceName">
|
||
<summary>
|
||
Gets or sets the name of the device.
|
||
</summary>
|
||
<value>The name of the device.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.DeviceType">
|
||
<summary>
|
||
Gets or sets the type of the device.
|
||
</summary>
|
||
<value>The type of the device.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.NowPlayingItem">
|
||
<summary>
|
||
Gets or sets the now playing item.
|
||
</summary>
|
||
<value>The now playing item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.FullNowPlayingItem">
|
||
<summary>
|
||
Gets or sets the now playing queue full items.
|
||
</summary>
|
||
<value>The now playing queue full items.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.NowViewingItem">
|
||
<summary>
|
||
Gets or sets the now viewing item.
|
||
</summary>
|
||
<value>The now viewing item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.DeviceId">
|
||
<summary>
|
||
Gets or sets the device id.
|
||
</summary>
|
||
<value>The device id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.ApplicationVersion">
|
||
<summary>
|
||
Gets or sets the application version.
|
||
</summary>
|
||
<value>The application version.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.SessionControllers">
|
||
<summary>
|
||
Gets or sets the session controller.
|
||
</summary>
|
||
<value>The session controller.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.TranscodingInfo">
|
||
<summary>
|
||
Gets or sets the transcoding info.
|
||
</summary>
|
||
<value>The transcoding info.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.IsActive">
|
||
<summary>
|
||
Gets a value indicating whether this instance is active.
|
||
</summary>
|
||
<value><c>true</c> if this instance is active; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.SupportsMediaControl">
|
||
<summary>
|
||
Gets a value indicating whether the session supports media control.
|
||
</summary>
|
||
<value><c>true</c> if this session supports media control; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.SupportsRemoteControl">
|
||
<summary>
|
||
Gets a value indicating whether the session supports remote control.
|
||
</summary>
|
||
<value><c>true</c> if this session supports remote control; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.NowPlayingQueue">
|
||
<summary>
|
||
Gets or sets the now playing queue.
|
||
</summary>
|
||
<value>The now playing queue.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.NowPlayingQueueFullItems">
|
||
<summary>
|
||
Gets or sets the now playing queue full items.
|
||
</summary>
|
||
<value>The now playing queue full items.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.HasCustomDeviceName">
|
||
<summary>
|
||
Gets or sets a value indicating whether the session has a custom device name.
|
||
</summary>
|
||
<value><c>true</c> if this session has a custom device name; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.PlaylistItemId">
|
||
<summary>
|
||
Gets or sets the playlist item id.
|
||
</summary>
|
||
<value>The playlist item id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.ServerId">
|
||
<summary>
|
||
Gets or sets the server id.
|
||
</summary>
|
||
<value>The server id.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.UserPrimaryImageTag">
|
||
<summary>
|
||
Gets or sets the user primary image tag.
|
||
</summary>
|
||
<value>The user primary image tag.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Session.SessionInfo.SupportedCommands">
|
||
<summary>
|
||
Gets the supported commands.
|
||
</summary>
|
||
<value>The supported commands.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.EnsureController``1(System.Func{MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.Session.ISessionController})">
|
||
<summary>
|
||
Ensures a controller of type exists.
|
||
</summary>
|
||
<typeparam name="T">Class to register.</typeparam>
|
||
<param name="factory">The factory.</param>
|
||
<returns>Tuple{ISessionController, bool}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.AddController(MediaBrowser.Controller.Session.ISessionController)">
|
||
<summary>
|
||
Adds a controller to the session.
|
||
</summary>
|
||
<param name="controller">The controller.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.ContainsUser(System.Guid)">
|
||
<summary>
|
||
Gets a value indicating whether the session contains a user.
|
||
</summary>
|
||
<param name="userId">The user id to check.</param>
|
||
<returns><c>true</c> if this session contains the user; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.StartAutomaticProgress(MediaBrowser.Model.Session.PlaybackProgressInfo)">
|
||
<summary>
|
||
Starts automatic progressing.
|
||
</summary>
|
||
<param name="progressInfo">The playback progress info.</param>
|
||
<value>The supported commands.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.StopAutomaticProgress">
|
||
<summary>
|
||
Stops automatic progressing.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Session.SessionInfo.DisposeAsync">
|
||
<summary>
|
||
Disposes the instance async.
|
||
</summary>
|
||
<returns>ValueTask.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Sorting.IBaseItemComparer">
|
||
<summary>
|
||
Interface IBaseItemComparer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Sorting.IBaseItemComparer.Type">
|
||
<summary>
|
||
Gets the comparer type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Sorting.IUserBaseItemComparer">
|
||
<summary>
|
||
Represents a BaseItem comparer that requires a User to perform its comparison.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Sorting.IUserBaseItemComparer.User">
|
||
<summary>
|
||
Gets or sets the user.
|
||
</summary>
|
||
<value>The user.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Sorting.IUserBaseItemComparer.UserManager">
|
||
<summary>
|
||
Gets or sets the user manager.
|
||
</summary>
|
||
<value>The user manager.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Sorting.IUserBaseItemComparer.UserDataManager">
|
||
<summary>
|
||
Gets or sets the user data repository.
|
||
</summary>
|
||
<value>The user data repository.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Streaming.ProgressiveFileStream">
|
||
<summary>
|
||
A progressive file stream for transferring transcoded files as they are written to.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.#ctor(System.String,MediaBrowser.Controller.MediaEncoding.TranscodingJob,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Streaming.ProgressiveFileStream"/> class.
|
||
</summary>
|
||
<param name="filePath">The path to the transcoded file.</param>
|
||
<param name="job">The transcoding job information.</param>
|
||
<param name="transcodeManager">The transcode manager.</param>
|
||
<param name="timeoutMs">The timeout duration in milliseconds.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.#ctor(System.IO.Stream,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Streaming.ProgressiveFileStream"/> class.
|
||
</summary>
|
||
<param name="stream">The stream to progressively copy.</param>
|
||
<param name="timeoutMs">The timeout duration in milliseconds.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.ProgressiveFileStream.CanRead">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.ProgressiveFileStream.CanSeek">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.ProgressiveFileStream.CanWrite">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Length">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Position">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Flush">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Read(System.Span{System.Byte})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.SetLength(System.Int64)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.ProgressiveFileStream.Dispose(System.Boolean)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Streaming.StreamingRequestDto">
|
||
<summary>
|
||
The audio streaming request dto.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.Params">
|
||
<summary>
|
||
Gets or sets the params.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.PlaySessionId">
|
||
<summary>
|
||
Gets or sets the play session id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.Tag">
|
||
<summary>
|
||
Gets or sets the tag.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.SegmentContainer">
|
||
<summary>
|
||
Gets or sets the segment container.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.SegmentLength">
|
||
<summary>
|
||
Gets or sets the segment length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.MinSegments">
|
||
<summary>
|
||
Gets or sets the min segments.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.CurrentRuntimeTicks">
|
||
<summary>
|
||
Gets or sets the position of the requested segment in ticks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamingRequestDto.ActualSegmentLengthTicks">
|
||
<summary>
|
||
Gets or sets the actual segment length in ticks.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Streaming.StreamState">
|
||
<summary>
|
||
The stream state dto.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.StreamState.#ctor(MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.MediaEncoding.TranscodingJobType,MediaBrowser.Controller.MediaEncoding.ITranscodeManager)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.Streaming.StreamState" /> class.
|
||
</summary>
|
||
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager" /> interface.</param>
|
||
<param name="transcodingType">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType" />.</param>
|
||
<param name="transcodeManager">The <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager" /> singleton.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.RequestedUrl">
|
||
<summary>
|
||
Gets or sets the requested url.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.Request">
|
||
<summary>
|
||
Gets or sets the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.VideoRequest">
|
||
<summary>
|
||
Gets the video request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.DirectStreamProvider">
|
||
<summary>
|
||
Gets or sets the direct stream provider.
|
||
</summary>
|
||
<remarks>
|
||
Deprecated.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.WaitForPath">
|
||
<summary>
|
||
Gets or sets the path to wait for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.IsOutputVideo">
|
||
<summary>
|
||
Gets a value indicating whether the request outputs video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.SegmentLength">
|
||
<summary>
|
||
Gets the segment length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.MinSegments">
|
||
<summary>
|
||
Gets the minimum number of segments.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.UserAgent">
|
||
<summary>
|
||
Gets or sets the user agent.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.EstimateContentLength">
|
||
<summary>
|
||
Gets or sets a value indicating whether to estimate the content length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.TranscodeSeekInfo">
|
||
<summary>
|
||
Gets or sets the transcode seek info.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.StreamState.TranscodingJob">
|
||
<summary>
|
||
Gets or sets the transcoding job.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.StreamState.Dispose">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.StreamState.ReportTranscodingProgress(System.Nullable{System.TimeSpan},System.Nullable{System.Single},System.Nullable{System.Double},System.Nullable{System.Int64},System.Nullable{System.Int32})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Streaming.StreamState.Dispose(System.Boolean)">
|
||
<summary>
|
||
Disposes the stream state.
|
||
</summary>
|
||
<param name="disposing">Whether the object is currently being disposed.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Streaming.VideoRequestDto">
|
||
<summary>
|
||
The video request dto.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.VideoRequestDto.HasFixedResolution">
|
||
<summary>
|
||
Gets a value indicating whether this instance has fixed resolution.
|
||
</summary>
|
||
<value><c>true</c> if this instance has fixed resolution; otherwise, <c>false</c>.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.VideoRequestDto.EnableSubtitlesInManifest">
|
||
<summary>
|
||
Gets or sets a value indicating whether to enable subtitles in the manifest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Streaming.VideoRequestDto.EnableTrickplay">
|
||
<summary>
|
||
Gets or sets a value indicating whether to enable trickplay images.
|
||
</summary>
|
||
</member>
|
||
<member name="E:MediaBrowser.Controller.Subtitles.ISubtitleManager.SubtitleDownloadFailure">
|
||
<summary>
|
||
Occurs when [subtitle download failure].
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.SearchSubtitles(MediaBrowser.Controller.Entities.Video,System.String,System.Nullable{System.Boolean},System.Boolean,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Searches the subtitles.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="language">Subtitle language.</param>
|
||
<param name="isPerfectMatch">Require perfect match.</param>
|
||
<param name="isAutomated">Request is automated.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>Subtitles, wrapped in task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.SearchSubtitles(MediaBrowser.Controller.Subtitles.SubtitleSearchRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Searches the subtitles.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{RemoteSubtitleInfo[]}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.DownloadSubtitles(MediaBrowser.Controller.Entities.Video,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Downloads the subtitles.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="subtitleId">Subtitle ID.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.DownloadSubtitles(MediaBrowser.Controller.Entities.Video,MediaBrowser.Model.Configuration.LibraryOptions,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Downloads the subtitles.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="libraryOptions">Library options to use.</param>
|
||
<param name="subtitleId">Subtitle ID.</param>
|
||
<param name="cancellationToken">CancellationToken to use for the operation.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.UploadSubtitle(MediaBrowser.Controller.Entities.Video,MediaBrowser.Controller.Subtitles.SubtitleResponse)">
|
||
<summary>
|
||
Upload new subtitle.
|
||
</summary>
|
||
<param name="video">The video the subtitle belongs to.</param>
|
||
<param name="response">The subtitle response.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.GetRemoteSubtitles(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the remote subtitles.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns><see cref="T:System.Threading.Tasks.Task`1" />.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.DeleteSubtitles(MediaBrowser.Controller.Entities.BaseItem,System.Int32)">
|
||
<summary>
|
||
Deletes the subtitles.
|
||
</summary>
|
||
<param name="item">Media item.</param>
|
||
<param name="index">Subtitle index.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleManager.GetSupportedProviders(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets the providers.
|
||
</summary>
|
||
<param name="item">The media item.</param>
|
||
<returns>Subtitles providers.</returns>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Subtitles.ISubtitleProvider.Name">
|
||
<summary>
|
||
Gets the name.
|
||
</summary>
|
||
<value>The name.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Subtitles.ISubtitleProvider.SupportedMediaTypes">
|
||
<summary>
|
||
Gets the supported media types.
|
||
</summary>
|
||
<value>The supported media types.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleProvider.Search(MediaBrowser.Controller.Subtitles.SubtitleSearchRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Searches the subtitles.
|
||
</summary>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{IEnumerable{RemoteSubtitleInfo}}.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Subtitles.ISubtitleProvider.GetSubtitles(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the subtitles.
|
||
</summary>
|
||
<param name="id">The identifier.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task{SubtitleResponse}.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Subtitles.SubtitleDownloadFailureEventArgs">
|
||
<summary>
|
||
An event that occurs when subtitle downloading fails.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Subtitles.SubtitleDownloadFailureEventArgs.Item">
|
||
<summary>
|
||
Gets or sets the item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Subtitles.SubtitleDownloadFailureEventArgs.Provider">
|
||
<summary>
|
||
Gets or sets the provider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.Subtitles.SubtitleDownloadFailureEventArgs.Exception">
|
||
<summary>
|
||
Gets or sets the exception.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupMember">
|
||
<summary>
|
||
Class GroupMember.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupMember.#ctor(MediaBrowser.Controller.Session.SessionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupMember"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.SessionId">
|
||
<summary>
|
||
Gets the identifier of the session.
|
||
</summary>
|
||
<value>The session identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.UserId">
|
||
<summary>
|
||
Gets the identifier of the user.
|
||
</summary>
|
||
<value>The user identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.UserName">
|
||
<summary>
|
||
Gets the username.
|
||
</summary>
|
||
<value>The username.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.Ping">
|
||
<summary>
|
||
Gets or sets the ping, in milliseconds.
|
||
</summary>
|
||
<value>The ping.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.IsBuffering">
|
||
<summary>
|
||
Gets or sets a value indicating whether this member is buffering.
|
||
</summary>
|
||
<value><c>true</c> if member is buffering; <c>false</c> otherwise.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupMember.IgnoreGroupWait">
|
||
<summary>
|
||
Gets or sets a value indicating whether this member is following group playback.
|
||
</summary>
|
||
<value><c>true</c> to ignore member on group wait; <c>false</c> if they're following group playback.</value>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState">
|
||
<summary>
|
||
Class AbstractGroupState.
|
||
</summary>
|
||
<remarks>
|
||
Class is not thread-safe, external locking is required when accessing methods.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState._logger">
|
||
<summary>
|
||
The logger.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState"/> class.
|
||
</summary>
|
||
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.LoggerFactory">
|
||
<summary>
|
||
Gets the logger factory.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.AbstractGroupState.SendGroupStateUpdate(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a group state update to all group.
|
||
</summary>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="reason">The reason of the state change.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState">
|
||
<summary>
|
||
Class IdleGroupState.
|
||
</summary>
|
||
<remarks>
|
||
Class is not thread-safe, external locking is required when accessing methods.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState._logger">
|
||
<summary>
|
||
The logger.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState"/> class.
|
||
</summary>
|
||
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.IdleGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState">
|
||
<summary>
|
||
Class PausedGroupState.
|
||
</summary>
|
||
<remarks>
|
||
Class is not thread-safe, external locking is required when accessing methods.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState"/> class.
|
||
</summary>
|
||
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PausedGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState">
|
||
<summary>
|
||
Class PlayingGroupState.
|
||
</summary>
|
||
<remarks>
|
||
Class is not thread-safe, external locking is required when accessing methods.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState"/> class.
|
||
</summary>
|
||
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.IgnoreBuffering">
|
||
<summary>
|
||
Gets or sets a value indicating whether requests for buffering should be ignored.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.PlayingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState">
|
||
<summary>
|
||
Class WaitingGroupState.
|
||
</summary>
|
||
<remarks>
|
||
Class is not thread-safe, external locking is required when accessing methods.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState._logger">
|
||
<summary>
|
||
The logger.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState"/> class.
|
||
</summary>
|
||
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.ResumePlaying">
|
||
<summary>
|
||
Gets or sets a value indicating whether playback should resume when group is ready.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.InitialStateSet">
|
||
<summary>
|
||
Gets or sets a value indicating whether the initial state has been set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.InitialState">
|
||
<summary>
|
||
Gets or sets the group state before the first ever event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.GroupStates.WaitingGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest">
|
||
<summary>
|
||
Interface IGroupPlaybackRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest.Action">
|
||
<summary>
|
||
Gets the playback request type.
|
||
</summary>
|
||
<returns>The playback request type.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Applies the request to a group.
|
||
</summary>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="state">The current state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.IGroupState">
|
||
<summary>
|
||
Interface IGroupState.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupState.Type">
|
||
<summary>
|
||
Gets the group state type.
|
||
</summary>
|
||
<value>The group state type.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.SessionJoined(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a session that joined the group.
|
||
</summary>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.SessionLeaving(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a session that is leaving the group.
|
||
</summary>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generic handler. Context's state can change.
|
||
</summary>
|
||
<param name="request">The generic request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a play request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The play request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a set-playlist-item request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The set-playlist-item request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a remove-items request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The remove-items request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a move-playlist-item request from a session. Context's state should not change.
|
||
</summary>
|
||
<param name="request">The move-playlist-item request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a queue request from a session. Context's state should not change.
|
||
</summary>
|
||
<param name="request">The queue request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles an unpause request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The unpause request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a pause request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The pause request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a stop request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The stop request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a seek request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The seek request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a buffer request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The buffer request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a ready request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The ready request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a next-item request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The next-item request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a previous-item request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The previous-item request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a set-repeat-mode request from a session. Context's state should not change.
|
||
</summary>
|
||
<param name="request">The repeat-mode request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a set-shuffle-mode request from a session. Context's state should not change.
|
||
</summary>
|
||
<param name="request">The shuffle-mode request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates the ping of a session. Context's state should not change.
|
||
</summary>
|
||
<param name="request">The ping request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupState.HandleRequest(MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest,MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Model.SyncPlay.GroupStateType,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handles a ignore-wait request from a session. Context's state can change.
|
||
</summary>
|
||
<param name="request">The ignore-wait request.</param>
|
||
<param name="context">The context of the state.</param>
|
||
<param name="prevState">The previous state.</param>
|
||
<param name="session">The session.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.IGroupStateContext">
|
||
<summary>
|
||
Interface IGroupStateContext.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.DefaultPing">
|
||
<summary>
|
||
Gets the default ping value used for sessions, in milliseconds.
|
||
</summary>
|
||
<value>The default ping value used for sessions, in milliseconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.TimeSyncOffset">
|
||
<summary>
|
||
Gets the maximum time offset error accepted for dates reported by clients, in milliseconds.
|
||
</summary>
|
||
<value>The maximum offset error accepted, in milliseconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.MaxPlaybackOffset">
|
||
<summary>
|
||
Gets the maximum offset error accepted for position reported by clients, in milliseconds.
|
||
</summary>
|
||
<value>The maximum offset error accepted, in milliseconds.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.GroupId">
|
||
<summary>
|
||
Gets the group identifier.
|
||
</summary>
|
||
<value>The group identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.PositionTicks">
|
||
<summary>
|
||
Gets or sets the position ticks.
|
||
</summary>
|
||
<value>The position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.LastActivity">
|
||
<summary>
|
||
Gets or sets the last activity.
|
||
</summary>
|
||
<value>The last activity.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.IGroupStateContext.PlayQueue">
|
||
<summary>
|
||
Gets the play queue.
|
||
</summary>
|
||
<value>The play queue.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetState(MediaBrowser.Controller.SyncPlay.IGroupState)">
|
||
<summary>
|
||
Sets a new state.
|
||
</summary>
|
||
<param name="state">The new state.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SendGroupUpdate``1(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Model.SyncPlay.SyncPlayBroadcastType,MediaBrowser.Model.SyncPlay.GroupUpdate{``0},System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a GroupUpdate message to the interested sessions.
|
||
</summary>
|
||
<param name="from">The current session.</param>
|
||
<param name="type">The filtering type.</param>
|
||
<param name="message">The message to send.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<typeparam name="T">The group update type.</typeparam>
|
||
<returns>The task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SendCommand(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Model.SyncPlay.SyncPlayBroadcastType,MediaBrowser.Model.SyncPlay.SendCommand,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a playback command to the interested sessions.
|
||
</summary>
|
||
<param name="from">The current session.</param>
|
||
<param name="type">The filtering type.</param>
|
||
<param name="message">The message to send.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.NewSyncPlayCommand(MediaBrowser.Model.SyncPlay.SendCommandType)">
|
||
<summary>
|
||
Builds a new playback command with some default values.
|
||
</summary>
|
||
<param name="type">The command type.</param>
|
||
<returns>The command.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SanitizePositionTicks(System.Nullable{System.Int64})">
|
||
<summary>
|
||
Sanitizes the PositionTicks, considers the current playing item when available.
|
||
</summary>
|
||
<param name="positionTicks">The PositionTicks.</param>
|
||
<returns>The sanitized position ticks.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.UpdatePing(MediaBrowser.Controller.Session.SessionInfo,System.Int64)">
|
||
<summary>
|
||
Updates the ping of a session, in milliseconds.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="ping">The ping, in milliseconds.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.GetHighestPing">
|
||
<summary>
|
||
Gets the highest ping in the group, in milliseconds.
|
||
</summary>
|
||
<returns>The highest ping in the group.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetBuffering(MediaBrowser.Controller.Session.SessionInfo,System.Boolean)">
|
||
<summary>
|
||
Sets the session's buffering state.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="isBuffering">The state.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetAllBuffering(System.Boolean)">
|
||
<summary>
|
||
Sets the buffering state of all the sessions.
|
||
</summary>
|
||
<param name="isBuffering">The state.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.IsBuffering">
|
||
<summary>
|
||
Gets the group buffering state.
|
||
</summary>
|
||
<returns><c>true</c> if there is a session buffering in the group; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetIgnoreGroupWait(MediaBrowser.Controller.Session.SessionInfo,System.Boolean)">
|
||
<summary>
|
||
Sets the session's group wait state.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="ignoreGroupWait">The state.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetPlayQueue(System.Collections.Generic.IReadOnlyList{System.Guid},System.Int32,System.Int64)">
|
||
<summary>
|
||
Sets a new play queue.
|
||
</summary>
|
||
<param name="playQueue">The new play queue.</param>
|
||
<param name="playingItemPosition">The playing item position in the play queue.</param>
|
||
<param name="startPositionTicks">The start position ticks.</param>
|
||
<returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetPlayingItem(System.Guid)">
|
||
<summary>
|
||
Sets the playing item.
|
||
</summary>
|
||
<param name="playlistItemId">The new playing item identifier.</param>
|
||
<returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.ClearPlayQueue(System.Boolean)">
|
||
<summary>
|
||
Clears the play queue.
|
||
</summary>
|
||
<param name="clearPlayingItem">Whether to remove the playing item as well.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.RemoveFromPlayQueue(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Removes items from the play queue.
|
||
</summary>
|
||
<param name="playlistItemIds">The items to remove.</param>
|
||
<returns><c>true</c> if playing item got removed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.MoveItemInPlayQueue(System.Guid,System.Int32)">
|
||
<summary>
|
||
Moves an item in the play queue.
|
||
</summary>
|
||
<param name="playlistItemId">The playlist identifier of the item to move.</param>
|
||
<param name="newIndex">The new position.</param>
|
||
<returns><c>true</c> if item has been moved; <c>false</c> if something went wrong.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.AddToPlayQueue(System.Collections.Generic.IReadOnlyList{System.Guid},MediaBrowser.Model.SyncPlay.GroupQueueMode)">
|
||
<summary>
|
||
Updates the play queue.
|
||
</summary>
|
||
<param name="newItems">The new items to add to the play queue.</param>
|
||
<param name="mode">The mode with which the items will be added.</param>
|
||
<returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.RestartCurrentItem">
|
||
<summary>
|
||
Restarts current item in play queue.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.NextItemInQueue">
|
||
<summary>
|
||
Picks next item in play queue.
|
||
</summary>
|
||
<returns><c>true</c> if the item changed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.PreviousItemInQueue">
|
||
<summary>
|
||
Picks previous item in play queue.
|
||
</summary>
|
||
<returns><c>true</c> if the item changed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetRepeatMode(MediaBrowser.Model.SyncPlay.GroupRepeatMode)">
|
||
<summary>
|
||
Sets the repeat mode.
|
||
</summary>
|
||
<param name="mode">The new mode.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.SetShuffleMode(MediaBrowser.Model.SyncPlay.GroupShuffleMode)">
|
||
<summary>
|
||
Sets the shuffle mode.
|
||
</summary>
|
||
<param name="mode">The new mode.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.IGroupStateContext.GetPlayQueueUpdate(MediaBrowser.Model.SyncPlay.PlayQueueUpdateReason)">
|
||
<summary>
|
||
Creates a play queue update.
|
||
</summary>
|
||
<param name="reason">The reason for the update.</param>
|
||
<returns>The play queue update.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.ISyncPlayManager">
|
||
<summary>
|
||
Interface ISyncPlayManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.NewGroup(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new group.
|
||
</summary>
|
||
<param name="session">The session that's creating the group.</param>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>The newly created group.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.JoinGroup(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Adds the session to a group.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.LeaveGroup(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.SyncPlay.Requests.LeaveGroupRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Removes the session from a group.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.ListGroups(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.SyncPlay.Requests.ListGroupsRequest)">
|
||
<summary>
|
||
Gets list of available groups for a session.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="request">The request.</param>
|
||
<returns>The list of available groups.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.GetGroup(MediaBrowser.Controller.Session.SessionInfo,System.Guid)">
|
||
<summary>
|
||
Gets available groups for a session by id.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="groupId">The group id.</param>
|
||
<returns>The groups or null.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.HandleRequest(MediaBrowser.Controller.Session.SessionInfo,MediaBrowser.Controller.SyncPlay.IGroupPlaybackRequest,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Handle a request by a session in a group.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="request">The request.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.ISyncPlayManager.IsUserActive(System.Guid)">
|
||
<summary>
|
||
Checks whether a user has an active session using SyncPlay.
|
||
</summary>
|
||
<param name="userId">The user identifier to check.</param>
|
||
<returns><c>true</c> if the user is using SyncPlay; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.ISyncPlayRequest">
|
||
<summary>
|
||
Interface ISyncPlayRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.ISyncPlayRequest.Type">
|
||
<summary>
|
||
Gets the request type.
|
||
</summary>
|
||
<returns>The request type.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest">
|
||
<summary>
|
||
Class AbstractPlaybackRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.AbstractPlaybackRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest">
|
||
<summary>
|
||
Class BufferGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.#ctor(System.DateTime,System.Int64,System.Boolean,System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest"/> class.
|
||
</summary>
|
||
<param name="when">When the request has been made, as reported by the client.</param>
|
||
<param name="positionTicks">The position ticks.</param>
|
||
<param name="isPlaying">Whether the client playback is unpaused.</param>
|
||
<param name="playlistItemId">The playlist item identifier of the playing item.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.When">
|
||
<summary>
|
||
Gets when the request has been made by the client.
|
||
</summary>
|
||
<value>The date of the request.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.PositionTicks">
|
||
<summary>
|
||
Gets the position ticks.
|
||
</summary>
|
||
<value>The position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.IsPlaying">
|
||
<summary>
|
||
Gets a value indicating whether the client playback is unpaused.
|
||
</summary>
|
||
<value>The client playback status.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playlist item identifier of the playing item.
|
||
</summary>
|
||
<value>The playlist item identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.BufferGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest">
|
||
<summary>
|
||
Class IgnoreWaitGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest.#ctor(System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest"/> class.
|
||
</summary>
|
||
<param name="ignoreWait">Whether the client should be ignored.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest.IgnoreWait">
|
||
<summary>
|
||
Gets a value indicating whether the client should be ignored.
|
||
</summary>
|
||
<value>The client group-wait status.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.IgnoreWaitGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest">
|
||
<summary>
|
||
Class MovePlaylistItemGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest.#ctor(System.Guid,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest"/> class.
|
||
</summary>
|
||
<param name="playlistItemId">The playlist identifier of the item.</param>
|
||
<param name="newIndex">The new position.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playlist identifier of the item.
|
||
</summary>
|
||
<value>The playlist identifier of the item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest.NewIndex">
|
||
<summary>
|
||
Gets the new position.
|
||
</summary>
|
||
<value>The new position.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.MovePlaylistItemGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest">
|
||
<summary>
|
||
Class NextItemGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest.#ctor(System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest"/> class.
|
||
</summary>
|
||
<param name="playlistItemId">The playing item identifier.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playing item identifier.
|
||
</summary>
|
||
<value>The playing item identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.NextItemGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest">
|
||
<summary>
|
||
Class PauseGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PauseGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest">
|
||
<summary>
|
||
Class PingGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest.#ctor(System.Int64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest"/> class.
|
||
</summary>
|
||
<param name="ping">The ping time.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest.Ping">
|
||
<summary>
|
||
Gets the ping time.
|
||
</summary>
|
||
<value>The ping time.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PingGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest">
|
||
<summary>
|
||
Class PlayGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.#ctor(System.Collections.Generic.IReadOnlyList{System.Guid},System.Int32,System.Int64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest"/> class.
|
||
</summary>
|
||
<param name="playingQueue">The playing queue.</param>
|
||
<param name="playingItemPosition">The playing item position.</param>
|
||
<param name="startPositionTicks">The start position ticks.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.PlayingQueue">
|
||
<summary>
|
||
Gets the playing queue.
|
||
</summary>
|
||
<value>The playing queue.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.PlayingItemPosition">
|
||
<summary>
|
||
Gets the position of the playing item in the queue.
|
||
</summary>
|
||
<value>The playing item position.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.StartPositionTicks">
|
||
<summary>
|
||
Gets the start position ticks.
|
||
</summary>
|
||
<value>The start position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PlayGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest">
|
||
<summary>
|
||
Class PreviousItemGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest.#ctor(System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest"/> class.
|
||
</summary>
|
||
<param name="playlistItemId">The playing item identifier.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playing item identifier.
|
||
</summary>
|
||
<value>The playing item identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.PreviousItemGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest">
|
||
<summary>
|
||
Class QueueGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest.#ctor(System.Collections.Generic.IReadOnlyList{System.Guid},MediaBrowser.Model.SyncPlay.GroupQueueMode)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest"/> class.
|
||
</summary>
|
||
<param name="items">The items to add to the queue.</param>
|
||
<param name="mode">The enqueue mode.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest.ItemIds">
|
||
<summary>
|
||
Gets the items to enqueue.
|
||
</summary>
|
||
<value>The items to enqueue.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest.Mode">
|
||
<summary>
|
||
Gets the mode in which to add the new items.
|
||
</summary>
|
||
<value>The enqueue mode.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.QueueGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest">
|
||
<summary>
|
||
Class ReadyGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.#ctor(System.DateTime,System.Int64,System.Boolean,System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest"/> class.
|
||
</summary>
|
||
<param name="when">When the request has been made, as reported by the client.</param>
|
||
<param name="positionTicks">The position ticks.</param>
|
||
<param name="isPlaying">Whether the client playback is unpaused.</param>
|
||
<param name="playlistItemId">The playlist item identifier of the playing item.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.When">
|
||
<summary>
|
||
Gets when the request has been made by the client.
|
||
</summary>
|
||
<value>The date of the request.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.PositionTicks">
|
||
<summary>
|
||
Gets the position ticks.
|
||
</summary>
|
||
<value>The position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.IsPlaying">
|
||
<summary>
|
||
Gets a value indicating whether the client playback is unpaused.
|
||
</summary>
|
||
<value>The client playback status.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playlist item identifier of the playing item.
|
||
</summary>
|
||
<value>The playlist item identifier.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.ReadyGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest">
|
||
<summary>
|
||
Class RemoveFromPlaylistGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.#ctor(System.Collections.Generic.IReadOnlyList{System.Guid},System.Boolean,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest"/> class.
|
||
</summary>
|
||
<param name="items">The playlist ids of the items to remove.</param>
|
||
<param name="clearPlaylist">Whether to clear the entire playlist. The items list will be ignored.</param>
|
||
<param name="clearPlayingItem">Whether to remove the playing item as well. Used only when clearing the playlist.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.PlaylistItemIds">
|
||
<summary>
|
||
Gets the playlist identifiers of the items.
|
||
</summary>
|
||
<value>The playlist identifiers of the items.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.ClearPlaylist">
|
||
<summary>
|
||
Gets a value indicating whether the entire playlist should be cleared.
|
||
</summary>
|
||
<value>Whether the entire playlist should be cleared.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.ClearPlayingItem">
|
||
<summary>
|
||
Gets a value indicating whether the playing item should be removed as well.
|
||
</summary>
|
||
<value>Whether the playing item should be removed as well.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.RemoveFromPlaylistGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest">
|
||
<summary>
|
||
Class SeekGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest.#ctor(System.Int64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest"/> class.
|
||
</summary>
|
||
<param name="positionTicks">The position ticks.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest.PositionTicks">
|
||
<summary>
|
||
Gets the position ticks.
|
||
</summary>
|
||
<value>The position ticks.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SeekGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest">
|
||
<summary>
|
||
Class SetPlaylistItemGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest.#ctor(System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest"/> class.
|
||
</summary>
|
||
<param name="playlistItemId">The playlist identifier of the item.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest.PlaylistItemId">
|
||
<summary>
|
||
Gets the playlist identifier of the playing item.
|
||
</summary>
|
||
<value>The playlist identifier of the playing item.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetPlaylistItemGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest">
|
||
<summary>
|
||
Class SetRepeatModeGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest.#ctor(MediaBrowser.Model.SyncPlay.GroupRepeatMode)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest"/> class.
|
||
</summary>
|
||
<param name="mode">The repeat mode.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest.Mode">
|
||
<summary>
|
||
Gets the repeat mode.
|
||
</summary>
|
||
<value>The repeat mode.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetRepeatModeGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest">
|
||
<summary>
|
||
Class SetShuffleModeGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest.#ctor(MediaBrowser.Model.SyncPlay.GroupShuffleMode)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest"/> class.
|
||
</summary>
|
||
<param name="mode">The shuffle mode.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest.Mode">
|
||
<summary>
|
||
Gets the shuffle mode.
|
||
</summary>
|
||
<value>The shuffle mode.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.SetShuffleModeGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest">
|
||
<summary>
|
||
Class StopGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.StopGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest">
|
||
<summary>
|
||
Class UnpauseGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest.Action">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.PlaybackRequests.UnpauseGroupRequest.Apply(MediaBrowser.Controller.SyncPlay.IGroupStateContext,MediaBrowser.Controller.SyncPlay.IGroupState,MediaBrowser.Controller.Session.SessionInfo,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager">
|
||
<summary>
|
||
Class PlayQueueManager.
|
||
</summary>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.NoPlayingItemIndex">
|
||
<summary>
|
||
Placeholder index for when no item is playing.
|
||
</summary>
|
||
<value>The no-playing item index.</value>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager._sortedPlaylist">
|
||
<summary>
|
||
The sorted playlist.
|
||
</summary>
|
||
<value>The sorted playlist, or play queue of the group.</value>
|
||
</member>
|
||
<member name="F:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager._shuffledPlaylist">
|
||
<summary>
|
||
The shuffled playlist.
|
||
</summary>
|
||
<value>The shuffled playlist, or play queue of the group.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.PlayingItemIndex">
|
||
<summary>
|
||
Gets the playing item index.
|
||
</summary>
|
||
<value>The playing item index.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.LastChange">
|
||
<summary>
|
||
Gets the last time the queue has been changed.
|
||
</summary>
|
||
<value>The last time the queue has been changed.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.ShuffleMode">
|
||
<summary>
|
||
Gets the shuffle mode.
|
||
</summary>
|
||
<value>The shuffle mode.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.RepeatMode">
|
||
<summary>
|
||
Gets the repeat mode.
|
||
</summary>
|
||
<value>The repeat mode.</value>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.IsItemPlaying">
|
||
<summary>
|
||
Checks if an item is playing.
|
||
</summary>
|
||
<returns><c>true</c> if an item is playing; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetPlaylist">
|
||
<summary>
|
||
Gets the current playlist considering the shuffle mode.
|
||
</summary>
|
||
<returns>The playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetPlaylist(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Sets a new playlist. Playing item is reset.
|
||
</summary>
|
||
<param name="items">The new items of the playlist.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.Queue(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Appends new items to the playlist. The specified order is maintained.
|
||
</summary>
|
||
<param name="items">The items to add to the playlist.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.ShufflePlaylist">
|
||
<summary>
|
||
Shuffles the playlist. Shuffle mode is changed. The playlist gets re-shuffled if already shuffled.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.RestoreSortedPlaylist">
|
||
<summary>
|
||
Resets the playlist to sorted mode. Shuffle mode is changed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.ClearPlaylist(System.Boolean)">
|
||
<summary>
|
||
Clears the playlist. Shuffle mode is preserved.
|
||
</summary>
|
||
<param name="clearPlayingItem">Whether to remove the playing item as well.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.QueueNext(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Adds new items to the playlist right after the playing item. The specified order is maintained.
|
||
</summary>
|
||
<param name="items">The items to add to the playlist.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetPlayingItemPlaylistId">
|
||
<summary>
|
||
Gets playlist identifier of the playing item, if any.
|
||
</summary>
|
||
<returns>The playlist identifier of the playing item.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetPlayingItemId">
|
||
<summary>
|
||
Gets the playing item identifier, if any.
|
||
</summary>
|
||
<returns>The playing item identifier.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetPlayingItemById(System.Guid)">
|
||
<summary>
|
||
Sets the playing item using its identifier. If not in the playlist, the playing item is reset.
|
||
</summary>
|
||
<param name="itemId">The new playing item identifier.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetPlayingItemByPlaylistId(System.Guid)">
|
||
<summary>
|
||
Sets the playing item using its playlist identifier. If not in the playlist, the playing item is reset.
|
||
</summary>
|
||
<param name="playlistItemId">The new playing item identifier.</param>
|
||
<returns><c>true</c> if playing item has been set; <c>false</c> if item is not in the playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetPlayingItemByIndex(System.Int32)">
|
||
<summary>
|
||
Sets the playing item using its position. If not in range, the playing item is reset.
|
||
</summary>
|
||
<param name="playlistIndex">The new playing item index.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.RemoveFromPlaylist(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Removes items from the playlist. If not removed, the playing item is preserved.
|
||
</summary>
|
||
<param name="playlistItemIds">The items to remove.</param>
|
||
<returns><c>true</c> if playing item got removed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.MovePlaylistItem(System.Guid,System.Int32)">
|
||
<summary>
|
||
Moves an item in the playlist to another position.
|
||
</summary>
|
||
<param name="playlistItemId">The item to move.</param>
|
||
<param name="newIndex">The new position.</param>
|
||
<returns><c>true</c> if the item has been moved; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.Reset">
|
||
<summary>
|
||
Resets the playlist to its initial state.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetRepeatMode(MediaBrowser.Model.SyncPlay.GroupRepeatMode)">
|
||
<summary>
|
||
Sets the repeat mode.
|
||
</summary>
|
||
<param name="mode">The new mode.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.SetShuffleMode(MediaBrowser.Model.SyncPlay.GroupShuffleMode)">
|
||
<summary>
|
||
Sets the shuffle mode.
|
||
</summary>
|
||
<param name="mode">The new mode.</param>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.ToggleShuffleMode">
|
||
<summary>
|
||
Toggles the shuffle mode between sorted and shuffled.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetNextItemPlaylistId">
|
||
<summary>
|
||
Gets the next item in the playlist considering repeat mode and shuffle mode.
|
||
</summary>
|
||
<returns>The next item in the playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.Next">
|
||
<summary>
|
||
Sets the next item in the queue as playing item.
|
||
</summary>
|
||
<returns><c>true</c> if the playing item changed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.Previous">
|
||
<summary>
|
||
Sets the previous item in the queue as playing item.
|
||
</summary>
|
||
<returns><c>true</c> if the playing item changed; <c>false</c> otherwise.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.CreateQueueItemsFromArray(System.Collections.Generic.IReadOnlyList{System.Guid})">
|
||
<summary>
|
||
Creates a list from the array of items. Each item is given an unique playlist identifier.
|
||
</summary>
|
||
<returns>The list of queue items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetPlaylistInternal">
|
||
<summary>
|
||
Gets the current playlist considering the shuffle mode.
|
||
</summary>
|
||
<returns>The playlist.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Queue.PlayQueueManager.GetPlayingItem">
|
||
<summary>
|
||
Gets the current playing item, depending on the shuffle mode.
|
||
</summary>
|
||
<returns>The playing item.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest">
|
||
<summary>
|
||
Class JoinGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest.#ctor(System.Guid)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest"/> class.
|
||
</summary>
|
||
<param name="groupId">The identifier of the group to join.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest.GroupId">
|
||
<summary>
|
||
Gets the group identifier.
|
||
</summary>
|
||
<value>The identifier of the group to join.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.JoinGroupRequest.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.Requests.LeaveGroupRequest">
|
||
<summary>
|
||
Class LeaveGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.LeaveGroupRequest.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.Requests.ListGroupsRequest">
|
||
<summary>
|
||
Class ListGroupsRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.ListGroupsRequest.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest">
|
||
<summary>
|
||
Class NewGroupRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest"/> class.
|
||
</summary>
|
||
<param name="groupName">The name of the new group.</param>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest.GroupName">
|
||
<summary>
|
||
Gets the group name.
|
||
</summary>
|
||
<value>The name of the new group.</value>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SyncPlay.Requests.NewGroupRequest.Type">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SystemBackupService.BackupManifestDto">
|
||
<summary>
|
||
Manifest type for backups internal structure.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupManifestDto.ServerVersion">
|
||
<summary>
|
||
Gets or sets the jellyfin version this backup was created with.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupManifestDto.BackupEngineVersion">
|
||
<summary>
|
||
Gets or sets the backup engine version this backup was created with.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupManifestDto.DateCreated">
|
||
<summary>
|
||
Gets or sets the date this backup was created with.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupManifestDto.Path">
|
||
<summary>
|
||
Gets or sets the path to the backup on the system.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupManifestDto.Options">
|
||
<summary>
|
||
Gets or sets the contents of the backup archive.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SystemBackupService.BackupOptionsDto">
|
||
<summary>
|
||
Defines the optional contents of the backup archive.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupOptionsDto.Metadata">
|
||
<summary>
|
||
Gets or sets a value indicating whether the archive contains the Metadata contents.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupOptionsDto.Trickplay">
|
||
<summary>
|
||
Gets or sets a value indicating whether the archive contains the Trickplay contents.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupOptionsDto.Subtitles">
|
||
<summary>
|
||
Gets or sets a value indicating whether the archive contains the Subtitle contents.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupOptionsDto.Database">
|
||
<summary>
|
||
Gets or sets a value indicating whether the archive contains the Database contents.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.SystemBackupService.BackupRestoreRequestDto">
|
||
<summary>
|
||
Defines properties used to start a restore process.
|
||
</summary>
|
||
</member>
|
||
<member name="P:MediaBrowser.Controller.SystemBackupService.BackupRestoreRequestDto.ArchiveFileName">
|
||
<summary>
|
||
Gets or Sets the name of the backup archive to restore from. Must be present in <see cref="P:MediaBrowser.Common.Configuration.IApplicationPaths.BackupPath"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.Trickplay.ITrickplayManager">
|
||
<summary>
|
||
Interface ITrickplayManager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.RefreshTrickplayDataAsync(MediaBrowser.Controller.Entities.Video,System.Boolean,MediaBrowser.Model.Configuration.LibraryOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates new trickplay images and metadata.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="replace">Whether or not existing data should be replaced.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.CreateTiles(System.Collections.Generic.IReadOnlyList{System.String},System.Int32,MediaBrowser.Model.Configuration.TrickplayOptions,System.String)">
|
||
<summary>
|
||
Creates trickplay tiles out of individual thumbnails.
|
||
</summary>
|
||
<param name="images">Ordered file paths of the thumbnails to be used.</param>
|
||
<param name="width">The width of a single thumbnail.</param>
|
||
<param name="options">The trickplay options.</param>
|
||
<param name="outputDir">The output directory.</param>
|
||
<returns>The associated trickplay information.</returns>
|
||
<remarks>
|
||
The output directory will be DELETED and replaced if it already exists.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetTrickplayResolutions(System.Guid)">
|
||
<summary>
|
||
Get available trickplay resolutions and corresponding info.
|
||
</summary>
|
||
<param name="itemId">The item.</param>
|
||
<returns>Map of width resolutions to trickplay tiles info.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetTrickplayItemsAsync(System.Int32,System.Int32)">
|
||
<summary>
|
||
Gets the item ids of all items with trickplay info.
|
||
</summary>
|
||
<param name="limit">The limit of items to return.</param>
|
||
<param name="offset">The offset to start the query at.</param>
|
||
<returns>The list of item ids that have trickplay info.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.SaveTrickplayInfo(Jellyfin.Database.Implementations.Entities.TrickplayInfo)">
|
||
<summary>
|
||
Saves trickplay info.
|
||
</summary>
|
||
<param name="info">The trickplay info.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.DeleteTrickplayDataAsync(System.Guid,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes all trickplay info for an item.
|
||
</summary>
|
||
<param name="itemId">The item id.</param>
|
||
<param name="cancellationToken">The cancellation token.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetTrickplayManifest(MediaBrowser.Controller.Entities.BaseItem)">
|
||
<summary>
|
||
Gets all trickplay infos for all media streams of an item.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<returns>A map of media source id to a map of tile width to trickplay info.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetTrickplayTilePathAsync(MediaBrowser.Controller.Entities.BaseItem,System.Int32,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Gets the path to a trickplay tile image.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="width">The width of a single thumbnail.</param>
|
||
<param name="index">The tile's index.</param>
|
||
<param name="saveWithMedia">Whether or not the tile should be saved next to the media file.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetTrickplayDirectory(MediaBrowser.Controller.Entities.BaseItem,System.Int32,System.Int32,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Gets the path to a trickplay tile image.
|
||
</summary>
|
||
<param name="item">The item.</param>
|
||
<param name="tileWidth">The amount of images for the tile width.</param>
|
||
<param name="tileHeight">The amount of images for the tile height.</param>
|
||
<param name="width">The width of a single thumbnail.</param>
|
||
<param name="saveWithMedia">Whether or not the tile should be saved next to the media file.</param>
|
||
<returns>The absolute path.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.MoveGeneratedTrickplayDataAsync(MediaBrowser.Controller.Entities.Video,MediaBrowser.Model.Configuration.LibraryOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Migrates trickplay images between local and media directories.
|
||
</summary>
|
||
<param name="video">The video.</param>
|
||
<param name="libraryOptions">The library options.</param>
|
||
<param name="cancellationToken">CancellationToken to use for operation.</param>
|
||
<returns>Task.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.Trickplay.ITrickplayManager.GetHlsPlaylist(System.Guid,System.Int32,System.String)">
|
||
<summary>
|
||
Gets the trickplay HLS playlist.
|
||
</summary>
|
||
<param name="itemId">The item.</param>
|
||
<param name="width">The width of a single thumbnail.</param>
|
||
<param name="apiKey">Optional api key of the requesting user.</param>
|
||
<returns>The text content of the .m3u8 playlist.</returns>
|
||
</member>
|
||
<member name="T:MediaBrowser.Controller.TV.ITVSeriesManager">
|
||
<summary>
|
||
The TV Series manager.
|
||
</summary>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.TV.ITVSeriesManager.GetNextUp(MediaBrowser.Model.Querying.NextUpQuery,MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the next up.
|
||
</summary>
|
||
<param name="query">The next up query.</param>
|
||
<param name="options">The dto options.</param>
|
||
<returns>The next up items.</returns>
|
||
</member>
|
||
<member name="M:MediaBrowser.Controller.TV.ITVSeriesManager.GetNextUp(MediaBrowser.Model.Querying.NextUpQuery,MediaBrowser.Controller.Entities.BaseItem[],MediaBrowser.Controller.Dto.DtoOptions)">
|
||
<summary>
|
||
Gets the next up.
|
||
</summary>
|
||
<param name="request">The next up request.</param>
|
||
<param name="parentsFolders">The list of parent folders.</param>
|
||
<param name="options">The dto options.</param>
|
||
<returns>The next up items.</returns>
|
||
</member>
|
||
<member name="T:Jellyfin.Server.Implementations.SystemBackupService.IBackupService">
|
||
<summary>
|
||
Defines an interface to restore and backup the jellyfin system.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Jellyfin.Server.Implementations.SystemBackupService.IBackupService.CreateBackupAsync(MediaBrowser.Controller.SystemBackupService.BackupOptionsDto)">
|
||
<summary>
|
||
Creates a new Backup zip file containing the current state of the application.
|
||
</summary>
|
||
<param name="backupOptions">The backup options.</param>
|
||
<returns>A task.</returns>
|
||
</member>
|
||
<member name="M:Jellyfin.Server.Implementations.SystemBackupService.IBackupService.EnumerateBackups">
|
||
<summary>
|
||
Gets a list of backups that are available to be restored from.
|
||
</summary>
|
||
<returns>A list of backup paths.</returns>
|
||
</member>
|
||
<member name="M:Jellyfin.Server.Implementations.SystemBackupService.IBackupService.GetBackupManifest(System.String)">
|
||
<summary>
|
||
Gets a single backup manifest if the path defines a valid Jellyfin backup archive.
|
||
</summary>
|
||
<param name="archivePath">The path to be loaded.</param>
|
||
<returns>The containing backup manifest or null if not existing or compatiable.</returns>
|
||
</member>
|
||
<member name="M:Jellyfin.Server.Implementations.SystemBackupService.IBackupService.RestoreBackupAsync(System.String)">
|
||
<summary>
|
||
Restores an backup zip file created by jellyfin.
|
||
</summary>
|
||
<param name="archivePath">Path to the archive.</param>
|
||
<returns>A Task.</returns>
|
||
<exception cref="T:System.IO.FileNotFoundException">Thrown when an invalid or missing file is specified.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when attempt to load an unsupported backup is made.</exception>
|
||
<exception cref="T:System.InvalidOperationException">Thrown for errors during the restore.</exception>
|
||
</member>
|
||
<member name="M:Jellyfin.Server.Implementations.SystemBackupService.IBackupService.ScheduleRestoreAndRestartServer(System.String)">
|
||
<summary>
|
||
Schedules a Restore and restarts the server.
|
||
</summary>
|
||
<param name="archivePath">The path to the archive to restore from.</param>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the WhiteSpaceRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.WhiteSpaceRegex_0.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.Utilities">
|
||
<summary>Helper methods used by generated <see cref="T:System.Text.RegularExpressions.Regex"/>-derived implementations.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_defaultTimeout">
|
||
<summary>Default timeout value set in <see cref="T:System.AppContext"/>, or <see cref="F:System.Text.RegularExpressions.Regex.InfiniteMatchTimeout"/> if none was set.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_hasTimeout">
|
||
<summary>Whether <see cref="F:System.Text.RegularExpressions.Generated.Utilities.s_defaultTimeout"/> is non-infinite.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_whitespace">
|
||
<summary>Supports searching for characters in or not in "\t\n\v\f\r \u0085 \u2028\u2029 ".</summary>
|
||
</member>
|
||
</members>
|
||
</doc>
|