Merge pull request #6386 from richlander/mediabrowser-controller-livetv

Fix warnings in MediaBrowser.Controller/LiveTv

MediaBrowser.Controller/LiveTv/ILiveTvManager.cs

@@ -22,12 +22,22 @@ namespace MediaBrowser.Controller.LiveTv
     /// </summary>
     public interface ILiveTvManager
     {
+        event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCancelled;
+
+        event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCancelled;
+
+        event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCreated;
+
+        event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCreated;
+
         /// <summary>
         /// Gets the services.
         /// </summary>
         /// <value>The services.</value>
         IReadOnlyList<ILiveTvService> Services { get; }
 
+        IListingsProvider[] ListingProviders { get; }
+
         /// <summary>
         /// Gets the new timer defaults asynchronous.
         /// </summary>
@@ -86,6 +96,7 @@ namespace MediaBrowser.Controller.LiveTv
         /// </summary>
         /// <param name="query">The query.</param>
         /// <param name="options">The options.</param>
+        /// <returns>A recording.</returns>
         QueryResult<BaseItemDto> GetRecordings(RecordingQuery query, DtoOptions options);
 
         /// <summary>
@@ -176,11 +187,16 @@ namespace MediaBrowser.Controller.LiveTv
         /// <param name="query">The query.</param>
         /// <param name="options">The options.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Recommended programs.</returns>
         QueryResult<BaseItemDto> GetRecommendedPrograms(InternalItemsQuery query, DtoOptions options, CancellationToken cancellationToken);
 
         /// <summary>
         /// Gets the recommended programs internal.
         /// </summary>
+        /// <param name="query">The query.</param>
+        /// <param name="options">The options.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Recommended programs.</returns>
         QueryResult<BaseItem> GetRecommendedProgramsInternal(InternalItemsQuery query, DtoOptions options, CancellationToken cancellationToken);
 
         /// <summary>
@@ -202,6 +218,7 @@ namespace MediaBrowser.Controller.LiveTv
         /// Gets the live tv folder.
         /// </summary>
         /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Live TV folder.</returns>
         Folder GetInternalLiveTvFolder(CancellationToken cancellationToken);
 
         /// <summary>
@@ -213,11 +230,18 @@ namespace MediaBrowser.Controller.LiveTv
         /// <summary>
         /// Gets the internal channels.
         /// </summary>
+        /// <param name="query">The query.</param>
+        /// <param name="dtoOptions">The options.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Internal channels.</returns>
         QueryResult<BaseItem> GetInternalChannels(LiveTvChannelQuery query, DtoOptions dtoOptions, CancellationToken cancellationToken);
 
         /// <summary>
         /// Gets the channel media sources.
         /// </summary>
+        /// <param name="item">Item to search for.</param>
+        /// <param name="cancellationToken">CancellationToken to use for operation.</param>
+        /// <returns>Channel media sources wrapped in a task.</returns>
         Task<IEnumerable<MediaSourceInfo>> GetChannelMediaSources(BaseItem item, CancellationToken cancellationToken);
 
         /// <summary>
@@ -232,6 +256,9 @@ namespace MediaBrowser.Controller.LiveTv
         /// <summary>
         /// Saves the tuner host.
         /// </summary>
+        /// <param name="info">Turner host to save.</param>
+        /// <param name="dataSourceChanged">Option to specify that data source has changed.</param>
+        /// <returns>Tuner host information wrapped in a task.</returns>
         Task<TunerHostInfo> SaveTunerHost(TunerHostInfo info, bool dataSourceChanged = true);
 
         /// <summary>
@@ -271,20 +298,10 @@ namespace MediaBrowser.Controller.LiveTv
 
         Task<List<ChannelInfo>> GetChannelsFromListingsProviderData(string id, CancellationToken cancellationToken);
 
-        IListingsProvider[] ListingProviders { get; }
-
         List<NameIdPair> GetTunerHostTypes();
 
         Task<List<TunerHostInfo>> DiscoverTuners(bool newDevicesOnly, CancellationToken cancellationToken);
 
-        event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCancelled;
-
-        event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCancelled;
-
-        event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCreated;
-
-        event EventHandler<GenericEventArgs<TimerEventInfo>> SeriesTimerCreated;
-
         string GetEmbyTvActiveRecordingPath(string id);
 
         ActiveRecordingInfo GetActiveRecordingInfo(string path);

MediaBrowser.Controller/LiveTv/ITunerHost.cs

@@ -30,6 +30,8 @@ namespace MediaBrowser.Controller.LiveTv
         /// <summary>
         /// Gets the channels.
         /// </summary>
+        /// <param name="enableCache">Option to enable using cache.</param>
+        /// <param name="cancellationToken">The CancellationToken for this operation.</param>
         /// <returns>Task&lt;IEnumerable&lt;ChannelInfo&gt;&gt;.</returns>
         Task<List<ChannelInfo>> GetChannels(bool enableCache, CancellationToken cancellationToken);
 
@@ -47,6 +49,7 @@ namespace MediaBrowser.Controller.LiveTv
         /// <param name="streamId">The stream identifier.</param>
         /// <param name="currentLiveStreams">The current live streams.</param>
         /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>Live stream wrapped in a task.</returns>
         Task<ILiveStream> GetChannelStream(string channelId, string streamId, List<ILiveStream> currentLiveStreams, CancellationToken cancellationToken);
 
         /// <summary>

MediaBrowser.Controller/LiveTv/LiveTvChannel.cs

@@ -18,23 +18,6 @@ namespace MediaBrowser.Controller.LiveTv
 {
     public class LiveTvChannel : BaseItem, IHasMediaSources, IHasProgramAttributes
     {
-        public override List<string> GetUserDataKeys()
-        {
-            var list = base.GetUserDataKeys();
-
-            if (!ConfigurationManager.Configuration.DisableLiveTvChannelUserDataName)
-            {
-                list.Insert(0, GetClientTypeName() + "-" + Name);
-            }
-
-            return list;
-        }
-
-        public override UnratedItem GetBlockUnratedType()
-        {
-            return UnratedItem.LiveTvChannel;
-        }
-
         [JsonIgnore]
         public override bool SupportsPositionTicksResume => false;
 
@@ -59,6 +42,67 @@ namespace MediaBrowser.Controller.LiveTv
         [JsonIgnore]
         public override LocationType LocationType => LocationType.Remote;
 
+        [JsonIgnore]
+        public override string MediaType => ChannelType == ChannelType.Radio ? Model.Entities.MediaType.Audio : Model.Entities.MediaType.Video;
+
+        [JsonIgnore]
+        public bool IsMovie { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether this instance is sports.
+        /// </summary>
+        /// <value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
+        [JsonIgnore]
+        public bool IsSports { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether this instance is series.
+        /// </summary>
+        /// <value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
+        [JsonIgnore]
+        public bool IsSeries { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether this instance is news.
+        /// </summary>
+        /// <value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
+        [JsonIgnore]
+        public bool IsNews { get; set; }
+
+        /// <summary>
+        /// Gets a value indicating whether this instance is kids.
+        /// </summary>
+        /// <value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
+        [JsonIgnore]
+        public bool IsKids => Tags.Contains("Kids", StringComparer.OrdinalIgnoreCase);
+
+        [JsonIgnore]
+        public bool IsRepeat { get; set; }
+
+        /// <summary>
+        /// Gets or sets the episode title.
+        /// </summary>
+        /// <value>The episode title.</value>
+        [JsonIgnore]
+        public string EpisodeTitle { get; set; }
+
+        public override List<string> GetUserDataKeys()
+        {
+            var list = base.GetUserDataKeys();
+
+            if (!ConfigurationManager.Configuration.DisableLiveTvChannelUserDataName)
+            {
+                list.Insert(0, GetClientTypeName() + "-" + Name);
+            }
+
+            return list;
+        }
+
+        public override UnratedItem GetBlockUnratedType()
+        {
+            return UnratedItem.LiveTvChannel;
+        }
+
         protected override string CreateSortName()
         {
             if (!string.IsNullOrEmpty(Number))
@@ -74,9 +118,6 @@ namespace MediaBrowser.Controller.LiveTv
             return (Number ?? string.Empty) + "-" + (Name ?? string.Empty);
         }
 
-        [JsonIgnore]
-        public override string MediaType => ChannelType == ChannelType.Radio ? Model.Entities.MediaType.Audio : Model.Entities.MediaType.Video;
-
         public override string GetClientTypeName()
         {
             return "TvChannel";
@@ -122,46 +163,5 @@ namespace MediaBrowser.Controller.LiveTv
         {
             return false;
         }
-
-        [JsonIgnore]
-        public bool IsMovie { get; set; }
-
-        /// <summary>
-        /// Gets or sets a value indicating whether this instance is sports.
-        /// </summary>
-        /// <value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
-        [JsonIgnore]
-        public bool IsSports { get; set; }
-
-        /// <summary>
-        /// Gets or sets a value indicating whether this instance is series.
-        /// </summary>
-        /// <value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
-        [JsonIgnore]
-        public bool IsSeries { get; set; }
-
-        /// <summary>
-        /// Gets or sets a value indicating whether this instance is news.
-        /// </summary>
-        /// <value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
-        [JsonIgnore]
-        public bool IsNews { get; set; }
-
-        /// <summary>
-        /// Gets a value indicating whether this instance is kids.
-        /// </summary>
-        /// <value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
-        [JsonIgnore]
-        public bool IsKids => Tags.Contains("Kids", StringComparer.OrdinalIgnoreCase);
-
-        [JsonIgnore]
-        public bool IsRepeat { get; set; }
-
-        /// <summary>
-        /// Gets or sets the episode title.
-        /// </summary>
-        /// <value>The episode title.</value>
-        [JsonIgnore]
-        public string EpisodeTitle { get; set; }
     }
 }

MediaBrowser.Controller/LiveTv/LiveTvProgram.cs

@@ -1,6 +1,6 @@
 #nullable disable
 
-#pragma warning disable CS1591
+#pragma warning disable CS1591, SA1306
 
 using System;
 using System.Collections.Generic;
@@ -19,54 +19,14 @@ namespace MediaBrowser.Controller.LiveTv
 {
     public class LiveTvProgram : BaseItem, IHasLookupInfo<ItemLookupInfo>, IHasStartDate, IHasProgramAttributes
     {
+        private static string EmbyServiceName = "Emby";
+
         public LiveTvProgram()
         {
             IsVirtualItem = true;
         }
 
-        public override List<string> GetUserDataKeys()
-        {
-            var list = base.GetUserDataKeys();
-
-            if (!IsSeries)
-            {
-                var key = this.GetProviderId(MetadataProvider.Imdb);
-                if (!string.IsNullOrEmpty(key))
-                {
-                    list.Insert(0, key);
-                }
-
-                key = this.GetProviderId(MetadataProvider.Tmdb);
-                if (!string.IsNullOrEmpty(key))
-                {
-                    list.Insert(0, key);
-                }
-            }
-            else if (!string.IsNullOrEmpty(EpisodeTitle))
-            {
-                var name = GetClientTypeName();
-
-                list.Insert(0, name + "-" + Name + (EpisodeTitle ?? string.Empty));
-            }
-
-            return list;
-        }
-
-        private static string EmbyServiceName = "Emby";
-
-        public override double GetDefaultPrimaryImageAspectRatio()
-        {
-            var serviceName = ServiceName;
-
-            if (string.Equals(serviceName, EmbyServiceName, StringComparison.OrdinalIgnoreCase) || string.Equals(serviceName, "Next Pvr", StringComparison.OrdinalIgnoreCase))
-            {
-                return 2.0 / 3;
-            }
-            else
-            {
-                return 16.0 / 9;
-            }
-        }
+        public string SeriesName { get; set; }
 
         [JsonIgnore]
         public override SourceType SourceType => SourceType.LiveTV;
@@ -182,6 +142,66 @@ namespace MediaBrowser.Controller.LiveTv
             }
         }
 
+        [JsonIgnore]
+        public override bool SupportsPeople
+        {
+            get
+            {
+                // Optimization
+                if (IsNews || IsSports)
+                {
+                    return false;
+                }
+
+                return base.SupportsPeople;
+            }
+        }
+
+        [JsonIgnore]
+        public override bool SupportsAncestors => false;
+
+        public override List<string> GetUserDataKeys()
+        {
+            var list = base.GetUserDataKeys();
+
+            if (!IsSeries)
+            {
+                var key = this.GetProviderId(MetadataProvider.Imdb);
+                if (!string.IsNullOrEmpty(key))
+                {
+                    list.Insert(0, key);
+                }
+
+                key = this.GetProviderId(MetadataProvider.Tmdb);
+                if (!string.IsNullOrEmpty(key))
+                {
+                    list.Insert(0, key);
+                }
+            }
+            else if (!string.IsNullOrEmpty(EpisodeTitle))
+            {
+                var name = GetClientTypeName();
+
+                list.Insert(0, name + "-" + Name + (EpisodeTitle ?? string.Empty));
+            }
+
+            return list;
+        }
+
+        public override double GetDefaultPrimaryImageAspectRatio()
+        {
+            var serviceName = ServiceName;
+
+            if (string.Equals(serviceName, EmbyServiceName, StringComparison.OrdinalIgnoreCase) || string.Equals(serviceName, "Next Pvr", StringComparison.OrdinalIgnoreCase))
+            {
+                return 2.0 / 3;
+            }
+            else
+            {
+                return 16.0 / 9;
+            }
+        }
+
         public override string GetClientTypeName()
         {
             return "Program";
@@ -202,24 +222,6 @@ namespace MediaBrowser.Controller.LiveTv
             return false;
         }
 
-        [JsonIgnore]
-        public override bool SupportsPeople
-        {
-            get
-            {
-                // Optimization
-                if (IsNews || IsSports)
-                {
-                    return false;
-                }
-
-                return base.SupportsPeople;
-            }
-        }
-
-        [JsonIgnore]
-        public override bool SupportsAncestors => false;
-
         private LiveTvOptions GetConfiguration()
         {
             return ConfigurationManager.GetConfiguration<LiveTvOptions>("livetv");
@@ -273,7 +275,5 @@ namespace MediaBrowser.Controller.LiveTv
 
             return list;
         }
-
-        public string SeriesName { get; set; }
     }
 }