midiStreamOut

関数

MIDIイベントバッファをストリームへ送出して再生する。

DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiStreamOut(
    HMIDISTRM hms,
    MIDIHDR* pmh,
    DWORD cbmh
);

パラメーター

名前	型	方向	説明
hms	HMIDISTRM	in	MIDI ストリームへのハンドル。このハンドルは midiStreamOpen 関数の呼び出しによって返されたものである必要があります。このハンドルは出力デバイスを識別します。
pmh	MIDIHDR*	out	MIDI バッファーを識別する MIDIHDR 構造体へのポインター。
cbmh	DWORD	in	MIDIHDR 構造体のサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

midiStreamOut 関数は、MIDI データのストリーム(バッファー)を MIDI 出力デバイスに対して再生またはキューイングします。

戻り値

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

戻り値	説明
MMSYSERR_NOMEM	システムがメモリを割り当てまたはロックできません。
MIDIERR_STILLPLAYING	lpMidiHdr が指す出力バッファーがまだ再生中であるか、以前の midiStreamOut 呼び出しによってキューに入れられています。
MIDIERR_UNPREPARED	lpMidiHdr が指すヘッダーが準備されていません。
MMSYSERR_INVALHANDLE	指定されたデバイスハンドルが無効です。
MMSYSERR_INVALPARAM	lpMidiHdr で指定されたポインターが無効です。

解説(Remarks)

バッファーを midiStreamOpen に渡す前に、midiOutPrepareHeader 関数を使用してバッファーを準備する必要があります。

midiStreamOpen 関数は出力デバイスを一時停止モードで開くため、midiStreamOut を使用して再生を開始する前に midiStreamRestart 関数を呼び出す必要があります。

この関数の現在の実装では、バッファーは 64K 未満である必要があります。

MIDIHDR 構造体が指すバッファーには 1 つ以上の MIDI イベントが含まれ、それぞれが MIDIEVENT 構造体によって定義されます。

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

各言語での呼び出し定義

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

DWORD midiStreamOut(
    HMIDISTRM hms,
    MIDIHDR* pmh,
    DWORD cbmh
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiStreamOut(
    IntPtr hms,   // HMIDISTRM
    IntPtr pmh,   // MIDIHDR* out
    uint cbmh   // DWORD
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiStreamOut(
    hms As IntPtr,   ' HMIDISTRM
    pmh As IntPtr,   ' MIDIHDR* out
    cbmh As UInteger   ' DWORD
) As UInteger
End Function

' hms : HMIDISTRM
' pmh : MIDIHDR* out
' cbmh : DWORD
Declare PtrSafe Function midiStreamOut Lib "winmm" ( _
    ByVal hms As LongPtr, _
    ByVal pmh As LongPtr, _
    ByVal cbmh As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

midiStreamOut = ctypes.windll.winmm.midiStreamOut
midiStreamOut.restype = wintypes.DWORD
midiStreamOut.argtypes = [
    wintypes.HANDLE,  # hms : HMIDISTRM
    ctypes.c_void_p,  # pmh : MIDIHDR* out
    wintypes.DWORD,  # cbmh : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiStreamOut = Fiddle::Function.new(
  lib['midiStreamOut'],
  [
    Fiddle::TYPE_VOIDP,  # hms : HMIDISTRM
    Fiddle::TYPE_VOIDP,  # pmh : MIDIHDR* out
    -Fiddle::TYPE_INT,  # cbmh : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn midiStreamOut(
        hms: *mut core::ffi::c_void,  // HMIDISTRM
        pmh: *mut MIDIHDR,  // MIDIHDR* out
        cbmh: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint midiStreamOut(IntPtr hms, IntPtr pmh, uint cbmh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiStreamOut' -Namespace Win32 -PassThru
# $api::midiStreamOut(hms, pmh, cbmh)

#uselib "WINMM.dll"
#func global midiStreamOut "midiStreamOut" sptr, sptr, sptr
; midiStreamOut hms, varptr(pmh), cbmh   ; 戻り値は stat
; hms : HMIDISTRM -> "sptr"
; pmh : MIDIHDR* out -> "sptr"
; cbmh : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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