h2SrSrSrSrSSKrSSKrSSKJr \Rr \Rr \Rr \Rr\Rr\R r\R"r\R$r\R&r\R(r\R*r\R,r\R.r\R0r\R2r\R4r\R6r\R8r\R:r\R<r\R>r\R@r \RBr!\RDr"\RFr#\RHr$\RJr%\RLr&\RNr'\RPr(\RRr)\RTr*\RVr+\RXr,\RZr-\R\r.\R^r/\R`r0\Rbr1\Rdr2\Rfr3\Rhr4\Rjr5\Rlr6\Rnr7\Rpr8\Rrr9\Rtr:\Rvr;\Rxr<\Rzr=\R|r>\R~r?\Rr@\RrA\RrB\RrC\RrD\RrESrFSSjrGS rHS rI"S S 5rJ\K"\S 5(a"SS\R5rM"SS\JR5rNg!\ a \ "S5 ef=f)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.14zrestructuredtext enNz;Could not import the PyAudio C module 'pyaudio._portaudio'.c.[R"U5$)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)formats Y/home/james-whalen/eden_hybrid_phi/.venv/lib/python3.13/site-packages/pyaudio/__init__.pyrrs   f %%cUS:XaU(a[$[$US:Xa[$US:Xa[$US:Xa[$[ SU35e)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)widthunsigneds rget_format_from_widthrsO z N  z z z ug. //r c,[R"5$)z(Returns portaudio version. :rtype: int )r get_versionr rget_portaudio_versionrs >> r c,[R"5$)z+,77/Y/DL"&,,";";D #'<<#=#=D  - r c[R"UR5 SUlURR U5 g)zCloses the stream.FN)rcloser8r2r/_remove_streamr>s rrEPyAudio.Stream.closes, HHT\\ "$D  LL ' ' -r c.URR$)z*Returns the input latency. :rtype: float )r8r9rGs rget_input_latency PyAudio.Stream.get_input_latencys <<,, ,r c.URR$)z+Returns the output latency. :rtype: float )r8r;rGs rget_output_latency!PyAudio.Stream.get_output_latencys <<-- -r cB[R"UR5$)z$Returns stream time. :rtype: float )rget_stream_timer8rGs rget_timePyAudio.Stream.get_times %%dll3 3r cB[R"UR5$)zLReturn the CPU load. Always 0.0 when using the blocking API. :rtype: float )rget_stream_cpu_loadr8rGs r get_cpu_loadPyAudio.Stream.get_cpu_loads ))$,,7 7r cvUR(ag[R"UR5 SUlg)zStarts the stream.NT)r2rr=r8rGs rr=PyAudio.Stream.start_streams& OODLL )#D r cvUR(dg[R"UR5 SUlg)zStops the stream.NF)r2r stop_streamr8rGs rrZPyAudio.Stream.stop_streams&## NN4<< ($D r cB[R"UR5$)z4Returns whether the stream is active. :rtype: bool )ris_stream_activer8rGs r is_activePyAudio.Stream.is_actives &&t||4 4r cB[R"UR5$)z5Returns whether the stream is stopped. :rtype: bool )ris_stream_stoppedr8rGs r is_stoppedPyAudio.Stream.is_stoppeds '' 5 5r cUR(d[S[5eUc9[UR5n[ [ U5URU-- 5n[R"URXU5 g)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) r1IOError paCanNotWriteToAnInputOnlyStreamrr5intlenr4r write_streamr8)r>frames num_framesexception_on_underflowrs rwritePyAudio.Stream.writesi,??1>@@!' 5 V0F!GH OODLL&2 4r cUR(d[S[5e[R"UR UU5$)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)r0re"paCanNotReadFromAnOutputOnlyStreamr read_streamr8)r>rkexception_on_overflows rreadPyAudio.Stream.read)s<>>0@BB>>$,, "79 9r cB[R"UR5$)zOReturn the number of frames that can be read without waiting. :rtype: integer )rget_stream_read_availabler8rGs rget_read_available!PyAudio.Stream.get_read_available=s // = =r cB[R"UR5$)zRReturn the number of frames that can be written without waiting. :rtype: integer )rget_stream_write_availabler8rGs rget_write_available"PyAudio.Stream.get_write_availableDs 00> >r ) r4r5r6r:r0r1r2r<r/r3r8)NFT)__name__ __module__ __qualname____firstlineno____doc__rpaFramesPerBufferUnspecifiedrBrErJrMrQrUr=rZr^rbrmrsrwr{__static_attributes__rr rStreamr#ss ,!!(,)-')'F'F9=:>%)V .p . - . 4 8 $ % 5 6 4D 9( > ?r rcL[R"5 [5Ulg)zInitialize PortAudio.N)r initializeset_streamsrGs rrBPyAudio.__init__Ms  r cURR5HnUR5 M [5Ul[R "5 g)zTerminates PortAudio. :attention: Be sure to call this method for every instance of this object to release PortAudio resources. N)rcopyrErr terminater>streams rrPyAudio.terminateRs8 mm((*F LLN+  r c.[R"U5$)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)r>rs rrPyAudio.get_sample_size`s!!&))r c[X5$)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)r>rrs rrPyAudio.get_format_from_widthjs%U55r cp[R"U/UQ70UD6nURRU5 U$)zOpens a new stream. See constructor for :py:func:`PyAudio.Stream.__init__` for parameter details. :returns: A new :py:class:`PyAudio.Stream` )r rradd)r>argskwargsrs rr7 PyAudio.openws36t6v6 &! r c`XR;a[SUS35eUR5 g)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)rrrErs rrE PyAudio.closes+  &wvhj9: : r cZXR;aURRU5 gg)zcRemoves a stream. (Internal) :param stream: An instance of the :py:class:`PyAudio.Stream` object. N)rremovers rrFPyAudio._remove_streams% ]] " MM  ( #r c,[R"5$)zFReturns the number of available PortAudio Host APIs. :rtype: integer )rget_host_api_countrGs rrPyAudio.get_host_api_counts $$&&r cN[R"5nURU5$)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 )rget_default_host_apiget_host_api_info_by_index)r>default_host_api_indexs rget_default_host_api_info!PyAudio.get_default_host_api_infos%"$!8!8!:../EFFr cP[R"U5nURU5$)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 )r"host_api_type_id_to_host_api_indexr)r> host_api_typeindexs rget_host_api_info_by_type!PyAudio.get_host_api_info_by_types%55mD..u55r cNURU[R"U55$)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_dictionaryrget_host_api_info)r>host_api_indexs rr"PyAudio.get_host_api_info_by_indexs(--    02 2r cT[RnU"X5nURU5$)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 )r%host_api_device_index_to_device_indexget_device_info_by_index)r>rhost_api_device_indexlong_method_name device_indexs r(get_device_info_by_host_api_device_index0PyAudio.get_device_info_by_host_api_device_indexs+CC'N ,,\::r cUURURURURURUR S.$)zOCreates dictionary like PortAudio's ``PaHostApiInfo`` structure. :rtype: dict )r structVersiontypename deviceCountdefaultInputDevicedefaultOutputDevice)rrrrrr)r>rhost_api_structs rr!PyAudio._make_host_api_dictionarysG ,::#((#((*66"1"D"D#2#F#F  r c,[R"5$)zr%rrrrrrrs rrPyAudio.is_format_supporteds~F  M$9G! !  #%1> "'5# $%1> "  $&3? #(7$ %&3? #%%d5f55r cN[R"5nURU5$)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 )rget_default_input_devicerr>rs rget_default_input_device_info%PyAudio.get_default_input_device_info#s#224 ,,\::r cN[R"5nURU5$)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 )rget_default_output_devicerrs rget_default_output_device_info&PyAudio.get_default_output_device_info/s#335 ,,\::r cNURU[R"U55$)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_dictionaryrget_device_infors rr PyAudio.get_device_info_by_index;s(00    | ,. .r c \URn[R"SS9nUS4HnURU5n O UURUUR UR URURURURURURS. $! M=f)zPCreates a dictionary like PortAudio's ``PaDeviceInfo`` structure. :rtype: dict F) do_setlocalezutf-8) rrrhostApimaxInputChannelsmaxOutputChannelsdefaultLowInputLatencydefaultLowOutputLatencydefaultHighInputLatencydefaultHighOutputLatencydefaultSampleRate) rlocalegetpreferredencodingdecoderrrrrrrrr)r>r device_info device_name os_encodingcodecs rr$PyAudio._make_device_info_dictionaryHs "&& 11uE !7+E )007 ,!,!:!:#&..$/$@$@%0%B%B22333344--/ / s B&&B+)rr})NNNNNN)r~rrrrrrBrrrr7rErFrrrrrrrrrrrrrrr rr r s:r?r?l  * 6  )' G 6 2;  "%*.+/)-*.,0*. 36j ; ; . /r r paMacCoreStreamInfocJ^\rSrSrSr\R r\Rr\Rr\Rr \Rr \Rr \Rr \Rr \Rr\Rr\R rSU4SjjrSrSrSrSrU=r$) 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 cF>0nUbXS'UbX#S'[TU]"S0UD6 g)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)superrB)r>rrr __class__s rrBPaMacCoreStreamInfo.__init__s5F "'w&(3}% G  &v &r cN[R"S[SS9 UR$)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.r  stacklevel)warningswarnDeprecationWarningrrGs r get_flagsPaMacCoreStreamInfo.get_flagss' MM$"   :: r cN[R"S[SS9 UR$)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 r)rrrrrGs rget_channel_map#PaMacCoreStreamInfo.get_channel_maps) MM0"   ## #r c:[R"S[SS9 U$)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 r)rrrrGs r_get_host_api_stream_object/PaMacCoreStreamInfo._get_host_api_stream_objects# MM@"   Kr r)NN)r~rrrrrpaMacCoreChangeDeviceParameters!paMacCoreFailIfConversionRequiredpaMacCoreConversionQualityMin paMacCoreConversionQualityMediumpaMacCoreConversionQualityLowpaMacCoreConversionQualityHighpaMacCoreConversionQualityMaxpaMacCorePlayNice paMacCorePropaMacCoreMinimizeCPUButPlayNicepaMacCoreMinimizeCPUrBrrrr __classcell__rs@rrrns% L+-*L*L',.,P,P)(*(H(H%+-+N+N((*(H(H%)+)J)J&(*(H(H%00 *,*L*L'!66 '$  $  r rc,^\rSrSrSrU4SjrSrU=r$)rizReserved. Do not instantiate.cZ>[R"S[SS9 [TU]"U0UD6 g)NzDo not instantiate pyaudio.Stream directly. Use pyaudio.PyAudio.open() instead. pyaudio.Stream may change or be removed in the future.r r)rrrrrB)r>rrrs rrBStream.__init__s0  %    $)&)r r)r~rrrrrBrrrs@rrrs'**r rr})Or __author__ __version__ __docformat__rrpyaudio._portaudio _portaudior ImportErrorprintrpaInt32rrrrpaCustomFormatpaInDevelopment paDirectSoundpaMMEpaASIOpaSoundManager paCoreAudiopaOSSpaALSApaALpaBeOSpaWDMKSpaJACKpaWASAPI paNoDevice paNoErrorpaNotInitializedpaUnanticipatedHostErrorpaInvalidChannelCountpaInvalidSampleRater paInvalidFlagpaSampleFormatNotSupportedpaBadIODeviceCombinationpaInsufficientMemorypaBufferTooBigpaBufferTooSmallpaNullCallbackpaBadStreamPtr paTimedOutpaInternalErrorpaDeviceUnavailable'paIncompatibleHostApiSpecificStreamInfopaStreamIsStoppedpaStreamIsNotStoppedpaInputOverflowedpaOutputUnderflowedpaHostApiNotFoundpaInvalidHostApipaCanNotReadFromACallbackStreampaCanNotWriteToACallbackStreamrprfpaIncompatibleStreamHostApi paContinue paCompletepaAbortpaInputUnderflowpaInputOverflowpaOutputUnderflowpaOutputOverflowpaPrimingOutputrrrrrr hasattrrrrrr rrQs#.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--L=