In This Topic ▼

IltmmPlay::get_SelectedStream

Summary

Gets the index of the currently selected stream of the specified streamType.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmPlay_get_SelectedStream(pPlay, streamType, pVal)
C++	HRESULT get_SelectedStream(streamType, pVal)

Gets the index of the currently selected stream of the specified streamType.

Parameters

ltmmPlay_Stream streamType

The type of stream in which you are interested. Currently, only two stream types are supported: Video (ltmmPlay_Stream_Video) and Audio (ltmmPlay_Stream_Audio).

long *pVal

Pointer to a variable to be updated with the index of the specified streamType. The value stored in this variable will be between 0 and StreamCount -1, where StreamCount is the total number of streams of the specified type.

Returns

Value	Meaning
S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

Get the number of streams by calling IltmmPlay::get_StreamCount. Change the currently selected stream by calling IltmmPlay::put_SelectedStream.

The streams of a particular type are mutually exclusive. In other words, selecting a stream will automatically unselect the previously selected stream of the same type.

If you change the current program using IltmmPlay::put_CurrentProgram, the number of streams can change. So you will need to call IltmmPlay::get_SelectedStream again to see which stream is selected.

Do not confuse this with the Source Stream object returned by IltmmPlay::get_SourceStream. That refers to an alternative way to provide the source file using an IStream interface instead of a file on disk. Both properties have the word Stream in the name, but there is no connection between the source stream and the audio/video streams present in a file.

Required DLLs and Libraries

LTMM
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.