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

midiOutSetVolume

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

シグネチャ

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

DWORD midiOutSetVolume(
    HMIDIOUT hmo,   // optional
    DWORD dwVolume
);

パラメーター

名前方向説明
hmoHMIDIOUTinoptional開かれた MIDI 出力デバイスのハンドルです。このパラメーターには、HMIDIOUT にキャストされていれば MIDI ストリームのハンドルを指定することもできます。また、デバイス識別子を指定することもできます。
dwVolumeDWORDin

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

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

戻り値の型: DWORD

公式ドキュメント

midiOutSetVolume 関数は、MIDI 出力デバイスの音量を設定します。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。
MMSYSERR_NOMEM
システムがメモリを割り当てまたはロックできません。
MMSYSERR_NOTSUPPORTED
この関数はサポートされていません。

解説(Remarks)

デバイス識別子を使用した場合、midiOutSetVolume 呼び出しの結果はそのデバイスのすべてのインスタンスに適用されます。デバイスハンドルを使用した場合、結果はそのデバイスハンドルが参照するインスタンスにのみ適用されます。

すべてのデバイスが音量変更をサポートしているわけではありません。デバイスがサポートしているかどうかは、midiOutGetDevCaps 関数と MIDICAPS_VOLUME フラグを使用してデバイスを照会することで判断できます。

また、デバイスが左右両方のチャネルの音量制御をサポートしているかどうかも、midiOutGetDevCaps 関数と MIDICAPS_LRVOLUME フラグを使用してデバイスを照会することで判断できます。

16 ビットすべての音量レベル制御をサポートしていないデバイスは、要求された音量設定の上位ビットを使用します。たとえば、4 ビットの音量制御をサポートするデバイスは、0x4000、0x43be、0x4fff という音量レベル値に対して同じ音量設定を生成します。midiOutGetVolume 関数は、デバイスの機能に関係なく、midiOutSetVolume で設定された完全な 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 midiOutSetVolume(
    HMIDIOUT hmo,   // optional
    DWORD dwVolume
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiOutSetVolume(
    IntPtr hmo,   // HMIDIOUT optional
    uint dwVolume   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiOutSetVolume(
    hmo As IntPtr,   ' HMIDIOUT optional
    dwVolume As UInteger   ' DWORD
) As UInteger
End Function
' hmo : HMIDIOUT optional
' dwVolume : DWORD
Declare PtrSafe Function midiOutSetVolume Lib "winmm" ( _
    ByVal hmo As LongPtr, _
    ByVal dwVolume As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

midiOutSetVolume = ctypes.windll.winmm.midiOutSetVolume
midiOutSetVolume.restype = wintypes.DWORD
midiOutSetVolume.argtypes = [
    wintypes.HANDLE,  # hmo : HMIDIOUT optional
    wintypes.DWORD,  # dwVolume : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiOutSetVolume = winmm.NewProc("midiOutSetVolume")
)

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

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

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

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