Share via

IUccAudioMediaChannel.get_IsMuted Method

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets the flag indicating the muted status of a specified media direction.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Function get_IsMuted ( _
    enDirection As UCC_MEDIA_DIRECTIONS _
) As Boolean

bool get_IsMuted (
    UCC_MEDIA_DIRECTIONS enDirection
)

bool get_IsMuted (
    UCC_MEDIA_DIRECTIONS enDirection
)

boolean get_IsMuted (
    UCC_MEDIA_DIRECTIONS enDirection
)

function get_IsMuted (
    enDirection : UCC_MEDIA_DIRECTIONS
) : boolean

Parameters

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. A TRUE value means that the audio is muted. A FALSE value means otherwise.

Remarks

Win32 COM/C++ Syntax

HRESULT get_IsMuted
(
   UCC_MEDIA_DIRECTIONS enDirection,
   VARIANT_BOOL* pbIsMuted
);

The following example mutes or un-mutes an audio media channel after determining the current mute status of the channel.

        private void ToggleMute(IUccMediaChannel m_MediaChannel)
        {
            try
            {

                IUccAudioMediaChannel amc = m_MediaChannel as IUccAudioMediaChannel;
                if (amc.get_IsMuted(UCC_MEDIA_DIRECTIONS.UCCMD_SEND))
                {
                    amc.set_IsMuted(UCC_MEDIA_DIRECTIONS.UCCMD_SEND, false);
                }
                else
                {
                    amc.set_IsMuted(UCC_MEDIA_DIRECTIONS.UCCMD_SEND, true);
                }
            }
            catch (COMException ex)
            {
                MessageBox.Show("COM exception on mute audio: " + this.m_ReturnError.returnComError(ex.ErrorCode));
            }
        }

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccAudioMediaChannel Interface
IUccAudioMediaChannel Members
Microsoft.Office.Interop.UccApi Namespace