This method retrieves the format functions of the specified index.
Parameters
| Name | Explanation |
|---|---|
| Index | The index (With a range from -1 to GetStreamFormats method's return value - 1) |
Return Value
Returns True (nonzero) if successful, returns False (0) when not successful.
Explanation
The GetStreamFormat method retrieves the format functions of the specified index. If you pass an Index of -1, you will retrieve the currently selected format functions. Passing in Index values from 0 to GetStreamFormats method's return value -1 will give you the format functions for the specified index.
If the GetStreamFormat method is successful, if the return value is True (nonzero), then the following properties are updated: BitCount, Compression, FrameRate, MaximumBitRate, MaximumFrameRate, MinimumBitRate, MinimumFrameRate, VideoHeight, VideoSubType, and VideoWidth. If the GetStreamFormat method is not successful, if the return value is False (0), then values of 5 or 11 will be set in the ErrorStatus property.
Before executing the GetStreamFormat method, you must first execute the Open and GetStreamFormats methods.