IltmmMediaInfo::get_SourceFormat

Summary

Retrieves the format of the current source media file.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmMediaInfo_get_SourceFormat(pMediaInfo, pVal)
C++ HRESULT get_SourceFormat(pVal)

Parameters

IltmmMediaInfo *pMediaInfo

Pointer to an IltmmMediaInfo Interface.

long *pVal

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

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

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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C Retrieving Media File Information
C++ Retrieving Media File Information
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.