class Audio::AudioConfig

  • Статья

Представляет конфигурацию входных или выходных данных звука. Вход может осуществляться с микрофона, файла или входного потока. Аудиовыход может быть в динамике, в выходных данных аудиофайла в формате WAV или в выходном потоке.

Элементы

оператор SPXAUDIOCONFIGHANDLE

Синтаксис: public inline explicit operator SPXAUDIOCONFIGHANDLE ( ) const;

Внутренний оператор, используемый для получения значения базового дескриптора.

Возвращаемое значение

Дескриптор.

SetProperty

Синтаксис: public inline void SetProperty ( const std::string & name , const std::string & value );

Задает значение свойства по имени.

Параметры

  • name Имя свойства.

  • value Значение свойства.

SetProperty

Синтаксис: public inline void SetProperty ( PropertyId id , const std::string & value );

Задает значение свойства по идентификатору.

Параметры

  • id Идентификатор свойства.

  • value Значение свойства.

Getproperty

Синтаксис: public inline std::string GetProperty ( const std::string & name ) const;

Возвращает значение свойства по имени.

Параметры

  • name Имя параметра.

Возвращаемое значение

Значение свойства.

Getproperty

Синтаксис: public inline std::string GetProperty ( PropertyId id ) const;

Возвращает значение свойства по идентификатору.

Параметры

  • id Идентификатор параметра.

Возвращаемое значение

Значение свойства.

GetAudioProcessingOptions

Синтаксис: public inline std::shared_ptr< AudioProcessingOptions > GetAudioProcessingOptions ( ) const;

Возвращает экземпляр класса AudioProcessingOptions, который содержит параметры для обработки звука, используемые пакетом SDK службы "Речь".

Возвращаемое значение

Общий указатель на объект AudioProcessingOptions.

~AudioConfig

Синтаксис: public inline virtual ~AudioConfig ( );

Уничтожает объект .

FromDefaultMicrophoneInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromDefaultMicrophoneInput ( );

Создает объект AudioConfig, представляющий микрофон по умолчанию в системе.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromDefaultMicrophoneInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromDefaultMicrophoneInput ( std::shared_ptr< AudioProcessingOptions > audioProcessingOptions );

Создает объект AudioConfig, представляющий микрофон по умолчанию в системе.

Параметры

  • audioProcessingOptions Параметры обработки звука.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromMicrophoneInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromMicrophoneInput ( const std::string & deviceName );

Создает объект AudioConfig, представляющий определенный микрофон в системе. Добавлено в версии 1.3.0.

Параметры

  • deviceName Указывает имя устройства. Сведения о том, как получить имена микрофонов для конкретной платформы, см. на этой странице .

Возвращаемое значение

Общий указатель на объект AudioConfig

FromMicrophoneInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromMicrophoneInput ( const std::string & deviceName , std::shared_ptr< AudioProcessingOptions > audioProcessingOptions );

Создает объект AudioConfig, представляющий определенный микрофон в системе.

Параметры

  • deviceName Указывает имя устройства. Сведения о том, как получить имена микрофонов для конкретной платформы, см. на этой странице .

  • audioProcessingOptions Параметры обработки звука.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromWavFileInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromWavFileInput ( const std::string & fileName );

Создает объект AudioConfig, представляющий указанный файл.

Параметры

  • fileName Указывает входной звуковой файл.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromWavFileInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromWavFileInput ( const std::string & fileName , std::shared_ptr< AudioProcessingOptions > audioProcessingOptions );

Создает объект AudioConfig, представляющий указанный файл.

Параметры

  • fileName Указывает входной звуковой файл.

  • audioProcessingOptions Параметры обработки звука.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromStreamInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromStreamInput ( std::shared_ptr< AudioInputStream > stream );

Создает объект AudioConfig, представляющий указанный поток.

Параметры

  • stream Указывает пользовательский входной аудиопоток.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromStreamInput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromStreamInput ( std::shared_ptr< AudioInputStream > stream , std::shared_ptr< AudioProcessingOptions > audioProcessingOptions );

Создает объект AudioConfig, представляющий указанный поток.

Параметры

  • stream Указывает пользовательский входной аудиопоток.

  • audioProcessingOptions Параметры обработки звука.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromDefaultSpeakerOutput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromDefaultSpeakerOutput ( );

Создает объект AudioConfig, представляющий звуковое устройство (динамик) по умолчанию в системе. Добавлено в версии 1.4.0.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromSpeakerOutput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromSpeakerOutput ( const std::string & deviceName );

Создает объект AudioConfig, представляющий определенный динамик в системе. Добавлено в версии 1.14.0.

Параметры

  • deviceName Указывает имя устройства. Сведения о том, как получить имена звуковых устройств для конкретной платформы, см. на этой странице .

Возвращаемое значение

Общий указатель на объект AudioConfig

FromWavFileOutput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromWavFileOutput ( const std::string & fileName );

Создает объект AudioConfig, представляющий указанный файл для вывода звука. Добавлено в версии 1.4.0.

Параметры

  • fileName Указывает выходной звуковой файл. Родительский каталог уже должен существовать.

Возвращаемое значение

Общий указатель на объект AudioConfig

FromStreamOutput

Синтаксис: public inline static std::shared_ptr< AudioConfig > FromStreamOutput ( std::shared_ptr< AudioOutputStream > stream );

Создает объект AudioConfig, представляющий указанный выходной поток. Добавлено в версии 1.4.0.

Параметры

  • stream Указывает пользовательский поток вывода звука.

Возвращаемое значение

Общий указатель на объект AudioConfig