From 45e141ca505883277e8a5f65e04cdf8d915bc825 Mon Sep 17 00:00:00 2001
From: Konstantin <const@const.me>
Date: Sun, 29 Jan 2023 16:30:27 +0100
Subject: Comments

---
 WhisperNet/Context.cs | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'WhisperNet')

diff --git a/WhisperNet/Context.cs b/WhisperNet/Context.cs
index 4bea863..3170b89 100644
--- a/WhisperNet/Context.cs
+++ b/WhisperNet/Context.cs
@@ -199,6 +199,12 @@ namespace Whisper
 		}
 
 		/// <summary>Try to detect speaker by comparing channels of the stereo PCM data</summary>
+		/// <remarks>
+		/// <para>The feature requires stereo PCM data.<br/>Pass <c>stereo=true</c> to <see cref="iMediaFoundation.loadAudioFile" /> or <see cref="iMediaFoundation.openAudioFile"/> methods,<br/>
+		/// or <see cref="eCaptureFlags.Stereo" /> to <see cref="iMediaFoundation.openCaptureDevice" /> method.</para>
+		/// <para>It seems to work fine with <a href="https://www.bluemic.com/en-us/products/yeti/">Blue Yeti</a> microphone,
+		/// after switched the microphone to Stereo pattern.<br/> With recorded sounds however, the performance varies depending on the recording.</para>
+		/// </remarks>
 		public eSpeakerChannel detectSpeaker( sTimeInterval interval ) =>
 			context.detectSpeaker( ref interval );
 	}
-- 
cgit v1.2.3