mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-04 10:09:56 +03:00
cf78697eea
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
271 lines
11 KiB
ReStructuredText
271 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the AudioStreamPlayer.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_AudioStreamPlayer:
|
|
|
|
AudioStreamPlayer
|
|
=================
|
|
|
|
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Reproduce el audio sin posición.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Plays an audio stream non-positionally.
|
|
|
|
To play audio positionally, use :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>` or :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>` instead of ``AudioStreamPlayer``.
|
|
|
|
Tutoriales
|
|
--------------------
|
|
|
|
- :doc:`Audio streams <../tutorials/audio/audio_streams>`
|
|
|
|
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
|
|
|
|
- `Audio Device Changer Demo <https://godotengine.org/asset-library/asset/525>`__
|
|
|
|
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`__
|
|
|
|
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`__
|
|
|
|
- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`__
|
|
|
|
Propiedades
|
|
----------------------
|
|
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` | ``false`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` | ``"Master"`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` | ``0`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` | ``1.0`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | ``false`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | ``false`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` | ``0.0`` |
|
|
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_method_get_playback_position>` **(** **)** |
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`get_stream_playback<class_AudioStreamPlayer_method_get_stream_playback>` **(** **)** |
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`play<class_AudioStreamPlayer_method_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`seek<class_AudioStreamPlayer_method_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`stop<class_AudioStreamPlayer_method_stop>` **(** **)** |
|
|
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
|
|
Señales
|
|
--------------
|
|
|
|
.. _class_AudioStreamPlayer_signal_finished:
|
|
|
|
- **finished** **(** **)**
|
|
|
|
Emitido cuando el audio deja de reproducirse.
|
|
|
|
Enumeraciones
|
|
--------------------------
|
|
|
|
.. _enum_AudioStreamPlayer_MixTarget:
|
|
|
|
.. _class_AudioStreamPlayer_constant_MIX_TARGET_STEREO:
|
|
|
|
.. _class_AudioStreamPlayer_constant_MIX_TARGET_SURROUND:
|
|
|
|
.. _class_AudioStreamPlayer_constant_MIX_TARGET_CENTER:
|
|
|
|
enum **MixTarget**:
|
|
|
|
- **MIX_TARGET_STEREO** = **0** --- El audio se reproducirá sólo en el primer canal.
|
|
|
|
- **MIX_TARGET_SURROUND** = **1** --- El audio se reproducirá en todos los canales de sonido envolvente.
|
|
|
|
- **MIX_TARGET_CENTER** = **2** --- El audio se reproducirá en el segundo canal, que suele ser el del centro.
|
|
|
|
Descripciones de Propiedades
|
|
--------------------------------------------------------
|
|
|
|
.. _class_AudioStreamPlayer_property_autoplay:
|
|
|
|
- :ref:`bool<class_bool>` **autoplay**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_autoplay(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | is_autoplay_enabled() |
|
|
+-----------+-----------------------+
|
|
|
|
Si ``true``, el audio se reproduce cuando se añade al árbol de la escena.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_bus:
|
|
|
|
- :ref:`String<class_String>` **bus**
|
|
|
|
+-----------+----------------+
|
|
| *Default* | ``"Master"`` |
|
|
+-----------+----------------+
|
|
| *Setter* | set_bus(value) |
|
|
+-----------+----------------+
|
|
| *Getter* | get_bus() |
|
|
+-----------+----------------+
|
|
|
|
El bus en el que se está reproduciendo este audio.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_mix_target:
|
|
|
|
- :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_mix_target(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_mix_target() |
|
|
+-----------+-----------------------+
|
|
|
|
Si la configuración de audio tiene más de dos altavoces, esto establece los canales de destino. Ver las constantes de :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>`.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_pitch_scale:
|
|
|
|
- :ref:`float<class_float>` **pitch_scale**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_pitch_scale(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_pitch_scale() |
|
|
+-----------+------------------------+
|
|
|
|
El tono y el tempo del audio, como multiplicador de la tasa de muestreo de la muestra de audio.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_playing:
|
|
|
|
- :ref:`bool<class_bool>` **playing**
|
|
|
|
+-----------+--------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------+
|
|
| *Getter* | is_playing() |
|
|
+-----------+--------------+
|
|
|
|
Si ``true``, el audio se está reproduciendo.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_stream:
|
|
|
|
- :ref:`AudioStream<class_AudioStream>` **stream**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_stream(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_stream() |
|
|
+----------+-------------------+
|
|
|
|
El objeto :ref:`AudioStream<class_AudioStream>` que se va a reproducir.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_stream_paused:
|
|
|
|
- :ref:`bool<class_bool>` **stream_paused**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_stream_paused(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_stream_paused() |
|
|
+-----------+--------------------------+
|
|
|
|
Si ``true``, la reproducción se interrumpe. Puede reanudarla ajustando ``stream_paused`` a ``false``.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_property_volume_db:
|
|
|
|
- :ref:`float<class_float>` **volume_db**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_volume_db(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_volume_db() |
|
|
+-----------+----------------------+
|
|
|
|
Volumen del sonido, en dB.
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_AudioStreamPlayer_method_get_playback_position:
|
|
|
|
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
|
|
|
Devuelve la posición en el :ref:`AudioStream<class_AudioStream>` en segundos.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_method_get_stream_playback:
|
|
|
|
- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)**
|
|
|
|
Devuelve el objeto :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` asociado a este ``AudioStreamPlayer``.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_method_play:
|
|
|
|
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
|
|
|
Reproduce el audio del ``from_position`` dado, en segundos.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_method_seek:
|
|
|
|
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
|
|
|
Establece la posición desde la que se reproducirá el audio, en segundos.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamPlayer_method_stop:
|
|
|
|
- void **stop** **(** **)**
|
|
|
|
Detiene el audio.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|