Поделиться через

Метод IAudioSystemEffectsCustomFormats::GetFormat (audioenginebaseapo.h)

  • Статья

Метод GetFormat извлекает представление пользовательского формата IAudioMediaType .

Синтаксис

HRESULT GetFormat(
  [in]            UINT            nFormat,
  [out, optional] IAudioMediaType **ppFormat
);

Параметры

[in] nFormat

Указывает индекс поддерживаемого формата. Этот параметр может быть любым значением в диапазоне от нуля до одного меньше возвращаемого значения GetFormatCount. Иными словами, любое значение в диапазоне от нуля до GetFormatCount( ) — 1.

[out, optional] ppFormat

Указывает указатель на указатель на интерфейс IAudioMediaType . Вызывающий объект отвечает за освобождение интерфейса IAudioMediaType , на который указывает параметр ppFormat .

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

Метод GetFormat возвращает S_OK при успешном вызове. В противном случае возвращается один из кодов ошибок, показанных в следующей таблице.

Код возврата Описание
E_POINTER
 Недопустимый указатель, переданный в функцию
E_OUTOFMEMORY
 Не удается выделить возвращаемый буфер
E_INVALIDARG
 NFormat выходит за пределы диапазона

Комментарии

Когда аудиосистема GetFormat вызывает метод , sAPO создает объект типа аудиоданного мультимедиа и возвращает интерфейс IAudioMediaType . Реализация sAPO может использовать служебную функцию CreateAudioMediaType для создания объекта типа звукового носителя.

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows Vista и более поздних версиях Windows.
Целевая платформа Персональный компьютер
Верхняя часть audioenginebaseapo.h (включая Audioenginebaseapo.h)
IRQL Все уровни.

См. также раздел

CreateAudioMediaType

GetFormatCount

IAudioMediaType