Edit

IMFASFStreamConfig::GetPayloadExtension method (wmcontainer.h)

  • Article

Retrieves information about an existing payload extension.

Syntax

HRESULT GetPayloadExtension(
  [in]      WORD  wPayloadExtensionNumber,
  [out]     GUID  *pguidExtensionSystemID,
  [out]     WORD  *pcbExtensionDataSize,
  [out]     BYTE  *pbExtensionSystemInfo,
  [in, out] DWORD *pcbExtensionSystemInfo
);

Parameters

[in] wPayloadExtensionNumber

The payload extension index. Valid indexes range from 0, to one less than the number of extensions obtained by calling IMFASFStreamConfig::GetPayloadExtensionCount.

[out] pguidExtensionSystemID

Receives a GUID that identifies the payload extension. For a list of predefined payload extensions, see ASF Payload Extension GUIDs. Applications can also define custom payload extensions.

[out] pcbExtensionDataSize

Receives the number of bytes added to each sample for the extension.

[out] pbExtensionSystemInfo

Pointer to a buffer that receives information about this extension system. This information is the same for all samples and is stored in the content header (not in each sample). This parameter can be NULL. To find the required size of the buffer, set this parameter to NULL; the size is returned in pcbExtensionSystemInfo.

[in, out] pcbExtensionSystemInfo

On input, specifies the size of the buffer pointed to by pbExtensionSystemInfo. On output, receives the required size of the pbExtensionSystemInfo buffer in bytes.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
E_INVALIDARG
 Invalid argument.
MF_E_BUFFERTOOSMALL
 The buffer specified in pbExtensionSystemInfo is too small.
MF_E_INVALIDINDEX
 The wPayloadExtensionNumber parameter is out of range.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wmcontainer.h
Library Mfuuid.lib

See also

IMFASFStreamConfig

IMFASFStreamConfig::AddPayloadExtension

IMFASFStreamConfig::GetPayloadExtensionCount