Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Initialize method initializes the APO and supports data of variable length.
Syntax
HRESULT Initialize(
[in] UINT32 cbDataSize,
[in] BYTE *pbyData
);
Parameters
[in] cbDataSize
This is the size, in bytes, of the initialization data.
[in] pbyData
This is initialization data that is specific to this APO.
Return value
The Initialize
method returns a value of S_OK if the call was successful. Otherwise, this method returns one of the following error codes:
Return code | Description |
---|---|
|
Invalid pointer passed to the function. |
|
Invalid argument. |
|
APO already initialized. |
|
These additional error conditions are tracked by the audio engine. |
Remarks
If this method is used to initialize an APO without the need to initialize any data, it is acceptable to supply a NULL as the value of the pbyData parameter and a 0 (zero) as the value of the cbDataSize parameter. The data that is supplied is of variable length and must have the following format:
Struct MyAPOInitializationData
{
APOInitBaseStruct APOInit;
// list additional struct members here
// ...
};
Requirements
Requirement | Value |
---|---|
Minimum supported client | Available with Windows Vista and later Windows operating systems. |
Target Platform | Universal |
Header | audioenginebaseapo.h |
Library | Audioenginebaseapo.idl |
IRQL | Any level |