Document sound property defaults (#16280)

Author: docEdub

packages/dev/core/src/AudioV2/abstractAudio/staticSound.ts

@@ -40,7 +40,7 @@ export interface IStaticSoundOptionsBase {
 /** @internal */
 export interface IStaticSoundPlayOptionsBase {
     /**
-     * The time to wait before playing the sound, in seconds.
+     * The time to wait before playing the sound, in seconds. Defaults to `0`.
      */
     waitTime: number;
 }
@@ -60,7 +60,7 @@ export interface IStaticSoundPlayOptions extends IAbstractSoundPlayOptions, ISta
  */
 export interface IStaticSoundStopOptions {
     /**
-     * The time to wait before stopping the sound, in seconds.
+     * The time to wait before stopping the sound, in seconds. Defaults to `0`.
      */
     waitTime: number;
 }
@@ -99,7 +99,7 @@ export abstract class StaticSound extends AbstractSound {
     }
 
     /**
-     * The amount of time to play the sound for, in seconds.
+     * The amount of time to play the sound for, in seconds. Defaults to `0`.
      * - If less than or equal to `0`, the sound plays for its full duration.
      */
     public get duration(): number {
@@ -135,7 +135,7 @@ export abstract class StaticSound extends AbstractSound {
     }
 
     /**
-     * The pitch of the sound, in cents.
+     * The pitch of the sound, in cents. Defaults to `0`.
      * - Gets combined with {@link playbackRate} to determine the final pitch.
      */
     public get pitch(): number {
@@ -147,7 +147,7 @@ export abstract class StaticSound extends AbstractSound {
     }
 
     /**
-     * The playback rate of the sound.
+     * The playback rate of the sound. Defaults to `1`.
      * - Gets combined with {@link pitch} to determine the final playback rate.
      */
     public get playbackRate(): number {

packages/dev/core/src/AudioV2/abstractAudio/streamingSound.ts

@@ -51,7 +51,7 @@ export abstract class StreamingSound extends AbstractSound {
     }
 
     /**
-     * The number of instances to preload.
+     * The number of instances to preload. Defaults to `1`.
      */
     public get preloadCount(): number {
         return this._options.preloadCount ?? 1;