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

SpatialAudioHrtfActivationParams2

構造体
サイズx64: 76 バイト / x86: 48 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
ObjectFormatWAVEFORMATEX*8/4+0+0ストリームに関連付けられる空間オーディオオブジェクトのフォーマット記述子です。すべてのオブジェクトは同じフォーマットでなければならず、WAVEFORMATEX 型または WAVEFORMATEXTENSIBLE 型でなければなりません。
StaticObjectTypeMaskAudioObjectType4+8+4アクティブ化されたストリームで許可される静的な空間オーディオチャンネルのセットを示す、AudioObjectType 値のビット単位の組み合わせです。
MinDynamicObjectCountDWORD4+12+8同時に使用する動的オブジェクトの最小数です。この数の動的オーディオオブジェクトを同時にアクティブ化できない場合、動的オーディオオブジェクトは 1 つもアクティブ化されません。
MaxDynamicObjectCountDWORD4+16+12ISpatialAudioRenderStreamForHrtf で同時にアクティブ化できる動的オブジェクトの最大数です。
CategoryAUDIO_STREAM_CATEGORY4+20+16オーディオストリームおよびその空間オーディオオブジェクトのカテゴリです。
EventHandleHANDLE8/4+24+20さらにオーディオデータを提供するようクライアントに通知するイベントです。このハンドルは、使用される前に内部で複製されます。
NotifyObjectISpatialAudioObjectRenderStreamNotify*8/4+32+24ISpatialAudioRenderStreamForHrtf の状態変化に空間オーディオクライアントが対応できるよう、通知を提供するオブジェクトです。このオブジェクトは、同時にアクティブ化できる動的な空間オーディオオブジェクトの数が変更されようとしていることをクライアントに通知するために使用されます。
DistanceDecaySpatialAudioHrtfDistanceDecay*8/4+40+28ストリームに関連付けられた ISpatialAudioObjectForHrtf オブジェクトに使用される減衰モデルの既定値です (省略可能)。使用しない場合は nullptr を指定します。
DirectivitySpatialAudioHrtfDirectivityUnion*8/4+48+32ストリームに関連付けられた ISpatialAudioObjectForHrtf オブジェクトに使用される空間オーディオの指向性モデルの既定値です (省略可能)。使用しない場合は nullptr を指定します。
EnvironmentSpatialAudioHrtfEnvironmentType*8/4+56+36ストリームに関連付けられた ISpatialAudioObjectForHrtf オブジェクトのオーディオ処理時にシミュレートされる環境の種類の既定値です (省略可能)。使用しない場合は nullptr を指定します。
OrientationFLOAT*8/4+64+40ストリームに関連付けられた ISpatialAudioObjectForHrtf オブジェクトの向きの既定値です (省略可能)。使用しない場合は nullptr を指定します。
OptionsSPATIAL_AUDIO_STREAM_OPTIONS4+72+44xref:NE:spatialaudioclient.SPATIAL_AUDIO_STREAM_OPTIONS 列挙型のメンバーで、アクティブ化されるオーディオストリームのオプションを指定します。

公式ドキュメント

空間オーディオレンダーストリームのアクティブ化パラメーターを表します。xref:NS:spatialaudiohrtf.SpatialAudioHrtfActivationParams を拡張し、ストリームオプションを指定できるようにしたものです。

解説(Remarks)

次の例は、ストリームオプションを指定して HRTF 用の空間オーディオレンダーストリームをアクティブ化する方法を示しています。

void CreateSpatialAudioObjectRenderStreamForHrtf(
    _In_ ISpatialAudioClient2* spatialAudioClient,
    _In_ WAVEFORMATEX const* objectFormat,
    AudioObjectType staticObjectTypeMask,
    UINT32 minDynamicObjectCount,
    UINT32 maxDynamicObjectCount,
    AUDIO_STREAM_CATEGORY streamCategory,
    _In_ HANDLE eventHandle,
    _In_opt_ ISpatialAudioObjectRenderStreamNotify* notifyObject,
    _In_opt_ SpatialAudioHrtfDistanceDecay* distanceDecay,
    _In_opt_ SpatialAudioHrtfDirectivityUnion* directivity,
    _In_opt_ SpatialAudioHrtfEnvironmentType* environment,
    _In_opt_ SpatialAudioHrtfOrientation* orientation,
    bool enableOffload,
    _COM_Outptr_ ISpatialAudioObjectRenderStreamForHrtf** stream)
{
    SpatialAudioHrtfActivationParams2 streamActivationParams =
    {
        objectFormat,
        staticObjectTypeMask,
        minDynamicObjectCount,
        maxDynamicObjectCount,
        streamCategory,
        eventHandle,
        notifyObject,
        distanceDecay,
        directivity,
        environment,
        orientation,
        enableOffload ? SPATIAL_AUDIO_STREAM_OPTIONS_OFFLOAD : SPATIAL_AUDIO_STREAM_OPTIONS_NONE
    };

    PROPVARIANT activateParamsPropVariant = {};
    activateParamsPropVariant.vt = VT_BLOB;
    activateParamsPropVariant.blob.cbSize = sizeof(streamActivationParams);
    activateParamsPropVariant.blob.pBlobData = reinterpret_cast<BYTE*>(&streamActivationParams);

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

各言語での定義

#include <windows.h>

// SpatialAudioHrtfActivationParams2  (x64 76 / x86 48 バイト)
#pragma pack(push, 1)
typedef struct SpatialAudioHrtfActivationParams2 {
    WAVEFORMATEX* ObjectFormat;
    AudioObjectType StaticObjectTypeMask;
    DWORD MinDynamicObjectCount;
    DWORD MaxDynamicObjectCount;
    AUDIO_STREAM_CATEGORY Category;
    HANDLE EventHandle;
    ISpatialAudioObjectRenderStreamNotify* NotifyObject;
    SpatialAudioHrtfDistanceDecay* DistanceDecay;
    SpatialAudioHrtfDirectivityUnion* Directivity;
    SpatialAudioHrtfEnvironmentType* Environment;
    FLOAT* Orientation;
    SPATIAL_AUDIO_STREAM_OPTIONS Options;
} SpatialAudioHrtfActivationParams2;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SpatialAudioHrtfActivationParams2
{
    public IntPtr ObjectFormat;
    public int StaticObjectTypeMask;
    public uint MinDynamicObjectCount;
    public uint MaxDynamicObjectCount;
    public int Category;
    public IntPtr EventHandle;
    public IntPtr NotifyObject;
    public IntPtr DistanceDecay;
    public IntPtr Directivity;
    public IntPtr Environment;
    public IntPtr Orientation;
    public int Options;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SpatialAudioHrtfActivationParams2
    Public ObjectFormat As IntPtr
    Public StaticObjectTypeMask As Integer
    Public MinDynamicObjectCount As UInteger
    Public MaxDynamicObjectCount As UInteger
    Public Category As Integer
    Public EventHandle As IntPtr
    Public NotifyObject As IntPtr
    Public DistanceDecay As IntPtr
    Public Directivity As IntPtr
    Public Environment As IntPtr
    Public Orientation As IntPtr
    Public Options As Integer
End Structure
import ctypes
from ctypes import wintypes

class SpatialAudioHrtfActivationParams2(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("ObjectFormat", ctypes.c_void_p),
        ("StaticObjectTypeMask", ctypes.c_int),
        ("MinDynamicObjectCount", wintypes.DWORD),
        ("MaxDynamicObjectCount", wintypes.DWORD),
        ("Category", ctypes.c_int),
        ("EventHandle", ctypes.c_void_p),
        ("NotifyObject", ctypes.c_void_p),
        ("DistanceDecay", ctypes.c_void_p),
        ("Directivity", ctypes.c_void_p),
        ("Environment", ctypes.c_void_p),
        ("Orientation", ctypes.c_void_p),
        ("Options", ctypes.c_int),
    ]
#[repr(C, packed(1))]
pub struct SpatialAudioHrtfActivationParams2 {
    pub ObjectFormat: *mut core::ffi::c_void,
    pub StaticObjectTypeMask: i32,
    pub MinDynamicObjectCount: u32,
    pub MaxDynamicObjectCount: u32,
    pub Category: i32,
    pub EventHandle: *mut core::ffi::c_void,
    pub NotifyObject: *mut core::ffi::c_void,
    pub DistanceDecay: *mut core::ffi::c_void,
    pub Directivity: *mut core::ffi::c_void,
    pub Environment: *mut core::ffi::c_void,
    pub Orientation: *mut core::ffi::c_void,
    pub Options: i32,
}
import "golang.org/x/sys/windows"

type SpatialAudioHrtfActivationParams2 struct {
	ObjectFormat uintptr
	StaticObjectTypeMask int32
	MinDynamicObjectCount uint32
	MaxDynamicObjectCount uint32
	Category int32
	EventHandle uintptr
	NotifyObject uintptr
	DistanceDecay uintptr
	Directivity uintptr
	Environment uintptr
	Orientation uintptr
	Options int32
}
type
  SpatialAudioHrtfActivationParams2 = packed record
    ObjectFormat: Pointer;
    StaticObjectTypeMask: Integer;
    MinDynamicObjectCount: DWORD;
    MaxDynamicObjectCount: DWORD;
    Category: Integer;
    EventHandle: Pointer;
    NotifyObject: Pointer;
    DistanceDecay: Pointer;
    Directivity: Pointer;
    Environment: Pointer;
    Orientation: Pointer;
    Options: Integer;
  end;
const SpatialAudioHrtfActivationParams2 = extern struct {
    ObjectFormat: ?*anyopaque,
    StaticObjectTypeMask: i32,
    MinDynamicObjectCount: u32,
    MaxDynamicObjectCount: u32,
    Category: i32,
    EventHandle: ?*anyopaque,
    NotifyObject: ?*anyopaque,
    DistanceDecay: ?*anyopaque,
    Directivity: ?*anyopaque,
    Environment: ?*anyopaque,
    Orientation: ?*anyopaque,
    Options: i32,
};
type
  SpatialAudioHrtfActivationParams2 {.packed.} = object
    ObjectFormat: pointer
    StaticObjectTypeMask: int32
    MinDynamicObjectCount: uint32
    MaxDynamicObjectCount: uint32
    Category: int32
    EventHandle: pointer
    NotifyObject: pointer
    DistanceDecay: pointer
    Directivity: pointer
    Environment: pointer
    Orientation: pointer
    Options: int32
align(1)
struct SpatialAudioHrtfActivationParams2
{
    void* ObjectFormat;
    int StaticObjectTypeMask;
    uint MinDynamicObjectCount;
    uint MaxDynamicObjectCount;
    int Category;
    void* EventHandle;
    void* NotifyObject;
    void* DistanceDecay;
    void* Directivity;
    void* Environment;
    void* Orientation;
    int Options;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SpatialAudioHrtfActivationParams2 サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; ObjectFormat : WAVEFORMATEX* (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; StaticObjectTypeMask : AudioObjectType (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; MinDynamicObjectCount : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; MaxDynamicObjectCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; Category : AUDIO_STREAM_CATEGORY (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; EventHandle : HANDLE (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; NotifyObject : ISpatialAudioObjectRenderStreamNotify* (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; DistanceDecay : SpatialAudioHrtfDistanceDecay* (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; Directivity : SpatialAudioHrtfDirectivityUnion* (+32, 4byte)  varptr(st)+32 を基点に操作(4byte:入れ子/配列)
; Environment : SpatialAudioHrtfEnvironmentType* (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; Orientation : FLOAT* (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Options : SPATIAL_AUDIO_STREAM_OPTIONS (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SpatialAudioHrtfActivationParams2 サイズ: 76 バイト(x64)
dim st, 19    ; 4byte整数×19(構造体サイズ 76 / 4 切り上げ)
; ObjectFormat : WAVEFORMATEX* (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; StaticObjectTypeMask : AudioObjectType (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; MinDynamicObjectCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; MaxDynamicObjectCount : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; Category : AUDIO_STREAM_CATEGORY (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; EventHandle : HANDLE (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; NotifyObject : ISpatialAudioObjectRenderStreamNotify* (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; DistanceDecay : SpatialAudioHrtfDistanceDecay* (+40, 8byte)  varptr(st)+40 を基点に操作(8byte:入れ子/配列)
; Directivity : SpatialAudioHrtfDirectivityUnion* (+48, 8byte)  varptr(st)+48 を基点に操作(8byte:入れ子/配列)
; Environment : SpatialAudioHrtfEnvironmentType* (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; Orientation : FLOAT* (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; Options : SPATIAL_AUDIO_STREAM_OPTIONS (+72, 4byte)  st.18 = 値  /  値 = st.18   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SpatialAudioHrtfActivationParams2, pack=1
    #field intptr ObjectFormat
    #field int StaticObjectTypeMask
    #field int MinDynamicObjectCount
    #field int MaxDynamicObjectCount
    #field int Category
    #field intptr EventHandle
    #field intptr NotifyObject
    #field intptr DistanceDecay
    #field intptr Directivity
    #field intptr Environment
    #field intptr Orientation
    #field int Options
#endstruct

stdim st, SpatialAudioHrtfActivationParams2        ; NSTRUCT 変数を確保
st->StaticObjectTypeMask = 100
mes "StaticObjectTypeMask=" + st->StaticObjectTypeMask