ホーム › Media.Audio › mixerGetControlDetailsA

mixerGetControlDetailsA

関数

ミキサーコントロールの現在値の詳細を取得する(ANSI版)。

DLLWINMM.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD mixerGetControlDetailsA(
    HMIXEROBJ hmxobj,   // optional
    MIXERCONTROLDETAILS* pmxcd,
    DWORD fdwDetails
);

パラメーター

名前

型

方向

説明

hmxobj

HMIXEROBJ

inoptional

照会対象のミキサーデバイスオブジェクトへのハンドル。

pmxcd

MIXERCONTROLDETAILS*

inout

MIXERCONTROLDETAILS 構造体へのポインター。コントロールの状態情報が格納されます。

fdwDetails

DWORD

コントロールの詳細を取得するためのフラグ。次の値が定義されています。

値	意味
MIXER_GETCONTROLDETAILSF_LISTTEXT	MIXERCONTROLDETAILS 構造体の paDetails メンバーは、複数項目コントロールのテキストラベルを受け取るための 1 つ以上の MIXERCONTROLDETAILS_LISTTEXT 構造体を指します。アプリケーションは、複数項目コントロールのすべてのリストテキスト項目を一度に取得する必要があります。このフラグは MIXERCONTROL_CONTROLTYPE_CUSTOM コントロールでは使用できません。
MIXER_GETCONTROLDETAILSF_VALUE	コントロールの現在の値を取得します。MIXERCONTROLDETAILS 構造体の paDetails メンバーは、コントロールクラスに応じた 1 つ以上の詳細構造体を指します。
MIXER_OBJECTF_AUX	hmxobj パラメーターは補助デバイス識別子で、0 から auxGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲です。
MIXER_OBJECTF_HMIDIIN	hmxobj パラメーターは MIDI (Musical Instrument Digital Interface) 入力デバイスのハンドルです。このハンドルは 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 入力デバイスの識別子です。この識別子は、0 から midiInGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲でなければなりません。
MIXER_OBJECTF_MIDIOUT	hmxobj パラメーターは MIDI 出力デバイスの識別子です。この識別子は、0 から midiOutGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲でなければなりません。
MIXER_OBJECTF_MIXER	hmxobj パラメーターはミキサーデバイスの識別子で、0 から mixerGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲です。このフラグは省略可能です。
MIXER_OBJECTF_WAVEIN	hmxobj パラメーターは波形オーディオ入力デバイスの識別子で、0 から waveInGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲です。
MIXER_OBJECTF_WAVEOUT	hmxobj パラメーターは波形オーディオ出力デバイスの識別子で、0 から waveOutGetNumDevs 関数が返すデバイス数より 1 小さい値までの範囲です。

戻り値の型: DWORD

公式ドキュメント

mixerGetControlDetails 関数は、オーディオラインに関連付けられた単一のコントロールに関する詳細を取得します。(mixerGetControlDetailsA)

戻り値

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

戻り値	説明
MIXERR_INVALCONTROL	コントロール参照が無効です。
MMSYSERR_BADDEVICEID	hmxobj パラメーターが無効なデバイス識別子を指定しています。
MMSYSERR_INVALFLAG	1 つ以上のフラグが無効です。
MMSYSERR_INVALHANDLE	hmxobj パラメーターが無効なハンドルを指定しています。
MMSYSERR_INVALPARAM	1 つ以上のパラメーターが無効です。
MMSYSERR_NODRIVER	hmxobj で指定されたオブジェクトに使用できるミキサーデバイスがありません。

解説(Remarks)

この関数を呼び出す前に、MIXERCONTROLDETAILS 構造体のすべてのメンバーを初期化しておく必要があります。

メモ

mmeapi.h ヘッダーは mixerGetControlDetails をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD mixerGetControlDetailsA(
    HMIXEROBJ hmxobj,   // optional
    MIXERCONTROLDETAILS* pmxcd,
    DWORD fdwDetails
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint mixerGetControlDetailsA(
    IntPtr hmxobj,   // HMIXEROBJ optional
    IntPtr pmxcd,   // MIXERCONTROLDETAILS* in/out
    uint fdwDetails   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function mixerGetControlDetailsA(
    hmxobj As IntPtr,   ' HMIXEROBJ optional
    pmxcd As IntPtr,   ' MIXERCONTROLDETAILS* in/out
    fdwDetails As UInteger   ' DWORD
) As UInteger
End Function

' hmxobj : HMIXEROBJ optional
' pmxcd : MIXERCONTROLDETAILS* in/out
' fdwDetails : DWORD
Declare PtrSafe Function mixerGetControlDetailsA Lib "winmm" ( _
    ByVal hmxobj As LongPtr, _
    ByVal pmxcd As LongPtr, _
    ByVal fdwDetails As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

mixerGetControlDetailsA = ctypes.windll.winmm.mixerGetControlDetailsA
mixerGetControlDetailsA.restype = wintypes.DWORD
mixerGetControlDetailsA.argtypes = [
    wintypes.HANDLE,  # hmxobj : HMIXEROBJ optional
    ctypes.c_void_p,  # pmxcd : MIXERCONTROLDETAILS* in/out
    wintypes.DWORD,  # fdwDetails : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mixerGetControlDetailsA = Fiddle::Function.new(
  lib['mixerGetControlDetailsA'],
  [
    Fiddle::TYPE_VOIDP,  # hmxobj : HMIXEROBJ optional
    Fiddle::TYPE_VOIDP,  # pmxcd : MIXERCONTROLDETAILS* in/out
    -Fiddle::TYPE_INT,  # fdwDetails : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn mixerGetControlDetailsA(
        hmxobj: *mut core::ffi::c_void,  // HMIXEROBJ optional
        pmxcd: *mut MIXERCONTROLDETAILS,  // MIXERCONTROLDETAILS* in/out
        fdwDetails: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Ansi)]
public static extern uint mixerGetControlDetailsA(IntPtr hmxobj, IntPtr pmxcd, uint fdwDetails);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mixerGetControlDetailsA' -Namespace Win32 -PassThru
# $api::mixerGetControlDetailsA(hmxobj, pmxcd, fdwDetails)

#uselib "WINMM.dll"
#func global mixerGetControlDetailsA "mixerGetControlDetailsA" sptr, sptr, sptr
; mixerGetControlDetailsA hmxobj, varptr(pmxcd), fdwDetails   ; 戻り値は stat
; hmxobj : HMIXEROBJ optional -> "sptr"
; pmxcd : MIXERCONTROLDETAILS* in/out -> "sptr"
; fdwDetails : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global mixerGetControlDetailsA "mixerGetControlDetailsA" sptr, var, int
; res = mixerGetControlDetailsA(hmxobj, pmxcd, fdwDetails)
; hmxobj : HMIXEROBJ optional -> "sptr"
; pmxcd : MIXERCONTROLDETAILS* in/out -> "var"
; fdwDetails : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global mixerGetControlDetailsA "mixerGetControlDetailsA" sptr, sptr, int
; res = mixerGetControlDetailsA(hmxobj, varptr(pmxcd), fdwDetails)
; hmxobj : HMIXEROBJ optional -> "sptr"
; pmxcd : MIXERCONTROLDETAILS* in/out -> "sptr"
; fdwDetails : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。