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

auxSetVolume

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

シグネチャ

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

DWORD auxSetVolume(
    DWORD uDeviceID,
    DWORD dwVolume
);

パラメーター

名前方向説明
uDeviceIDDWORDin問い合わせ対象となる補助出力デバイスの識別子です。デバイス識別子は、システムに存在するデバイス数から暗黙的に決定されます。デバイス識別子の値は、0 から存在するデバイス数より 1 小さい値までの範囲を取ります。システム内の補助デバイス数を取得するには、auxGetNumDevs 関数を使用してください。
dwVolumeDWORDin

新しい音量設定を指定します。下位ワードは左チャンネルの音量設定を、上位ワードは右チャンネルの音量設定を指定します。値 0xFFFF は最大音量を表し、値 0x0000 は無音を表します。

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

戻り値の型: DWORD

公式ドキュメント

auxSetVolume 関数は、指定した補助出力デバイスの音量を設定します。

戻り値

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

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

解説(Remarks)

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

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

ほとんどのデバイスは 16 ビット全体の音量レベル制御をサポートしておらず、要求された音量設定のうち上位ビットのみを使用します。たとえば、4 ビットの音量制御をサポートするデバイスでは、要求された音量レベルの値 0x4000、0x4FFF、0x43BE はいずれも同じ物理的な音量設定 0x4000 になります。auxGetVolume 関数は、auxSetVolume で設定した 16 ビット全体の設定値を返します。

音量設定は対数的に解釈されます。これは、音量レベルを 0x5000 から 0x6000 へ上げたときと 0x4000 から 0x5000 へ上げたときとで、知覚される音量の増加が同じであることを意味します。

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

各言語での呼び出し定義

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

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

auxSetVolume = ctypes.windll.winmm.auxSetVolume
auxSetVolume.restype = wintypes.DWORD
auxSetVolume.argtypes = [
    wintypes.DWORD,  # uDeviceID : DWORD
    wintypes.DWORD,  # dwVolume : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
auxSetVolume = Fiddle::Function.new(
  lib['auxSetVolume'],
  [
    -Fiddle::TYPE_INT,  # uDeviceID : DWORD
    -Fiddle::TYPE_INT,  # dwVolume : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn auxSetVolume(
        uDeviceID: u32,  // DWORD
        dwVolume: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint auxSetVolume(uint uDeviceID, uint dwVolume);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_auxSetVolume' -Namespace Win32 -PassThru
# $api::auxSetVolume(uDeviceID, dwVolume)
#uselib "WINMM.dll"
#func global auxSetVolume "auxSetVolume" sptr, sptr
; auxSetVolume uDeviceID, dwVolume   ; 戻り値は stat
; uDeviceID : DWORD -> "sptr"
; dwVolume : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global auxSetVolume "auxSetVolume" int, int
; res = auxSetVolume(uDeviceID, dwVolume)
; uDeviceID : DWORD -> "int"
; dwVolume : DWORD -> "int"
; DWORD auxSetVolume(DWORD uDeviceID, DWORD dwVolume)
#uselib "WINMM.dll"
#cfunc global auxSetVolume "auxSetVolume" int, int
; res = auxSetVolume(uDeviceID, dwVolume)
; uDeviceID : DWORD -> "int"
; dwVolume : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procauxSetVolume = winmm.NewProc("auxSetVolume")
)

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

extern "winmm" fn auxSetVolume(
    uDeviceID: u32, // DWORD
    dwVolume: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc auxSetVolume(
    uDeviceID: uint32,  # DWORD
    dwVolume: uint32  # DWORD
): uint32 {.importc: "auxSetVolume", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint auxSetVolume(
    uint uDeviceID,   // DWORD
    uint dwVolume   // DWORD
);
ccall((:auxSetVolume, "WINMM.dll"), stdcall, UInt32,
      (UInt32, UInt32),
      uDeviceID, dwVolume)
# uDeviceID : DWORD -> UInt32
# dwVolume : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t auxSetVolume(
    uint32_t uDeviceID,
    uint32_t dwVolume);
]]
local winmm = ffi.load("winmm")
-- winmm.auxSetVolume(uDeviceID, dwVolume)
-- uDeviceID : DWORD
-- dwVolume : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const auxSetVolume = lib.func('__stdcall', 'auxSetVolume', 'uint32_t', ['uint32_t', 'uint32_t']);
// auxSetVolume(uDeviceID, dwVolume)
// uDeviceID : DWORD -> 'uint32_t'
// dwVolume : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  auxSetVolume: { parameters: ["u32", "u32"], result: "u32" },
});
// lib.symbols.auxSetVolume(uDeviceID, dwVolume)
// uDeviceID : DWORD -> "u32"
// dwVolume : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t auxSetVolume(
    uint32_t uDeviceID,
    uint32_t dwVolume);
C, "WINMM.dll");
// $ffi->auxSetVolume(uDeviceID, dwVolume);
// uDeviceID : DWORD
// dwVolume : 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 auxSetVolume(
        int uDeviceID,   // DWORD
        int dwVolume   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun auxSetVolume = auxSetVolume(
    uDeviceID : UInt32,   # DWORD
    dwVolume : 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 auxSetVolumeNative = Uint32 Function(Uint32, Uint32);
typedef auxSetVolumeDart = int Function(int, int);
final auxSetVolume = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<auxSetVolumeNative, auxSetVolumeDart>('auxSetVolume');
// uDeviceID : DWORD -> Uint32
// dwVolume : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function auxSetVolume(
  uDeviceID: DWORD;   // DWORD
  dwVolume: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'auxSetVolume';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let auxsetvolume =
  foreign "auxSetVolume"
    (uint32_t @-> uint32_t @-> returning uint32_t)
(* uDeviceID : DWORD -> uint32_t *)
(* dwVolume : 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 ("auxSetVolume" aux-set-volume :convention :stdcall) :uint32
  (u-device-id :uint32)   ; DWORD
  (dw-volume :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $auxSetVolume = Win32::API::More->new('WINMM',
    'DWORD auxSetVolume(DWORD uDeviceID, DWORD dwVolume)');
# my $ret = $auxSetVolume->Call($uDeviceID, $dwVolume);
# uDeviceID : DWORD -> DWORD
# dwVolume : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。