waveInOpen

関数

録音用の波形オーディオ入力デバイスを開く。

DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD waveInOpen(
    HWAVEIN* phwi,   // optional
    DWORD uDeviceID,
    WAVEFORMATEX* pwfx,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    MIDI_WAVE_OPEN_TYPE fdwOpen
);

パラメーター

名前

型

方向

説明

phwi

HWAVEIN*

outoptional

開いた波形オーディオ入力デバイスを識別するハンドルを受け取るバッファーへのポインター。他の波形オーディオ入力関数を呼び出す際に、このハンドルを使用してデバイスを識別します。fdwOpen に WAVE_FORMAT_QUERY を指定した場合、このパラメーターは NULL にできます。

uDeviceID

DWORD

開く波形オーディオ入力デバイスの識別子。デバイス識別子、または開いている波形オーディオ入力デバイスのハンドルのいずれかを指定できます。デバイス識別子の代わりに、次のフラグを使用できます。

値	意味
WAVE_MAPPER	指定された形式で録音できる波形オーディオ入力デバイスを関数が選択します。

pwfx

WAVEFORMATEX*

録音する波形オーディオデータの目的の形式を識別する WAVEFORMATEX 構造体へのポインター。この構造体は、waveInOpen が戻った直後に解放できます。

dwCallback

UINT_PTR

inoptional

録音の進行状況に関するメッセージを処理するために、波形オーディオ録音中に呼び出される、固定コールバック関数へのポインター、イベントハンドル、ウィンドウへのハンドル、またはスレッドの識別子。コールバック関数が不要な場合、この値は 0 にできます。コールバック関数の詳細については、waveInProc を参照してください。

dwInstance

UINT_PTR

inoptional

コールバック機構に渡されるユーザーインスタンスデータ。このパラメーターは、ウィンドウコールバック機構では使用されません。

fdwOpen

MIDI_WAVE_OPEN_TYPE

デバイスを開くためのフラグ。次の値が定義されています。

値	意味
CALLBACK_EVENT	dwCallback パラメーターはイベントハンドルです。
CALLBACK_FUNCTION	dwCallback パラメーターはコールバックプロシージャのアドレスです。
CALLBACK_NULL	コールバック機構なし。これが既定の設定です。
CALLBACK_THREAD	dwCallback パラメーターはスレッド識別子です。
CALLBACK_WINDOW	dwCallback パラメーターはウィンドウハンドルです。
WAVE_MAPPED_DEFAULT_COMMUNICATION_DEVICE	このフラグが指定され、かつ uDeviceID パラメーターが WAVE_MAPPER の場合、関数は既定の通信デバイスを開きます。このフラグは、uDeviceID が WAVE_MAPPER に等しい場合にのみ適用されます。注 Windows 7 が必要です
WAVE_FORMAT_DIRECT	このフラグが指定されている場合、ACM ドライバーはオーディオデータの変換を行いません。
WAVE_FORMAT_QUERY	関数は、指定された形式をデバイスがサポートしているかどうかを判定するためにデバイスに照会しますが、デバイスは開きません。
WAVE_MAPPED	uDeviceID パラメーターは、wave mapper によってマップされる波形オーディオデバイスを指定します。

戻り値の型: DWORD

公式ドキュメント

waveInOpen 関数は、指定された波形オーディオ入力デバイスを録音用に開きます。

戻り値

成功した場合は MMSYSERR_NOERROR を、それ以外の場合はエラーを返します。考えられるエラー値には次のものがあります。

戻り値	説明
MMSYSERR_ALLOCATED	指定されたリソースは既に割り当てられています。
MMSYSERR_BADDEVICEID	指定されたデバイス識別子が範囲外です。
MMSYSERR_NODRIVER	デバイスドライバーが存在しません。
MMSYSERR_NOMEM	メモリの割り当てまたはロックができません。
WAVERR_BADFORMAT	サポートされていない波形オーディオ形式で開こうとしました。

解説(Remarks)

システムに存在する波形オーディオ入力デバイスの数を判定するには、waveInGetNumDevs 関数を使用します。uDeviceID で指定するデバイス識別子は、0 から存在するデバイス数より 1 少ない値までの範囲を取ります。WAVE_MAPPER 定数もデバイス識別子として使用できます。

ウィンドウまたはスレッドにコールバック情報を受け取らせる場合、波形オーディオ入力の進行状況を示すために、次のメッセージがウィンドウプロシージャまたはスレッドに送信されます: MM_WIM_OPEN、MM_WIM_CLOSE、MM_WIM_DATA。

関数にコールバック情報を受け取らせる場合、波形オーディオ入力の進行状況を示すために、次のメッセージが関数に送信されます: WIM_OPEN、WIM_CLOSE、WIM_DATA。

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

各言語での呼び出し定義

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

DWORD waveInOpen(
    HWAVEIN* phwi,   // optional
    DWORD uDeviceID,
    WAVEFORMATEX* pwfx,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    MIDI_WAVE_OPEN_TYPE fdwOpen
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint waveInOpen(
    IntPtr phwi,   // HWAVEIN* optional, out
    uint uDeviceID,   // DWORD
    IntPtr pwfx,   // WAVEFORMATEX*
    UIntPtr dwCallback,   // UINT_PTR optional
    UIntPtr dwInstance,   // UINT_PTR optional
    uint fdwOpen   // MIDI_WAVE_OPEN_TYPE
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function waveInOpen(
    phwi As IntPtr,   ' HWAVEIN* optional, out
    uDeviceID As UInteger,   ' DWORD
    pwfx As IntPtr,   ' WAVEFORMATEX*
    dwCallback As UIntPtr,   ' UINT_PTR optional
    dwInstance As UIntPtr,   ' UINT_PTR optional
    fdwOpen As UInteger   ' MIDI_WAVE_OPEN_TYPE
) As UInteger
End Function

' phwi : HWAVEIN* optional, out
' uDeviceID : DWORD
' pwfx : WAVEFORMATEX*
' dwCallback : UINT_PTR optional
' dwInstance : UINT_PTR optional
' fdwOpen : MIDI_WAVE_OPEN_TYPE
Declare PtrSafe Function waveInOpen Lib "winmm" ( _
    ByVal phwi As LongPtr, _
    ByVal uDeviceID As Long, _
    ByVal pwfx As LongPtr, _
    ByVal dwCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwOpen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

waveInOpen = ctypes.windll.winmm.waveInOpen
waveInOpen.restype = wintypes.DWORD
waveInOpen.argtypes = [
    ctypes.c_void_p,  # phwi : HWAVEIN* optional, out
    wintypes.DWORD,  # uDeviceID : DWORD
    ctypes.c_void_p,  # pwfx : WAVEFORMATEX*
    ctypes.c_size_t,  # dwCallback : UINT_PTR optional
    ctypes.c_size_t,  # dwInstance : UINT_PTR optional
    wintypes.DWORD,  # fdwOpen : MIDI_WAVE_OPEN_TYPE
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
waveInOpen = Fiddle::Function.new(
  lib['waveInOpen'],
  [
    Fiddle::TYPE_VOIDP,  # phwi : HWAVEIN* optional, out
    -Fiddle::TYPE_INT,  # uDeviceID : DWORD
    Fiddle::TYPE_VOIDP,  # pwfx : WAVEFORMATEX*
    Fiddle::TYPE_UINTPTR_T,  # dwCallback : UINT_PTR optional
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR optional
    -Fiddle::TYPE_INT,  # fdwOpen : MIDI_WAVE_OPEN_TYPE
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn waveInOpen(
        phwi: *mut *mut core::ffi::c_void,  // HWAVEIN* optional, out
        uDeviceID: u32,  // DWORD
        pwfx: *mut WAVEFORMATEX,  // WAVEFORMATEX*
        dwCallback: usize,  // UINT_PTR optional
        dwInstance: usize,  // UINT_PTR optional
        fdwOpen: u32  // MIDI_WAVE_OPEN_TYPE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint waveInOpen(IntPtr phwi, uint uDeviceID, IntPtr pwfx, UIntPtr dwCallback, UIntPtr dwInstance, uint fdwOpen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_waveInOpen' -Namespace Win32 -PassThru
# $api::waveInOpen(phwi, uDeviceID, pwfx, dwCallback, dwInstance, fdwOpen)

#uselib "WINMM.dll"
#func global waveInOpen "waveInOpen" sptr, sptr, sptr, sptr, sptr, sptr
; waveInOpen phwi, uDeviceID, varptr(pwfx), dwCallback, dwInstance, fdwOpen   ; 戻り値は stat
; phwi : HWAVEIN* optional, out -> "sptr"
; uDeviceID : DWORD -> "sptr"
; pwfx : WAVEFORMATEX* -> "sptr"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global waveInOpen "waveInOpen" sptr, int, var, sptr, sptr, int
; res = waveInOpen(phwi, uDeviceID, pwfx, dwCallback, dwInstance, fdwOpen)
; phwi : HWAVEIN* optional, out -> "sptr"
; uDeviceID : DWORD -> "int"
; pwfx : WAVEFORMATEX* -> "var"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global waveInOpen "waveInOpen" sptr, int, sptr, sptr, sptr, int
; res = waveInOpen(phwi, uDeviceID, varptr(pwfx), dwCallback, dwInstance, fdwOpen)
; phwi : HWAVEIN* optional, out -> "sptr"
; uDeviceID : DWORD -> "int"
; pwfx : WAVEFORMATEX* -> "sptr"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。