mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-06-03 22:38:30 +01:00
Add full stop at end of comments (SA1629)
This commit is contained in:
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Channels
|
||||
public List<ChannelMediaContentType> ContentTypes { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Represents the maximum number of records the channel allows retrieving at a time
|
||||
/// Represents the maximum number of records the channel allows retrieving at a time.
|
||||
/// </summary>
|
||||
public int? MaxPageSize { get; set; }
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Model.Configuration;
|
||||
namespace MediaBrowser.Controller.Configuration
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IServerConfigurationManager
|
||||
/// Interface IServerConfigurationManager.
|
||||
/// </summary>
|
||||
public interface IServerConfigurationManager : IConfigurationManager
|
||||
{
|
||||
|
||||
@@ -10,7 +10,7 @@ using MediaBrowser.Model.Entities;
|
||||
namespace MediaBrowser.Controller.Drawing
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IImageProcessor
|
||||
/// Interface IImageProcessor.
|
||||
/// </summary>
|
||||
public interface IImageProcessor
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Querying;
|
||||
namespace MediaBrowser.Controller.Dto
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IDtoService
|
||||
/// Interface IDtoService.
|
||||
/// </summary>
|
||||
public interface IDtoService
|
||||
{
|
||||
|
||||
@@ -35,7 +35,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public override bool SupportsPlayedStatus => false;
|
||||
|
||||
/// <summary>
|
||||
/// The _virtual children
|
||||
/// The _virtual children.
|
||||
/// </summary>
|
||||
private readonly ConcurrentBag<BaseItem> _virtualChildren = new ConcurrentBag<BaseItem>();
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Entities;
|
||||
namespace MediaBrowser.Controller.Entities.Audio
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Audio
|
||||
/// Class Audio.
|
||||
/// </summary>
|
||||
public class Audio : BaseItem,
|
||||
IHasAlbumArtist,
|
||||
|
||||
@@ -15,7 +15,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
|
||||
namespace MediaBrowser.Controller.Entities.Audio
|
||||
{
|
||||
/// <summary>
|
||||
/// Class MusicAlbum
|
||||
/// Class MusicAlbum.
|
||||
/// </summary>
|
||||
public class MusicAlbum : Folder, IHasAlbumArtist, IHasArtist, IHasMusicGenres, IHasLookupInfo<AlbumInfo>, IMetadataContainer
|
||||
{
|
||||
|
||||
@@ -15,7 +15,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
|
||||
namespace MediaBrowser.Controller.Entities.Audio
|
||||
{
|
||||
/// <summary>
|
||||
/// Class MusicArtist
|
||||
/// Class MusicArtist.
|
||||
/// </summary>
|
||||
public class MusicArtist : Folder, IItemByName, IHasMusicGenres, IHasDualAccess, IHasLookupInfo<ArtistInfo>
|
||||
{
|
||||
@@ -111,7 +111,7 @@ namespace MediaBrowser.Controller.Entities.Audio
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -201,7 +201,7 @@ namespace MediaBrowser.Controller.Entities.Audio
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities.Audio
|
||||
{
|
||||
/// <summary>
|
||||
/// Class MusicGenre
|
||||
/// Class MusicGenre.
|
||||
/// </summary>
|
||||
public class MusicGenre : BaseItem, IItemByName
|
||||
{
|
||||
@@ -34,7 +34,7 @@ namespace MediaBrowser.Controller.Entities.Audio
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -98,7 +98,7 @@ namespace MediaBrowser.Controller.Entities.Audio
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -31,12 +31,12 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class BaseItem
|
||||
/// Class BaseItem.
|
||||
/// </summary>
|
||||
public abstract class BaseItem : IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IEquatable<BaseItem>
|
||||
{
|
||||
/// <summary>
|
||||
/// The supported image extensions
|
||||
/// The supported image extensions.
|
||||
/// </summary>
|
||||
public static readonly string[] SupportedImageExtensions
|
||||
= new[] { ".png", ".jpg", ".jpeg", ".tbn", ".gif" };
|
||||
@@ -75,7 +75,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public static char SlugChar = '-';
|
||||
|
||||
/// <summary>
|
||||
/// The trailer folder name
|
||||
/// The trailer folder name.
|
||||
/// </summary>
|
||||
public const string TrailerFolderName = "trailers";
|
||||
public const string ThemeSongsFolderName = "theme-music";
|
||||
@@ -243,7 +243,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
[JsonIgnore]
|
||||
public virtual string ContainingFolderPath
|
||||
@@ -267,7 +267,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public string ServiceName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// If this content came from an external service, the id of the content on that service
|
||||
/// If this content came from an external service, the id of the content on that service.
|
||||
/// </summary>
|
||||
[JsonIgnore]
|
||||
public string ExternalId { get; set; }
|
||||
@@ -411,7 +411,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is just a helper for convenience
|
||||
/// This is just a helper for convenience.
|
||||
/// </summary>
|
||||
/// <value>The primary image path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -556,7 +556,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public DateTime DateLastRefreshed { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The logger
|
||||
/// The logger.
|
||||
/// </summary>
|
||||
public static ILoggerFactory LoggerFactory { get; set; }
|
||||
public static ILogger<BaseItem> Logger { get; set; }
|
||||
@@ -799,7 +799,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finds a parent of a given type
|
||||
/// Finds a parent of a given type.
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns>``0.</returns>
|
||||
@@ -1351,7 +1351,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Overrides the base implementation to refresh metadata for local trailers
|
||||
/// Overrides the base implementation to refresh metadata for local trailers.
|
||||
/// </summary>
|
||||
/// <param name="options">The options.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
@@ -1753,7 +1753,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines if a given user has access to this item
|
||||
/// Determines if a given user has access to this item.
|
||||
/// </summary>
|
||||
/// <param name="user">The user.</param>
|
||||
/// <returns><c>true</c> if [is parental allowed] [the specified user]; otherwise, <c>false</c>.</returns>
|
||||
@@ -2059,7 +2059,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public virtual bool EnableRememberingTrackSelections => true;
|
||||
|
||||
/// <summary>
|
||||
/// Adds a studio to the item
|
||||
/// Adds a studio to the item.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <exception cref="ArgumentNullException"></exception>
|
||||
@@ -2095,7 +2095,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds a genre to the item
|
||||
/// Adds a genre to the item.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <exception cref="ArgumentNullException"></exception>
|
||||
@@ -2190,7 +2190,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets an image
|
||||
/// Gets an image.
|
||||
/// </summary>
|
||||
/// <param name="type">The type.</param>
|
||||
/// <param name="imageIndex">Index of the image.</param>
|
||||
@@ -2506,7 +2506,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the file system path to delete when the item is to be deleted
|
||||
/// Gets the file system path to delete when the item is to be deleted.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public virtual IEnumerable<FileSystemMetadata> GetDeletePaths()
|
||||
|
||||
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <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
|
||||
/// It is created from the user-specific folders within the system root.
|
||||
/// </summary>
|
||||
public class CollectionFolder : Folder, ICollectionFolder
|
||||
{
|
||||
@@ -140,7 +140,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Allow different display preferences for each collection folder
|
||||
/// Allow different display preferences for each collection folder.
|
||||
/// </summary>
|
||||
/// <value>The display prefs id.</value>
|
||||
[JsonIgnore]
|
||||
|
||||
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Entities;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Extensions
|
||||
/// Class Extensions.
|
||||
/// </summary>
|
||||
public static class Extensions
|
||||
{
|
||||
|
||||
@@ -31,7 +31,7 @@ using Series = MediaBrowser.Controller.Entities.TV.Series;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Folder
|
||||
/// Class Folder.
|
||||
/// </summary>
|
||||
public class Folder : BaseItem
|
||||
{
|
||||
@@ -172,7 +172,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public virtual IEnumerable<BaseItem> Children => LoadChildren();
|
||||
|
||||
/// <summary>
|
||||
/// thread-safe access to all recursive children of this folder - without regard to user
|
||||
/// thread-safe access to all recursive children of this folder - without regard to user.
|
||||
/// </summary>
|
||||
/// <value>The recursive children.</value>
|
||||
[JsonIgnore]
|
||||
@@ -229,7 +229,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates that the children of the folder still exist
|
||||
/// Validates that the children of the folder still exist.
|
||||
/// </summary>
|
||||
/// <param name="progress">The progress.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
@@ -570,7 +570,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get the children of this folder from the actual file system
|
||||
/// Get the children of this folder from the actual file system.
|
||||
/// </summary>
|
||||
/// <returns>IEnumerable{BaseItem}.</returns>
|
||||
protected virtual IEnumerable<BaseItem> GetNonCachedChildren(IDirectoryService directoryService)
|
||||
@@ -582,7 +582,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get our children from the repo - stubbed for now
|
||||
/// Get our children from the repo - stubbed for now.
|
||||
/// </summary>
|
||||
/// <returns>IEnumerable{BaseItem}.</returns>
|
||||
protected List<BaseItem> GetCachedChildren()
|
||||
@@ -1286,7 +1286,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets allowed recursive children of an item
|
||||
/// Gets allowed recursive children of an item.
|
||||
/// </summary>
|
||||
/// <param name="user">The user.</param>
|
||||
/// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
|
||||
|
||||
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Genre
|
||||
/// Class Genre.
|
||||
/// </summary>
|
||||
public class Genre : BaseItem, IItemByName
|
||||
{
|
||||
@@ -31,7 +31,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using System;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// This is just a marker interface to denote top level folders
|
||||
/// This is just a marker interface to denote top level folders.
|
||||
/// </summary>
|
||||
public interface ICollectionFolder : IHasCollectionType
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IHasAspectRatio
|
||||
/// Interface IHasAspectRatio.
|
||||
/// </summary>
|
||||
public interface IHasAspectRatio
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IHasDisplayOrder
|
||||
/// Interface IHasDisplayOrder.
|
||||
/// </summary>
|
||||
public interface IHasDisplayOrder
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IHasScreenshots
|
||||
/// Interface IHasScreenshots.
|
||||
/// </summary>
|
||||
public interface IHasScreenshots
|
||||
{
|
||||
|
||||
@@ -16,7 +16,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
public string Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Serves as a cache
|
||||
/// Serves as a cache.
|
||||
/// </summary>
|
||||
public Guid? ItemId { get; set; }
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Querying;
|
||||
namespace MediaBrowser.Controller.Entities.Movies
|
||||
{
|
||||
/// <summary>
|
||||
/// Class BoxSet
|
||||
/// Class BoxSet.
|
||||
/// </summary>
|
||||
public class BoxSet : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo<BoxSetInfo>
|
||||
{
|
||||
|
||||
@@ -13,7 +13,7 @@ using MediaBrowser.Model.Providers;
|
||||
namespace MediaBrowser.Controller.Entities.Movies
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Movie
|
||||
/// Class Movie.
|
||||
/// </summary>
|
||||
public class Movie : Video, IHasSpecialFeatures, IHasTrailers, IHasLookupInfo<MovieInfo>, ISupportsBoxSetGrouping
|
||||
{
|
||||
|
||||
@@ -46,7 +46,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -118,7 +118,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Studio
|
||||
/// Class Studio.
|
||||
/// </summary>
|
||||
public class Studio : BaseItem, IItemByName
|
||||
{
|
||||
@@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -97,7 +97,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -12,7 +12,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities.TV
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Episode
|
||||
/// Class Episode.
|
||||
/// </summary>
|
||||
public class Episode : Video, IHasTrailers, IHasLookupInfo<EpisodeInfo>, IHasSeries
|
||||
{
|
||||
@@ -101,7 +101,7 @@ namespace MediaBrowser.Controller.Entities.TV
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This Episode's Series Instance
|
||||
/// This Episode's Series Instance.
|
||||
/// </summary>
|
||||
/// <value>The series.</value>
|
||||
[JsonIgnore]
|
||||
|
||||
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Querying;
|
||||
namespace MediaBrowser.Controller.Entities.TV
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Season
|
||||
/// Class Season.
|
||||
/// </summary>
|
||||
public class Season : Folder, IHasSeries, IHasLookupInfo<SeasonInfo>
|
||||
{
|
||||
@@ -68,7 +68,7 @@ namespace MediaBrowser.Controller.Entities.TV
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This Episode's Series Instance
|
||||
/// This Episode's Series Instance.
|
||||
/// </summary>
|
||||
/// <value>The series.</value>
|
||||
[JsonIgnore]
|
||||
@@ -225,7 +225,7 @@ namespace MediaBrowser.Controller.Entities.TV
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
|
||||
@@ -17,7 +17,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
|
||||
namespace MediaBrowser.Controller.Entities.TV
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Series
|
||||
/// Class Series.
|
||||
/// </summary>
|
||||
public class Series : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo<SeriesInfo>, IMetadataContainer
|
||||
{
|
||||
@@ -54,7 +54,7 @@ namespace MediaBrowser.Controller.Entities.TV
|
||||
public IReadOnlyList<Guid> RemoteTrailerIds { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// airdate, dvd or absolute
|
||||
/// airdate, dvd or absolute.
|
||||
/// </summary>
|
||||
public string DisplayOrder { get; set; }
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ using MediaBrowser.Model.Providers;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Trailer
|
||||
/// Class Trailer.
|
||||
/// </summary>
|
||||
public class Trailer : Video, IHasLookupInfo<TrailerInfo>
|
||||
{
|
||||
|
||||
@@ -4,7 +4,7 @@ using System.Text.Json.Serialization;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class UserItemData
|
||||
/// Class UserItemData.
|
||||
/// </summary>
|
||||
public class UserItemData
|
||||
{
|
||||
@@ -21,11 +21,11 @@ namespace MediaBrowser.Controller.Entities
|
||||
public string Key { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The _rating
|
||||
/// The _rating.
|
||||
/// </summary>
|
||||
private double? _rating;
|
||||
/// <summary>
|
||||
/// Gets or sets the users 0-10 rating
|
||||
/// Gets or sets the users 0-10 rating.
|
||||
/// </summary>
|
||||
/// <value>The rating.</value>
|
||||
/// <exception cref="ArgumentOutOfRangeException">Rating;A 0 to 10 rating is required for UserItemData.</exception>
|
||||
|
||||
@@ -17,7 +17,7 @@ using MediaBrowser.Model.MediaInfo;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Video
|
||||
/// Class Video.
|
||||
/// </summary>
|
||||
public class Video : BaseItem,
|
||||
IHasAspectRatio,
|
||||
|
||||
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Entities
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Year
|
||||
/// Class Year.
|
||||
/// </summary>
|
||||
public class Year : BaseItem, IItemByName
|
||||
{
|
||||
@@ -21,7 +21,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
@@ -107,7 +107,7 @@ namespace MediaBrowser.Controller.Entities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made
|
||||
/// This is called before any metadata refresh and returns true or false indicating if changes were made.
|
||||
/// </summary>
|
||||
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ using System.Text.RegularExpressions;
|
||||
namespace MediaBrowser.Controller.Extensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Class BaseExtensions
|
||||
/// Class BaseExtensions.
|
||||
/// </summary>
|
||||
public static class StringExtensions
|
||||
{
|
||||
|
||||
@@ -10,7 +10,7 @@ using Microsoft.AspNetCore.Http;
|
||||
namespace MediaBrowser.Controller
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IServerApplicationHost
|
||||
/// Interface IServerApplicationHost.
|
||||
/// </summary>
|
||||
public interface IServerApplicationHost : IApplicationHost
|
||||
{
|
||||
|
||||
@@ -5,7 +5,7 @@ namespace MediaBrowser.Controller
|
||||
public interface IServerApplicationPaths : IApplicationPaths
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the path to the base root media directory
|
||||
/// Gets the path to the base root media directory.
|
||||
/// </summary>
|
||||
/// <value>The root folder path.</value>
|
||||
string RootFolderPath { get; }
|
||||
@@ -17,13 +17,13 @@ namespace MediaBrowser.Controller
|
||||
string DefaultUserViewsPath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the People directory
|
||||
/// Gets the path to the People directory.
|
||||
/// </summary>
|
||||
/// <value>The people path.</value>
|
||||
string PeoplePath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the Genre directory
|
||||
/// Gets the path to the Genre directory.
|
||||
/// </summary>
|
||||
/// <value>The genre path.</value>
|
||||
string GenrePath { get; }
|
||||
@@ -35,25 +35,25 @@ namespace MediaBrowser.Controller
|
||||
string MusicGenrePath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the Studio directory
|
||||
/// Gets the path to the Studio directory.
|
||||
/// </summary>
|
||||
/// <value>The studio path.</value>
|
||||
string StudioPath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the Year directory
|
||||
/// Gets the path to the Year directory.
|
||||
/// </summary>
|
||||
/// <value>The year path.</value>
|
||||
string YearPath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the General IBN directory
|
||||
/// Gets the path to the General IBN directory.
|
||||
/// </summary>
|
||||
/// <value>The general path.</value>
|
||||
string GeneralPath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the Ratings IBN directory
|
||||
/// Gets the path to the Ratings IBN directory.
|
||||
/// </summary>
|
||||
/// <value>The ratings path.</value>
|
||||
string RatingsPath { get; }
|
||||
@@ -65,7 +65,7 @@ namespace MediaBrowser.Controller
|
||||
string MediaInfoImagesPath { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path to the user configuration directory
|
||||
/// Gets the path to the user configuration directory.
|
||||
/// </summary>
|
||||
/// <value>The user configuration directory path.</value>
|
||||
string UserConfigurationDirectoryPath { get; }
|
||||
|
||||
@@ -5,7 +5,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class BaseIntroProvider
|
||||
/// Class BaseIntroProvider.
|
||||
/// </summary>
|
||||
public interface IIntroProvider
|
||||
{
|
||||
|
||||
@@ -21,7 +21,7 @@ using Person = MediaBrowser.Controller.Entities.Person;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface ILibraryManager
|
||||
/// Interface ILibraryManager.
|
||||
/// </summary>
|
||||
public interface ILibraryManager
|
||||
{
|
||||
@@ -38,7 +38,7 @@ namespace MediaBrowser.Controller.Library
|
||||
bool allowIgnorePath = true);
|
||||
|
||||
/// <summary>
|
||||
/// Resolves a set of files into a list of BaseItem
|
||||
/// Resolves a set of files into a list of BaseItem.
|
||||
/// </summary>
|
||||
IEnumerable<BaseItem> ResolvePaths(
|
||||
IEnumerable<FileSystemMetadata> files,
|
||||
@@ -54,7 +54,7 @@ namespace MediaBrowser.Controller.Library
|
||||
AggregateFolder RootFolder { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a Person
|
||||
/// Gets a Person.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>Task{Person}.</returns>
|
||||
@@ -75,14 +75,14 @@ namespace MediaBrowser.Controller.Library
|
||||
MusicArtist GetArtist(string name);
|
||||
MusicArtist GetArtist(string name, DtoOptions options);
|
||||
/// <summary>
|
||||
/// Gets a Studio
|
||||
/// Gets a Studio.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>Task{Studio}.</returns>
|
||||
Studio GetStudio(string name);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a Genre
|
||||
/// Gets a Genre.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>Task{Genre}.</returns>
|
||||
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Library
|
||||
MusicGenre GetMusicGenre(string name);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a Year
|
||||
/// Gets a Year.
|
||||
/// </summary>
|
||||
/// <param name="value">The value.</param>
|
||||
/// <returns>Task{Year}.</returns>
|
||||
@@ -113,7 +113,7 @@ namespace MediaBrowser.Controller.Library
|
||||
Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress);
|
||||
|
||||
/// <summary>
|
||||
/// Reloads the root media folder
|
||||
/// Reloads the root media folder.
|
||||
/// </summary>
|
||||
/// <param name="progress">The progress.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
|
||||
@@ -5,7 +5,7 @@ using System.Threading.Tasks;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// An interface for tasks that run after the media library scan
|
||||
/// An interface for tasks that run after the media library scan.
|
||||
/// </summary>
|
||||
public interface ILibraryPostScanTask
|
||||
{
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IMetadataSaver
|
||||
/// Interface IMetadataSaver.
|
||||
/// </summary>
|
||||
public interface IMetadataSaver
|
||||
{
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Model.Search;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface ILibrarySearchEngine
|
||||
/// Interface ILibrarySearchEngine.
|
||||
/// </summary>
|
||||
public interface ISearchEngine
|
||||
{
|
||||
|
||||
@@ -42,14 +42,14 @@ namespace MediaBrowser.Controller.Library
|
||||
UserItemDataDto GetUserDataDto(BaseItem item, BaseItemDto itemDto, User user, DtoOptions dto_options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all user data for the given user
|
||||
/// Get all user data for the given user.
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <returns></returns>
|
||||
List<UserItemData> GetAllUserData(Guid userId);
|
||||
|
||||
/// <summary>
|
||||
/// Save the all provided user data for the given user
|
||||
/// Save the all provided user data for the given user.
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="userData"></param>
|
||||
@@ -58,7 +58,7 @@ namespace MediaBrowser.Controller.Library
|
||||
void SaveAllUserData(Guid userId, UserItemData[] userData, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Updates playstate for an item and returns true or false indicating if it was played to completion
|
||||
/// Updates playstate for an item and returns true or false indicating if it was played to completion.
|
||||
/// </summary>
|
||||
bool UpdatePlayState(BaseItem item, UserItemData data, long? positionTicks);
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Users;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IUserManager
|
||||
/// Interface IUserManager.
|
||||
/// </summary>
|
||||
public interface IUserManager
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class ItemChangeEventArgs
|
||||
/// Class ItemChangeEventArgs.
|
||||
/// </summary>
|
||||
public class ItemChangeEventArgs
|
||||
{
|
||||
|
||||
@@ -15,7 +15,7 @@ namespace MediaBrowser.Controller.Library
|
||||
public class ItemResolveArgs : EventArgs
|
||||
{
|
||||
/// <summary>
|
||||
/// The _app paths
|
||||
/// The _app paths.
|
||||
/// </summary>
|
||||
private readonly IServerApplicationPaths _appPaths;
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ using MediaBrowser.Model.Dto;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Holds information about a playback progress event
|
||||
/// Holds information about a playback progress event.
|
||||
/// </summary>
|
||||
public class PlaybackProgressEventArgs : EventArgs
|
||||
{
|
||||
|
||||
@@ -5,21 +5,21 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class Profiler
|
||||
/// Class Profiler.
|
||||
/// </summary>
|
||||
public class Profiler : IDisposable
|
||||
{
|
||||
/// <summary>
|
||||
/// The name
|
||||
/// The name.
|
||||
/// </summary>
|
||||
readonly string _name;
|
||||
/// <summary>
|
||||
/// The stopwatch
|
||||
/// The stopwatch.
|
||||
/// </summary>
|
||||
readonly Stopwatch _stopwatch;
|
||||
|
||||
/// <summary>
|
||||
/// The _logger
|
||||
/// The _logger.
|
||||
/// </summary>
|
||||
private readonly ILogger<Profiler> _logger;
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class SearchHintInfo
|
||||
/// Class SearchHintInfo.
|
||||
/// </summary>
|
||||
public class SearchHintInfo
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using System;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class TVUtils
|
||||
/// Class TVUtils.
|
||||
/// </summary>
|
||||
public static class TVUtils
|
||||
{
|
||||
|
||||
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Entities;
|
||||
namespace MediaBrowser.Controller.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// Class UserDataSaveEventArgs
|
||||
/// Class UserDataSaveEventArgs.
|
||||
/// </summary>
|
||||
public class UserDataSaveEventArgs : EventArgs
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Model.LiveTv;
|
||||
namespace MediaBrowser.Controller.LiveTv
|
||||
{
|
||||
/// <summary>
|
||||
/// Class ChannelInfo
|
||||
/// Class ChannelInfo.
|
||||
/// </summary>
|
||||
public class ChannelInfo
|
||||
{
|
||||
@@ -44,13 +44,13 @@ namespace MediaBrowser.Controller.LiveTv
|
||||
public ChannelType ChannelType { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image path if it can be accessed directly from the file system
|
||||
/// Supply the image path if it can be accessed directly from the file system.
|
||||
/// </summary>
|
||||
/// <value>The image path.</value>
|
||||
public string ImagePath { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image url if it can be downloaded
|
||||
/// Supply the image url if it can be downloaded.
|
||||
/// </summary>
|
||||
/// <value>The image URL.</value>
|
||||
public string ImageUrl { get; set; }
|
||||
|
||||
@@ -14,7 +14,7 @@ using MediaBrowser.Model.Querying;
|
||||
namespace MediaBrowser.Controller.LiveTv
|
||||
{
|
||||
/// <summary>
|
||||
/// Manages all live tv services installed on the server
|
||||
/// Manages all live tv services installed on the server.
|
||||
/// </summary>
|
||||
public interface ILiveTvManager
|
||||
{
|
||||
|
||||
@@ -140,7 +140,7 @@ namespace MediaBrowser.Controller.LiveTv
|
||||
|
||||
/// <summary>
|
||||
/// Returns the folder containing the item.
|
||||
/// If the item is a folder, it returns the folder itself
|
||||
/// If the item is a folder, it returns the folder itself.
|
||||
/// </summary>
|
||||
/// <value>The containing folder path.</value>
|
||||
[JsonIgnore]
|
||||
|
||||
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.LiveTv
|
||||
public string ChannelId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Name of the program
|
||||
/// Name of the program.
|
||||
/// </summary>
|
||||
public string Name { get; set; }
|
||||
|
||||
@@ -95,13 +95,13 @@ namespace MediaBrowser.Controller.LiveTv
|
||||
public string EpisodeTitle { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image path if it can be accessed directly from the file system
|
||||
/// Supply the image path if it can be accessed directly from the file system.
|
||||
/// </summary>
|
||||
/// <value>The image path.</value>
|
||||
public string ImagePath { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image url if it can be downloaded
|
||||
/// Supply the image url if it can be downloaded.
|
||||
/// </summary>
|
||||
/// <value>The image URL.</value>
|
||||
public string ImageUrl { get; set; }
|
||||
|
||||
@@ -169,13 +169,13 @@ namespace MediaBrowser.Controller.LiveTv
|
||||
public float? CommunityRating { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image path if it can be accessed directly from the file system
|
||||
/// Supply the image path if it can be accessed directly from the file system.
|
||||
/// </summary>
|
||||
/// <value>The image path.</value>
|
||||
public string ImagePath { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Supply the image url if it can be downloaded
|
||||
/// Supply the image url if it can be downloaded.
|
||||
/// </summary>
|
||||
/// <value>The image URL.</value>
|
||||
public string ImageUrl { get; set; }
|
||||
|
||||
@@ -108,7 +108,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the name of the output video codec
|
||||
/// Gets the name of the output video codec.
|
||||
/// </summary>
|
||||
public string GetVideoEncoder(EncodingJobInfo state, EncodingOptions encodingOptions)
|
||||
{
|
||||
@@ -285,7 +285,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Infers the audio codec based on the url
|
||||
/// Infers the audio codec based on the url.
|
||||
/// </summary>
|
||||
public string InferAudioCodec(string container)
|
||||
{
|
||||
@@ -703,7 +703,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the video bitrate to specify on the command line
|
||||
/// Gets the video bitrate to specify on the command line.
|
||||
/// </summary>
|
||||
public string GetVideoQualityParam(EncodingJobInfo state, string videoEncoder, EncodingOptions encodingOptions, string defaultPreset)
|
||||
{
|
||||
@@ -1300,7 +1300,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the number of audio channels to specify on the command line
|
||||
/// 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>
|
||||
@@ -1486,7 +1486,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines which stream will be used for playback
|
||||
/// Determines which stream will be used for playback.
|
||||
/// </summary>
|
||||
/// <param name="allStream">All stream.</param>
|
||||
/// <param name="desiredIndex">Index of the desired.</param>
|
||||
@@ -1961,7 +1961,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// If we're going to put a fixed size on the command line, this will calculate it
|
||||
/// If we're going to put a fixed size on the command line, this will calculate it.
|
||||
/// </summary>
|
||||
public string GetOutputSizeParam(
|
||||
EncodingJobInfo state,
|
||||
@@ -2505,7 +2505,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the name of the output video codec
|
||||
/// Gets the name of the output video codec.
|
||||
/// </summary>
|
||||
protected string GetHardwareAcceleratedVideoDecoder(EncodingJobInfo state, EncodingOptions encodingOptions)
|
||||
{
|
||||
|
||||
@@ -418,7 +418,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Predicts the audio sample rate that will be in the output stream
|
||||
/// Predicts the audio sample rate that will be in the output stream.
|
||||
/// </summary>
|
||||
public double? TargetVideoLevel
|
||||
{
|
||||
@@ -441,7 +441,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Predicts the audio sample rate that will be in the output stream
|
||||
/// Predicts the audio sample rate that will be in the output stream.
|
||||
/// </summary>
|
||||
public int? TargetVideoBitDepth
|
||||
{
|
||||
@@ -476,7 +476,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Predicts the audio sample rate that will be in the output stream
|
||||
/// Predicts the audio sample rate that will be in the output stream.
|
||||
/// </summary>
|
||||
public float? TargetFramerate
|
||||
{
|
||||
@@ -508,7 +508,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Predicts the audio sample rate that will be in the output stream
|
||||
/// Predicts the audio sample rate that will be in the output stream.
|
||||
/// </summary>
|
||||
public int? TargetPacketLength
|
||||
{
|
||||
@@ -524,7 +524,7 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Predicts the audio sample rate that will be in the output stream
|
||||
/// Predicts the audio sample rate that will be in the output stream.
|
||||
/// </summary>
|
||||
public string TargetVideoProfile
|
||||
{
|
||||
@@ -679,20 +679,20 @@ namespace MediaBrowser.Controller.MediaEncoding
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Enum TranscodingJobType
|
||||
/// Enum TranscodingJobType.
|
||||
/// </summary>
|
||||
public enum TranscodingJobType
|
||||
{
|
||||
/// <summary>
|
||||
/// The progressive
|
||||
/// The progressive.
|
||||
/// </summary>
|
||||
Progressive,
|
||||
/// <summary>
|
||||
/// The HLS
|
||||
/// The HLS.
|
||||
/// </summary>
|
||||
Hls,
|
||||
/// <summary>
|
||||
/// The dash
|
||||
/// The dash.
|
||||
/// </summary>
|
||||
Dash
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ using MediaBrowser.Model.System;
|
||||
namespace MediaBrowser.Controller.MediaEncoding
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IMediaEncoder
|
||||
/// Interface IMediaEncoder.
|
||||
/// </summary>
|
||||
public interface IMediaEncoder : ITranscoderSupport
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ using MediaBrowser.Model.IO;
|
||||
namespace MediaBrowser.Controller.MediaEncoding
|
||||
{
|
||||
/// <summary>
|
||||
/// Class MediaEncoderHelpers
|
||||
/// Class MediaEncoderHelpers.
|
||||
/// </summary>
|
||||
public static class MediaEncoderHelpers
|
||||
{
|
||||
|
||||
@@ -11,7 +11,7 @@ using Microsoft.Extensions.Logging;
|
||||
namespace MediaBrowser.Controller.Net
|
||||
{
|
||||
/// <summary>
|
||||
/// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received
|
||||
/// 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>
|
||||
@@ -20,7 +20,7 @@ namespace MediaBrowser.Controller.Net
|
||||
where TReturnDataType : class
|
||||
{
|
||||
/// <summary>
|
||||
/// The _active connections
|
||||
/// The _active connections.
|
||||
/// </summary>
|
||||
private readonly List<Tuple<IWebSocketConnection, CancellationTokenSource, TStateType>> _activeConnections =
|
||||
new List<Tuple<IWebSocketConnection, CancellationTokenSource, TStateType>>();
|
||||
@@ -38,7 +38,7 @@ namespace MediaBrowser.Controller.Net
|
||||
protected abstract Task<TReturnDataType> GetDataToSend();
|
||||
|
||||
/// <summary>
|
||||
/// The logger
|
||||
/// The logger.
|
||||
/// </summary>
|
||||
protected ILogger<BasePeriodicWebSocketListener<TReturnDataType, TStateType>> Logger;
|
||||
|
||||
@@ -78,7 +78,7 @@ namespace MediaBrowser.Controller.Net
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts sending messages over a web socket
|
||||
/// Starts sending messages over a web socket.
|
||||
/// </summary>
|
||||
/// <param name="message">The message.</param>
|
||||
private void Start(WebSocketMessageInfo message)
|
||||
@@ -180,7 +180,7 @@ namespace MediaBrowser.Controller.Net
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Stops sending messages over a web socket
|
||||
/// Stops sending messages over a web socket.
|
||||
/// </summary>
|
||||
/// <param name="message">The message.</param>
|
||||
private void Stop(WebSocketMessageInfo message)
|
||||
|
||||
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Services;
|
||||
namespace MediaBrowser.Controller.Net
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IHttpResultFactory
|
||||
/// Interface IHttpResultFactory.
|
||||
/// </summary>
|
||||
public interface IHttpResultFactory
|
||||
{
|
||||
|
||||
@@ -29,19 +29,19 @@ namespace MediaBrowser.Controller.Net
|
||||
void Init(IEnumerable<Type> serviceTypes, IEnumerable<IWebSocketListener> listener, IEnumerable<string> urlPrefixes);
|
||||
|
||||
/// <summary>
|
||||
/// If set, all requests will respond with this message
|
||||
/// If set, all requests will respond with this message.
|
||||
/// </summary>
|
||||
string GlobalResponse { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The HTTP request handler
|
||||
/// The HTTP request handler.
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <returns></returns>
|
||||
Task RequestHandler(HttpContext context);
|
||||
|
||||
/// <summary>
|
||||
/// Get the default CORS headers
|
||||
/// Get the default CORS headers.
|
||||
/// </summary>
|
||||
/// <param name="req"></param>
|
||||
/// <returns></returns>
|
||||
|
||||
@@ -3,7 +3,7 @@ using System.Threading.Tasks;
|
||||
namespace MediaBrowser.Controller.Net
|
||||
{
|
||||
/// <summary>
|
||||
///This is an interface for listening to messages coming through a web socket connection
|
||||
///This is an interface for listening to messages coming through a web socket connection.
|
||||
/// </summary>
|
||||
public interface IWebSocketListener
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Model.Net;
|
||||
namespace MediaBrowser.Controller.Net
|
||||
{
|
||||
/// <summary>
|
||||
/// Class WebSocketMessageInfo
|
||||
/// Class WebSocketMessageInfo.
|
||||
/// </summary>
|
||||
public class WebSocketMessageInfo : WebSocketMessage<string>
|
||||
{
|
||||
|
||||
@@ -9,12 +9,12 @@ using MediaBrowser.Model.Querying;
|
||||
namespace MediaBrowser.Controller.Persistence
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides an interface to implement an Item repository
|
||||
/// Provides an interface to implement an Item repository.
|
||||
/// </summary>
|
||||
public interface IItemRepository : IRepository
|
||||
{
|
||||
/// <summary>
|
||||
/// Saves an item
|
||||
/// Saves an item.
|
||||
/// </summary>
|
||||
/// <param name="item">The item.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
@@ -43,14 +43,14 @@ namespace MediaBrowser.Controller.Persistence
|
||||
BaseItem RetrieveItem(Guid id);
|
||||
|
||||
/// <summary>
|
||||
/// Gets chapters for an item
|
||||
/// Gets chapters for an item.
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
List<ChapterInfo> GetChapters(BaseItem id);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single chapter for an item
|
||||
/// Gets a single chapter for an item.
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="index"></param>
|
||||
|
||||
@@ -3,12 +3,12 @@ using System;
|
||||
namespace MediaBrowser.Controller.Persistence
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides a base interface for all the repository interfaces
|
||||
/// Provides a base interface for all the repository interfaces.
|
||||
/// </summary>
|
||||
public interface IRepository : IDisposable
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the name of the repository
|
||||
/// Gets the name of the repository.
|
||||
/// </summary>
|
||||
/// <value>The name.</value>
|
||||
string Name { get; }
|
||||
|
||||
@@ -5,7 +5,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Persistence
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides an interface to implement a UserData repository
|
||||
/// Provides an interface to implement a UserData repository.
|
||||
/// </summary>
|
||||
public interface IUserDataRepository : IRepository
|
||||
{
|
||||
@@ -30,14 +30,14 @@ namespace MediaBrowser.Controller.Persistence
|
||||
UserItemData GetUserData(long userId, List<string> keys);
|
||||
|
||||
/// <summary>
|
||||
/// Return all user data associated with the given user
|
||||
/// Return all user data associated with the given user.
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <returns></returns>
|
||||
List<UserItemData> GetAllUserData(long userId);
|
||||
|
||||
/// <summary>
|
||||
/// Save all user data associated with the given user
|
||||
/// Save all user data associated with the given user.
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="userData"></param>
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Common.Plugins;
|
||||
namespace MediaBrowser.Controller.Plugins
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IConfigurationPage
|
||||
/// Interface IConfigurationPage.
|
||||
/// </summary>
|
||||
public interface IPluginConfigurationPage
|
||||
{
|
||||
@@ -34,16 +34,16 @@ namespace MediaBrowser.Controller.Plugins
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Enum ConfigurationPageType
|
||||
/// Enum ConfigurationPageType.
|
||||
/// </summary>
|
||||
public enum ConfigurationPageType
|
||||
{
|
||||
/// <summary>
|
||||
/// The plugin configuration
|
||||
/// The plugin configuration.
|
||||
/// </summary>
|
||||
PluginConfiguration,
|
||||
/// <summary>
|
||||
/// The none
|
||||
/// The none.
|
||||
/// </summary>
|
||||
None
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Marker interface
|
||||
/// Marker interface.
|
||||
/// </summary>
|
||||
public interface IMetadataProvider
|
||||
{
|
||||
|
||||
@@ -3,22 +3,22 @@ namespace MediaBrowser.Controller.Providers
|
||||
public enum MetadataRefreshMode
|
||||
{
|
||||
/// <summary>
|
||||
/// The none
|
||||
/// The none.
|
||||
/// </summary>
|
||||
None = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The validation only
|
||||
/// The validation only.
|
||||
/// </summary>
|
||||
ValidationOnly = 1,
|
||||
|
||||
/// <summary>
|
||||
/// Providers will be executed based on default rules
|
||||
/// Providers will be executed based on default rules.
|
||||
/// </summary>
|
||||
Default = 2,
|
||||
|
||||
/// <summary>
|
||||
/// All providers will be executed to search for new metadata
|
||||
/// All providers will be executed to search for new metadata.
|
||||
/// </summary>
|
||||
FullRefresh = 3
|
||||
}
|
||||
|
||||
@@ -40,7 +40,7 @@ namespace MediaBrowser.Controller.Providers
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people
|
||||
/// Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people.
|
||||
/// </summary>
|
||||
public void ResetPeople()
|
||||
{
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
namespace MediaBrowser.Controller.Providers
|
||||
{
|
||||
/// <summary>
|
||||
/// Enum VideoContentType
|
||||
/// Enum VideoContentType.
|
||||
/// </summary>
|
||||
public enum VideoContentType
|
||||
{
|
||||
/// <summary>
|
||||
/// The episode
|
||||
/// The episode.
|
||||
/// </summary>
|
||||
Episode = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The movie
|
||||
/// The movie.
|
||||
/// </summary>
|
||||
Movie = 1
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Library;
|
||||
namespace MediaBrowser.Controller.Resolvers
|
||||
{
|
||||
/// <summary>
|
||||
/// Class ItemResolver
|
||||
/// Class ItemResolver.
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public abstract class ItemResolver<T> : IItemResolver
|
||||
@@ -27,7 +27,7 @@ namespace MediaBrowser.Controller.Resolvers
|
||||
public virtual ResolverPriority Priority => ResolverPriority.First;
|
||||
|
||||
/// <summary>
|
||||
/// Sets initial values on the newly resolved item
|
||||
/// Sets initial values on the newly resolved item.
|
||||
/// </summary>
|
||||
/// <param name="item">The item.</param>
|
||||
/// <param name="args">The args.</param>
|
||||
|
||||
@@ -7,7 +7,7 @@ using MediaBrowser.Model.IO;
|
||||
namespace MediaBrowser.Controller.Resolvers
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IItemResolver
|
||||
/// Interface IItemResolver.
|
||||
/// </summary>
|
||||
public interface IItemResolver
|
||||
{
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
namespace MediaBrowser.Controller.Resolvers
|
||||
{
|
||||
/// <summary>
|
||||
/// Enum ResolverPriority
|
||||
/// Enum ResolverPriority.
|
||||
/// </summary>
|
||||
public enum ResolverPriority
|
||||
{
|
||||
/// <summary>
|
||||
/// The first
|
||||
/// The first.
|
||||
/// </summary>
|
||||
First = 1,
|
||||
/// <summary>
|
||||
/// The second
|
||||
/// The second.
|
||||
/// </summary>
|
||||
Second = 2,
|
||||
/// <summary>
|
||||
/// The third
|
||||
/// The third.
|
||||
/// </summary>
|
||||
Third = 3,
|
||||
Fourth = 4,
|
||||
/// <summary>
|
||||
/// The last
|
||||
/// The last.
|
||||
/// </summary>
|
||||
Last = 5
|
||||
}
|
||||
|
||||
@@ -13,7 +13,7 @@ using MediaBrowser.Model.SyncPlay;
|
||||
namespace MediaBrowser.Controller.Session
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface ISessionManager
|
||||
/// Interface ISessionManager.
|
||||
/// </summary>
|
||||
public interface ISessionManager
|
||||
{
|
||||
@@ -79,14 +79,14 @@ namespace MediaBrowser.Controller.Session
|
||||
void UpdateDeviceName(string sessionId, string reportedDeviceName);
|
||||
|
||||
/// <summary>
|
||||
/// Used to report that playback has started for an item
|
||||
/// Used to report that playback has started for an item.
|
||||
/// </summary>
|
||||
/// <param name="info">The info.</param>
|
||||
/// <returns>Task.</returns>
|
||||
Task OnPlaybackStart(PlaybackStartInfo info);
|
||||
|
||||
/// <summary>
|
||||
/// Used to report playback progress for an item
|
||||
/// Used to report playback progress for an item.
|
||||
/// </summary>
|
||||
/// <param name="info">The info.</param>
|
||||
/// <returns>Task.</returns>
|
||||
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Session
|
||||
Task OnPlaybackProgress(PlaybackProgressInfo info, bool isAutomated);
|
||||
|
||||
/// <summary>
|
||||
/// Used to report that playback has ended for an item
|
||||
/// Used to report that playback has ended for an item.
|
||||
/// </summary>
|
||||
/// <param name="info">The info.</param>
|
||||
/// <returns>Task.</returns>
|
||||
|
||||
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Entities;
|
||||
namespace MediaBrowser.Controller.Sorting
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface IBaseItemComparer
|
||||
/// Interface IBaseItemComparer.
|
||||
/// </summary>
|
||||
public interface IBaseItemComparer : IComparer<BaseItem>
|
||||
{
|
||||
|
||||
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Library;
|
||||
namespace MediaBrowser.Controller.Sorting
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a BaseItem comparer that requires a User to perform it's comparison
|
||||
/// Represents a BaseItem comparer that requires a User to perform it's comparison.
|
||||
/// </summary>
|
||||
public interface IUserBaseItemComparer : IBaseItemComparer
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace MediaBrowser.Controller.Sync
|
||||
{
|
||||
/// <summary>
|
||||
/// A marker interface
|
||||
/// A marker interface.
|
||||
/// </summary>
|
||||
public interface IRemoteSyncProvider
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user