IWMReaderAdvanced::SetStreamsSelected

The SetStreamsSelected method enables the selected state of a stream to be changed. This controls whether data from a stream can be delivered from the reader or not. This can only be used when manual stream selection is specified.

Syntax

HRESULT SetStreamsSelected(
  WORD  cStreamCount,
  WORD*  pwStreamNumbers,
  WMT_STREAM_SELECTION*  pSelections
);

Parameters

cStreamCount

[in] Word containing the count of stream numbers in the pwStreamNumbers array.

pwStreamNumbers

[in] Pointer to an array of words containing the stream numbers.

pSelections

[in] Pointer to an array, of equal length to pwStreamNumbers, with each entry containing one member of the WMT_STREAM_SELECTION enumeration type. Set this to WMT_OFF to receive no data from that stream from the reader, WMT_ON to receieve all data, and WMT_CLEANPOINT_ONLY to recieve only cleanpoints.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code	Meaning
E_UNEXPECTED	The method failed for an unspecified reason.

Remarks

This method allows the selected state of multiple streams to be changed at once. This allows for multiple streams to be turned on or off at the exact time required. For this reason there is a lack of symmetry between the parameters input to this method and the GetStreamSelected method.

Stream numbers may only be in the range of 1-64.

See Also

Previous

Next