IMFMediaSink::GetStreamSinkById Method

Gets a stream sink, specified by stream identifier.

Syntax

public:
HRESULT GetStreamSinkById(
         DWORD dwStreamSinkIdentifier,
         IMFStreamSink **ppStreamSink
)

Parameters

dwStreamSinkIdentifier
Type: DWORD

Stream identifier of the stream sink.

ppStreamSink
Type: IMFStreamSink **

[out, optional]

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

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codes

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.

Refer to Media Foundation return codes.

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

Header: Declared in mfidl.h.

Library: Use mfuuid.lib.