ホーム › Media.MediaFoundation › MFEnumDeviceSources

MFEnumDeviceSources

関数

条件に合うキャプチャデバイスソースを列挙する。

DLLMF.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// MF.dll
#include <windows.h>

HRESULT MFEnumDeviceSources(
    IMFAttributes* pAttributes,
    IMFActivate*** pppSourceActivate,
    DWORD* pcSourceActivate
);

パラメーター

名前

型

方向

説明

pAttributes

IMFAttributes*

検索条件を格納する属性ストアへのポインター。属性ストアを作成するには MFCreateAttributes を呼び出します。次の属性のうち 1 つ以上を属性ストアに設定します。

値	意味
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE	オーディオデバイスとビデオデバイスのどちらを列挙するかを指定します。(必須。)
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_AUDCAP_ROLE	オーディオキャプチャデバイスの場合、デバイスのロールを指定します。(省略可能。)
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_CATEGORY	ビデオキャプチャデバイスの場合、デバイスのカテゴリを指定します。(省略可能。)

pppSourceActivate

IMFActivate***

out

IMFActivate インターフェイスポインターの配列を受け取ります。各ポインターはメディアソースのアクティブ化オブジェクトを表します。配列のメモリはこの関数が割り当てます。呼び出し側は配列内のポインターを解放し、CoTaskMemFree を呼び出して配列のメモリを解放する必要があります。

pcSourceActivate

DWORD*

out

pppSourceActivate 配列内の要素数を受け取ります。検索条件に一致するキャプチャデバイスがない場合、このパラメーターは値 0 を受け取ります。

戻り値の型: HRESULT

公式ドキュメント

オーディオまたはビデオのキャプチャデバイスの一覧を列挙します。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

返される各 IMFActivate ポインターはキャプチャデバイスを表し、そのデバイス用のメディアソースを作成するために使用できます。また、IMFActivate ポインターを使用して、デバイスを記述する属性を照会することもできます。次の属性が設定される場合があります。

属性	説明
MF_DEVSOURCE_ATTRIBUTE_FRIENDLY_NAME	デバイスの表示名。
MF_DEVSOURCE_ATTRIBUTE_MEDIA_TYPE	デバイスの出力形式を記述するメジャータイプおよびサブタイプの GUID。
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE	キャプチャデバイスの種類(オーディオまたはビデオ)。
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_AUDCAP_ENDPOINT_ID	オーディオエンドポイント ID 文字列。(オーディオデバイスのみ。)
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_CATEGORY	デバイスのカテゴリ。(ビデオデバイスのみ。)
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_HW_SOURCE	デバイスがハードウェアデバイスかソフトウェアデバイスか。(ビデオデバイスのみ。)
MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_SYMBOLIC_LINK	デバイスドライバーのシンボリックリンク。(ビデオデバイスのみ。)

IMFActivate ポインターからメディアソースを作成するには、IMFActivate::ActivateObject メソッドを呼び出します。

例

次の例では、システム上のビデオキャプチャデバイスを列挙し、一覧の最初のデバイス用のメディアソースを作成します。

HRESULT CreateVideoDeviceSource(IMFMediaSource **ppSource)
{
    *ppSource = NULL;

    IMFMediaSource *pSource = NULL;
    IMFAttributes *pAttributes = NULL;
    IMFActivate **ppDevices = NULL;

    // Create an attribute store to specify the enumeration parameters.
    HRESULT hr = MFCreateAttributes(&pAttributes, 1);
    if (FAILED(hr))
    {
        goto done;
    }

    // Source type: video capture devices
    hr = pAttributes->SetGUID(
        MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE, 
        MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_GUID
        );
    if (FAILED(hr))
    {
        goto done;
    }

    // Enumerate devices.
    UINT32 count;
    hr = MFEnumDeviceSources(pAttributes, &ppDevices, &count);
    if (FAILED(hr))
    {
        goto done;
    }

    if (count == 0)
    {
        hr = E_FAIL;
        goto done;
    }

    // Create the media source object.
    hr = ppDevices[0]->ActivateObject(IID_PPV_ARGS(&pSource));
    if (FAILED(hr))
    {
        goto done;
    }

    *ppSource = pSource;
    (*ppSource)->AddRef();

done:
    SafeRelease(&pAttributes);

    for (DWORD i = 0; i < count; i++)
    {
        SafeRelease(&ppDevices[i]);
    }
    CoTaskMemFree(ppDevices);
    SafeRelease(&pSource);
    return hr;
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// MF.dll
#include <windows.h>

HRESULT MFEnumDeviceSources(
    IMFAttributes* pAttributes,
    IMFActivate*** pppSourceActivate,
    DWORD* pcSourceActivate
);

[DllImport("MF.dll", ExactSpelling = true)]
static extern int MFEnumDeviceSources(
    IntPtr pAttributes,   // IMFAttributes*
    IntPtr pppSourceActivate,   // IMFActivate*** out
    out uint pcSourceActivate   // DWORD* out
);

<DllImport("MF.dll", ExactSpelling:=True)>
Public Shared Function MFEnumDeviceSources(
    pAttributes As IntPtr,   ' IMFAttributes*
    pppSourceActivate As IntPtr,   ' IMFActivate*** out
    <Out> ByRef pcSourceActivate As UInteger   ' DWORD* out
) As Integer
End Function

' pAttributes : IMFAttributes*
' pppSourceActivate : IMFActivate*** out
' pcSourceActivate : DWORD* out
Declare PtrSafe Function MFEnumDeviceSources Lib "mf" ( _
    ByVal pAttributes As LongPtr, _
    ByVal pppSourceActivate As LongPtr, _
    ByRef pcSourceActivate As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MFEnumDeviceSources = ctypes.windll.mf.MFEnumDeviceSources
MFEnumDeviceSources.restype = ctypes.c_int
MFEnumDeviceSources.argtypes = [
    ctypes.c_void_p,  # pAttributes : IMFAttributes*
    ctypes.c_void_p,  # pppSourceActivate : IMFActivate*** out
    ctypes.POINTER(wintypes.DWORD),  # pcSourceActivate : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MF.dll')
MFEnumDeviceSources = Fiddle::Function.new(
  lib['MFEnumDeviceSources'],
  [
    Fiddle::TYPE_VOIDP,  # pAttributes : IMFAttributes*
    Fiddle::TYPE_VOIDP,  # pppSourceActivate : IMFActivate*** out
    Fiddle::TYPE_VOIDP,  # pcSourceActivate : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "mf")]
extern "system" {
    fn MFEnumDeviceSources(
        pAttributes: *mut core::ffi::c_void,  // IMFAttributes*
        pppSourceActivate: *mut *mut *mut core::ffi::c_void,  // IMFActivate*** out
        pcSourceActivate: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MF.dll")]
public static extern int MFEnumDeviceSources(IntPtr pAttributes, IntPtr pppSourceActivate, out uint pcSourceActivate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MF_MFEnumDeviceSources' -Namespace Win32 -PassThru
# $api::MFEnumDeviceSources(pAttributes, pppSourceActivate, pcSourceActivate)

#uselib "MF.dll"
#func global MFEnumDeviceSources "MFEnumDeviceSources" sptr, sptr, sptr
; MFEnumDeviceSources pAttributes, pppSourceActivate, varptr(pcSourceActivate)   ; 戻り値は stat
; pAttributes : IMFAttributes* -> "sptr"
; pppSourceActivate : IMFActivate*** out -> "sptr"
; pcSourceActivate : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MF.dll"
#cfunc global MFEnumDeviceSources "MFEnumDeviceSources" sptr, sptr, var
; res = MFEnumDeviceSources(pAttributes, pppSourceActivate, pcSourceActivate)
; pAttributes : IMFAttributes* -> "sptr"
; pppSourceActivate : IMFActivate*** out -> "sptr"
; pcSourceActivate : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MF.dll"
#cfunc global MFEnumDeviceSources "MFEnumDeviceSources" sptr, sptr, sptr
; res = MFEnumDeviceSources(pAttributes, pppSourceActivate, varptr(pcSourceActivate))
; pAttributes : IMFAttributes* -> "sptr"
; pppSourceActivate : IMFActivate*** out -> "sptr"
; pcSourceActivate : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。