Skip to content

Latest commit

 

History

History
169 lines (141 loc) · 5 KB

nf-msacm-acmstreamconvert.md

File metadata and controls

169 lines (141 loc) · 5 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:msacm.acmStreamConvert
acmStreamConvert function (msacm.h)
The acmStreamConvert function requests the ACM to perform a conversion on the specified conversion stream. A conversion may be synchronous or asynchronous, depending on how the stream was opened.
_win32_acmStreamConvert
acmStreamConvert
acmStreamConvert function [Windows Multimedia]
msacm/acmStreamConvert
multimedia.acmstreamconvert
multimedia\acmstreamconvert.htm
Multimedia
97537dcc-acf4-4fea-b17f-2301a72a6a78
12/05/2018
_win32_acmStreamConvert, acmStreamConvert, acmStreamConvert function [Windows Multimedia], msacm/acmStreamConvert, multimedia.acmstreamconvert
msacm.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Msacm32.lib
Msacm32.dll
Windows
19H1
acmStreamConvert
msacm/acmStreamConvert
c++
APIRef
kbSyntax
DllExport
Msacm32.dll
Ext-MS-Win-mm-msacm-l1-1-0.dll
acmStreamConvert

acmStreamConvert function

-description

The acmStreamConvert function requests the ACM to perform a conversion on the specified conversion stream. A conversion may be synchronous or asynchronous, depending on how the stream was opened.

-parameters

-param has

Handle to the open conversion stream.

-param pash

Pointer to a stream header that describes source and destination buffers for a conversion. This header must have been prepared previously by using the acmStreamPrepareHeader function.

-param fdwConvert

Flags for doing the conversion. The following values are defined.

Value Meaning
ACM_STREAMCONVERTF_BLOCKALIGN Only integral numbers of blocks will be converted. Converted data will end on block-aligned boundaries. An application should use this flag for all conversions on a stream until there is not enough source data to convert to a block-aligned destination. In this case, the last conversion should be specified without this flag.
ACM_STREAMCONVERTF_END ACM conversion stream should begin returning pending instance data. For example, if a conversion stream holds instance data, such as the end of an echo filter operation, this flag will cause the stream to start returning this remaining data with optional source data. This flag can be specified with the ACM_STREAMCONVERTF_START flag.
ACM_STREAMCONVERTF_START ACM conversion stream should reinitialize its instance data. For example, if a conversion stream holds instance data, such as delta or predictor information, this flag will restore the stream to starting defaults. This flag can be specified with the ACM_STREAMCONVERTF_END flag.

-returns

Returns zero if successful or an error otherwise. Possible error values include the following.

Return code Description
ACMERR_BUSY
The stream header specified in pash is currently in use and cannot be reused.
ACMERR_UNPREPARED
The stream header specified in pash is currently not prepared by the acmStreamPrepareHeader function.
MMSYSERR_INVALFLAG
At least one flag is invalid.
MMSYSERR_INVALHANDLE
The specified handle is invalid.
MMSYSERR_INVALPARAM
At least one parameter is invalid.

-remarks

You must use the acmStreamPrepareHeader function to prepare the source and destination buffers before they are passed to acmStreamConvert.

If an asynchronous conversion request is successfully queued by the ACM or driver and the conversion is later determined to be impossible, the ACMSTREAMHEADER structure is posted back to the application's callback function with the cbDstLengthUsed member set to zero.

-see-also

Audio Compression Functions

Audio Compression Manager