Retrieves the preferred filter display name set using IltmmCapture::SetPreferredFilter.
#include "ltmm.h"
Language | Syntax |
---|---|
C | HRESULT IltmmCapture_GetPreferredFilter(pCapture, FilterType, pVal) |
C++ | HRESULT GetPreferredFilter(FilterType, pVal) |
Pointer to an IltmmCapture interface.
Value that indicates the type of filter. For a list of possible values, refer to lltmmCapture_PreferredFilter constants.
Pointer to a string to be updated with the filter's display name. For a list of possible values, refer to ltmmFilter constants.
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. |
This method can be used to determine whether a preferred filter has been set by IltmmCapture::SetPreferredFilter. It will return NULL (if no preferred filter has been set) or a display name indicating the preferred filter.
A display name uniquely identifies a filter. Display names for filters have the following format: @device:sw:GUID\GUID.
For example, the display name for the LEAD H.264 Decoder is:
@device:sw:{083863F1-70DE-11D0-BD40-00A0C911CE86}\{E2B7DF25-38C5-11D5-91F6-00104BDB8FF9}
Note that there is a single backslash between the two GUIDs. But if you enter this as a C/C++ string, you would need to use two backslashes since '\' is an escape character in C/C++ strings.
If the method succeeds, the caller must free the returned string by calling the SysFreeString function.
A list of display names for common LEAD filters can be found in ltmmFilter constants.
Please see IltmmCapture::SetPreferredFilter for more information on filter display names.
Win32, x64.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.