IMFMediaSink::GetStreamSinkByIndex Method

Gets a stream sink, specified by index.

Syntax

public:
HRESULT GetStreamSinkByIndex(
         DWORD dwIndex,
         IMFStreamSink **ppStreamSink
)

Parameters

dwIndex
Type: DWORD 

Zero-based index of the stream. To get the number of streams, call IMFMediaSink::GetStreamSinkCount.

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_INVALIDINDEX Invalid index.
MF_E_SHUTDOWN The media sink’s Shutdown method has been called.

Refer to Media Foundation return codes.

Remarks

Enumerating stream sinks is not a thread-safe operation, because stream sinks can be added or removed between calls to this method.

Requirements

Header: Declared in mfidl.h.

Library: Use mfuuid.lib.