class_audiostreamplayback.rst 4.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. .. _class_AudioStreamPlayback:
  2. AudioStreamPlayback
  3. ===================
  4. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  5. **Category:** Core
  6. Brief Description
  7. -----------------
  8. Member Functions
  9. ----------------
  10. +----------------------------+------------------------------------------------------------------------------------------------------+
  11. | void | :ref:`play<class_AudioStreamPlayback_play>` **(** :ref:`float<class_float>` from_pos_sec=0 **)** |
  12. +----------------------------+------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`stop<class_AudioStreamPlayback_stop>` **(** **)** |
  14. +----------------------------+------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_is_playing>` **(** **)** const |
  16. +----------------------------+------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_loop<class_AudioStreamPlayback_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
  18. +----------------------------+------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamPlayback_has_loop>` **(** **)** const |
  20. +----------------------------+------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_get_loop_count>` **(** **)** const |
  22. +----------------------------+------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`seek_pos<class_AudioStreamPlayback_seek_pos>` **(** :ref:`float<class_float>` pos **)** |
  24. +----------------------------+------------------------------------------------------------------------------------------------------+
  25. | :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayback_get_pos>` **(** **)** const |
  26. +----------------------------+------------------------------------------------------------------------------------------------------+
  27. | :ref:`float<class_float>` | :ref:`get_length<class_AudioStreamPlayback_get_length>` **(** **)** const |
  28. +----------------------------+------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`get_channels<class_AudioStreamPlayback_get_channels>` **(** **)** const |
  30. +----------------------------+------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamPlayback_get_mix_rate>` **(** **)** const |
  32. +----------------------------+------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`get_minimum_buffer_size<class_AudioStreamPlayback_get_minimum_buffer_size>` **(** **)** const |
  34. +----------------------------+------------------------------------------------------------------------------------------------------+
  35. Member Function Description
  36. ---------------------------
  37. .. _class_AudioStreamPlayback_play:
  38. - void **play** **(** :ref:`float<class_float>` from_pos_sec=0 **)**
  39. .. _class_AudioStreamPlayback_stop:
  40. - void **stop** **(** **)**
  41. .. _class_AudioStreamPlayback_is_playing:
  42. - :ref:`bool<class_bool>` **is_playing** **(** **)** const
  43. .. _class_AudioStreamPlayback_set_loop:
  44. - void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
  45. .. _class_AudioStreamPlayback_has_loop:
  46. - :ref:`bool<class_bool>` **has_loop** **(** **)** const
  47. .. _class_AudioStreamPlayback_get_loop_count:
  48. - :ref:`int<class_int>` **get_loop_count** **(** **)** const
  49. .. _class_AudioStreamPlayback_seek_pos:
  50. - void **seek_pos** **(** :ref:`float<class_float>` pos **)**
  51. .. _class_AudioStreamPlayback_get_pos:
  52. - :ref:`float<class_float>` **get_pos** **(** **)** const
  53. .. _class_AudioStreamPlayback_get_length:
  54. - :ref:`float<class_float>` **get_length** **(** **)** const
  55. .. _class_AudioStreamPlayback_get_channels:
  56. - :ref:`int<class_int>` **get_channels** **(** **)** const
  57. .. _class_AudioStreamPlayback_get_mix_rate:
  58. - :ref:`int<class_int>` **get_mix_rate** **(** **)** const
  59. .. _class_AudioStreamPlayback_get_minimum_buffer_size:
  60. - :ref:`int<class_int>` **get_minimum_buffer_size** **(** **)** const