IWMStreamPrioritization::SetPriorityRecords method (wmsdkidl.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SetPriorityRecords method assigns the members of an array as the stream priority list in the stream prioritization object.

Syntax

HRESULT SetPriorityRecords(
  [in] WM_STREAM_PRIORITY_RECORD *pRecordArray,
  [in] WORD                      cRecords
);

Parameters

[in] pRecordArray

Pointer to an array of WM_STREAM_PRIORITY_RECORD structures.

[in] cRecords

Count of records.

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	cRecords specifies a record count greater than zero, but pRecordArray is NULL. OR One of the array rules has been broken (see the Remarks section).
E_OUTOFMEMORY	The method is unable to allocate the memory required to store the array in the stream prioritization object.

Return code

Description

S_OK

The method succeeded.

E_INVALIDARG

cRecords specifies a record count greater than zero, but pRecordArray is NULL.

One of the array rules has been broken (see the Remarks section).

E_OUTOFMEMORY

The method is unable to allocate the memory required to store the array in the stream prioritization object.

Remarks

Valid arrays contain no duplicate stream numbers. Streams are listed in the array in descending priority order. Any stream that is designated as mandatory must occur in the array before any entries that are optional. If any of these rules are broken, SetPriorityRecords will return E_INVALIDARG.

SetPriorityRecords overwrites an existing stream priority array if there is one. You can clear the array by passing zero for cRecords.

This method does not verify that the streams specified are valid for the profile.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)

Share via