IltmmCapture::get_Mute

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_get_Mute(pCapture, pMute)

C++ Syntax

HRESULT get_Mute(pMute)

IltmmCapture *pCapture;

pointer to an interface

VARIANT_BOOL *pMute;

pointer to a variable

Gets a value that indicates whether the audio stream of the preview output is muted.

Parameter Description
pCapture Pointer to an IltmmCapture interface.
pMute Pointer to a variable to be updated with a value that indicates whether the audio stream is muted. Possible values are:
  Value Meaning
  TRUE The audio stream is muted.
  FALSE The audio stream is not muted.

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

If the audio stream is not muted, then the volume used is the volume set using IltmmCapture::put_Volume. This property gets only the mute value that is applied to the preview output.

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.

Platforms

Win32, x64

See Also

Elements:

IltmmCapture::get_Balance, IltmmCapture::put_Balance, IltmmCapture::get_Volume, IltmmCapture::put_Volume, IltmmCapture::put_Mute

Topics:

Multimedia Function Groups

Example

For a C example, refer to IltmmCapture::IsPreviewTapSupported Example for C.

For a C++ example, refer to IltmmCapture::IsPreviewTapSupported Example for C++.

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

LEADTOOLS Multimedia C API Help