summaryrefslogtreecommitdiff
path: root/doc/classes/AudioServer.xml
AgeCommit message (Collapse)Author
2022-08-22Replace Array return types with TypedArraykobewi
2022-08-17[doc] Fix grammar in class docs: amount vs. numberAndy Maloney
Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (8)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-07-23Implement BPM supportreduz
Based on #62896, only implements the BPM support part. * Implements BPM support in the AudioStreamOGG/MP3 importers. * Can select BPM/Bar Size and total beats in a song file, as well as edit looping points. * Looping is now BPM aware * Added a special importer UI for configuring this. * Added a special preview showing the audio waveform as well as the playback position in the resource picker. * Renamed `AudioStream::instance` to `instantiate` for correctness.
2022-02-17Expose `AudioServer.capture_device` as a propertyHugo Locurcio
This is more consistent with `AudioServer.device` (for output), which is already exposed as a property.
2022-02-15Merge pull request #35679 from Calinou/doc-add-xml-schemaRémi Verschelde
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14Improve documentation for AudioServer device properties and methodsHugo Locurcio
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-08-07Invert how `global_rate_scale` value works, and rename it to ↵Michael Alexsander
`playback_speed_scale`
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2020-10-01Link to demos from within the class referenceAaron Franke
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-02-22doc: Sync classref with StringName/Callable changesRémi Verschelde
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-23doc: Misc updates for AnimationNode* and othersRémi Verschelde
- Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-20Revert "Exposes capture methods to AudioServer + documentation" #30468Rémi Verschelde
Reverts the following commits: - c81ec6f26d40b70283958a4ef3e216fb32cbaf14: "Exposes capture methods to AudioServer, variable renames for consistency, added documentation." - 47c558b98abf842910c780294314326662410cdf: "Expose audio callbacks as signals." - dabaa11b3c451e9b8f2cca7e563bd9ec51edb169: "Fix to make sure the capture buffers are deallocated at shutdown. Silences warnings." Some documentation improvements were kept for pre-existing methods. See rationale for reverting these changes in #30468.
2019-08-13doc: Sync classref with current sourceRémi Verschelde
2019-07-15Exposes capture methods to AudioServer, variable renames for consistency,Saracen
added documentation.
2019-07-02doc: Sync classref with current sourceRémi Verschelde
2019-07-01Merge pull request #29413 from YeldhamDev/global_rate_scaleRémi Verschelde
Add 'global_rate_scale' to the AudioServer
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-19Add 'global_rate_scale' to the AudioServerMichael Alexsander Silva Dias
Closes #28953.
2019-04-27Added docs to AudioStreamPlayer for get_mix_timeJuan Linietsky
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-15doc: Sync classref with current sourceRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-02-13Fix typos with codespellRémi Verschelde
Using codespell 1.14.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang doubleclick lod nd numer que te unselect EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2018-12-20doc: Add missing commas after "If true/false"Rémi Verschelde
2018-12-11Fix EditorAudioBuses not updating when changing to a device with different ↵Marcelo Fernandez
channels
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-10-25doc: Sync with current sourceRémi Verschelde
2018-08-21doc: Sync classref with current sourceRémi Verschelde
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-04-10doc: Sync classref with current sourceRémi Verschelde
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Fix references to online tutorials after godotengine/godot-docs#1015Rémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-17doc: Replace some more "val" with "value" + syncRémi Verschelde
2018-01-15Filled tutorial field in most relevent classes.Juan Linietsky
Added tutorial display in doc.
2018-01-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Fix enum tags thanks to 2bc6db6Rémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-19Fix the class docs for the rst-syntax errors.Martin Capitanio
- Generate a correkt rst-syntax for the [/code] inline markup. (http://www.sphinx-doc.org/en/1.6.5/rest.html#inline-markup) - Fix xml souce bugs for the sphinx's rst syntax werrors: class_area.rst:319: WARNING: Inline literal start-string without end-string. class_area2d.rst:287: WARNING: Inline literal start-string without end-string. class_audioserver.rst:287: WARNING: Inline literal start-string without end-string. class_control.rst:509: WARNING: Inline literal start-string without end-string. class_image.rst:422: WARNING: Inline literal start-string without end-string. class_image.rst:434: WARNING: Inline literal start-string without end-string. class_inputevent.rst:74: WARNING: Inline literal start-string without end-string. class_inputeventaction.rst:45: WARNING: Inline literal start-string without end-string. class_inputmap.rst:47: WARNING: Inline literal start-string without end-string. class_kinematicbody.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_kinematicbody2d.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_line2d.rst:182: WARNING: Inline literal start-string without end-string. class_thread.rst:51: WARNING: Inline literal start-string without end-string. class_treeitem.rst:160: WARNING: Inline literal start-string without end-string.
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-11doc: Sync classref with current sourceRémi Verschelde
Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11updated AudioStream docs and added AudioServer docsGrosskopf