IMFMediaSink::GetStreamSinkById method (mfidl.h)

Article
02/22/2024

Gets a stream sink, specified by stream identifier.

Syntax

HRESULT GetStreamSinkById(
  [in]  DWORD         dwStreamSinkIdentifier,
  [out] IMFStreamSink **ppStreamSink
);

Parameters

[in] dwStreamSinkIdentifier

Stream identifier of the stream sink.

[out] ppStreamSink

Receives a pointer to the stream's IMFStreamSink interface. The caller must release the interface.

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.
MF_E_INVALIDSTREAMNUMBER	The stream identifier is not valid.
MF_E_SHUTDOWN	The media sink's Shutdown method has been called.

Remarks

If you add a stream sink by calling the IMFMediaSink::AddStreamSink method, the stream identifier is specified in the dwStreamSinkIdentifier parameter of that method. If the media sink has a fixed set of streams, the media sink assigns the stream identifiers.

To enumerate the streams by index number instead of stream identifier, call IMFMediaSink::GetStreamSinkByIndex.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	mfidl.h
Library	Mfuuid.lib