IltmfTargetVideoFormat::get_FriendlyName

Summary

Retrieves the target video format's descriptive name.

Syntax

#include "ltmf.h"

Language Syntax
C HRESULT IltmfTargetVideoFormat_get_FriendlyName(pTargetVideoFormat, pVal)
C++ HRESULT get_FriendlyName(pVal)

Parameters

IltmfTargetVideoFormat *TargetVideoFormat

Pointer to an IltmfTargetVideoFormat.

BSTR *pVal

Pointer to a variable that receives a string containing the target video format's friendly name (the target Video format's descriptive name).

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 MediaFoundation documentation.

Comments

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For a C++ example, refer to Recompressing MP4 File Example for C++.

Help Version 22.0.2023.7.14
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

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