godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2025-12-31 09:49:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.x
godot-docs-l10n/classes/zh_Hant/class_audiostreamplayback.rst
Rémi Verschelde c3f2364c10 Sync classref with 4.6 branch 
Lots of translations invalidated (fuzzied) as we just synced Weblate.
2025-12-19 16:39:51 +01:00

328 lines
19 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. _class_AudioStreamPlayback:
AudioStreamPlayback
===================
**繼承：** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**被繼承：** :ref:`AudioStreamPlaybackInteractive<class_AudioStreamPlaybackInteractive>`, :ref:`AudioStreamPlaybackPlaylist<class_AudioStreamPlaybackPlaylist>`, :ref:`AudioStreamPlaybackPolyphonic<class_AudioStreamPlaybackPolyphonic>`, :ref:`AudioStreamPlaybackResampled<class_AudioStreamPlaybackResampled>`, :ref:`AudioStreamPlaybackSynchronized<class_AudioStreamPlaybackSynchronized>`
用於播放音訊的元類。
.. rst-class:: classref-introduction-group
說明
----
可播放、循環及暫停音訊。使用方式請參閱 :ref:`AudioStream<class_AudioStream>` 與 :ref:`AudioStreamOggVorbis<class_AudioStreamOggVorbis>`\ 。
.. rst-class:: classref-introduction-group
教學
----
- `音訊產生器範例 <https://godotengine.org/asset-library/asset/2759>`__
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_loop_count<class_AudioStreamPlayback_private_method__get_loop_count>`\ (\ ) |virtual| |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`_get_parameter<class_AudioStreamPlayback_private_method__get_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`_get_playback_position<class_AudioStreamPlayback_private_method__get_playback_position>`\ (\ ) |virtual| |required| |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_is_playing<class_AudioStreamPlayback_private_method__is_playing>`\ (\ ) |virtual| |required| |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_mix<class_AudioStreamPlayback_private_method__mix>`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |virtual| |required| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_seek<class_AudioStreamPlayback_private_method__seek>`\ (\ position\: :ref:`float<class_float>`\ ) |virtual| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_set_parameter<class_AudioStreamPlayback_private_method__set_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |virtual| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_start<class_AudioStreamPlayback_private_method__start>`\ (\ from_pos\: :ref:`float<class_float>`\ ) |virtual| |required| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_stop<class_AudioStreamPlayback_private_method__stop>`\ (\ ) |virtual| |required| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_tag_used_streams<class_AudioStreamPlayback_private_method__tag_used_streams>`\ (\ ) |virtual| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_method_get_loop_count>`\ (\ ) |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayback_method_get_playback_position>`\ (\ ) |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` | :ref:`get_sample_playback<class_AudioStreamPlayback_method_get_sample_playback>`\ (\ ) |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_method_is_playing>`\ (\ ) |const| |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`mix_audio<class_AudioStreamPlayback_method_mix_audio>`\ (\ rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`seek<class_AudioStreamPlayback_method_seek>`\ (\ time\: :ref:`float<class_float>` = 0.0\ ) |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_sample_playback<class_AudioStreamPlayback_method_set_sample_playback>`\ (\ playback_sample\: :ref:`AudioSamplePlayback<class_AudioSamplePlayback>`\ ) |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`start<class_AudioStreamPlayback_method_start>`\ (\ from_pos\: :ref:`float<class_float>` = 0.0\ ) |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`stop<class_AudioStreamPlayback_method_stop>`\ (\ ) |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法說明
--------
.. _class_AudioStreamPlayback_private_method__get_loop_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **_get_loop_count**\ (\ ) |virtual| |const| :ref:`🔗<class_AudioStreamPlayback_private_method__get_loop_count>`
可覆寫的方法。應回傳此音訊流已循環的次數。大多數內建播放通常回傳 ``0``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__get_parameter:
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **_get_parameter**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const| :ref:`🔗<class_AudioStreamPlayback_private_method__get_parameter>`
依名稱回傳播放參數的目前值（參見 :ref:`AudioStream._get_parameter_list()<class_AudioStream_private_method__get_parameter_list>`\ ）。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__get_playback_position:
.. rst-class:: classref-method
:ref:`float<class_float>` **_get_playback_position**\ (\ ) |virtual| |required| |const| :ref:`🔗<class_AudioStreamPlayback_private_method__get_playback_position>`
可覆寫的方法。應回傳音訊流目前的播放進度（秒）。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__is_playing:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_is_playing**\ (\ ) |virtual| |required| |const| :ref:`🔗<class_AudioStreamPlayback_private_method__is_playing>`
可覆寫的方法。若此播放實例處於啟動並正在播放音訊流時，應回傳 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__mix:
.. rst-class:: classref-method
:ref:`int<class_int>` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |virtual| |required| :ref:`🔗<class_AudioStreamPlayback_private_method__mix>`
重寫此方法以自訂混音行為，即便播放未啟動也會呼叫。
\ **注意：** 在 GDScript 或 C# 中覆寫此方法並無實際用途；僅 GDExtension 可以利用。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__seek:
.. rst-class:: classref-method
|void| **_seek**\ (\ position\: :ref:`float<class_float>`\ ) |virtual| :ref:`🔗<class_AudioStreamPlayback_private_method__seek>`
重寫此方法以自訂在尋位至指定 ``position`` 時的行為，例如由 :ref:`AudioStreamPlayer.seek()<class_AudioStreamPlayer_method_seek>` 觸發。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__set_parameter:
.. rst-class:: classref-method
|void| **_set_parameter**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |virtual| :ref:`🔗<class_AudioStreamPlayback_private_method__set_parameter>`
依名稱設定播放參數的目前值（參見 :ref:`AudioStream._get_parameter_list()<class_AudioStream_private_method__get_parameter_list>`\ ）。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__start:
.. rst-class:: classref-method
|void| **_start**\ (\ from_pos\: :ref:`float<class_float>`\ ) |virtual| |required| :ref:`🔗<class_AudioStreamPlayback_private_method__start>`
重寫此方法以自訂播放自指定位置開始（例如呼叫 :ref:`AudioStreamPlayer.play()<class_AudioStreamPlayer_method_play>`\ ）時的行為。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__stop:
.. rst-class:: classref-method
|void| **_stop**\ (\ ) |virtual| |required| :ref:`🔗<class_AudioStreamPlayback_private_method__stop>`
重寫此方法以自訂停止播放（例如呼叫 :ref:`AudioStreamPlayer.stop()<class_AudioStreamPlayer_method_stop>`\ ）時的行為。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_private_method__tag_used_streams:
.. rst-class:: classref-method
|void| **_tag_used_streams**\ (\ ) |virtual| :ref:`🔗<class_AudioStreamPlayback_private_method__tag_used_streams>`
可覆寫的方法。當播放啟動且 :ref:`AudioServer.set_enable_tagging_used_audio_streams()<class_AudioServer_method_set_enable_tagging_used_audio_streams>` 為 ``true`` 時，每次混音都會呼叫。編輯器外掛可透過此方法標記音訊流當前位置並於預覽中顯示。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_get_loop_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_loop_count**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_get_loop_count>`
回傳此串流已循環的次數。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_get_playback_position:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_playback_position**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_get_playback_position>`
回傳串流目前的位置（秒）。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_get_sample_playback:
.. rst-class:: classref-method
:ref:`AudioSamplePlayback<class_AudioSamplePlayback>` **get_sample_playback**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_get_sample_playback>`
**實驗性：** 此方法可能在未來版本中變更或移除。
回傳與此 **AudioStreamPlayback** 關聯、用於播放此串流取樣的 :ref:`AudioSamplePlayback<class_AudioSamplePlayback>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_is_playing:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_playing**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_is_playing>`
若串流正在播放則回傳 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_mix_audio:
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` **mix_audio**\ (\ rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioStreamPlayback_method_mix_audio>`
自目前位置起，依 ``rate_scale`` 速度混音最多 ``frames`` 個影格並推進串流。
回傳的 :ref:`PackedVector2Array<class_PackedVector2Array>` 中，每個元素包含該影格左右聲道的音量。
\ **注意：** 實際回傳的影格數可能少於要求值，請使用回傳陣列的長度做後續處理。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_seek:
.. rst-class:: classref-method
|void| **seek**\ (\ time\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_AudioStreamPlayback_method_seek>`
將串流尋位至指定 ``time``\ （秒）。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_set_sample_playback:
.. rst-class:: classref-method
|void| **set_sample_playback**\ (\ playback_sample\: :ref:`AudioSamplePlayback<class_AudioSamplePlayback>`\ ) :ref:`🔗<class_AudioStreamPlayback_method_set_sample_playback>`
**實驗性：** 此方法可能在未來版本中變更或移除。
將 :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` 關聯到此 **AudioStreamPlayback** 以播放該串流的取樣。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_start:
.. rst-class:: classref-method
|void| **start**\ (\ from_pos\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_AudioStreamPlayback_method_start>`
自指定的 ``from_pos``\ （秒）開始播放串流。
.. rst-class:: classref-item-separator
----
.. _class_AudioStreamPlayback_method_stop:
.. rst-class:: classref-method
|void| **stop**\ (\ ) :ref:`🔗<class_AudioStreamPlayback_method_stop>`
停止串流播放。
.. |virtual| replace:: :abbr:`virtual (本方法通常需要使用者覆寫才能生效。)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (本方法沒有副作用。不會修改該實例的任何成員變數。)`
.. |vararg| replace:: :abbr:`vararg (本方法除了這裡描述的參數外，還可以接受任意數量的參數。)`
.. |constructor| replace:: :abbr:`constructor (本方法用於建構一個型別。)`
.. |static| replace:: :abbr:`static (本方法無需實例即可呼叫，因此可以直接使用類別名稱呼叫。)`
.. |operator| replace:: :abbr:`operator (本方法描述將本型別作為左運算元時可用的有效運算子。)`
.. |bitfield| replace:: :abbr:`BitField (此值是由下列旗標組成的位元遮罩整數。)`
.. |void| replace:: :abbr:`void (無回傳值。)`
Reference in New Issue View Git Blame Copy Permalink