deploy: 2de4445

api/Adrenak.UniMic.MicAudioSource.html

@@ -83,12 +83,8 @@
 
   <h1 id="Adrenak_UniMic_MicAudioSource" data-uid="Adrenak.UniMic.MicAudioSource" class="text-break">Class MicAudioSource
   </h1>
-  <div class="markdown level0 summary"><p>A simple AudioSource based component that just plays what 
-the default <a class="xref" href="Adrenak.UniMic.Mic.Device.html">Mic.Device</a> instance is receiving.
-Provides optional feature to start the recording by itself.
-NOTE: This component is pretty basic. Also there isn&apos;t much
-use case for playing back what the user is saying. Use this
-class as a reference for your own UniMic usage.</p>
+  <div class="markdown level0 summary"><p>A wrapper over StreamedAudioSource to play what a <a class="xref" href="Adrenak.UniMic.Mic.Device.html">Mic.Device</a>
+is capturing. </p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">

api/Adrenak.UniMic.html

@@ -94,12 +94,8 @@ <h4><a class="xref" href="Adrenak.UniMic.Mic.Device.html">Mic.Device</a></h4>
       <section><p>Provides information and APIs for a single recording device.</p>
 </section>
       <h4><a class="xref" href="Adrenak.UniMic.MicAudioSource.html">MicAudioSource</a></h4>
-      <section><p>A simple AudioSource based component that just plays what 
-the default <a class="xref" href="Adrenak.UniMic.Mic.Device.html">Mic.Device</a> instance is receiving.
-Provides optional feature to start the recording by itself.
-NOTE: This component is pretty basic. Also there isn&apos;t much
-use case for playing back what the user is saying. Use this
-class as a reference for your own UniMic usage.</p>
+      <section><p>A wrapper over StreamedAudioSource to play what a <a class="xref" href="Adrenak.UniMic.Mic.Device.html">Mic.Device</a>
+is capturing. </p>
 </section>
       <h4><a class="xref" href="Adrenak.UniMic.StreamedAudioSource.html">StreamedAudioSource</a></h4>
       <section><p>Plays back the streaming audio provided to it.

index.json

@@ -2,7 +2,7 @@
   "api/Adrenak.UniMic.html": {
     "href": "api/Adrenak.UniMic.html",
     "title": "Namespace Adrenak.UniMic | UniMic documentation",
-    "keywords": "Namespace Adrenak.UniMic Classes Mic Provides access to all the recording devices available Mic.Device Provides information and APIs for a single recording device. MicAudioSource A simple AudioSource based component that just plays what the default Mic.Device instance is receiving. Provides optional feature to start the recording by itself. NOTE: This component is pretty basic. Also there isn't much use case for playing back what the user is saying. Use this class as a reference for your own UniMic usage. StreamedAudioSource Plays back the streaming audio provided to it. Automatically adjusts to any changing sampling frequency or channel count. Samples of varying lengths can be sent, however this could impact performance. Consider keeping sample length constant."
+    "keywords": "Namespace Adrenak.UniMic Classes Mic Provides access to all the recording devices available Mic.Device Provides information and APIs for a single recording device. MicAudioSource A wrapper over StreamedAudioSource to play what a Mic.Device is capturing. StreamedAudioSource Plays back the streaming audio provided to it. Automatically adjusts to any changing sampling frequency or channel count. Samples of varying lengths can be sent, however this could impact performance. Consider keeping sample length constant."
   },
   "api/Adrenak.UniMic.Mic.Device.html": {
     "href": "api/Adrenak.UniMic.Mic.Device.html",
@@ -17,7 +17,7 @@
   "api/Adrenak.UniMic.MicAudioSource.html": {
     "href": "api/Adrenak.UniMic.MicAudioSource.html",
     "title": "Class MicAudioSource | UniMic documentation",
-    "keywords": "Class MicAudioSource A simple AudioSource based component that just plays what the default Mic.Device instance is receiving. Provides optional feature to start the recording by itself. NOTE: This component is pretty basic. Also there isn't much use case for playing back what the user is saying. Use this class as a reference for your own UniMic usage. Inheritance System.Object MicAudioSource Namespace : Adrenak.UniMic Assembly : cs.temp.dll.dll Syntax public class MicAudioSource : MonoBehaviour Properties Device Declaration public Mic.Device Device { get; set; } Property Value Type Description Mic.Device StreamedAudioSource Declaration public StreamedAudioSource StreamedAudioSource { get; } Property Value Type Description StreamedAudioSource"
+    "keywords": "Class MicAudioSource A wrapper over StreamedAudioSource to play what a Mic.Device is capturing. Inheritance System.Object MicAudioSource Namespace : Adrenak.UniMic Assembly : cs.temp.dll.dll Syntax public class MicAudioSource : MonoBehaviour Properties Device Declaration public Mic.Device Device { get; set; } Property Value Type Description Mic.Device StreamedAudioSource Declaration public StreamedAudioSource StreamedAudioSource { get; } Property Value Type Description StreamedAudioSource"
   },
   "api/Adrenak.UniMic.Samples.html": {
     "href": "api/Adrenak.UniMic.Samples.html",
@@ -58,10 +58,5 @@
     "href": "index.html",
     "title": "UniMic 🎤 | UniMic documentation",
     "keywords": "UniMic 🎤 A wrapper for Unity's Microphone class. Provides easy APIs for mic input and management. Also includes StreamedAudioSource , a (not Microphone related) class that can be used for playing streaming audio by feeding it incoming audio samples. Documentation 📝 Refer to the Scripting Reference Installing 📦 ⚠️ OpenUPM doesn't have up to date releases. Install using NPM registry instead 👇 Ensure you have the NPM registry in the packages.json file of your Unity project with com.adrenak.unimic as one of the scopes \"scopedRegistries\": [ { \"name\": \"npmjs\", \"url\": \"https://registry.npmjs.org\", \"scopes\": [ \"com.npmjs\", \"com.adrenak.unimic\" ] } } Add \"com.adrenak.unimic\" : \"x.y.z\" to dependencies list in packages.json file where x.y.z is the version name 💬 You can see the versions on the NPM page here . Also note that v3.x.x is recommended. v3 has several breaking changes against v1 and v2. Refer to the scripting reference if you're upgrading. Samples 🚀 Getting started with some samples is the best way to see the features of UniMic, and there are many! Ensure that atleast one recording device is connected to your PC/Mac for the samples to work. Simple MicAudioSource Sample A gameobject called My Mic is placed. It has the MicAudioSource component. Another gmeobject called Sample has SimpleMicAudioSourceSample On start it checks if there are any mic devices available If yes, it takes the first recording device available and starts the recording using .StartRecording() Then assigns the device to MicAudioSource , which then starts playing the audio Play the scene. You should be able to hear your voice in the editor Multiple MicAudioSource Sample Run the scene, you should see every mic device connected On start, all the devices will start recording in parallel and playing back Toggling the checkbox on or off will start or stop the recording for a device Prefab MicDeviceCell is used to represent one device. The MicDeviceCell.cs script handles its UI. Check out the MultipleMicAudioSourceSample script to see how the UI has been created MicAudioSource Switch Sample Run the scene, recording should start on one device and a dropdown will show all the available recording devices Use the dropdown to change to a difference device at runtime Check out the MicAudioSourceSwitchSample script to see how the Device of a MicAudioSource can be changed at runtime. Spatial Blend Sample (for spatial audio) Run the scene, the audio source is a moving ball. When you speak, your audio is played from the balls position. Use headphones to hear the sound moving. Using the slider, you can change the spatial blend from 0 to 1 Note 📄 Some Xiaomi phones may prevent side loaded APKs from functioning. There is no AEC (Acoustic Echo Cancelletion). If you're trying the samples be sure to use headphones to avoid creating a feedback loop. Contact 👥 @github @website @discord: adrenak#1934"
-  },
-  "manual/manual.html": {
-    "href": "manual/manual.html",
-    "title": "| UniMic documentation",
-    "keywords": "Home Link to repo"
   }
 }

manifest.json

@@ -52,7 +52,7 @@
       "output": {
         ".html": {
           "relative_path": "api/Adrenak.UniMic.MicAudioSource.html",
-          "hash": "FNpnzRRb0uonx72KBcfX7UX72AmlQbt4FCreMQK/HOE="
+          "hash": "+UxFsV/Paujc46cqVY3dY82puQvl4/ojfEX4BKc1nSc="
         }
       },
       "is_incremental": false,
@@ -148,7 +148,7 @@
       "output": {
         ".html": {
           "relative_path": "api/Adrenak.UniMic.html",
-          "hash": "F/nys03dBzTI+JfHBG2nKdSBzyXDNZbzP2oJQyRp+mU="
+          "hash": "/3vn8QOudNI2BdV1EWm9ATejpjMEK53MjHF1HA/zA5E="
         }
       },
       "is_incremental": false,
@@ -178,18 +178,6 @@
       "is_incremental": false,
       "version": ""
     },
-    {
-      "type": "Conceptual",
-      "source_relative_path": "manual/manual.md",
-      "output": {
-        ".html": {
-          "relative_path": "manual/manual.html",
-          "hash": "vZqOtsqtDaH4Al04hS3zVnb/EDbq5heSFgcXl+av0dg="
-        }
-      },
-      "is_incremental": false,
-      "version": ""
-    },
     {
       "type": "Toc",
       "source_relative_path": "toc.yml",
@@ -217,7 +205,7 @@
         "ConceptualDocumentProcessor": {
           "can_incremental": false,
           "incrementalPhase": "build",
-          "total_file_count": 2,
+          "total_file_count": 1,
           "skipped_file_count": 0
         },
         "ManagedReferenceDocumentProcessor": {

sitemap.xml

@@ -2,79 +2,73 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Mic.Device.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Mic.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.MicAudioSource.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.MicDeviceCell.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.MicudioSourceSwitchSample.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.MultipleMicAudioSourceSample.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.SimpleMicAudioSourceSample.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.SpatialBlendSample.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.Samples.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.StreamedAudioSource.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/api/Adrenak.UniMic.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://adrenak.github.io/unimic/index.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
-    <changefreq>weekly</changefreq>
-    <priority>0.5</priority>
-  </url>
-  <url>
-    <loc>https://adrenak.github.io/unimic/manual/manual.html</loc>
-    <lastmod>2024-12-15T11:28:24+00:00</lastmod>
+    <lastmod>2024-12-15T11:39:12+00:00</lastmod>
     <changefreq>weekly</changefreq>
     <priority>0.5</priority>
   </url>