IltmmMediaInfo::get_SourceFormat
#include "ltmm.h"
C Syntax |
HRESULT IltmmMediaInfo_get_SourceFormat(pMediaInfo, Format) |
C++ Syntax |
HRESULT get_SourceFormat(Format) |
IltmmMediaInfo *pMediaInfo; |
/* pointer to an interface */ |
long *Format; |
/* pointer to a variable */ |
Retrieves the format of the current source media file.
Parameter |
Description |
pMediaInfo |
Pointer to an IltmmMediaInfo Interface. |
Format |
Pointer to a variable to be updated with a value that represents the format of the current source media file. For a list of possible values, refer to the ltmmMediaInfo_SourceFormat constants. |
Returns
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
Call IltmmMediaInfo::get_SourceFormatName to get a descriptive string for the format.
To get the current source media file, call IltmmMediaInfo::get_SourceFile.
The current source media file, set using IltmmMediaInfo::put_SourceFile, is the file for which the IltmmMediaInfo interface/object gets information. This function must be called before calling any of the other IltmmMediaInfo functions used for retrieving information.
Call IltmmMediaInfo::ResetSource to release the source file when it is no longer needed.
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. |
See Also
Example
For a C example, refer to Retrieving Media File Information for C.
For a C++ example, refer to Retrieving Media File Information for C++.