diff --git a/MediaBrowser.Providers/MediaInfo/AudioResolver.cs b/MediaBrowser.Providers/MediaInfo/AudioResolver.cs index b6f3ac1cc1..20dee834ff 100644 --- a/MediaBrowser.Providers/MediaInfo/AudioResolver.cs +++ b/MediaBrowser.Providers/MediaInfo/AudioResolver.cs @@ -18,12 +18,21 @@ using MediaBrowser.Model.MediaInfo; namespace MediaBrowser.Providers.MediaInfo { + /// + /// Resolves external audios for videos. + /// public class AudioResolver { private readonly ILocalizationManager _localizationManager; private readonly IMediaEncoder _mediaEncoder; private readonly NamingOptions _namingOptions; + /// + /// Initializes a new instance of the class. + /// + /// The localization manager. + /// The media encoder. + /// The naming options. public AudioResolver( ILocalizationManager localizationManager, IMediaEncoder mediaEncoder, @@ -34,6 +43,15 @@ namespace MediaBrowser.Providers.MediaInfo _namingOptions = namingOptions; } + /// + /// Returns the audio streams found in the external audio files for the given video. + /// + /// The video to get the external audio streams from. + /// The stream index to start adding audio streams at. + /// The directory service to search for files. + /// True if the directory service cache should be cleared before searching. + /// The cancellation token to cancel operation. + /// A list of external audio streams. public async IAsyncEnumerable GetExternalAudioStreams( Video video, int startIndex, @@ -83,6 +101,13 @@ namespace MediaBrowser.Providers.MediaInfo } } + /// + /// Returns the external audio file paths for the given video. + /// + /// The video to get the external audio file paths from. + /// The directory service to search for files. + /// True if the directory service cache should be cleared before searching. + /// A list of external audio file paths. public IEnumerable GetExternalAudioFiles( Video video, IDirectoryService directoryService, @@ -123,6 +148,12 @@ namespace MediaBrowser.Providers.MediaInfo } } + /// + /// Returns the media info of the given audio file. + /// + /// The path to the audio file. + /// The cancellation token to cancel operation. + /// The media info for the given audio file. private Task GetMediaInfo(string path, CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested();