Win32 API 日本語リファレンス
ホームUI.Input.XboxController › XInputGetAudioDeviceIds

XInputGetAudioDeviceIds

関数
Xboxコントローラーの音声入出力デバイスIDを取得する。
DLLxinput1_4.dll呼出規約winapi

シグネチャ

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

DWORD XInputGetAudioDeviceIds(
    DWORD dwUserIndex,
    LPWSTR pRenderDeviceId,   // optional
    DWORD* pRenderCount,   // optional
    LPWSTR pCaptureDeviceId,   // optional
    DWORD* pCaptureCount   // optional
);

パラメーター

名前方向説明
dwUserIndexDWORDin対象コントローラーのインデックス(0〜3)を指定する。
pRenderDeviceIdLPWSTRoutoptional再生(ヘッドセット出力)デバイスIDを受け取るバッファへのポインタ。NULL可。
pRenderCountDWORD*inoutoptional入力時はバッファ容量、出力時は文字数を表すDWORDへのポインタ。
pCaptureDeviceIdLPWSTRoutoptional録音(マイク入力)デバイスIDを受け取るバッファへのポインタ。NULL可。
pCaptureCountDWORD*inoutoptional入力時はバッファ容量、出力時は文字数を表すDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD XInputGetAudioDeviceIds(
    DWORD dwUserIndex,
    LPWSTR pRenderDeviceId,   // optional
    DWORD* pRenderCount,   // optional
    LPWSTR pCaptureDeviceId,   // optional
    DWORD* pCaptureCount   // optional
);
[DllImport("xinput1_4.dll", ExactSpelling = true)]
static extern uint XInputGetAudioDeviceIds(
    uint dwUserIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pRenderDeviceId,   // LPWSTR optional, out
    IntPtr pRenderCount,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pCaptureDeviceId,   // LPWSTR optional, out
    IntPtr pCaptureCount   // DWORD* optional, in/out
);
<DllImport("xinput1_4.dll", ExactSpelling:=True)>
Public Shared Function XInputGetAudioDeviceIds(
    dwUserIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pRenderDeviceId As System.Text.StringBuilder,   ' LPWSTR optional, out
    pRenderCount As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPWStr)> pCaptureDeviceId As System.Text.StringBuilder,   ' LPWSTR optional, out
    pCaptureCount As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' dwUserIndex : DWORD
' pRenderDeviceId : LPWSTR optional, out
' pRenderCount : DWORD* optional, in/out
' pCaptureDeviceId : LPWSTR optional, out
' pCaptureCount : DWORD* optional, in/out
Declare PtrSafe Function XInputGetAudioDeviceIds Lib "xinput1_4" ( _
    ByVal dwUserIndex As Long, _
    ByVal pRenderDeviceId As LongPtr, _
    ByVal pRenderCount As LongPtr, _
    ByVal pCaptureDeviceId As LongPtr, _
    ByVal pCaptureCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

XInputGetAudioDeviceIds = ctypes.windll.xinput1_4.XInputGetAudioDeviceIds
XInputGetAudioDeviceIds.restype = wintypes.DWORD
XInputGetAudioDeviceIds.argtypes = [
    wintypes.DWORD,  # dwUserIndex : DWORD
    wintypes.LPWSTR,  # pRenderDeviceId : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pRenderCount : DWORD* optional, in/out
    wintypes.LPWSTR,  # pCaptureDeviceId : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pCaptureCount : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	xinput1_4 = windows.NewLazySystemDLL("xinput1_4.dll")
	procXInputGetAudioDeviceIds = xinput1_4.NewProc("XInputGetAudioDeviceIds")
)

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

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

typedef XInputGetAudioDeviceIdsNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
typedef XInputGetAudioDeviceIdsDart = int Function(int, Pointer<Utf16>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
final XInputGetAudioDeviceIds = DynamicLibrary.open('xinput1_4.dll')
    .lookupFunction<XInputGetAudioDeviceIdsNative, XInputGetAudioDeviceIdsDart>('XInputGetAudioDeviceIds');
// dwUserIndex : DWORD -> Uint32
// pRenderDeviceId : LPWSTR optional, out -> Pointer<Utf16>
// pRenderCount : DWORD* optional, in/out -> Pointer<Uint32>
// pCaptureDeviceId : LPWSTR optional, out -> Pointer<Utf16>
// pCaptureCount : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function XInputGetAudioDeviceIds(
  dwUserIndex: DWORD;   // DWORD
  pRenderDeviceId: PWideChar;   // LPWSTR optional, out
  pRenderCount: Pointer;   // DWORD* optional, in/out
  pCaptureDeviceId: PWideChar;   // LPWSTR optional, out
  pCaptureCount: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'xinput1_4.dll' name 'XInputGetAudioDeviceIds';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "XInputGetAudioDeviceIds"
  c_XInputGetAudioDeviceIds :: Word32 -> CWString -> Ptr Word32 -> CWString -> Ptr Word32 -> IO Word32
-- dwUserIndex : DWORD -> Word32
-- pRenderDeviceId : LPWSTR optional, out -> CWString
-- pRenderCount : DWORD* optional, in/out -> Ptr Word32
-- pCaptureDeviceId : LPWSTR optional, out -> CWString
-- pCaptureCount : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let xinputgetaudiodeviceids =
  foreign "XInputGetAudioDeviceIds"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* dwUserIndex : DWORD -> uint32_t *)
(* pRenderDeviceId : LPWSTR optional, out -> (ptr uint16_t) *)
(* pRenderCount : DWORD* optional, in/out -> (ptr uint32_t) *)
(* pCaptureDeviceId : LPWSTR optional, out -> (ptr uint16_t) *)
(* pCaptureCount : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library xinput1_4 (t "xinput1_4.dll"))
(cffi:use-foreign-library xinput1_4)

(cffi:defcfun ("XInputGetAudioDeviceIds" xinput-get-audio-device-ids :convention :stdcall) :uint32
  (dw-user-index :uint32)   ; DWORD
  (p-render-device-id :pointer)   ; LPWSTR optional, out
  (p-render-count :pointer)   ; DWORD* optional, in/out
  (p-capture-device-id :pointer)   ; LPWSTR optional, out
  (p-capture-count :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $XInputGetAudioDeviceIds = Win32::API::More->new('xinput1_4',
    'DWORD XInputGetAudioDeviceIds(DWORD dwUserIndex, LPWSTR pRenderDeviceId, LPVOID pRenderCount, LPWSTR pCaptureDeviceId, LPVOID pCaptureCount)');
# my $ret = $XInputGetAudioDeviceIds->Call($dwUserIndex, $pRenderDeviceId, $pRenderCount, $pCaptureDeviceId, $pCaptureCount);
# dwUserIndex : DWORD -> DWORD
# pRenderDeviceId : LPWSTR optional, out -> LPWSTR
# pRenderCount : DWORD* optional, in/out -> LPVOID
# pCaptureDeviceId : LPWSTR optional, out -> LPWSTR
# pCaptureCount : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。