+ h2csRtRtRtRt^RIt^RIt^RIHt]Pt ]Pt ]Pt ]Pt]Pt]P t]P"t]P$t]P&t]P(t]P*t]P,t]P.t]P0t]P2t]P4t]P6t]P8t]P:t]P<t]P>t]P@t ]PBt!]PDt"]PFt#]PHt$]PJt%]PLt&]PNt']PPt(]PRt)]PTt*]PVt+]PXt,]PZt-]P\t.]P^t/]P`t0]Pbt1]Pdt2]Pft3]Pht4]Pjt5]Plt6]Pnt7]Ppt8]Prt9]Ptt:]Pvt;]Pxt<]Pzt=]P|t>]P~t?]Pt@]PtA]PtB]PtC]PtD]PtERtFRRltGRtHR tI!R R 4tJ]K!]R 4'd!R R]P4tM!RR]JP4tNR# ] d ] !R4hi;i)aZ PyAudio provides Python bindings for PortAudio, the cross-platform audio I/O library. With PyAudio, you can easily use Python to play and record audio on a variety of platforms. .. include:: ../sphinx/examples.rst Overview -------- **Classes** :py:class:`PyAudio`, :py:class:`PyAudio.Stream` .. only:: pamac **Host Specific Classes** :py:class:`PaMacCoreStreamInfo` **Stream Conversion Convenience Functions** :py:func:`get_sample_size`, :py:func:`get_format_from_width` **PortAudio version** :py:func:`get_portaudio_version`, :py:func:`get_portaudio_version_text` .. |PaSampleFormat| replace:: :ref:`PortAudio Sample Format ` .. _PaSampleFormat: **Portaudio Sample Formats** :py:data:`paFloat32`, :py:data:`paInt32`, :py:data:`paInt24`, :py:data:`paInt16`, :py:data:`paInt8`, :py:data:`paUInt8`, :py:data:`paCustomFormat` .. |PaHostAPI| replace:: :ref:`PortAudio Host API ` .. _PaHostAPI: **PortAudio Host APIs** :py:data:`paInDevelopment`, :py:data:`paDirectSound`, :py:data:`paMME`, :py:data:`paASIO`, :py:data:`paSoundManager`, :py:data:`paCoreAudio`, :py:data:`paOSS`, :py:data:`paALSA`, :py:data:`paAL`, :py:data:`paBeOS`, :py:data:`paWDMKS`, :py:data:`paJACK`, :py:data:`paWASAPI`, :py:data:`paNoDevice` .. |PaErrorCode| replace:: :ref:`PortAudio Error Code ` .. _PaErrorCode: **PortAudio Error Codes** :py:data:`paNoError`, :py:data:`paNotInitialized`, :py:data:`paUnanticipatedHostError`, :py:data:`paInvalidChannelCount`, :py:data:`paInvalidSampleRate`, :py:data:`paInvalidDevice`, :py:data:`paInvalidFlag`, :py:data:`paSampleFormatNotSupported`, :py:data:`paBadIODeviceCombination`, :py:data:`paInsufficientMemory`, :py:data:`paBufferTooBig`, :py:data:`paBufferTooSmall`, :py:data:`paNullCallback`, :py:data:`paBadStreamPtr`, :py:data:`paTimedOut`, :py:data:`paInternalError`, :py:data:`paDeviceUnavailable`, :py:data:`paIncompatibleHostApiSpecificStreamInfo`, :py:data:`paStreamIsStopped`, :py:data:`paStreamIsNotStopped`, :py:data:`paInputOverflowed`, :py:data:`paOutputUnderflowed`, :py:data:`paHostApiNotFound`, :py:data:`paInvalidHostApi`, :py:data:`paCanNotReadFromACallbackStream`, :py:data:`paCanNotWriteToACallbackStream`, :py:data:`paCanNotReadFromAnOutputOnlyStream`, :py:data:`paCanNotWriteToAnInputOnlyStream`, :py:data:`paIncompatibleStreamHostApi` .. |PaCallbackReturnCodes| replace:: :ref:`PortAudio Callback Return Code ` .. _PaCallbackReturnCodes: **PortAudio Callback Return Codes** :py:data:`paContinue`, :py:data:`paComplete`, :py:data:`paAbort` .. |PaCallbackFlags| replace:: :ref:`PortAutio Callback Flag ` .. _PaCallbackFlags: **PortAudio Callback Flags** :py:data:`paInputUnderflow`, :py:data:`paInputOverflow`, :py:data:`paOutputUnderflow`, :py:data:`paOutputOverflow`, :py:data:`paPrimingOutput` z Hubert Phamz0.2.13zrestructuredtext enNz;Could not import the PyAudio C module 'pyaudio._portaudio'.cs.\P!V4#)zReturns the size (in bytes) for the specified sample *format*. :param format: A |PaSampleFormat| constant. :raises ValueError: on invalid specified `format`. :rtype: integer paget_sample_size)format&7/usr/lib64/python3.14/site-packages/pyaudio/__init__.pyrrs   f %%csV^8XdV'd\#\#V^8Xd\#V^8Xd\#V^8Xd\#\ RV 24h)aReturns a PortAudio format constant for the specified *width*. :param width: The desired sample width in bytes (1, 2, 3, or 4) :param unsigned: For 1 byte width, specifies signed or unsigned format. :raises ValueError: when invalid *width* :rtype: A |PaSampleFormat| constant zInvalid width: )paUInt8paInt8paInt16paInt24 paFloat32 ValueError)widthunsigned&&rget_format_from_widthrsO z N  z z z ug. //rc,\P!4#)z(Returns portaudio version. :rtype: int )rZ get_versionrrget_portaudio_versionrs >> rcr)z+,77/Y/DL"&,,";";D #'<<#=#=D  - rc s\P!VP4RVnVPP V4R#)zCloses the stream.FN)rcloser*r$r!_remove_streamr0rrr2ZPyAudio.Stream.closes, HHT\\ "$D  LL ' ' -rc .VPP#)z*Returns the input latency. :rtype: float )r*r+r4rrget_input_latencyZ PyAudio.Stream.get_input_latencys <<,, ,rc r5)z+Returns the output latency. :rtype: float )r*r-r4rrget_output_latencyZ!PyAudio.Stream.get_output_latencys <<-- -rc B\P!VP4#)z$Returns stream time. :rtype: float )rZget_stream_timer*r4rrget_timeZPyAudio.Stream.get_times %%dll3 3rc r8)zLReturn the CPU load. Always 0.0 when using the blocking API. :rtype: float )rZget_stream_cpu_loadr*r4rr get_cpu_loadZPyAudio.Stream.get_cpu_loads ))$,,7 7rc s|VP'dR#\P!VP4RVnR#)zStarts the stream.NT)r$rr/r*r4rrr/ZPyAudio.Stream.start_streams) OODLL )#D rc s|VP'gR#\P!VP4RVnR#)zStops the stream.NF)r$r stop_streamr*r4rrr;ZPyAudio.Stream.stop_streams)### NN4<< ($D rc r8)z4Returns whether the stream is active. :rtype: bool )rZis_stream_activer*r4rr is_activeZPyAudio.Stream.is_actives &&t||4 4rc r8)z5Returns whether the stream is stopped. :rtype: bool )rZis_stream_stoppedr*r4rr is_stoppedZPyAudio.Stream.is_stoppeds '' 5 5rc sVP'g\R\4hVfB\VP4p\ \ V4VPV,, 4p\P!VPWV4R#)aNWrite samples to the stream for playback. Do not call when using non-blocking mode. :param frames: The frames of data. :param num_frames: The number of frames to write. Defaults to None, in which this value will be automatically computed. :param exception_on_underflow: Specifies whether an IOError exception should be thrown (or silently ignored) on buffer underflow. Defaults to False for improved performance, especially on slower platforms. :raises IOError: if the stream is not an output stream or if the write operation was unsuccessful. :rtype: `None` zNot output streamN) r#IOError paCanNotWriteToAnInputOnlyStreamrr'ZintZlenr&rZ write_streamr*)r0Zframes num_framesZexception_on_underflowr s&&&& rwriteZPyAudio.Stream.writesk,???1>@@!' 5 V0F!GH OODLL&2 4rc sVP'g\R\4h\P!VP VV4#)aRead samples from the stream. Do not call when using non-blocking mode. :param num_frames: The number of frames to read. :param exception_on_overflow: Specifies whether an IOError exception should be thrown (or silently ignored) on input buffer overflow. Defaults to True. :raises IOError: if stream is not an input stream or if the read operation was unsuccessful. :rtype: bytes zNot input stream)r"r>"paCanNotReadFromAnOutputOnlyStreamrZ read_streamr*)r0r@Zexception_on_overflow&&&rreadZPyAudio.Stream.read)s>>>>0@BB>>$,, "79 9rc r8)zOReturn the number of frames that can be read without waiting. :rtype: integer )rZget_stream_read_availabler*r4rrget_read_availableZ!PyAudio.Stream.get_read_available=s // = =rc r8)zRReturn the number of frames that can be written without waiting. :rtype: integer )rZget_stream_write_availabler*r4rrget_write_availableZ"PyAudio.Stream.get_write_availableDs 00> >r) r&r'r(r,r"r#r$r.r!r%r*)NFT)__name__ __module__ __qualname____firstlineno____doc__rpaFramesPerBufferUnspecifiedr1r2r6r7r9r:r/r;r<r=rArDrErF__static_attributes____classdictcell__ __classdict__@rStreamrs{ ,!!(,)-')'F'F9=:>%)V .p . - . 4 8 $ % 5 6 4D 9( > ? ?rrSc sN\P!4\4VnR#)zInitialize PortAudio.N)rZ initializeset_streamsr4rrr1ZPyAudio.__init__Ms  rc sVPP4FpVP4K \4Vn\P !4R#)zTerminates PortAudio. :attention: Be sure to call this method for every instance of this object to release PortAudio resources. N)rUZcopyr2rTr terminater0stream& rrVZPyAudio.terminateRs8 mm((*F LLN+  rc s.\P!V4#)zReturns the size (in bytes) for the specified sample `format` (a |PaSampleFormat| constant). :param format: A |PaSampleFormat| constant. :raises ValueError: Invalid specified `format`. :rtype: integer r)r0rrrrZPyAudio.get_sample_size`s!!&))rc s\W4#)aReturns a PortAudio format constant for the specified `width`. :param width: The desired sample width in bytes (1, 2, 3, or 4) :param unsigned: For 1 byte width, specifies signed or unsigned format. :raises ValueError: for invalid `width` :rtype: A |PaSampleFormat| constant. )r)r0r rrCrrZPyAudio.get_format_from_widthjs%U55rc sp\P!V.VO5/VBpVPPV4V#)zOpens a new stream. See constructor for :py:func:`PyAudio.Stream.__init__` for parameter details. :returns: A new :py:class:`PyAudio.Stream` )rrSrUZadd)r0argskwargsrXs&*, rr)Z PyAudio.openws36t6v6 &! rc sdWP9d\RV R24hVP4R#)zCloses a stream. Use :py:func:`PyAudio.Stream.close` instead. :param stream: An instance of the :py:class:`PyAudio.Stream` object. :raises ValueError: if stream does not exist. zStream z not foundN)rUr r2rWrrr2Z PyAudio.closes+  &wvhj9: : rc s`WP9dVPPV4R#R#)zcRemoves a stream. (Internal) :param stream: An instance of the :py:class:`PyAudio.Stream` object. N)rUZremoverWrrr3ZPyAudio._remove_streams% ]] " MM  ( #rc r)zFReturns the number of available PortAudio Host APIs. :rtype: integer )rget_host_api_countr4rrr\ZPyAudio.get_host_api_counts $$&&rc N\P!4pVPV4#)zReturns a dictionary containing the default Host API parameters. The keys of the dictionary mirror the data fields of PortAudio's ``PaHostApiInfo`` structure. :raises IOError: if no default input device is available :rtype: dict )rZget_default_host_apiget_host_api_info_by_index)r0Zdefault_host_api_indexrYrget_default_host_api_infoZ!PyAudio.get_default_host_api_infos%"$!8!8!:../EFFrc sP\P!V4pVPV4#)a2Returns a dictionary containing the Host API parameters for the host API specified by the `host_api_type`. The keys of the dictionary mirror the data fields of PortAudio's ``PaHostApiInfo`` structure. :param host_api_type: The desired |PaHostAPI| :raises IOError: for invalid `host_api_type` :rtype: dict )rZ"host_api_type_id_to_host_api_indexr^)r0Z host_api_typeindexs&& rget_host_api_info_by_typeZ!PyAudio.get_host_api_info_by_types%55mD..u55rc NVPV\P!V44#)a0Returns a dictionary containing the Host API parameters for the host API specified by the `host_api_index`. The keys of the dictionary mirror the data fields of PortAudio's ``PaHostApiInfo`` structure. :param host_api_index: The host api index :raises IOError: for invalid `host_api_index` :rtype: dict )_make_host_api_dictionaryrZget_host_api_info)r0host_api_indexrrr^Z"PyAudio.get_host_api_info_by_indexs(--    02 2rc sT\PpV!W4pVPV4#)aYReturns a dictionary containing the Device parameters for a given Host API's n'th device. The keys of the dictionary mirror the data fields of PortAudio's ``PaDeviceInfo`` structure. :param host_api_index: The Host API index number :param host_api_device_index: The n'th device of the host API :raises IOError: for invalid indices :rtype: dict )rZ%host_api_device_index_to_device_indexget_device_info_by_index)r0rdZhost_api_device_indexZlong_method_name device_indexs&&& r(get_device_info_by_host_api_device_indexZ0PyAudio.get_device_info_by_host_api_device_indexs+CC'N ,,\::rc sRVRVPRVPRVPRVPRVPRVP /#)zOCreates dictionary like PortAudio's ``PaHostApiInfo`` structure. :rtype: dict r` structVersiontypename deviceCountdefaultInputDevicedefaultOutputDevice)rhrirjrkrlrm)r0r`Zhost_api_structrCrrcZ!PyAudio._make_host_api_dictionarysU U _:: O(( O(( ?66 /"D"D !?#F#F  rc r)z "'5# $%1> "  $&3? #(7$ %&3? #%%d5f55rc r])zReturns the default input device parameters as a dictionary. The keys of the dictionary mirror the data fields of PortAudio's ``PaDeviceInfo`` structure. :raises IOError: No default input device available. :rtype: dict )rZget_default_input_devicerer0rfrYrget_default_input_device_infoZ%PyAudio.get_default_input_device_info#s#224 ,,\::rc r])zReturns the default output device parameters as a dictionary. The keys of the dictionary mirror the data fields of PortAudio's ``PaDeviceInfo`` structure. :raises IOError: No default output device available. :rtype: dict )rZget_default_output_devicererwrYrget_default_output_device_infoZ&PyAudio.get_default_output_device_info/s#335 ,,\::rc rb)aReturns the device parameters for device specified in `device_index` as a dictionary. The keys of the dictionary mirror the data fields of PortAudio's ``PaDeviceInfo`` structure. :param device_index: The device index :raises IOError: Invalid `device_index`. :rtype: dict )_make_device_info_dictionaryrZget_device_inforwrrreZ PyAudio.get_device_info_by_index;s(00    | ,. .rc svVPp\P!RR7pVR3FpVPV4pM RVRVPRVRVP RVP R VPR VPR VPR VPR VPRVP/ # K;i)zPCreates a dictionary like PortAudio's ``PaDeviceInfo`` structure. :rtype: dict F)Z do_setlocalezutf-8r`rhrjhostApimaxInputChannelsmaxOutputChannelsdefaultLowInputLatencydefaultLowOutputLatencydefaultHighInputLatencydefaultHighOutputLatencydefaultSampleRate) rjlocaleZgetpreferredencodingZdecoderhr{r|r}r~rrrr)r0r`Z device_infoZ device_nameZ os_encodingZcodecs&&& rrzZ$PyAudio._make_device_info_dictionaryHs "&& 11uE !7+E )007 ,!:!: ;.."K$@$@#[%B%B(22)33)33*44#--/ / s B33B8)rUrG)NNNNNN)rHrIrJrKrLrSr1rVrrr)r2r3r\r_rar^rgrcrnrvrxryrerzrNrOrPrRrrrs}:r?r?l  * 6  )' G 6 2;  "%36j ; ; . / /rrpaMacCoreStreamInfocsTaa]tRtRtoRt]P t]Pt]Pt]Pt ]Pt ]Pt ]Pt ]Pt ]Pt]Pt]P tRV3RlltRtRtRtRtVtV;t#) PaMacCoreStreamInfoinazPortAudio Host API Specific Stream Info for macOS-specific settings. To configure macOS-specific settings, instantiate this class and pass it as the argument in :py:func:`PyAudio.open` to parameters ``input_host_api_specific_stream_info`` or ``output_host_api_specific_stream_info``. (See :py:func:`PyAudio.Stream.__init__`.) :note: macOS-only. .. |PaMacCoreFlags| replace:: :ref:`PortAudio Mac Core Flags ` .. _PaMacCoreFlags: **PortAudio Mac Core Flags** :py:data:`paMacCoreChangeDeviceParameters`, :py:data:`paMacCoreFailIfConversionRequired`, :py:data:`paMacCoreConversionQualityMin`, :py:data:`paMacCoreConversionQualityMedium`, :py:data:`paMacCoreConversionQualityLow`, :py:data:`paMacCoreConversionQualityHigh`, :py:data:`paMacCoreConversionQualityMax`, :py:data:`paMacCorePlayNice`, :py:data:`paMacCorePro`, :py:data:`paMacCoreMinimizeCPUButPlayNice`, :py:data:`paMacCoreMinimizeCPU` .. attribute:: flags The flags specified to the constructor. :type: |PaMacCoreFlags| .. attribute:: channel_map The channel_map specified to the constructor :type: tuple or None if unspecified c sL</pVeWR&VeW#R&\SV`!R/VBR#)aInitialize with macOS setting flags and channel_map. See PortAudio documentation for more details on these parameters. :param flags: |PaMacCoreFlags| OR'ed together. :param channel_map: An array describing the channel mapping. See PortAudio documentation for usage. Nflags channel_mapr)superr1)r0rrr[ __class__s&&& rr1ZPaMacCoreStreamInfo.__init__s5F "'w&(3}% G  &v &rc T\P!R\^R7VP#)zReturns the flags set at instantiation. Deprecated. :rtype: integer .. deprecated:: 0.2.13 Use :py:attr:`flags` property. zLPaMacCoreStreamInfo.get_flags is deprecated. Use the flags property instead.Z stacklevel)warningswarnDeprecationWarningrr4rr get_flagsZPaMacCoreStreamInfo.get_flagss' MM$"   :: rc r)zReturns the channel map set at instantiation. Deprecated. :rtype: tuple or None .. deprecated:: 0.2.13 Use :py:attr:`channel_map` property. zXPaMacCoreStreamInfo.get_channel_map is deprecated. Use the channel_map property instead.r)rrrrr4rrget_channel_mapZ#PaMacCoreStreamInfo.get_channel_maps) MM0"   ## #rc s@\P!R\^R7V#)zZReturns the underyling stream info. .. :deprecated:: 0.2.13 Use stream_info property. z`PaMacCoreStreamInfo._get_host_api_stream_object is deprecated. Use this object instance instead.r)rrrr4rr_get_host_api_stream_objectZ/PaMacCoreStreamInfo._get_host_api_stream_objects# MM@"   Krr)NN)rHrIrJrKrLrZpaMacCoreChangeDeviceParametersZ!paMacCoreFailIfConversionRequiredZpaMacCoreConversionQualityMinZ paMacCoreConversionQualityMediumZpaMacCoreConversionQualityLowZpaMacCoreConversionQualityHighZpaMacCoreConversionQualityMaxZpaMacCorePlayNiceZ paMacCoreProZpaMacCoreMinimizeCPUButPlayNiceZpaMacCoreMinimizeCPUr1rrrrNrO __classcell__rrQ@@rrrns% L+-*L*L',.,P,P)(*(H(H%+-+N+N((*(H(H%)+)J)J&(*(H(H%00 *,*L*L'!66 '$  $  rrcs6aa]tRtRtoRtV3RltRtVtV;t#)rSizReserved. Do not instantiate.csb<\P!R\^R7\SV`!V/VBR#)zDo not instantiate pyaudio.Stream directly. Use pyaudio.PyAudio.open() instead. pyaudio.Stream may change or be removed in the future.rN)rrrrr1)r0rZr[rs&*,rr1ZStream.__init__s0  %    $)&)rr) rHrIrJrKrLr1rNrOrrrrrSrSs'**rrSrG)OrLZ __author__Z __version__Z __docformat__rrZpyaudio._portaudioZ _portaudiorZ ImportErrorZprintr ZpaInt32r r rrZpaCustomFormatZpaInDevelopmentZ paDirectSoundZpaMMEZpaASIOZpaSoundManagerZ paCoreAudioZpaOSSZpaALSAZpaALZpaBeOSZpaWDMKSZpaJACKZpaWASAPIZ paNoDeviceZ paNoErrorZpaNotInitializedZpaUnanticipatedHostErrorZpaInvalidChannelCountZpaInvalidSampleRateruZ paInvalidFlagZpaSampleFormatNotSupportedZpaBadIODeviceCombinationZpaInsufficientMemoryZpaBufferTooBigZpaBufferTooSmallZpaNullCallbackZpaBadStreamPtrZ paTimedOutZpaInternalErrorZpaDeviceUnavailableZ'paIncompatibleHostApiSpecificStreamInfoZpaStreamIsStoppedZpaStreamIsNotStoppedZpaInputOverflowedZpaOutputUnderflowedZpaHostApiNotFoundZpaInvalidHostApiZpaCanNotReadFromACallbackStreamZpaCanNotWriteToACallbackStreamrBr?ZpaIncompatibleStreamHostApiZ paContinueZ paCompleteZpaAbortZpaInputUnderflowZpaInputOverflowZpaOutputUnderflowZpaOutputOverflowZpaPrimingOutputrMrrrrrZhasattrrrrSrrrrs#.N`  %  # LL ** ** **  **""$$    ""nn    ww  **  ;; ]]  LL &&6600,,$$  ::66..""&&"""" ]] $$,,..(((..((,,((&&"$"D"D!#!B!B%'%J%J"#%#F#F  <<]] ]] **&&$$((&&$$ ">> &02!o /o /h 2$%%nb44np *W^^ *m  GH  s L//M