diff options
| author | Cody Robibero <cody@robibe.ro> | 2020-11-16 17:07:06 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-16 17:07:06 -0700 |
| commit | be3c65d80f4b2972a2e1a60ed3894102c0ee9cb8 (patch) | |
| tree | 84ae4cf9f5142b697d8164090562f027787f754e | |
| parent | 1d96167e8d58ff59859ae5b9afc1f9e0f6bed74f (diff) | |
| parent | 7b42b7e8bd40ef7bd6bb6a533cb3c9dfcd00c63f (diff) | |
Merge branch 'master' into docker-pls
20 files changed, 985 insertions, 295 deletions
diff --git a/Emby.Dlna/Common/Argument.cs b/Emby.Dlna/Common/Argument.cs index f375e6049..430a3b47d 100644 --- a/Emby.Dlna/Common/Argument.cs +++ b/Emby.Dlna/Common/Argument.cs @@ -1,13 +1,23 @@ -#pragma warning disable CS1591 - namespace Emby.Dlna.Common { + /// <summary> + /// DLNA Query parameter type, used when quering DLNA devices via SOAP. + /// </summary> public class Argument { - public string Name { get; set; } + /// <summary> + /// Gets or sets name of the DLNA argument. + /// </summary> + public string Name { get; set; } = string.Empty; - public string Direction { get; set; } + /// <summary> + /// Gets or sets the direction of the parameter. + /// </summary> + public string Direction { get; set; } = string.Empty; - public string RelatedStateVariable { get; set; } + /// <summary> + /// Gets or sets the related DLNA state variable for this argument. + /// </summary> + public string RelatedStateVariable { get; set; } = string.Empty; } } diff --git a/Emby.Dlna/Common/DeviceIcon.cs b/Emby.Dlna/Common/DeviceIcon.cs index c3f7fa8aa..f9fd1dcec 100644 --- a/Emby.Dlna/Common/DeviceIcon.cs +++ b/Emby.Dlna/Common/DeviceIcon.cs @@ -1,29 +1,41 @@ -#pragma warning disable CS1591 - using System.Globalization; namespace Emby.Dlna.Common { + /// <summary> + /// Defines the <see cref="DeviceIcon" />. + /// </summary> public class DeviceIcon { - public string Url { get; set; } + /// <summary> + /// Gets or sets the Url. + /// </summary> + public string Url { get; set; } = string.Empty; - public string MimeType { get; set; } + /// <summary> + /// Gets or sets the MimeType. + /// </summary> + public string MimeType { get; set; } = string.Empty; + /// <summary> + /// Gets or sets the Width. + /// </summary> public int Width { get; set; } + /// <summary> + /// Gets or sets the Height. + /// </summary> public int Height { get; set; } - public string Depth { get; set; } + /// <summary> + /// Gets or sets the Depth. + /// </summary> + public string Depth { get; set; } = string.Empty; /// <inheritdoc /> public override string ToString() { - return string.Format( - CultureInfo.InvariantCulture, - "{0}x{1}", - Height, - Width); + return string.Format(CultureInfo.InvariantCulture, "{0}x{1}", Height, Width); } } } diff --git a/Emby.Dlna/Common/DeviceService.cs b/Emby.Dlna/Common/DeviceService.cs index 44c0a0412..c1369558e 100644 --- a/Emby.Dlna/Common/DeviceService.cs +++ b/Emby.Dlna/Common/DeviceService.cs @@ -1,21 +1,36 @@ -#pragma warning disable CS1591 - namespace Emby.Dlna.Common { + /// <summary> + /// Defines the <see cref="DeviceService" />. + /// </summary> public class DeviceService { - public string ServiceType { get; set; } + /// <summary> + /// Gets or sets the Service Type. + /// </summary> + public string ServiceType { get; set; } = string.Empty; - public string ServiceId { get; set; } + /// <summary> + /// Gets or sets the Service Id. + /// </summary> + public string ServiceId { get; set; } = string.Empty; - public string ScpdUrl { get; set; } + /// <summary> + /// Gets or sets the Scpd Url. + /// </summary> + public string ScpdUrl { get; set; } = string.Empty; - public string ControlUrl { get; set; } + /// <summary> + /// Gets or sets the Control Url. + /// </summary> + public string ControlUrl { get; set; } = string.Empty; - public string EventSubUrl { get; set; } + /// <summary> + /// Gets or sets the EventSubUrl. + /// </summary> + public string EventSubUrl { get; set; } = string.Empty; /// <inheritdoc /> - public override string ToString() - => ServiceId; + public override string ToString() => ServiceId; } } diff --git a/Emby.Dlna/Common/ServiceAction.cs b/Emby.Dlna/Common/ServiceAction.cs index d458d7f3f..02b81a0aa 100644 --- a/Emby.Dlna/Common/ServiceAction.cs +++ b/Emby.Dlna/Common/ServiceAction.cs @@ -1,24 +1,31 @@ -#pragma warning disable CS1591 - using System.Collections.Generic; namespace Emby.Dlna.Common { + /// <summary> + /// Defines the <see cref="ServiceAction" />. + /// </summary> public class ServiceAction { + /// <summary> + /// Initializes a new instance of the <see cref="ServiceAction"/> class. + /// </summary> public ServiceAction() { ArgumentList = new List<Argument>(); } - public string Name { get; set; } + /// <summary> + /// Gets or sets the name of the action. + /// </summary> + public string Name { get; set; } = string.Empty; + /// <summary> + /// Gets the ArgumentList. + /// </summary> public List<Argument> ArgumentList { get; } /// <inheritdoc /> - public override string ToString() - { - return Name; - } + public override string ToString() => Name; } } diff --git a/Emby.Dlna/Common/StateVariable.cs b/Emby.Dlna/Common/StateVariable.cs index 6daf7ab6b..fd733e085 100644 --- a/Emby.Dlna/Common/StateVariable.cs +++ b/Emby.Dlna/Common/StateVariable.cs @@ -1,27 +1,34 @@ -#pragma warning disable CS1591 - using System; using System.Collections.Generic; namespace Emby.Dlna.Common { + /// <summary> + /// Defines the <see cref="StateVariable" />. + /// </summary> public class StateVariable { - public StateVariable() - { - AllowedValues = Array.Empty<string>(); - } - - public string Name { get; set; } + /// <summary> + /// Gets or sets the name of the state variable. + /// </summary> + public string Name { get; set; } = string.Empty; - public string DataType { get; set; } + /// <summary> + /// Gets or sets the data type of the state variable. + /// </summary> + public string DataType { get; set; } = string.Empty; + /// <summary> + /// Gets or sets a value indicating whether it sends events. + /// </summary> public bool SendsEvents { get; set; } - public IReadOnlyList<string> AllowedValues { get; set; } + /// <summary> + /// Gets or sets the allowed values range. + /// </summary> + public IReadOnlyList<string> AllowedValues { get; set; } = Array.Empty<string>(); /// <inheritdoc /> - public override string ToString() - => Name; + public override string ToString() => Name; } } diff --git a/Emby.Dlna/ContentDirectory/ContentDirectoryService.cs b/Emby.Dlna/ContentDirectory/ContentDirectoryService.cs index 5760f260c..2f3107450 100644 --- a/Emby.Dlna/ContentDirectory/ContentDirectoryService.cs +++ b/Emby.Dlna/ContentDirectory/ContentDirectoryService.cs @@ -19,6 +19,9 @@ using Microsoft.Extensions.Logging; namespace Emby.Dlna.ContentDirectory { + /// <summary> + /// Defines the <see cref="ContentDirectoryService" />. + /// </summary> public class ContentDirectoryService : BaseService, IContentDirectory { private readonly ILibraryManager _libraryManager; @@ -33,6 +36,22 @@ namespace Emby.Dlna.ContentDirectory private readonly IMediaEncoder _mediaEncoder; private readonly ITVSeriesManager _tvSeriesManager; + /// <summary> + /// Initializes a new instance of the <see cref="ContentDirectoryService"/> class. + /// </summary> + /// <param name="dlna">The <see cref="IDlnaManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="userDataManager">The <see cref="IUserDataManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="imageProcessor">The <see cref="IImageProcessor"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="libraryManager">The <see cref="ILibraryManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="config">The <see cref="IServerConfigurationManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="userManager">The <see cref="IUserManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="logger">The <see cref="ILogger{ContentDirectoryService}"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="httpClient">The <see cref="IHttpClientFactory"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="localization">The <see cref="ILocalizationManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="mediaSourceManager">The <see cref="IMediaSourceManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="userViewManager">The <see cref="IUserViewManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="mediaEncoder">The <see cref="IMediaEncoder"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> + /// <param name="tvSeriesManager">The <see cref="ITVSeriesManager"/> to use in the <see cref="ContentDirectoryService"/> instance.</param> public ContentDirectoryService( IDlnaManager dlna, IUserDataManager userDataManager, @@ -62,7 +81,10 @@ namespace Emby.Dlna.ContentDirectory _tvSeriesManager = tvSeriesManager; } - private int SystemUpdateId + /// <summary> + /// Gets the system id. (A unique id which changes on when our definition changes.) + /// </summary> + private static int SystemUpdateId { get { @@ -75,14 +97,18 @@ namespace Emby.Dlna.ContentDirectory /// <inheritdoc /> public string GetServiceXml() { - return new ContentDirectoryXmlBuilder().GetXml(); + return ContentDirectoryXmlBuilder.GetXml(); } /// <inheritdoc /> public Task<ControlResponse> ProcessControlRequestAsync(ControlRequest request) { - var profile = _dlna.GetProfile(request.Headers) ?? - _dlna.GetDefaultProfile(); + if (request == null) + { + throw new ArgumentNullException(nameof(request)); + } + + var profile = _dlna.GetProfile(request.Headers) ?? _dlna.GetDefaultProfile(); var serverAddress = request.RequestedUrl.Substring(0, request.RequestedUrl.IndexOf("/dlna", StringComparison.OrdinalIgnoreCase)); @@ -107,6 +133,11 @@ namespace Emby.Dlna.ContentDirectory .ProcessControlRequestAsync(request); } + /// <summary> + /// Get the user stored in the device profile. + /// </summary> + /// <param name="profile">The <see cref="DeviceProfile"/>.</param> + /// <returns>The <see cref="User"/>.</returns> private User GetUser(DeviceProfile profile) { if (!string.IsNullOrEmpty(profile.UserId)) diff --git a/Emby.Dlna/ContentDirectory/ContentDirectoryXmlBuilder.cs b/Emby.Dlna/ContentDirectory/ContentDirectoryXmlBuilder.cs index 743dcc516..3edaabb70 100644 --- a/Emby.Dlna/ContentDirectory/ContentDirectoryXmlBuilder.cs +++ b/Emby.Dlna/ContentDirectory/ContentDirectoryXmlBuilder.cs @@ -6,143 +6,154 @@ using Emby.Dlna.Service; namespace Emby.Dlna.ContentDirectory { - public class ContentDirectoryXmlBuilder + /// <summary> + /// Defines the <see cref="ContentDirectoryXmlBuilder" />. + /// </summary> + public static class ContentDirectoryXmlBuilder { - public string GetXml() + /// <summary> + /// Gets the ContentDirectory:1 service template. + /// See http://upnp.org/specs/av/UPnP-av-ContentDirectory-v1-Service.pdf. + /// </summary> + /// <returns>An XML description of this service.</returns> + public static string GetXml() { - return new ServiceXmlBuilder().GetXml( - new ServiceActionListBuilder().GetActions(), - GetStateVariables()); + return new ServiceXmlBuilder().GetXml(ServiceActionListBuilder.GetActions(), GetStateVariables()); } + /// <summary> + /// Get the list of state variables for this invocation. + /// </summary> + /// <returns>The <see cref="IEnumerable{StateVariable}"/>.</returns> private static IEnumerable<StateVariable> GetStateVariables() { - var list = new List<StateVariable>(); - - list.Add(new StateVariable + var list = new List<StateVariable> { - Name = "A_ARG_TYPE_Filter", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_Filter", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_SortCriteria", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_SortCriteria", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_Index", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_Index", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_Count", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_Count", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_UpdateID", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_UpdateID", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "SearchCapabilities", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "SearchCapabilities", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "SortCapabilities", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "SortCapabilities", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "SystemUpdateID", - DataType = "ui4", - SendsEvents = true - }); + new StateVariable + { + Name = "SystemUpdateID", + DataType = "ui4", + SendsEvents = true + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_SearchCriteria", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_SearchCriteria", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_Result", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_Result", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_ObjectID", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_ObjectID", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_BrowseFlag", - DataType = "string", - SendsEvents = false, + new StateVariable + { + Name = "A_ARG_TYPE_BrowseFlag", + DataType = "string", + SendsEvents = false, - AllowedValues = new[] + AllowedValues = new[] { "BrowseMetadata", "BrowseDirectChildren" } - }); + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_BrowseLetter", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_BrowseLetter", + DataType = "string", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_CategoryType", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_CategoryType", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_RID", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_RID", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_PosSec", - DataType = "ui4", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_PosSec", + DataType = "ui4", + SendsEvents = false + }, - list.Add(new StateVariable - { - Name = "A_ARG_TYPE_Featurelist", - DataType = "string", - SendsEvents = false - }); + new StateVariable + { + Name = "A_ARG_TYPE_Featurelist", + DataType = "string", + SendsEvents = false + } + }; return list; } diff --git a/Emby.Dlna/ContentDirectory/ControlHandler.cs b/Emby.Dlna/ContentDirectory/ControlHandler.cs index 5f25b8cdc..9f35c1959 100644 --- a/Emby.Dlna/ContentDirectory/ControlHandler.cs +++ b/Emby.Dlna/ContentDirectory/ControlHandler.cs @@ -1,6 +1,5 @@ -#pragma warning disable CS1591 - using System; +using System.Collections; using System.Collections.Generic; using System.Globalization; using System.IO; @@ -8,6 +7,7 @@ using System.Linq; using System.Text; using System.Threading; using System.Xml; +using Emby.Dlna.Configuration; using Emby.Dlna.Didl; using Emby.Dlna.Service; using Jellyfin.Data.Entities; @@ -38,6 +38,9 @@ using Series = MediaBrowser.Controller.Entities.TV.Series; namespace Emby.Dlna.ContentDirectory { + /// <summary> + /// Defines the <see cref="ControlHandler" />. + /// </summary> public class ControlHandler : BaseControlHandler { private const string NsDc = "http://purl.org/dc/elements/1.1/"; @@ -58,6 +61,24 @@ namespace Emby.Dlna.ContentDirectory private readonly DeviceProfile _profile; + /// <summary> + /// Initializes a new instance of the <see cref="ControlHandler"/> class. + /// </summary> + /// <param name="logger">The <see cref="ILogger"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="libraryManager">The <see cref="ILibraryManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="profile">The <see cref="DeviceProfile"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="serverAddress">The server address to use in this instance> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="accessToken">The <see cref="string"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="imageProcessor">The <see cref="IImageProcessor"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="userDataManager">The <see cref="IUserDataManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="user">The <see cref="User"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="systemUpdateId">The system id for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="config">The <see cref="IServerConfigurationManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="localization">The <see cref="ILocalizationManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="mediaSourceManager">The <see cref="IMediaSourceManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="userViewManager">The <see cref="IUserViewManager"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="mediaEncoder">The <see cref="IMediaEncoder"/> for use with the <see cref="ControlHandler"/> instance.</param> + /// <param name="tvSeriesManager">The <see cref="ITVSeriesManager"/> for use with the <see cref="ControlHandler"/> instance.</param> public ControlHandler( ILogger logger, ILibraryManager libraryManager, @@ -102,6 +123,16 @@ namespace Emby.Dlna.ContentDirectory /// <inheritdoc /> protected override void WriteResult(string methodName, IDictionary<string, string> methodParams, XmlWriter xmlWriter) { + if (xmlWriter == null) + { + throw new ArgumentNullException(nameof(xmlWriter)); + } + + if (methodParams == null) + { + throw new ArgumentNullException(nameof(methodParams)); + } + const string DeviceId = "test"; if (string.Equals(methodName, "GetSearchCapabilities", StringComparison.OrdinalIgnoreCase)) @@ -167,6 +198,10 @@ namespace Emby.Dlna.ContentDirectory throw new ResourceNotFoundException("Unexpected control request name: " + methodName); } + /// <summary> + /// Adds a "XSetBookmark" element to the xml document. + /// </summary> + /// <param name="sparams">The <see cref="IDictionary"/>.</param> private void HandleXSetBookmark(IDictionary<string, string> sparams) { var id = sparams["ObjectID"]; @@ -189,41 +224,69 @@ namespace Emby.Dlna.ContentDirectory CancellationToken.None); } - private void HandleGetSearchCapabilities(XmlWriter xmlWriter) + /// <summary> + /// Adds the "SearchCaps" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + private static void HandleGetSearchCapabilities(XmlWriter xmlWriter) { xmlWriter.WriteElementString( "SearchCaps", "res@resolution,res@size,res@duration,dc:title,dc:creator,upnp:actor,upnp:artist,upnp:genre,upnp:album,dc:date,upnp:class,@id,@refID,@protocolInfo,upnp:author,dc:description,pv:avKeywords"); } - private void HandleGetSortCapabilities(XmlWriter xmlWriter) + /// <summary> + /// Adds the "SortCaps" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + private static void HandleGetSortCapabilities(XmlWriter xmlWriter) { xmlWriter.WriteElementString( "SortCaps", "res@duration,res@size,res@bitrate,dc:date,dc:title,dc:size,upnp:album,upnp:artist,upnp:albumArtist,upnp:episodeNumber,upnp:genre,upnp:originalTrackNumber,upnp:rating"); } - private void HandleGetSortExtensionCapabilities(XmlWriter xmlWriter) + /// <summary> + /// Adds the "SortExtensionCaps" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + private static void HandleGetSortExtensionCapabilities(XmlWriter xmlWriter) { xmlWriter.WriteElementString( "SortExtensionCaps", "res@duration,res@size,res@bitrate,dc:date,dc:title,dc:size,upnp:album,upnp:artist,upnp:albumArtist,upnp:episodeNumber,upnp:genre,upnp:originalTrackNumber,upnp:rating"); } + /// <summary> + /// Adds the "Id" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> private void HandleGetSystemUpdateID(XmlWriter xmlWriter) { xmlWriter.WriteElementString("Id", _systemUpdateId.ToString(CultureInfo.InvariantCulture)); } - private void HandleGetFeatureList(XmlWriter xmlWriter) + /// <summary> + /// Adds the "FeatureList" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + private static void HandleGetFeatureList(XmlWriter xmlWriter) { xmlWriter.WriteElementString("FeatureList", WriteFeatureListXml()); } - private void HandleXGetFeatureList(XmlWriter xmlWriter) + /// <summary> + /// Adds the "FeatureList" element to the xml document. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + private static void HandleXGetFeatureList(XmlWriter xmlWriter) => HandleGetFeatureList(xmlWriter); - private string WriteFeatureListXml() + /// <summary> + /// Builds a static feature list. + /// </summary> + /// <returns>The xml feature list.</returns> + private static string WriteFeatureListXml() { // TODO: clean this up var builder = new StringBuilder(); @@ -242,9 +305,16 @@ namespace Emby.Dlna.ContentDirectory return builder.ToString(); } - public string GetValueOrDefault(IDictionary<string, string> sparams, string key, string defaultValue) + /// <summary> + /// Returns the value in the key of the dictionary, or defaultValue if it doesn't exist. + /// </summary> + /// <param name="sparams">The <see cref="IDictionary"/>.</param> + /// <param name="key">The key.</param> + /// <param name="defaultValue">The defaultValue.</param> + /// <returns>The <see cref="string"/>.</returns> + public static string GetValueOrDefault(IDictionary<string, string> sparams, string key, string defaultValue) { - if (sparams.TryGetValue(key, out string val)) + if (sparams != null && sparams.TryGetValue(key, out string val)) { return val; } @@ -252,6 +322,12 @@ namespace Emby.Dlna.ContentDirectory return defaultValue; } + /// <summary> + /// Builds the "Browse" xml response. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + /// <param name="sparams">The <see cref="IDictionary"/>.</param> + /// <param name="deviceId">The device Id to use.</param> private void HandleBrowse(XmlWriter xmlWriter, IDictionary<string, string> sparams, string deviceId) { var id = sparams["ObjectID"]; @@ -313,7 +389,6 @@ namespace Emby.Dlna.ContentDirectory } else { - var dlnaOptions = _config.GetDlnaConfiguration(); _didlBuilder.WriteItemElement(writer, item, _user, null, null, deviceId, filter); } @@ -326,7 +401,6 @@ namespace Emby.Dlna.ContentDirectory provided = childrenResult.Items.Count; - var dlnaOptions = _config.GetDlnaConfiguration(); foreach (var i in childrenResult.Items) { var childItem = i.Item; @@ -357,12 +431,24 @@ namespace Emby.Dlna.ContentDirectory xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture)); } + /// <summary> + /// Builds the response to the "X_BrowseByLetter request. + /// </summary> + /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param> + /// <param name="sparams">The <see cref="IDictionary"/>.</param> + /// <param name="deviceId">The device id.</param> private void HandleXBrowseByLetter(XmlWriter xmlWriter, IDictionary<string, string> sparams, string deviceId) { // TODO: Implement this method HandleSearch(xmlWriter, sparams, deviceId); } + /// <summary> + /// Builds a response to the "Search" request. + /// </summary> + /// <param name="xmlWriter">The xmlWriter<see cref="XmlWriter"/>.</param> + /// <param name="sparams">The sparams<see cref="IDictionary"/>.</param> + /// <param name="deviceId">The deviceId<see cref="string"/>.</param> private void HandleSearch(XmlWriter xmlWriter, IDictionary<string, string> sparams, string deviceId) { var searchCriteria = new SearchCriteria(GetValueOrDefault(sparams, "SearchCriteria", string.Empty)); @@ -442,7 +528,17 @@ namespace Emby.Dlna.ContentDirectory xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture)); } - private QueryResult<BaseItem> GetChildrenSorted(BaseItem item, User user, SearchCriteria search, SortCriteria sort, int? startIndex, int? limit) + /// <summary> + /// Returns the child items meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="search">The <see cref="SearchCriteria"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{BaseItem}"/>.</returns> + private static QueryResult<BaseItem> GetChildrenSorted(BaseItem item, User user, SearchCriteria search, SortCriteria sort, int? startIndex, int? limit) { var folder = (Folder)item; @@ -494,11 +590,25 @@ namespace Emby.Dlna.ContentDirectory }); } - private DtoOptions GetDtoOptions() + /// <summary> + /// Returns a new DtoOptions object. + /// </summary> + /// <returns>The <see cref="DtoOptions"/>.</returns> + private static DtoOptions GetDtoOptions() { return new DtoOptions(true); } + /// <summary> + /// Returns the User items meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="stubType">The <see cref="StubType"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetUserItems(BaseItem item, StubType? stubType, User user, SortCriteria sort, int? startIndex, int? limit) { if (item is MusicGenre) @@ -568,6 +678,14 @@ namespace Emby.Dlna.ContentDirectory return ToResult(queryResult); } + /// <summary> + /// Returns the Live Tv Channels meeting the criteria. + /// </summary> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetLiveTvChannels(User user, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -584,6 +702,16 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music folders meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="stubType">The <see cref="StubType"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -643,57 +771,58 @@ namespace Emby.Dlna.ContentDirectory return GetMusicGenres(item, user, query); } - var list = new List<ServerItem>(); - - list.Add(new ServerItem(item) + var list = new List<ServerItem> { - StubType = StubType.Latest - }); + new ServerItem(item) + { + StubType = StubType.Latest + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Playlists - }); + new ServerItem(item) + { + StubType = StubType.Playlists + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Albums - }); + new ServerItem(item) + { + StubType = StubType.Albums + }, - list.Add(new ServerItem(item) - { - StubType = StubType.AlbumArtists - }); + new ServerItem(item) + { + StubType = StubType.AlbumArtists + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Artists - }); + new ServerItem(item) + { + StubType = StubType.Artists + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Songs - }); + new ServerItem(item) + { + StubType = StubType.Songs + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Genres - }); + new ServerItem(item) + { + StubType = StubType.Genres + }, - list.Add(new ServerItem(item) - { - StubType = StubType.FavoriteArtists - }); + new ServerItem(item) + { + StubType = StubType.FavoriteArtists + }, - list.Add(new ServerItem(item) - { - StubType = StubType.FavoriteAlbums - }); + new ServerItem(item) + { + StubType = StubType.FavoriteAlbums + }, - list.Add(new ServerItem(item) - { - StubType = StubType.FavoriteSongs - }); + new ServerItem(item) + { + StubType = StubType.FavoriteSongs + } + }; return new QueryResult<ServerItem> { @@ -702,6 +831,16 @@ namespace Emby.Dlna.ContentDirectory }; } + /// <summary> + /// Returns the movie folders meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="stubType">The <see cref="StubType"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -776,6 +915,13 @@ namespace Emby.Dlna.ContentDirectory }; } + /// <summary> + /// Returns the folders meeting the criteria. + /// </summary> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFolders(User user, int? startIndex, int? limit) { var folders = _libraryManager.GetUserRootFolder().GetChildren(user, true) @@ -796,6 +942,16 @@ namespace Emby.Dlna.ContentDirectory limit); } + /// <summary> + /// Returns the TV folders meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="stubType">The <see cref="StubType"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetTvFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -840,42 +996,43 @@ namespace Emby.Dlna.ContentDirectory return GetGenres(item, user, query); } - var list = new List<ServerItem>(); - - list.Add(new ServerItem(item) + var list = new List<ServerItem> { - StubType = StubType.ContinueWatching - }); + new ServerItem(item) + { + StubType = StubType.ContinueWatching + }, - list.Add(new ServerItem(item) - { - StubType = StubType.NextUp - }); + new ServerItem(item) + { + StubType = StubType.NextUp + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Latest - }); + new ServerItem(item) + { + StubType = StubType.Latest + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Series - }); + new ServerItem(item) + { + StubType = StubType.Series + }, - list.Add(new ServerItem(item) - { - StubType = StubType.FavoriteSeries - }); + new ServerItem(item) + { + StubType = StubType.FavoriteSeries + }, - list.Add(new ServerItem(item) - { - StubType = StubType.FavoriteEpisodes - }); + new ServerItem(item) + { + StubType = StubType.FavoriteEpisodes + }, - list.Add(new ServerItem(item) - { - StubType = StubType.Genres - }); + new ServerItem(item) + { + StubType = StubType.Genres + } + }; return new QueryResult<ServerItem> { @@ -884,6 +1041,13 @@ namespace Emby.Dlna.ContentDirectory }; } + /// <summary> + /// Returns the Movies that are part watched that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieContinueWatching(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -904,6 +1068,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the series meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetSeries(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -917,6 +1088,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the Movie folders meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieMovies(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -930,6 +1108,12 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the Movie collections meeting the criteria. + /// </summary> + /// <param name="user">The see cref="User"/>.</param> + /// <param name="query">The see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieCollections(User user, InternalItemsQuery query) { query.Recursive = true; @@ -943,6 +1127,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the Music albums meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicAlbums(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -956,6 +1147,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the Music songs meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicSongs(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -969,6 +1167,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the songs tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFavoriteSongs(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -982,6 +1187,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the series tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFavoriteSeries(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -995,6 +1207,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the episodes tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFavoriteEpisodes(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -1008,6 +1227,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the movies tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieFavorites(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -1021,6 +1247,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// /// Returns the albums tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFavoriteAlbums(BaseItem parent, User user, InternalItemsQuery query) { query.Recursive = true; @@ -1034,6 +1267,14 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the genres meeting the criteria. + /// The GetGenres. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetGenres(BaseItem parent, User user, InternalItemsQuery query) { var genresResult = _libraryManager.GetGenres(new InternalItemsQuery(user) @@ -1052,6 +1293,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music genres meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicGenres(BaseItem parent, User user, InternalItemsQuery query) { var genresResult = _libraryManager.GetMusicGenres(new InternalItemsQuery(user) @@ -1070,6 +1318,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music albums by artist that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicAlbumArtists(BaseItem parent, User user, InternalItemsQuery query) { var artists = _libraryManager.GetAlbumArtists(new InternalItemsQuery(user) @@ -1088,6 +1343,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music artists meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicArtists(BaseItem parent, User user, InternalItemsQuery query) { var artists = _libraryManager.GetArtists(new InternalItemsQuery(user) @@ -1106,6 +1368,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the artists tagged as favourite that meet the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetFavoriteArtists(BaseItem parent, User user, InternalItemsQuery query) { var artists = _libraryManager.GetArtists(new InternalItemsQuery(user) @@ -1125,6 +1394,12 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music playlists meeting the criteria. + /// </summary> + /// <param name="user">The user<see cref="User"/>.</param> + /// <param name="query">The query<see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicPlaylists(User user, InternalItemsQuery query) { query.Parent = null; @@ -1137,6 +1412,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the latest music meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicLatest(BaseItem parent, User user, InternalItemsQuery query) { query.OrderBy = Array.Empty<(string, SortOrder)>(); @@ -1155,6 +1437,12 @@ namespace Emby.Dlna.ContentDirectory return ToResult(items); } + /// <summary> + /// Returns the next up item meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetNextUp(BaseItem parent, InternalItemsQuery query) { query.OrderBy = Array.Empty<(string, SortOrder)>(); @@ -1172,6 +1460,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the latest tv meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetTvLatest(BaseItem parent, User user, InternalItemsQuery query) { query.OrderBy = Array.Empty<(string, SortOrder)>(); @@ -1190,6 +1485,13 @@ namespace Emby.Dlna.ContentDirectory return ToResult(items); } + /// <summary> + /// Returns the latest movies meeting the criteria. + /// </summary> + /// <param name="parent">The <see cref="BaseItem"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMovieLatest(BaseItem parent, User user, InternalItemsQuery query) { query.OrderBy = Array.Empty<(string, SortOrder)>(); @@ -1208,6 +1510,16 @@ namespace Emby.Dlna.ContentDirectory return ToResult(items); } + /// <summary> + /// Returns music artist items that meet the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="parentId">The <see cref="Guid"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicArtistItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -1228,6 +1540,16 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the genre items meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="parentId">The <see cref="Guid"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -1252,6 +1574,16 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } + /// <summary> + /// Returns the music genre items meeting the criteria. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> + /// <param name="parentId">The <see cref="Guid"/>.</param> + /// <param name="user">The <see cref="User"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> private QueryResult<ServerItem> GetMusicGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit) { var query = new InternalItemsQuery(user) @@ -1272,7 +1604,12 @@ namespace Emby.Dlna.ContentDirectory return ToResult(result); } - private QueryResult<ServerItem> ToResult(BaseItem[] result) + /// <summary> + /// Converts a <see cref="BaseItem"/> array into a <see cref="QueryResult{ServerItem}"/>. + /// </summary> + /// <param name="result">An array of <see cref="BaseItem"/>.</param> + /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns> + private static QueryResult<ServerItem> ToResult(BaseItem[] result) { var serverItems = result .Select(i => new ServerItem(i)) @@ -1285,7 +1622,12 @@ namespace Emby.Dlna.ContentDirectory }; } - private QueryResult<ServerItem> ToResult(QueryResult<BaseItem> result) + /// <summary> + /// Converts a <see cref="QueryResult{BaseItem}"/> to a <see cref="QueryResult{ServerItem}"/>. + /// </summary> + /// <param name="result">A <see cref="QueryResult{BaseItem}"/>.</param> + /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns> + private static QueryResult<ServerItem> ToResult(QueryResult<BaseItem> result) { var serverItems = result .Items @@ -1299,7 +1641,13 @@ namespace Emby.Dlna.ContentDirectory }; } - private void SetSorting(InternalItemsQuery query, SortCriteria sort, bool isPreSorted) + /// <summary> + /// Sets the sorting method on a query. + /// </summary> + /// <param name="query">The <see cref="InternalItemsQuery"/>.</param> + /// <param name="sort">The <see cref="SortCriteria"/>.</param> + /// <param name="isPreSorted">True if pre-sorted.</param> + private static void SetSorting(InternalItemsQuery query, SortCriteria sort, bool isPreSorted) { if (isPreSorted) { @@ -1311,13 +1659,25 @@ namespace Emby.Dlna.ContentDirectory } } - private QueryResult<ServerItem> ApplyPaging(QueryResult<ServerItem> result, int? startIndex, int? limit) + /// <summary> + /// Apply paging to a query. + /// </summary> + /// <param name="result">The <see cref="QueryResult{ServerItem}"/>.</param> + /// <param name="startIndex">The start index.</param> + /// <param name="limit">The maximum number to return.</param> + /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns> + private static QueryResult<ServerItem> ApplyPaging(QueryResult<ServerItem> result, int? startIndex, int? limit) { result.Items = result.Items.Skip(startIndex ?? 0).Take(limit ?? int.MaxValue).ToArray(); return result; } + /// <summary> + /// Retreives the ServerItem id. + /// </summary> + /// <param name="id">The id<see cref="string"/>.</param> + /// <returns>The <see cref="ServerItem"/>.</returns> private ServerItem GetItemFromObjectId(string id) { return DidlBuilder.IsIdRoot(id) @@ -1326,6 +1686,11 @@ namespace Emby.Dlna.ContentDirectory : ParseItemId(id); } + /// <summary> + /// Parses the item id into a <see cref="ServerItem"/>. + /// </summary> + /// <param name="id">The <see cref="string"/>.</param> + /// <returns>The corresponding <see cref="ServerItem"/>.</returns> private ServerItem ParseItemId(string id) { StubType? stubType = null; diff --git a/Emby.Dlna/ContentDirectory/ServerItem.cs b/Emby.Dlna/ContentDirectory/ServerItem.cs index e40605414..34244000c 100644 --- a/Emby.Dlna/ContentDirectory/ServerItem.cs +++ b/Emby.Dlna/ContentDirectory/ServerItem.cs @@ -4,8 +4,15 @@ using MediaBrowser.Controller.Entities; namespace Emby.Dlna.ContentDirectory { + /// <summary> + /// Defines the <see cref="ServerItem" />. + /// </summary> internal class ServerItem { + /// <summary> + /// Initializes a new instance of the <see cref="ServerItem"/> class. + /// </summary> + /// <param name="item">The <see cref="BaseItem"/>.</param> public ServerItem(BaseItem item) { Item = item; @@ -16,8 +23,14 @@ namespace Emby.Dlna.ContentDirectory } } + /// <summary> + /// Gets or sets the underlying base item. + /// </summary> public BaseItem Item { get; set; } + /// <summary> + /// Gets or sets the DLNA item type. + /// </summary> public StubType? StubType { get; set; } } } diff --git a/Emby.Dlna/ContentDirectory/ServiceActionListBuilder.cs b/Emby.Dlna/ContentDirectory/ServiceActionListBuilder.cs index 921b14e39..7e3db4651 100644 --- a/Emby.Dlna/ContentDirectory/ServiceActionListBuilder.cs +++ b/Emby.Dlna/ContentDirectory/ServiceActionListBuilder.cs @@ -1,13 +1,18 @@ -#pragma warning disable CS1591 - using System.Collections.Generic; using Emby.Dlna.Common; namespace Emby.Dlna.ContentDirectory { - public class ServiceActionListBuilder + /// <summary> + /// Defines the <see cref="ServiceActionListBuilder" />. + /// </summary> + public static class ServiceActionListBuilder { - public IEnumerable<ServiceAction> GetActions() + /// <summary> + /// Returns a list of services that this instance provides. + /// </summary> + /// <returns>An <see cref="IEnumerable{ServiceAction}"/>.</returns> + public static IEnumerable<ServiceAction> GetActions() { return new[] { @@ -22,6 +27,10 @@ namespace Emby.Dlna.ContentDirectory }; } + /// <summary> + /// Returns the action details for "GetSystemUpdateID". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> private static ServiceAction GetGetSystemUpdateIDAction() { var action = new ServiceAction @@ -39,6 +48,10 @@ namespace Emby.Dlna.ContentDirectory return action; } + /// <summary> + /// Returns the action details for "GetSearchCapabilities". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> private static ServiceAction GetSearchCapabilitiesAction() { var action = new ServiceAction @@ -56,6 +69,10 @@ namespace Emby.Dlna.ContentDirectory return action; } + /// <summary> + /// Returns the action details for "GetSortCapabilities". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> private static ServiceAction GetSortCapabilitiesAction() { var action = new ServiceAction @@ -73,6 +90,10 @@ namespace Emby.Dlna.ContentDirectory return action; } + /// <summary> + /// Returns the action details for "X_GetFeatureList". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> private static ServiceAction GetX_GetFeatureListAction() { var action = new ServiceAction @@ -90,6 +111,10 @@ namespace Emby.Dlna.ContentDirectory return action; } + /// <summary> + /// Returns the action details for "Search". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> private static ServiceAction GetSearchAction() { var action = new ServiceAction @@ -170,7 +195,11 @@ namespace Emby.Dlna.ContentDirectory return action; } - private ServiceAction GetBrowseAction() + /// <summary> + /// Returns the action details for "Browse". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> + private static ServiceAction GetBrowseAction() { var action = new ServiceAction { @@ -250,7 +279,11 @@ namespace Emby.Dlna.ContentDirectory return action; } - private ServiceAction GetBrowseByLetterAction() + /// <summary> + /// Returns the action details for "X_BrowseByLetter". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> + private static ServiceAction GetBrowseByLetterAction() { var action = new ServiceAction { @@ -337,7 +370,11 @@ namespace Emby.Dlna.ContentDirectory return action; } - private ServiceAction GetXSetBookmarkAction() + /// <summary> + /// Returns the action details for "X_SetBookmark". + /// </summary> + /// <returns>The <see cref="ServiceAction"/>.</returns> + private static ServiceAction GetXSetBookmarkAction() { var action = new ServiceAction { diff --git a/Emby.Dlna/ContentDirectory/StubType.cs b/Emby.Dlna/ContentDirectory/StubType.cs index eee405d3e..982ae5d68 100644 --- a/Emby.Dlna/ContentDirectory/StubType.cs +++ b/Emby.Dlna/ContentDirectory/StubType.cs @@ -3,6 +3,9 @@ namespace Emby.Dlna.ContentDirectory { + /// <summary> + /// Defines the DLNA item types. + /// </summary> public enum StubType { Folder = 0, diff --git a/Emby.Server.Implementations/Localization/Core/en-US.json b/Emby.Server.Implementations/Localization/Core/en-US.json index 6d8b222b4..f8f595faa 100644 --- a/Emby.Server.Implementations/Localization/Core/en-US.json +++ b/Emby.Server.Implementations/Localization/Core/en-US.json @@ -9,11 +9,13 @@ "Channels": "Channels", "ChapterNameValue": "Chapter {0}", "Collections": "Collections", + "Default": "Default", "DeviceOfflineWithName": "{0} has disconnected", "DeviceOnlineWithName": "{0} is connected", "FailedLoginAttemptWithUserName": "Failed login attempt from {0}", "Favorites": "Favorites", "Folders": "Folders", + "Forced": "Forced", "Genres": "Genres", "HeaderAlbumArtists": "Album Artists", "HeaderContinueWatching": "Continue Watching", @@ -77,6 +79,7 @@ "Sync": "Sync", "System": "System", "TvShows": "TV Shows", + "Undefined": "Undefined", "User": "User", "UserCreatedWithName": "User {0} has been created", "UserDeletedWithName": "User {0} has been deleted", diff --git a/Emby.Server.Implementations/Localization/Core/pt-BR.json b/Emby.Server.Implementations/Localization/Core/pt-BR.json index 5e49ca702..8d25e27f6 100644 --- a/Emby.Server.Implementations/Localization/Core/pt-BR.json +++ b/Emby.Server.Implementations/Localization/Core/pt-BR.json @@ -113,5 +113,7 @@ "TasksChannelsCategory": "Canais da Internet", "TasksApplicationCategory": "Aplicativo", "TasksLibraryCategory": "Biblioteca", - "TasksMaintenanceCategory": "Manutenção" + "TasksMaintenanceCategory": "Manutenção", + "TaskCleanActivityLogDescription": "Apaga o registro de atividades mais antigo que a idade configurada.", + "TaskCleanActivityLog": "Limpar Registro de Atividades" } diff --git a/MediaBrowser.Model/Dlna/DeviceIdentification.cs b/MediaBrowser.Model/Dlna/DeviceIdentification.cs index 43407383a..c511801f4 100644 --- a/MediaBrowser.Model/Dlna/DeviceIdentification.cs +++ b/MediaBrowser.Model/Dlna/DeviceIdentification.cs @@ -11,59 +11,54 @@ namespace MediaBrowser.Model.Dlna /// Gets or sets the name of the friendly. /// </summary> /// <value>The name of the friendly.</value> - public string FriendlyName { get; set; } + public string FriendlyName { get; set; } = string.Empty; /// <summary> /// Gets or sets the model number. /// </summary> /// <value>The model number.</value> - public string ModelNumber { get; set; } + public string ModelNumber { get; set; } = string.Empty; /// <summary> /// Gets or sets the serial number. /// </summary> /// <value>The serial number.</value> - public string SerialNumber { get; set; } + public string SerialNumber { get; set; } = string.Empty; /// <summary> /// Gets or sets the name of the model. /// </summary> /// <value>The name of the model.</value> - public string ModelName { get; set; } + public string ModelName { get; set; } = string.Empty; /// <summary> /// Gets or sets the model description. /// </summary> /// <value>The model description.</value> - public string ModelDescription { get; set; } + public string ModelDescription { get; set; } = string.Empty; /// <summary> /// Gets or sets the model URL. /// </summary> /// <value>The model URL.</value> - public string ModelUrl { get; set; } + public string ModelUrl { get; set; } = string.Empty; /// <summary> /// Gets or sets the manufacturer. /// </summary> /// <value>The manufacturer.</value> - public string Manufacturer { get; set; } + public string Manufacturer { get; set; } = string.Empty; /// <summary> /// Gets or sets the manufacturer URL. /// </summary> /// <value>The manufacturer URL.</value> - public string ManufacturerUrl { get; set; } + public string ManufacturerUrl { get; set; } = string.Empty; /// <summary> /// Gets or sets the headers. /// </summary> /// <value>The headers.</value> - public HttpHeaderInfo[] Headers { get; set; } - - public DeviceIdentification() - { - Headers = Array.Empty<HttpHeaderInfo>(); - } + public HttpHeaderInfo[] Headers { get; set; } = Array.Empty<HttpHeaderInfo>(); } } diff --git a/MediaBrowser.Model/Dlna/DeviceProfile.cs b/MediaBrowser.Model/Dlna/DeviceProfile.cs index e842efead..ff5186658 100644 --- a/MediaBrowser.Model/Dlna/DeviceProfile.cs +++ b/MediaBrowser.Model/Dlna/DeviceProfile.cs @@ -1,6 +1,5 @@ #nullable disable -#pragma warning disable CS1591 - +#pragma warning disable CA1819 // Properties should not return arrays using System; using System.Linq; using System.Xml.Serialization; @@ -8,129 +7,243 @@ using MediaBrowser.Model.MediaInfo; namespace MediaBrowser.Model.Dlna { + /// <summary> + /// Defines the <see cref="DeviceProfile" />. + /// </summary> [XmlRoot("Profile")] public class DeviceProfile { /// <summary> - /// Gets or sets the name. + /// Initializes a new instance of the <see cref="DeviceProfile"/> class. + /// </summary> + public DeviceProfile() + { + DirectPlayProfiles = Array.Empty<DirectPlayProfile>(); + TranscodingProfiles = Array.Empty<TranscodingProfile>(); + ResponseProfiles = Array.Empty<ResponseProfile>(); + CodecProfiles = Array.Empty<CodecProfile>(); + ContainerProfiles = Array.Empty<ContainerProfile>(); + SubtitleProfiles = Array.Empty<SubtitleProfile>(); + + XmlRootAttributes = Array.Empty<XmlAttribute>(); + + SupportedMediaTypes = "Audio,Photo,Video"; + MaxStreamingBitrate = 8000000; + MaxStaticBitrate = 8000000; + MusicStreamingTranscodingBitrate = 128000; + } + + /// <summary> + /// Gets or sets the Name. /// </summary> - /// <value>The name.</value> public string Name { get; set; } + /// <summary> + /// Gets or sets the Id. + /// </summary> [XmlIgnore] public string Id { get; set; } /// <summary> - /// Gets or sets the identification. + /// Gets or sets the Identification. /// </summary> - /// <value>The identification.</value> public DeviceIdentification Identification { get; set; } + /// <summary> + /// Gets or sets the FriendlyName. + /// </summary> public string FriendlyName { get; set; } + /// <summary> + /// Gets or sets the Manufacturer. + /// </summary> public string Manufacturer { get; set; } + /// <summary> + /// Gets or sets the ManufacturerUrl. + /// </summary> public string ManufacturerUrl { get; set; } + /// <summary> + /// Gets or sets the ModelName. + /// </summary> public string ModelName { get; set; } + /// <summary> + /// Gets or sets the ModelDescription. + /// </summary> public string ModelDescription { get; set; } + /// <summary> + /// Gets or sets the ModelNumber. + /// </summary> public string ModelNumber { get; set; } + /// <summary> + /// Gets or sets the ModelUrl. + /// </summary> public string ModelUrl { get; set; } + /// <summary> + /// Gets or sets the SerialNumber. + /// </summary> public string SerialNumber { get; set; } + /// <summary> + /// Gets or sets a value indicating whether EnableAlbumArtInDidl. + /// </summary> public bool EnableAlbumArtInDidl { get; set; } + /// <summary> + /// Gets or sets a value indicating whether EnableSingleAlbumArtLimit. + /// </summary> public bool EnableSingleAlbumArtLimit { get; set; } + /// <summary> + /// Gets or sets a value indicating whether EnableSingleSubtitleLimit. + /// </summary> public bool EnableSingleSubtitleLimit { get; set; } + /// <summary> + /// Gets or sets the SupportedMediaTypes. + /// </summary> public string SupportedMediaTypes { get; set; } + /// <summary> + /// Gets or sets the UserId. + /// </summary> public string UserId { get; set; } + /// <summary> + /// Gets or sets the AlbumArtPn. + /// </summary> public string AlbumArtPn { get; set; } + /// <summary> + /// Gets or sets the MaxAlbumArtWidth. + /// </summary> public int MaxAlbumArtWidth { get; set; } + /// <summary> + /// Gets or sets the MaxAlbumArtHeight. + /// </summary> public int MaxAlbumArtHeight { get; set; } + /// <summary> + /// Gets or sets the MaxIconWidth. + /// </summary> public int? MaxIconWidth { get; set; } + /// <summary> + /// Gets or sets the MaxIconHeight. + /// </summary> public int? MaxIconHeight { get; set; } + /// <summary> + /// Gets or sets the MaxStreamingBitrate. + /// </summary> public int? MaxStreamingBitrate { get; set; } + /// <summary> + /// Gets or sets the MaxStaticBitrate. + /// </summary> public int? MaxStaticBitrate { get; set; } + /// <summary> + /// Gets or sets the MusicStreamingTranscodingBitrate. + /// </summary> public int? MusicStreamingTranscodingBitrate { get; set; } + /// <summary> + /// Gets or sets the MaxStaticMusicBitrate. + /// </summary> public int? MaxStaticMusicBitrate { get; set; } /// <summary> - /// Controls the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. + /// Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. /// </summary> public string SonyAggregationFlags { get; set; } + /// <summary> + /// Gets or sets the ProtocolInfo. + /// </summary> public string ProtocolInfo { get; set; } + /// <summary> + /// Gets or sets the TimelineOffsetSeconds. + /// </summary> public int TimelineOffsetSeconds { get; set; } + /// <summary> + /// Gets or sets a value indicating whether RequiresPlainVideoItems. + /// </summary> public bool RequiresPlainVideoItems { get; set; } + /// <summary> + /// Gets or sets a value indicating whether RequiresPlainFolders. + /// </summary> public bool RequiresPlainFolders { get; set; } + /// <summary> + /// Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. + /// </summary> public bool EnableMSMediaReceiverRegistrar { get; set; } + /// <summary> + /// Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. + /// </summary> public bool IgnoreTranscodeByteRangeRequests { get; set; } + /// <summary> + /// Gets or sets the XmlRootAttributes. + /// </summary> public XmlAttribute[] XmlRootAttributes { get; set; } /// <summary> /// Gets or sets the direct play profiles. /// </summary> - /// <value>The direct play profiles.</value> public DirectPlayProfile[] DirectPlayProfiles { get; set; } /// <summary> /// Gets or sets the transcoding profiles. /// </summary> - /// <value>The transcoding profiles.</value> public TranscodingProfile[] TranscodingProfiles { get; set; } + /// <summary> + /// Gets or sets the ContainerProfiles. + /// </summary> public ContainerProfile[] ContainerProfiles { get; set; } + /// <summary> + /// Gets or sets the CodecProfiles. + /// </summary> public CodecProfile[] CodecProfiles { get; set; } + /// <summary> + /// Gets or sets the ResponseProfiles. + /// </summary> public ResponseProfile[] ResponseProfiles { get; set; } + /// <summary> + /// Gets or sets the SubtitleProfiles. + /// </summary> public SubtitleProfile[] SubtitleProfiles { get; set; } - public DeviceProfile() - { - DirectPlayProfiles = Array.Empty<DirectPlayProfile>(); - TranscodingProfiles = Array.Empty<TranscodingProfile>(); - ResponseProfiles = Array.Empty<ResponseProfile>(); - CodecProfiles = Array.Empty<CodecProfile>(); - ContainerProfiles = Array.Empty<ContainerProfile>(); - SubtitleProfiles = Array.Empty<SubtitleProfile>(); - - XmlRootAttributes = Array.Empty<XmlAttribute>(); - - SupportedMediaTypes = "Audio,Photo,Video"; - MaxStreamingBitrate = 8000000; - MaxStaticBitrate = 8000000; - MusicStreamingTranscodingBitrate = 128000; - } - + /// <summary> + /// The GetSupportedMediaTypes. + /// </summary> + /// <returns>The .</returns> public string[] GetSupportedMediaTypes() { return ContainerProfile.SplitValue(SupportedMediaTypes); } + /// <summary> + /// Gets the audio transcoding profile. + /// </summary> + /// <param name="container">The container.</param> + /// <param name="audioCodec">The audio Codec.</param> + /// <returns>A <see cref="TranscodingProfile"/>.</returns> public TranscodingProfile GetAudioTranscodingProfile(string container, string audioCodec) { container = (container ?? string.Empty).TrimStart('.'); @@ -158,6 +271,13 @@ namespace MediaBrowser.Model.Dlna return null; } + /// <summary> + /// Gets the video transcoding profile. + /// </summary> + /// <param name="container">The container.</param> + /// <param name="audioCodec">The audio Codec.</param> + /// <param name="videoCodec">The video Codec.</param> + /// <returns>The <see cref="TranscodingProfile"/>.</returns> public TranscodingProfile GetVideoTranscodingProfile(string container, string audioCodec, string videoCodec) { container = (container ?? string.Empty).TrimStart('.'); @@ -190,6 +310,16 @@ namespace MediaBrowser.Model.Dlna return null; } + /// <summary> + /// Gets the audio media profile. + /// </summary> + /// <param name="container">The container.</param> + /// <param name="audioCodec">The audio codec.</param> + /// <param name="audioChannels">The audio channels.</param> + /// <param name="audioBitrate">The audio bitrate.</param> + /// <param name="audioSampleRate">The audio sample rate.</param> + /// <param name="audioBitDepth">The audio bit depth.</param> + /// <returns>The <see cref="ResponseProfile"/>.</returns> public ResponseProfile GetAudioMediaProfile(string container, string audioCodec, int? audioChannels, int? audioBitrate, int? audioSampleRate, int? audioBitDepth) { foreach (var i in ResponseProfiles) @@ -231,6 +361,11 @@ namespace MediaBrowser.Model.Dlna return null; } + /// <summary> + /// Gets the model profile condition. + /// </summary> + /// <param name="c">The c<see cref="ProfileCondition"/>.</param> + /// <returns>The <see cref="ProfileCondition"/>.</returns> private ProfileCondition GetModelProfileCondition(ProfileCondition c) { return new ProfileCondition @@ -242,6 +377,13 @@ namespace MediaBrowser.Model.Dlna }; } + /// <summary> + /// Gets the image media profile. + /// </summary> + /// <param name="container">The container.</param> + /// <param name="width">The width.</param> + /// <param name="height">The height.</param> + /// <returns>The <see cref="ResponseProfile"/>.</returns> public ResponseProfile GetImageMediaProfile(string container, int? width, int? height) { foreach (var i in ResponseProfiles) @@ -277,6 +419,29 @@ namespace MediaBrowser.Model.Dlna return null; } + /// <summary> + /// Gets the video media profile. + /// </summary> + /// <param name="container">The container.</param> + /// <param name="audioCodec">The audio codec.</param> + /// <param name="videoCodec">The video codec.</param> + /// <param name="width">The width.</param> + /// <param name="height">The height.</param> + /// <param name="bitDepth">The bit depth.</param> + /// <param name="videoBitrate">The video bitrate.</param> + /// <param name="videoProfile">The video profile.</param> + /// <param name="videoLevel">The video level.</param> + /// <param name="videoFramerate">The video framerate.</param> + /// <param name="packetLength">The packet length.</param> + /// <param name="timestamp">The timestamp<see cref="TransportStreamTimestamp"/>.</param> + /// <param name="isAnamorphic">True if anamorphic.</param> + /// <param name="isInterlaced">True if interlaced.</param> + /// <param name="refFrames">The ref frames.</param> + /// <param name="numVideoStreams">The number of video streams.</param> + /// <param name="numAudioStreams">The number of audio streams.</param> + /// <param name="videoCodecTag">The video Codec tag.</param> + /// <param name="isAvc">True if Avc.</param> + /// <returns>The <see cref="ResponseProfile"/>.</returns> public ResponseProfile GetVideoMediaProfile( string container, string audioCodec, diff --git a/MediaBrowser.Model/Dlna/XmlAttribute.cs b/MediaBrowser.Model/Dlna/XmlAttribute.cs index 3a8939a79..03bb2e4b1 100644 --- a/MediaBrowser.Model/Dlna/XmlAttribute.cs +++ b/MediaBrowser.Model/Dlna/XmlAttribute.cs @@ -5,11 +5,20 @@ using System.Xml.Serialization; namespace MediaBrowser.Model.Dlna { + /// <summary> + /// Defines the <see cref="XmlAttribute" />. + /// </summary> public class XmlAttribute { + /// <summary> + /// Gets or sets the name of the attribute. + /// </summary> [XmlAttribute("name")] public string Name { get; set; } + /// <summary> + /// Gets or sets the value of the attribute. + /// </summary> [XmlAttribute("value")] public string Value { get; set; } } diff --git a/MediaBrowser.Model/Entities/MediaStream.cs b/MediaBrowser.Model/Entities/MediaStream.cs index fa3c9aaa2..ca0b93c30 100644 --- a/MediaBrowser.Model/Entities/MediaStream.cs +++ b/MediaBrowser.Model/Entities/MediaStream.cs @@ -191,6 +191,11 @@ namespace MediaBrowser.Model.Entities attributes.Add(Codec.ToUpperInvariant()); } + if (!string.IsNullOrEmpty(VideoRange)) + { + attributes.Add(VideoRange.ToUpperInvariant()); + } + if (!string.IsNullOrEmpty(Title)) { var result = new StringBuilder(Title); diff --git a/deployment/Dockerfile.docker.amd64 b/deployment/Dockerfile.docker.amd64 index 926dd0cae..0b1a57014 100644 --- a/deployment/Dockerfile.docker.amd64 +++ b/deployment/Dockerfile.docker.amd64 @@ -1,6 +1,6 @@ ARG DOTNET_VERSION=5.0 -FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster +FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster-slim ARG SOURCE_DIR=/src ARG ARTIFACT_DIR=/jellyfin diff --git a/deployment/Dockerfile.docker.arm64 b/deployment/Dockerfile.docker.arm64 index 8fb03fcd0..583f53ca0 100644 --- a/deployment/Dockerfile.docker.arm64 +++ b/deployment/Dockerfile.docker.arm64 @@ -1,6 +1,6 @@ ARG DOTNET_VERSION=5.0 -FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster +FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster-slim ARG SOURCE_DIR=/src ARG ARTIFACT_DIR=/jellyfin diff --git a/deployment/Dockerfile.docker.armhf b/deployment/Dockerfile.docker.armhf index d2c7fa3ff..177c11713 100644 --- a/deployment/Dockerfile.docker.armhf +++ b/deployment/Dockerfile.docker.armhf @@ -1,6 +1,6 @@ ARG DOTNET_VERSION=5.0 -FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster +FROM mcr.microsoft.com/dotnet/sdk:${DOTNET_VERSION}-buster-slim ARG SOURCE_DIR=/src ARG ARTIFACT_DIR=/jellyfin |