IUccMediaDeviceManager.GetRecommendedDevice Method

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 recommended media device for the specified category instance, media type, and direction.

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

Syntax

'Declaration
Function GetRecommendedDevice ( _
    enDeviceCategory As UCC_AUDIO_VIDEO_DEVICE_CATEGORY, _
    enMediaType As UCC_MEDIA_TYPES, _
    enMediaDirection As UCC_MEDIA_DIRECTIONS _
) As IUccMediaDevice

IUccMediaDevice GetRecommendedDevice (
    UCC_AUDIO_VIDEO_DEVICE_CATEGORY enDeviceCategory,
    UCC_MEDIA_TYPES enMediaType,
    UCC_MEDIA_DIRECTIONS enMediaDirection
)

IUccMediaDevice^ GetRecommendedDevice (
    UCC_AUDIO_VIDEO_DEVICE_CATEGORY enDeviceCategory, 
    UCC_MEDIA_TYPES enMediaType, 
    UCC_MEDIA_DIRECTIONS enMediaDirection
)

IUccMediaDevice GetRecommendedDevice (
    UCC_AUDIO_VIDEO_DEVICE_CATEGORY enDeviceCategory, 
    UCC_MEDIA_TYPES enMediaType, 
    UCC_MEDIA_DIRECTIONS enMediaDirection
)

function GetRecommendedDevice (
    enDeviceCategory : UCC_AUDIO_VIDEO_DEVICE_CATEGORY, 
    enMediaType : UCC_MEDIA_TYPES, 
    enMediaDirection : UCC_MEDIA_DIRECTIONS
) : IUccMediaDevice

Parameters

• enDeviceCategory
  A value of the UCC_AUDIO_VIDEO_DEVICE_CATEGORY type. This specifies the category of the default device.

• enMediaType
  A value of the UCC_MEDIA_TYPES type. This specifies the media types for the default device.

• enMediaDirection
  A value of the UCC_MEDIA_DIRECTIONS type. This specifies the direction of media transmission for the default device.

Return Value

A value of the IUccMediaDevice** (IUccMediaDevice, for a .NET application) type. The successful result points to the default media device object.

Remarks

Win32 COM/C++ Syntax

HRESULT GetRecommendedDevice
(
   UCC_AUDIO_VIDEO_DEVICE_CATEGORY enDeviceCategory,
   UCC_MEDIA_TYPES enMediaType,
   UCC_MEDIA_DIRECTIONS enMediaDirection,
   IUccMediaDevice** ppMediaDevice
);

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

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