IMiniportWaveCyclicStream::SetFormat method (portcls.h)

The SetFormat method sets the KS data format of the wave stream.

Syntax

NTSTATUS SetFormat(
  [in] PKSDATAFORMAT DataFormat
);

Parameters

[in] DataFormat

Specifies the new format of the stream. This parameter is a pointer to a structure of type KSDATAFORMAT.

Return value

SetFormat returns STATUS_SUCCESS if the call was successful. Otherwise, the method returns an appropriate error code.

Remarks

The wave stream's initial format is specified in the IMiniportWaveCyclic::NewStream call that creates the stream. Following stream creation, the SetFormat call can change the stream's format from its initial setting.

For information about specifying wave stream formats, see Audio Data Formats and Data Ranges.

Requirements

See also

IMiniportWaveCyclic::NewStream

IMiniportWaveCyclicStream

KSDATAFORMAT