From aa63a4e414c2e47dc32e2675af4c1785631b4148 Mon Sep 17 00:00:00 2001 From: Redot Organization Date: Sat, 28 Feb 2026 04:33:35 +0000 Subject: [PATCH] classref: Sync with current master branch (3ef8058) --- classes/class_engine.rst | 2 +- classes/class_refcounted.rst | 2 +- ...s_signalsmith.rst => class_soundsmith.rst} | 88 +++++++++---------- classes/index.rst | 2 +- 4 files changed, 47 insertions(+), 47 deletions(-) rename classes/{class_signalsmith.rst => class_soundsmith.rst} (70%) diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 27e59d8eb39..b79a2abe3f1 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -356,7 +356,7 @@ Every :ref:`Dictionary` contains a ``name`` identifier, and a Returns a :ref:`Dictionary` of categorized donor names. Each entry is an :ref:`Array` of strings: -{``donors``} +\ ``donors`` .. rst-class:: classref-item-separator diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index b6f7a105882..7ac7db05b46 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SignalSmith`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SoundSmith`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_signalsmith.rst b/classes/class_soundsmith.rst similarity index 70% rename from classes/class_signalsmith.rst rename to classes/class_soundsmith.rst index 5e2b4c82541..8015f82a363 100644 --- a/classes/class_signalsmith.rst +++ b/classes/class_soundsmith.rst @@ -3,23 +3,23 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Redot engine sources. .. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SignalSmith.xml. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SoundSmith.xml. -.. _class_SignalSmith: +.. _class_SoundSmith: -SignalSmith -=========== +SoundSmith +========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -Performs time-stretching and pitch-shifting on raw audio buffers using Signalsmith. +Performs time-stretching and pitch-shifting on raw audio buffers using Soundsmith. .. rst-class:: classref-introduction-group Description ----------- -SignalSmith is a low-level audio processing utility which wraps the Signalsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. +SoundSmith is a low-level audio processing utility which wraps the Soundsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. .. rst-class:: classref-reftable-group @@ -29,25 +29,25 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reset`\ (\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,13 +58,13 @@ Methods Method Descriptions ------------------- -.. _class_SignalSmith_method_change_tempo: +.. _class_SoundSmith_method_change_tempo: .. rst-class:: classref-method -:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` +:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` -Loads an MP3 file, applies time-stretching and pitch-shifting using the Signalsmith engine, and returns a streamable AudioStreamWAV. +Loads an MP3 file, applies time-stretching and pitch-shifting using the Soundsmith engine, and returns a streamable AudioStreamWAV. The `tempo` parameter controls playback speed without affecting pitch. A value of `1.0` preserves the original speed. @@ -76,11 +76,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_channels: +.. _class_SoundSmith_method_get_last_channels: .. rst-class:: classref-method -:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -90,11 +90,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_sample_rate: +.. _class_SoundSmith_method_get_last_sample_rate: .. rst-class:: classref-method -:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -104,11 +104,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_process: +.. _class_SoundSmith_method_process: .. rst-class:: classref-method -:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` +:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Processes a block of interleaved audio samples and returns a new buffer containing the time-stretched and pitch-shifted result. @@ -118,11 +118,11 @@ The effective playback speed is determined by the ratio of input samples to outp ---- -.. _class_SignalSmith_method_reset: +.. _class_SoundSmith_method_reset: .. rst-class:: classref-method -|void| **reset**\ (\ ) :ref:`🔗` +|void| **reset**\ (\ ) :ref:`🔗` Resets the internal processing state. @@ -132,11 +132,11 @@ This should be called when restarting playback or discontinuously changing input ---- -.. _class_SignalSmith_method_set_channels: +.. _class_SoundSmith_method_set_channels: .. rst-class:: classref-method -|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` +|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` Sets the number of audio channels. @@ -146,11 +146,11 @@ Input and output buffers are expected to be interleaved according to this channe ---- -.. _class_SignalSmith_method_set_pitch: +.. _class_SoundSmith_method_set_pitch: .. rst-class:: classref-method -|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` +|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` Sets the pitch transpose factor. @@ -160,11 +160,11 @@ A value of `1.0` leaves pitch unchanged. Values greater than `1.0` raise pitch, ---- -.. _class_SignalSmith_method_set_sample_rate: +.. _class_SoundSmith_method_set_sample_rate: .. rst-class:: classref-method -|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` +|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` Sets the sample rate, in Hz, used by the internal processing engine. @@ -174,11 +174,11 @@ Changing the sample rate resets the internal state. ---- -.. _class_SignalSmith_method_set_tempo: +.. _class_SoundSmith_method_set_tempo: .. rst-class:: classref-method -|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` +|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` Sets the tempo multiplier used during processing. diff --git a/classes/index.rst b/classes/index.rst index 4eba42a0b5a..2b99d8dfe72 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -969,8 +969,8 @@ Other objects class_scriptlanguageextension class_semaphore class_shaderincludedb - class_signalsmith class_skinreference + class_soundsmith class_streampeer class_streampeerbuffer class_streampeerextension