IAudioSystemEffectsCustomFormats：：GetFormat 方法 (audioenginebaseapo.h)

方法 GetFormat 检索自定义格式的 IAudioMediaType 表示形式。

语法

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

参数

[in] nFormat

指定受支持格式的索引。 此参数可以是从零到比 GetFormatCount 的返回值小 1 范围内的任意值。 换句话说，从零到 GetFormatCount 范围内的任何值 ( ) - 1。

[out, optional] ppFormat

指定指向 IAudioMediaType 接口的指针的指针。 调用方负责释放 ppFormat 参数指向的 IAudioMediaType 接口。

返回值

当调用成功时，方法 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