Win32 API 日本語リファレンス
ホームMedia.Audio › mixerGetID

mixerGetID

関数
ミキサーオブジェクトからミキサーデバイスIDを取得する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD mixerGetID(
    HMIXEROBJ hmxobj,   // optional
    DWORD* puMxId,
    DWORD fdwId
);

パラメーター

名前方向説明
hmxobjHMIXEROBJinoptionalミキサーデバイス識別子にマップするオーディオミキサーオブジェクトのハンドル。
puMxIdDWORD*outミキサーデバイス識別子を受け取る変数へのポインター。hmxobj オブジェクトに対して使用可能なミキサーデバイスがない場合、この場所に値 -1 が格納され、MMSYSERR_NODRIVER エラー値が返されます。
fdwIdDWORDin

ミキサーオブジェクト hmxobj をマップするためのフラグ。次の値が定義されています。

意味
MIXER_OBJECTF_AUX hmxobj パラメーターは、auxGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲の補助デバイス識別子です。
MIXER_OBJECTF_HMIDIIN hmxobj パラメーターは MIDI 入力デバイスのハンドルです。このハンドルは midiInOpen 関数によって返されたものでなければなりません。
MIXER_OBJECTF_HMIDIOUT hmxobj パラメーターは MIDI 出力デバイスのハンドルです。このハンドルは midiOutOpen 関数によって返されたものでなければなりません。
MIXER_OBJECTF_HMIXER hmxobj パラメーターは mixerOpen 関数が返したミキサーデバイスハンドルです。このフラグは省略可能です。
MIXER_OBJECTF_HWAVEIN hmxobj パラメーターは waveInOpen 関数が返した波形オーディオ入力ハンドルです。
MIXER_OBJECTF_HWAVEOUT hmxobj パラメーターは waveOutOpen 関数が返した波形オーディオ出力ハンドルです。
MIXER_OBJECTF_MIDIIN hmxobj パラメーターは MIDI 入力デバイスの識別子です。この識別子は、midiInGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲でなければなりません。
MIXER_OBJECTF_MIDIOUT hmxobj パラメーターは MIDI 出力デバイスの識別子です。この識別子は、midiOutGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲でなければなりません。
MIXER_OBJECTF_MIXER hmxobj パラメーターは、mixerGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲のミキサーデバイスの識別子です。このフラグは省略可能です。
MIXER_OBJECTF_WAVEIN hmxobj パラメーターは、waveInGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲の波形オーディオ入力デバイスの識別子です。
MIXER_OBJECTF_WAVEOUT hmxobj パラメーターは、waveOutGetNumDevs 関数が返すデバイス数より 1 小さい値からゼロまでの範囲の波形オーディオ出力デバイスの識別子です。

戻り値の型: DWORD

公式ドキュメント

mixerGetID 関数は、指定されたデバイスハンドルに関連付けられたミキサーデバイスのデバイス識別子を取得します。

戻り値

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

戻り値 説明
MMSYSERR_BADDEVICEID
hmxobj パラメーターが無効なデバイス識別子を指定しています。
MMSYSERR_INVALFLAG
1 つ以上のフラグが無効です。
MMSYSERR_INVALHANDLE
hmxobj パラメーターが無効なハンドルを指定しています。
MMSYSERR_INVALPARAM
1 つ以上のパラメーターが無効です。
MMSYSERR_NODRIVER
hmxobj で指定されたオブジェクトに対して使用可能なオーディオミキサーデバイスがありません。puMxId が参照する場所にも値 -1 が格納されます。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD mixerGetID(
    HMIXEROBJ hmxobj,   // optional
    DWORD* puMxId,
    DWORD fdwId
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint mixerGetID(
    IntPtr hmxobj,   // HMIXEROBJ optional
    out uint puMxId,   // DWORD* out
    uint fdwId   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mixerGetID(
    hmxobj As IntPtr,   ' HMIXEROBJ optional
    <Out> ByRef puMxId As UInteger,   ' DWORD* out
    fdwId As UInteger   ' DWORD
) As UInteger
End Function
' hmxobj : HMIXEROBJ optional
' puMxId : DWORD* out
' fdwId : DWORD
Declare PtrSafe Function mixerGetID Lib "winmm" ( _
    ByVal hmxobj As LongPtr, _
    ByRef puMxId As Long, _
    ByVal fdwId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

mixerGetID = ctypes.windll.winmm.mixerGetID
mixerGetID.restype = wintypes.DWORD
mixerGetID.argtypes = [
    wintypes.HANDLE,  # hmxobj : HMIXEROBJ optional
    ctypes.POINTER(wintypes.DWORD),  # puMxId : DWORD* out
    wintypes.DWORD,  # fdwId : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mixerGetID = Fiddle::Function.new(
  lib['mixerGetID'],
  [
    Fiddle::TYPE_VOIDP,  # hmxobj : HMIXEROBJ optional
    Fiddle::TYPE_VOIDP,  # puMxId : DWORD* out
    -Fiddle::TYPE_INT,  # fdwId : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn mixerGetID(
        hmxobj: *mut core::ffi::c_void,  // HMIXEROBJ optional
        puMxId: *mut u32,  // DWORD* out
        fdwId: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint mixerGetID(IntPtr hmxobj, out uint puMxId, uint fdwId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mixerGetID' -Namespace Win32 -PassThru
# $api::mixerGetID(hmxobj, puMxId, fdwId)
#uselib "WINMM.dll"
#func global mixerGetID "mixerGetID" sptr, sptr, sptr
; mixerGetID hmxobj, varptr(puMxId), fdwId   ; 戻り値は stat
; hmxobj : HMIXEROBJ optional -> "sptr"
; puMxId : DWORD* out -> "sptr"
; fdwId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global mixerGetID "mixerGetID" sptr, var, int
; res = mixerGetID(hmxobj, puMxId, fdwId)
; hmxobj : HMIXEROBJ optional -> "sptr"
; puMxId : DWORD* out -> "var"
; fdwId : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD mixerGetID(HMIXEROBJ hmxobj, DWORD* puMxId, DWORD fdwId)
#uselib "WINMM.dll"
#cfunc global mixerGetID "mixerGetID" intptr, var, int
; res = mixerGetID(hmxobj, puMxId, fdwId)
; hmxobj : HMIXEROBJ optional -> "intptr"
; puMxId : DWORD* out -> "var"
; fdwId : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmixerGetID = winmm.NewProc("mixerGetID")
)

// hmxobj (HMIXEROBJ optional), puMxId (DWORD* out), fdwId (DWORD)
r1, _, err := procmixerGetID.Call(
	uintptr(hmxobj),
	uintptr(puMxId),
	uintptr(fdwId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function mixerGetID(
  hmxobj: THandle;   // HMIXEROBJ optional
  puMxId: Pointer;   // DWORD* out
  fdwId: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mixerGetID';
result := DllCall("WINMM\mixerGetID"
    , "Ptr", hmxobj   ; HMIXEROBJ optional
    , "Ptr", puMxId   ; DWORD* out
    , "UInt", fdwId   ; DWORD
    , "UInt")   ; return: DWORD
●mixerGetID(hmxobj, puMxId, fdwId) = DLL("WINMM.dll", "dword mixerGetID(void*, void*, dword)")
# 呼び出し: mixerGetID(hmxobj, puMxId, fdwId)
# hmxobj : HMIXEROBJ optional -> "void*"
# puMxId : DWORD* out -> "void*"
# fdwId : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn mixerGetID(
    hmxobj: ?*anyopaque, // HMIXEROBJ optional
    puMxId: [*c]u32, // DWORD* out
    fdwId: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc mixerGetID(
    hmxobj: pointer,  # HMIXEROBJ optional
    puMxId: ptr uint32,  # DWORD* out
    fdwId: uint32  # DWORD
): uint32 {.importc: "mixerGetID", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint mixerGetID(
    void* hmxobj,   // HMIXEROBJ optional
    uint* puMxId,   // DWORD* out
    uint fdwId   // DWORD
);
ccall((:mixerGetID, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}, UInt32),
      hmxobj, puMxId, fdwId)
# hmxobj : HMIXEROBJ optional -> Ptr{Cvoid}
# puMxId : DWORD* out -> Ptr{UInt32}
# fdwId : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t mixerGetID(
    void* hmxobj,
    uint32_t* puMxId,
    uint32_t fdwId);
]]
local winmm = ffi.load("winmm")
-- winmm.mixerGetID(hmxobj, puMxId, fdwId)
-- hmxobj : HMIXEROBJ optional
-- puMxId : DWORD* out
-- fdwId : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const mixerGetID = lib.func('__stdcall', 'mixerGetID', 'uint32_t', ['void *', 'uint32_t *', 'uint32_t']);
// mixerGetID(hmxobj, puMxId, fdwId)
// hmxobj : HMIXEROBJ optional -> 'void *'
// puMxId : DWORD* out -> 'uint32_t *'
// fdwId : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  mixerGetID: { parameters: ["pointer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.mixerGetID(hmxobj, puMxId, fdwId)
// hmxobj : HMIXEROBJ optional -> "pointer"
// puMxId : DWORD* out -> "pointer"
// fdwId : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t mixerGetID(
    void* hmxobj,
    uint32_t* puMxId,
    uint32_t fdwId);
C, "WINMM.dll");
// $ffi->mixerGetID(hmxobj, puMxId, fdwId);
// hmxobj : HMIXEROBJ optional
// puMxId : DWORD* out
// fdwId : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winmm extends StdCallLibrary {
    Winmm INSTANCE = Native.load("winmm", Winmm.class);
    int mixerGetID(
        Pointer hmxobj,   // HMIXEROBJ optional
        IntByReference puMxId,   // DWORD* out
        int fdwId   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun mixerGetID = mixerGetID(
    hmxobj : Void*,   # HMIXEROBJ optional
    puMxId : UInt32*,   # DWORD* out
    fdwId : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef mixerGetIDNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Uint32);
typedef mixerGetIDDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final mixerGetID = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<mixerGetIDNative, mixerGetIDDart>('mixerGetID');
// hmxobj : HMIXEROBJ optional -> Pointer<Void>
// puMxId : DWORD* out -> Pointer<Uint32>
// fdwId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function mixerGetID(
  hmxobj: THandle;   // HMIXEROBJ optional
  puMxId: Pointer;   // DWORD* out
  fdwId: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mixerGetID';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "mixerGetID"
  c_mixerGetID :: Ptr () -> Ptr Word32 -> Word32 -> IO Word32
-- hmxobj : HMIXEROBJ optional -> Ptr ()
-- puMxId : DWORD* out -> Ptr Word32
-- fdwId : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mixergetid =
  foreign "mixerGetID"
    ((ptr void) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* hmxobj : HMIXEROBJ optional -> (ptr void) *)
(* puMxId : DWORD* out -> (ptr uint32_t) *)
(* fdwId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("mixerGetID" mixer-get-id :convention :stdcall) :uint32
  (hmxobj :pointer)   ; HMIXEROBJ optional
  (pu-mx-id :pointer)   ; DWORD* out
  (fdw-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $mixerGetID = Win32::API::More->new('WINMM',
    'DWORD mixerGetID(HANDLE hmxobj, LPVOID puMxId, DWORD fdwId)');
# my $ret = $mixerGetID->Call($hmxobj, $puMxId, $fdwId);
# hmxobj : HMIXEROBJ optional -> HANDLE
# puMxId : DWORD* out -> LPVOID
# fdwId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。