LEADTOOLS Media Foundation Help
| LEADTOOLS Media Foundation Help > LEADTOOLS Media Foundation Features > Media Foundation Function References > IltmfTargetAudioFormat Interface > IltmfTargetAudioFormat::get_FriendlyName |
#include "ltmf.h"
|
C Syntax |
HRESULT IltmfTargetAudioFormat_get_FriendlyName(pTargetAudioFormat, pVal) |
|
C++ Syntax |
HRESULT get_FriendlyName(pVal) |
|
IltmfTargetAudioFormat *pTargetAudioFormat; |
/* pointer to an interface */ |
|
BSTR * pVal |
/* pointer to a variable */ |
Retrieves the target audio format's descriptive name.
|
Parameter |
Description |
|
TargetAudioFormat |
Pointer to an IltmfTargetAudioFormat. |
|
pVal |
Pointer to a variable that receives a string containing the target audio format's friendly name (the target audio format's descriptive name). |
Returns
|
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
|
LTMF For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64
See Also
|
Elements: |
IltmfTargetAudioFormat Interface, IltmfTargetAudioFormat::put_Selected, IltmfTargetAudioFormat::get_Name, IltmfTargetAudioFormat::get_Selected |
|
Topics: |
Example
For a C++ example, refer to Recompressing MP4 File Example for C++.
