| 
    HephAudio v3.1.0
    
   A cross-platform C++ library for recording, playing, and processing audio on Windows, Android, Linux, iOS, and macOS. 
   | 
 
uses DirectSound More...
#include <WinAudioDS.h>
  
Public Member Functions | |
| WinAudioDS () | |
| WinAudioDS (const WinAudioDS &)=delete | |
| WinAudioDS & | operator= (const WinAudioDS &)=delete | 
| ~WinAudioDS () | |
| void | SetMasterVolume (double volume) override | 
| double | GetMasterVolume () const override | 
| void | InitializeRender (AudioDevice *device, AudioFormatInfo format) override | 
| void | StopRendering () override | 
| void | InitializeCapture (AudioDevice *device, AudioFormatInfo format) override | 
| void | StopCapturing () override | 
| void | GetNativeParams (NativeAudioParams &nativeParams) const override | 
| void | SetNativeParams (const NativeAudioParams &nativeParams) override | 
| void | InitializeRender () | 
| void | InitializeRender (const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeRender (AudioFormatInfo format) | 
| void | InitializeRender (AudioDevice *device, const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeCapture () | 
| void | InitializeCapture (const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeCapture (AudioFormatInfo format) | 
| void | InitializeCapture (AudioDevice *device, const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
  Public Member Functions inherited from HephAudio::Native::WinAudioBase | |
| WinAudioBase () | |
| WinAudioBase (const WinAudioBase &)=delete | |
| WinAudioBase & | operator= (const WinAudioBase &)=delete | 
| virtual | ~WinAudioBase ()=default | 
  Public Member Functions inherited from HephAudio::Native::NativeAudio | |
| NativeAudio () | |
| NativeAudio (const NativeAudio &)=delete | |
| NativeAudio & | operator= (const NativeAudio &)=delete | 
| virtual | ~NativeAudio ()=default | 
| std::shared_ptr< IAudioDecoder > | GetAudioDecoder () const | 
| void | SetAudioDecoder (std::shared_ptr< IAudioDecoder > pNewDecoder) | 
| std::shared_ptr< IAudioEncoder > | GetAudioEncoder () const | 
| void | SetAudioEncoder (std::shared_ptr< IAudioEncoder > pNewEncoder) | 
| AudioObject * | Play (const std::filesystem::path &filePath) | 
| AudioObject * | Play (const std::filesystem::path &filePath, uint32_t playCount) | 
| AudioObject * | Load (const std::filesystem::path &filePath) | 
| AudioObject * | Load (const std::filesystem::path &filePath, uint32_t playCount) | 
| AudioObject * | CreateAudioObject (const std::string &name, size_t bufferFrameCount, AudioChannelLayout channelLayout, uint32_t sampleRate) | 
| bool | DestroyAudioObject (AudioObject *pAudioObject) | 
| bool | DestroyAudioObject (const Heph::Guid &audioObjectId) | 
| bool | AudioObjectExists (AudioObject *pAudioObject) const | 
| bool | AudioObjectExists (const Heph::Guid &audioObjectId) const | 
| AudioObject * | GetAudioObject (size_t index) | 
| AudioObject * | GetAudioObject (const Heph::Guid &audioObjectId) | 
| AudioObject * | GetAudioObject (const std::string &audioObjectName) | 
| size_t | GetAudioObjectCount () const | 
| void | ResumeCapture () | 
| void | PauseCapture () | 
| bool | IsCapturePaused () const | 
| uint32_t | GetDeviceEnumerationPeriod () const | 
| void | SetDeviceEnumerationPeriod (uint32_t deviceEnumerationPeriod_ms) | 
| const AudioFormatInfo & | GetRenderFormat () const | 
| const AudioFormatInfo & | GetCaptureFormat () const | 
| void | InitializeRender () | 
| void | InitializeRender (const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeRender (AudioFormatInfo format) | 
| void | InitializeRender (AudioDevice *device, const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeCapture () | 
| void | InitializeCapture (const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| void | InitializeCapture (AudioFormatInfo format) | 
| void | InitializeCapture (AudioDevice *device, const AudioChannelLayout &channelLayout, uint32_t sampleRate) | 
| AudioDevice | GetAudioDeviceById (const std::string &deviceId) const | 
| AudioDevice | GetRenderDevice () const | 
| AudioDevice | GetCaptureDevice () const | 
| AudioDevice | GetDefaultAudioDevice (AudioDeviceType deviceType) const | 
| std::vector< AudioDevice > | GetAudioDevices (AudioDeviceType deviceType) const | 
uses DirectSound
| HephAudio::Native::WinAudioDS::WinAudioDS | ( | ) | 
creates a new instance and initializes it with default values.
| HephAudio::Native::WinAudioDS::~WinAudioDS | ( | ) | 
releases the resources and destroys the instance.
      
  | 
  overridevirtual | 
sets the master volume.
| volume | new master volume. | 
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
gets the master volume.
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
initializes rendering with the provided device and the provided format.
| device | pointer to the audio render device. | 
| format | render format. | 
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
stops rendering and releases the resources allocated for it.
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
initializes capturing with the provided device and the provided format.
| device | pointer to the audio capture device. | 
| format | capture format. | 
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
stops capturing and releases the resources allocated for it.
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
gets the native API specific parameters.
Implements HephAudio::Native::NativeAudio.
      
  | 
  overridevirtual | 
sets the native API specific parameters.
Implements HephAudio::Native::NativeAudio.
| void HephAudio::Native::NativeAudio::InitializeRender | ( | ) | 
initializes rendering with the default device and default format.
| void HephAudio::Native::NativeAudio::InitializeRender | ( | const AudioChannelLayout & | channelLayout, | 
| uint32_t | sampleRate ) | 
initializes rendering with the default device and the provided format.
| channelLayout | channel layout of the render format. | 
| sampleRate | sample rate of the render format. | 
| void HephAudio::Native::NativeAudio::InitializeRender | ( | AudioFormatInfo | format | ) | 
initializes rendering with the default device and the provided format.
| format | render format. | 
| void HephAudio::Native::NativeAudio::InitializeRender | ( | AudioDevice * | device, | 
| const AudioChannelLayout & | channelLayout, | ||
| uint32_t | sampleRate ) | 
initializes rendering with the provided device and the provided format.
| device | pointer to the audio render device. | 
| channelLayout | channel layout of the render format. | 
| sampleRate | sample rate of the render format. | 
| void HephAudio::Native::NativeAudio::InitializeCapture | ( | ) | 
initializes capturing with the default device and default format.
| void HephAudio::Native::NativeAudio::InitializeCapture | ( | const AudioChannelLayout & | channelLayout, | 
| uint32_t | sampleRate ) | 
initializes capturing with the default device and the provided format.
| channelLayout | channel layout of the capture format. | 
| sampleRate | sample rate of the capture format. | 
| void HephAudio::Native::NativeAudio::InitializeCapture | ( | AudioFormatInfo | format | ) | 
initializes capturing with the default device and the provided format.
| format | capture format. | 
| void HephAudio::Native::NativeAudio::InitializeCapture | ( | AudioDevice * | device, | 
| const AudioChannelLayout & | channelLayout, | ||
| uint32_t | sampleRate ) | 
initializes capturing with the provided device and the provided format.
| device | pointer to the audio capture device. | 
| channelLayout | channel layout of the capture format. | 
| sampleRate | sample rate of the capture format. |