QtSpatialAudio.pyi 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. # Copyright (C) 2022 The Qt Company Ltd.
  2. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
  3. """
  4. This file contains the exact signatures for all functions in module
  5. PySide6.QtSpatialAudio, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtSpatialAudio`
  9. import PySide6.QtSpatialAudio
  10. import PySide6.QtCore
  11. import PySide6.QtGui
  12. import PySide6.QtMultimedia
  13. import enum
  14. import typing
  15. from PySide6.QtCore import Signal
  16. class QAmbientSound(PySide6.QtCore.QObject):
  17. autoPlayChanged : typing.ClassVar[Signal] = ... # autoPlayChanged()
  18. loopsChanged : typing.ClassVar[Signal] = ... # loopsChanged()
  19. sourceChanged : typing.ClassVar[Signal] = ... # sourceChanged()
  20. volumeChanged : typing.ClassVar[Signal] = ... # volumeChanged()
  21. class Loops(enum.IntEnum):
  22. Infinite = -1
  23. Once = 0x1
  24. def __init__(self, engine: PySide6.QtSpatialAudio.QAudioEngine, /, *, source: PySide6.QtCore.QUrl | None = ..., volume: float | None = ..., loops: int | None = ..., autoPlay: bool | None = ...) -> None: ...
  25. def autoPlay(self, /) -> bool: ...
  26. def engine(self, /) -> PySide6.QtSpatialAudio.QAudioEngine: ...
  27. def loops(self, /) -> int: ...
  28. def pause(self, /) -> None: ...
  29. def play(self, /) -> None: ...
  30. def setAutoPlay(self, autoPlay: bool, /) -> None: ...
  31. def setLoops(self, loops: int, /) -> None: ...
  32. def setSource(self, url: PySide6.QtCore.QUrl | str, /) -> None: ...
  33. def setVolume(self, volume: float, /) -> None: ...
  34. def source(self, /) -> PySide6.QtCore.QUrl: ...
  35. def stop(self, /) -> None: ...
  36. def volume(self, /) -> float: ...
  37. class QAudioEngine(PySide6.QtCore.QObject):
  38. distanceScaleChanged : typing.ClassVar[Signal] = ... # distanceScaleChanged()
  39. masterVolumeChanged : typing.ClassVar[Signal] = ... # masterVolumeChanged()
  40. outputDeviceChanged : typing.ClassVar[Signal] = ... # outputDeviceChanged()
  41. outputModeChanged : typing.ClassVar[Signal] = ... # outputModeChanged()
  42. pausedChanged : typing.ClassVar[Signal] = ... # pausedChanged()
  43. class OutputMode(enum.Enum):
  44. Surround = 0x0
  45. Stereo = 0x1
  46. Headphone = 0x2
  47. @typing.overload
  48. def __init__(self, parent: PySide6.QtCore.QObject, /, *, outputMode: PySide6.QtSpatialAudio.QAudioEngine.OutputMode | None = ..., outputDevice: PySide6.QtMultimedia.QAudioDevice | None = ..., masterVolume: float | None = ..., paused: bool | None = ..., distanceScale: float | None = ...) -> None: ...
  49. @typing.overload
  50. def __init__(self, /, *, outputMode: PySide6.QtSpatialAudio.QAudioEngine.OutputMode | None = ..., outputDevice: PySide6.QtMultimedia.QAudioDevice | None = ..., masterVolume: float | None = ..., paused: bool | None = ..., distanceScale: float | None = ...) -> None: ...
  51. @typing.overload
  52. def __init__(self, sampleRate: int, /, parent: PySide6.QtCore.QObject | None = ..., *, outputMode: PySide6.QtSpatialAudio.QAudioEngine.OutputMode | None = ..., outputDevice: PySide6.QtMultimedia.QAudioDevice | None = ..., masterVolume: float | None = ..., paused: bool | None = ..., distanceScale: float | None = ...) -> None: ...
  53. def distanceScale(self, /) -> float: ...
  54. def masterVolume(self, /) -> float: ...
  55. def outputDevice(self, /) -> PySide6.QtMultimedia.QAudioDevice: ...
  56. def outputMode(self, /) -> PySide6.QtSpatialAudio.QAudioEngine.OutputMode: ...
  57. def pause(self, /) -> None: ...
  58. def paused(self, /) -> bool: ...
  59. def resume(self, /) -> None: ...
  60. def roomEffectsEnabled(self, /) -> bool: ...
  61. def sampleRate(self, /) -> int: ...
  62. def setDistanceScale(self, scale: float, /) -> None: ...
  63. def setMasterVolume(self, volume: float, /) -> None: ...
  64. def setOutputDevice(self, device: PySide6.QtMultimedia.QAudioDevice, /) -> None: ...
  65. def setOutputMode(self, mode: PySide6.QtSpatialAudio.QAudioEngine.OutputMode, /) -> None: ...
  66. def setPaused(self, paused: bool, /) -> None: ...
  67. def setRoomEffectsEnabled(self, enabled: bool, /) -> None: ...
  68. def start(self, /) -> None: ...
  69. def stop(self, /) -> None: ...
  70. class QAudioListener(PySide6.QtCore.QObject):
  71. def __init__(self, engine: PySide6.QtSpatialAudio.QAudioEngine, /) -> None: ...
  72. def engine(self, /) -> PySide6.QtSpatialAudio.QAudioEngine: ...
  73. def position(self, /) -> PySide6.QtGui.QVector3D: ...
  74. def rotation(self, /) -> PySide6.QtGui.QQuaternion: ...
  75. def setPosition(self, pos: PySide6.QtGui.QVector3D, /) -> None: ...
  76. def setRotation(self, q: PySide6.QtGui.QQuaternion, /) -> None: ...
  77. class QAudioRoom(PySide6.QtCore.QObject):
  78. dimensionsChanged : typing.ClassVar[Signal] = ... # dimensionsChanged()
  79. positionChanged : typing.ClassVar[Signal] = ... # positionChanged()
  80. reflectionGainChanged : typing.ClassVar[Signal] = ... # reflectionGainChanged()
  81. reverbBrightnessChanged : typing.ClassVar[Signal] = ... # reverbBrightnessChanged()
  82. reverbGainChanged : typing.ClassVar[Signal] = ... # reverbGainChanged()
  83. reverbTimeChanged : typing.ClassVar[Signal] = ... # reverbTimeChanged()
  84. rotationChanged : typing.ClassVar[Signal] = ... # rotationChanged()
  85. wallsChanged : typing.ClassVar[Signal] = ... # wallsChanged()
  86. class Material(enum.Enum):
  87. Transparent = 0x0
  88. AcousticCeilingTiles = 0x1
  89. BrickBare = 0x2
  90. BrickPainted = 0x3
  91. ConcreteBlockCoarse = 0x4
  92. ConcreteBlockPainted = 0x5
  93. CurtainHeavy = 0x6
  94. FiberGlassInsulation = 0x7
  95. GlassThin = 0x8
  96. GlassThick = 0x9
  97. Grass = 0xa
  98. LinoleumOnConcrete = 0xb
  99. Marble = 0xc
  100. Metal = 0xd
  101. ParquetOnConcrete = 0xe
  102. PlasterRough = 0xf
  103. PlasterSmooth = 0x10
  104. PlywoodPanel = 0x11
  105. PolishedConcreteOrTile = 0x12
  106. Sheetrock = 0x13
  107. WaterOrIceSurface = 0x14
  108. WoodCeiling = 0x15
  109. WoodPanel = 0x16
  110. UniformMaterial = 0x17
  111. class Wall(enum.Enum):
  112. LeftWall = 0x0
  113. RightWall = 0x1
  114. Floor = 0x2
  115. Ceiling = 0x3
  116. FrontWall = 0x4
  117. BackWall = 0x5
  118. def __init__(self, engine: PySide6.QtSpatialAudio.QAudioEngine, /, *, position: PySide6.QtGui.QVector3D | None = ..., dimensions: PySide6.QtGui.QVector3D | None = ..., rotation: PySide6.QtGui.QQuaternion | None = ..., reflectionGain: float | None = ..., reverbGain: float | None = ..., reverbTime: float | None = ..., reverbBrightness: float | None = ...) -> None: ...
  119. def dimensions(self, /) -> PySide6.QtGui.QVector3D: ...
  120. def position(self, /) -> PySide6.QtGui.QVector3D: ...
  121. def reflectionGain(self, /) -> float: ...
  122. def reverbBrightness(self, /) -> float: ...
  123. def reverbGain(self, /) -> float: ...
  124. def reverbTime(self, /) -> float: ...
  125. def rotation(self, /) -> PySide6.QtGui.QQuaternion: ...
  126. def setDimensions(self, dim: PySide6.QtGui.QVector3D, /) -> None: ...
  127. def setPosition(self, pos: PySide6.QtGui.QVector3D, /) -> None: ...
  128. def setReflectionGain(self, factor: float, /) -> None: ...
  129. def setReverbBrightness(self, factor: float, /) -> None: ...
  130. def setReverbGain(self, factor: float, /) -> None: ...
  131. def setReverbTime(self, factor: float, /) -> None: ...
  132. def setRotation(self, q: PySide6.QtGui.QQuaternion, /) -> None: ...
  133. def setWallMaterial(self, wall: PySide6.QtSpatialAudio.QAudioRoom.Wall, material: PySide6.QtSpatialAudio.QAudioRoom.Material, /) -> None: ...
  134. def wallMaterial(self, wall: PySide6.QtSpatialAudio.QAudioRoom.Wall, /) -> PySide6.QtSpatialAudio.QAudioRoom.Material: ...
  135. class QIntList: ...
  136. class QSpatialSound(PySide6.QtCore.QObject):
  137. autoPlayChanged : typing.ClassVar[Signal] = ... # autoPlayChanged()
  138. directivityChanged : typing.ClassVar[Signal] = ... # directivityChanged()
  139. directivityOrderChanged : typing.ClassVar[Signal] = ... # directivityOrderChanged()
  140. distanceCutoffChanged : typing.ClassVar[Signal] = ... # distanceCutoffChanged()
  141. distanceModelChanged : typing.ClassVar[Signal] = ... # distanceModelChanged()
  142. loopsChanged : typing.ClassVar[Signal] = ... # loopsChanged()
  143. manualAttenuationChanged : typing.ClassVar[Signal] = ... # manualAttenuationChanged()
  144. nearFieldGainChanged : typing.ClassVar[Signal] = ... # nearFieldGainChanged()
  145. occlusionIntensityChanged: typing.ClassVar[Signal] = ... # occlusionIntensityChanged()
  146. positionChanged : typing.ClassVar[Signal] = ... # positionChanged()
  147. rotationChanged : typing.ClassVar[Signal] = ... # rotationChanged()
  148. sizeChanged : typing.ClassVar[Signal] = ... # sizeChanged()
  149. sourceChanged : typing.ClassVar[Signal] = ... # sourceChanged()
  150. volumeChanged : typing.ClassVar[Signal] = ... # volumeChanged()
  151. class DistanceModel(enum.Enum):
  152. Logarithmic = 0x0
  153. Linear = 0x1
  154. ManualAttenuation = 0x2
  155. class Loops(enum.IntEnum):
  156. Infinite = -1
  157. Once = 0x1
  158. def __init__(self, engine: PySide6.QtSpatialAudio.QAudioEngine, /, *, source: PySide6.QtCore.QUrl | None = ..., position: PySide6.QtGui.QVector3D | None = ..., rotation: PySide6.QtGui.QQuaternion | None = ..., volume: float | None = ..., distanceModel: PySide6.QtSpatialAudio.QSpatialSound.DistanceModel | None = ..., size: float | None = ..., distanceCutoff: float | None = ..., manualAttenuation: float | None = ..., occlusionIntensity: float | None = ..., directivity: float | None = ..., directivityOrder: float | None = ..., nearFieldGain: float | None = ..., loops: int | None = ..., autoPlay: bool | None = ...) -> None: ...
  159. def autoPlay(self, /) -> bool: ...
  160. def directivity(self, /) -> float: ...
  161. def directivityOrder(self, /) -> float: ...
  162. def distanceCutoff(self, /) -> float: ...
  163. def distanceModel(self, /) -> PySide6.QtSpatialAudio.QSpatialSound.DistanceModel: ...
  164. def engine(self, /) -> PySide6.QtSpatialAudio.QAudioEngine: ...
  165. def loops(self, /) -> int: ...
  166. def manualAttenuation(self, /) -> float: ...
  167. def nearFieldGain(self, /) -> float: ...
  168. def occlusionIntensity(self, /) -> float: ...
  169. def pause(self, /) -> None: ...
  170. def play(self, /) -> None: ...
  171. def position(self, /) -> PySide6.QtGui.QVector3D: ...
  172. def rotation(self, /) -> PySide6.QtGui.QQuaternion: ...
  173. def setAutoPlay(self, autoPlay: bool, /) -> None: ...
  174. def setDirectivity(self, alpha: float, /) -> None: ...
  175. def setDirectivityOrder(self, alpha: float, /) -> None: ...
  176. def setDistanceCutoff(self, cutoff: float, /) -> None: ...
  177. def setDistanceModel(self, model: PySide6.QtSpatialAudio.QSpatialSound.DistanceModel, /) -> None: ...
  178. def setLoops(self, loops: int, /) -> None: ...
  179. def setManualAttenuation(self, attenuation: float, /) -> None: ...
  180. def setNearFieldGain(self, gain: float, /) -> None: ...
  181. def setOcclusionIntensity(self, occlusion: float, /) -> None: ...
  182. def setPosition(self, pos: PySide6.QtGui.QVector3D, /) -> None: ...
  183. def setRotation(self, q: PySide6.QtGui.QQuaternion, /) -> None: ...
  184. def setSize(self, size: float, /) -> None: ...
  185. def setSource(self, url: PySide6.QtCore.QUrl | str, /) -> None: ...
  186. def setVolume(self, volume: float, /) -> None: ...
  187. def size(self, /) -> float: ...
  188. def source(self, /) -> PySide6.QtCore.QUrl: ...
  189. def stop(self, /) -> None: ...
  190. def volume(self, /) -> float: ...
  191. # eof