docs: Fixed SEO issues, added Clarity for aalytics.

docs/config/_default/hugo.toml

@@ -1,4 +1,4 @@
-title = "Amplitude"
+title = "Amplitude Audio SDK"
 baseurl = ""
 canonifyURLs = false
 disableAliases = true
@@ -70,13 +70,13 @@ rel  = "sitemap"
   toLower = false
     [[related.indices]]
     name = "categories"
-    weight = 100
+    weight = "100"
     [[related.indices]]
     name = "tags"
-    weight = 80
+    weight = "80"
     [[related.indices]]
     name = "date"
-    weight = 10
+    weight = "10"
 
 [imaging]
   anchor = "Smart"

docs/config/_default/languages.toml

@@ -7,28 +7,5 @@
     languageTag = "en-US"
     titleAddition = "A powerful and cross-platform audio engine, optimized for games"
     description = "Amplitude is a full-featured and cross-platform audio engine designed with the needs of games in mind. With his efficient audio mixer, you have all the controls to play spatialized sounds in 3D environments with custom attenuation models and a lot more."
-    footer = 'Brought to you by <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
+    footer = 'Copyright © Sparky Studios. All Rights Reserved. Licensed under Apache-2.0'
     alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
-
-[de]
-  languageName = "German"
-  contentDir = "content/de"
-  weight = 15
-  [de.params]
-    languageISO = "DE"
-    languageTag = "de-DE"
-    footer = 'Gebaut mit <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
-    alertText = 'Neue Version ist da! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.5/">Doks v0.5</a>'
-
-[nl]
-  languageName = "Nederlands"
-  contentDir = "content/nl"
-  weight = 20
-  [nl.params]
-    languageISO = "NL"
-    languageTag = "nl-NL"
-    titleAddition = "Modern documentatie-thema"
-    description = "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
-    titleHome = "Doks thema"
-    footer = 'Mogelijk gemaakt door <a href="https://www.netlify.com/">Netlify</a>, <a href="https://gohugo.io/">Hugo</a>, en <a href="https://getdoks.org/">Doks</a>'
-    alertText = 'Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.2/">Bekijk Doks v0.2</a>'

docs/config/_default/menus/menus.en.toml

@@ -17,10 +17,10 @@ name = "Documentation"
 url = "/docs/get-started/introduction/"
 weight = 10
 
-[[main]]
-name = "Blog"
-url = "/blog/"
-weight = 20
+#[[main]]
+#name = "Blog"
+#url = "/blog/"
+#weight = 20
 
 # -----
 
@@ -45,10 +45,10 @@ weight = 30
 
 # -----
 
-[[footer]]
-name = "Privacy Policy"
-url = "/privacy/"
-weight = 10
+#[[footer]]
+#name = "Privacy Policy"
+#url = "/privacy/"
+#weight = 10
 
 # -----
 

docs/content/_index.md

@@ -1,9 +1,9 @@
 ---
-title : "Amplitude Audio SDK"
-description: "A full-featured and cross-platform audio engine designed with the needs of games in mind. With his efficient audio mixer, you have all the controls to play spatialized sounds in 3D environments with custom attenuation models and a lot more."
-lead: "A full-featured and cross-platform audio engine designed with the needs of games in mind. With his efficient audio mixer, you have all the controls to play spatialized sounds in 3D environments with custom attenuation models and a lot more."
+title : Amplitude Audio SDK
+description: A full-featured and cross-platform audio engine designed with the needs of games in mind.
+lead: A full-featured and cross-platform audio engine designed with the needs of games in mind. With his efficient audio mixer, you have all the controls to play spatialized sounds in 3D environments with custom attenuation models and a lot more.
 date: 2020-10-06T08:47:36+00:00
-lastmod: 2020-10-06T08:47:36+00:00
+lastmod: 2023-11-01T19:34:36+00:00
 draft: false
 images: []
 ---

docs/content/docs/project-setup/99-api.md

@@ -8,6 +8,134 @@ weight: 299
 toc: true
 ---
 
+## CurveDefinition {#curve-definition}
+
+Describes a function that is applied on a value to transform the result.
+
+### parts {#curve-definition-parts}
+
+`CurvePartDefinition[]` `required`
+
+An array of objects representing each part of the curve. Each object provides a start point, an end point, and fading function to use to link them. Check the [CurvePartDefinition] section for more information.
+
+The final range of the curve will be bounded within the lowest point and the highest point of all the curve parts.
+
+### Example {#curve-definition-example}
+
+```json
+{
+  "parts": [
+    {
+      "start": {
+        "x": 0,
+        "y": 0
+      },
+      "end": {
+        "x": 1,
+        "y": 1
+      },
+      "fader": "Linear"
+    }
+  ]
+}
+```
+
+---
+
+## CurvePartDefinition {#curve-part-definition}
+
+An object describing a single part of a curve. Allowed properties are:
+
+### start {#curve-part-definition-start}
+
+`CurvePointDefinition` `required`
+
+The start point of the curve. It stores the coordinates of the point in the graph. Check the [CurvePointDefinition] section for more information.
+
+### end {#curve-part-definition-end}
+
+`CurvePointDefinition` `required`
+
+The end point of the curve. It stores the coordinates of the point in the graph. Check the [CurvePointDefinition] section for more information.
+
+### fader {#curve-part-definition-fader}
+
+`string` `required`
+
+The fader transition to use while moving values from the `start` point to the `end` point. This stores as value a name to a registered fader transition.
+
+### Example {#curve-part-definition-example}
+
+```json
+{
+  "start": {
+    "x": 0,
+    "y": 0
+  },
+  "end": {
+    "x": 1,
+    "y": 1
+  },
+  "fader": "SCurveSmooth"
+}
+```
+
+---
+
+## CurvePointDefinition {#curve-point-definition}
+
+Represents a point in a curve graph. It's an object defined by 2 coordinate values:
+
+### x {#curve-point-definition-x}
+
+`double` `required`
+
+The position of the point over the X-axis. The X-axis represents the values passed to the curve for computation.
+
+### y {#curve-point-definition-y}
+
+`float` `required`
+
+The position of the point over the Y-axis. The Y-axis represents the result of the computation for a given value.
+
+### Example {#curve-point-definition-example}
+
+```json
+{
+  "x": 1,
+  "y": 343.33
+}
+```
+
+---
+
+## FadeTransitionSettings {#fade-transition-settings}
+
+This object defines the settings for a fade transition. It is described by the following attributes:
+
+### duration {#fade-transition-settings-duration}
+
+`double` `required`
+
+The duration of the fade transition. The value is expressed in seconds.
+
+### fader {#fade-transition-settings-fader}
+
+`string` `required`
+
+The name of the [Fader] algorithm to be used. It can be one of those shipped with the engine or from plugins.
+
+### Example {#fade-transition-settings-example}
+
+```json
+{
+  "duration": 3.0,
+  "fader": "ExponentialSmooth"
+}
+```
+
+---
+
 ## RtpcCompatibleValue {#rtpc-compatible-value}
 
 An RTPC-compatible value is an object that can hold a static value or a link to an RTPC value.
@@ -42,4 +170,84 @@ An object that describe how the value should be updated according to a RTPC obje
 - `id`: The ID of the RTPC object to use.
 - `curve`: A [CurveDefinition] object that defines the function to apply on the RTPC value to compute this parameter value.
 
+Check the [RtpcParameter] section for more information.
+
+### Example {#rtpc-compatible-value-example}
+
+```json
+// An example of RTPC-compatible value with a static value
+{
+  "kind": "Static",
+  "value": 5
+}
+
+// An example of RTPC-compatible value with a RTPC value
+{
+  "kind": "RTPC",
+  "rtpc": {
+    "id": 19,
+    "curve": {
+      "parts": [
+        {
+          "start": {
+            "x": 0,
+            "y": 1
+          },
+          "end": {
+            "x": 100,
+            "y": 0
+          },
+          "fader": "Linear"
+        }
+      ]
+    }
+  }
+}
+```
+
+---
+
+## RtpcParameter {#rtpc-parameter}
+
+An object used to defines how to gather values from a [RtpcCompatibleValue] with the `kind` property set to `RTPC`. This allows you to use a curve to convert values from the RTPC object to other values.
+
+### id {#rtpc-parameter-id}
+
+`uint64` `required`
+
+The id of the RTPC object where to get the value. This value should reference a valid RTPC object.
+
+### curve {#rtpc-parameter-curve}
+
+`CurveDefinition` `required`
+
+The curve to use when converting values from the RTPC object. It stores as value an object matching the specification of a [CurveDefinition]. Check the [CurveDefinition] section for more information.
+
+### Example {#rtpc-parameter-example}
+
+```json
+{
+  "id": 24,
+  "curve": {
+    "parts": [
+      {
+        "start": {
+          "x": 0,
+          "y": 1
+        },
+        "end": {
+          "x": 1,
+          "y": 0
+        },
+        "fader": "SCurveSharp"
+      }
+    ]
+  }
+}
+```
+
 [CurveDefinition]: #curve-definition
+[CurvePartDefinition]: #curve-part-definition
+[CurvePointDefinition]: #curve-point-definition
+[RtpcCompatibleValue]: #rtpc-compatible-value
+[RtpcParameter]: #rtpc-parameter