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

auxGetVolume

関数
補助オーディオデバイスの現在の音量を取得する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD auxGetVolume(
    DWORD uDeviceID,
    DWORD* pdwVolume
);

パラメーター

名前方向説明
uDeviceIDDWORDin照会する補助出力デバイスの識別子です。
pdwVolumeDWORD*out

現在の音量設定が格納される変数へのポインターです。この位置の下位ワードには左チャンネルの音量設定が、上位ワードには右チャンネルの設定が含まれます。値 0xFFFF は最大音量を、値 0x0000 は無音を表します。

デバイスが左右両方の音量制御をサポートしていない場合、指定された位置の下位ワードに音量レベルが格納されます。

auxSetVolume 関数で設定された 16 ビット全体の設定値が返されます。これは、デバイスが 16 ビット全体の音量レベル制御をサポートしているかどうかに関係なく返されます。

戻り値の型: DWORD

公式ドキュメント

auxGetVolume 関数は、指定された補助出力デバイスの現在の音量設定を取得します。

戻り値

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

戻り値 説明
MMSYSERR_BADDEVICEID
指定されたデバイス識別子が範囲外です。

解説(Remarks)

すべてのデバイスが音量制御をサポートしているわけではありません。デバイスが音量制御をサポートしているかどうかを判別するには、AUXCAPS_VOLUME フラグを使用して AUXCAPS 構造体(auxGetDevCaps 関数によって設定される)の dwSupport メンバーをテストします。

デバイスが左右両方のチャンネルで音量制御をサポートしているかどうかを判別するには、AUXCAPS_LRVOLUME フラグを使用して AUXCAPS 構造体(auxGetDevCaps によって設定される)の dwSupport メンバーをテストします。

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

各言語での呼び出し定義

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

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

auxGetVolume = ctypes.windll.winmm.auxGetVolume
auxGetVolume.restype = wintypes.DWORD
auxGetVolume.argtypes = [
    wintypes.DWORD,  # uDeviceID : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwVolume : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procauxGetVolume = winmm.NewProc("auxGetVolume")
)

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

extern "winmm" fn auxGetVolume(
    uDeviceID: u32, // DWORD
    pdwVolume: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc auxGetVolume(
    uDeviceID: uint32,  # DWORD
    pdwVolume: ptr uint32  # DWORD* out
): uint32 {.importc: "auxGetVolume", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint auxGetVolume(
    uint uDeviceID,   // DWORD
    uint* pdwVolume   // DWORD* out
);
ccall((:auxGetVolume, "WINMM.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt32}),
      uDeviceID, pdwVolume)
# uDeviceID : DWORD -> UInt32
# pdwVolume : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t auxGetVolume(
    uint32_t uDeviceID,
    uint32_t* pdwVolume);
]]
local winmm = ffi.load("winmm")
-- winmm.auxGetVolume(uDeviceID, pdwVolume)
-- uDeviceID : DWORD
-- pdwVolume : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const auxGetVolume = lib.func('__stdcall', 'auxGetVolume', 'uint32_t', ['uint32_t', 'uint32_t *']);
// auxGetVolume(uDeviceID, pdwVolume)
// uDeviceID : DWORD -> 'uint32_t'
// pdwVolume : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  auxGetVolume: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.auxGetVolume(uDeviceID, pdwVolume)
// uDeviceID : DWORD -> "u32"
// pdwVolume : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t auxGetVolume(
    uint32_t uDeviceID,
    uint32_t* pdwVolume);
C, "WINMM.dll");
// $ffi->auxGetVolume(uDeviceID, pdwVolume);
// uDeviceID : DWORD
// pdwVolume : DWORD* out
// 構造体/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 auxGetVolume(
        int uDeviceID,   // DWORD
        IntByReference pdwVolume   // DWORD* out
    );
}
@[Link("winmm")]
lib LibWINMM
  fun auxGetVolume = auxGetVolume(
    uDeviceID : UInt32,   # DWORD
    pdwVolume : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef auxGetVolumeNative = Uint32 Function(Uint32, Pointer<Uint32>);
typedef auxGetVolumeDart = int Function(int, Pointer<Uint32>);
final auxGetVolume = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<auxGetVolumeNative, auxGetVolumeDart>('auxGetVolume');
// uDeviceID : DWORD -> Uint32
// pdwVolume : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function auxGetVolume(
  uDeviceID: DWORD;   // DWORD
  pdwVolume: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WINMM.dll' name 'auxGetVolume';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let auxgetvolume =
  foreign "auxGetVolume"
    (uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* uDeviceID : DWORD -> uint32_t *)
(* pdwVolume : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("auxGetVolume" aux-get-volume :convention :stdcall) :uint32
  (u-device-id :uint32)   ; DWORD
  (pdw-volume :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $auxGetVolume = Win32::API::More->new('WINMM',
    'DWORD auxGetVolume(DWORD uDeviceID, LPVOID pdwVolume)');
# my $ret = $auxGetVolume->Call($uDeviceID, $pdwVolume);
# uDeviceID : DWORD -> DWORD
# pdwVolume : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。