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

SpatialAudioObjectRenderStreamForMetadataActivationParams2

構造体
サイズx64: 72 バイト / x86: 56 バイトパッキング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同時に使用する動的オブジェクトの最小数です。この数の動的オーディオ オブジェクトを同時にアクティブ化できない場合、ISpatialAudioClient::ActivateSpatialAudioStream はエラー SPTLAUDCLNT_E_NO_MORE_OBJECTS で失敗します。
MaxDynamicObjectCountDWORD4+16+12ISpatialAudioObjectRenderStream でアクティブ化できる、同時に使用する動的オブジェクトの最大数です。
CategoryAUDIO_STREAM_CATEGORY4+20+16オーディオ ストリームおよびその空間オーディオ オブジェクトのカテゴリです。
EventHandleHANDLE8/4+24+20さらにオーディオ データを提供するようクライアントに通知するイベントです。このハンドルは、使用される前に内部で複製されます。
MetadataFormatIdGUID16+32+24現在アクティブな空間レンダリング エンジンにおけるメタデータ フォーマットの識別子です。
MaxMetadataItemCountDWORD4+48+401 フレームあたりのメタデータ項目の最大数です。
MetadataActivationParamsPROPVARIANT*8/4+52+44追加のアクティブ化パラメーターです。
NotifyObjectISpatialAudioObjectRenderStreamNotify*8/4+60+48ISpatialAudioObjectRenderStream の状態の変化に空間オーディオ クライアントが対応できるよう、通知を提供するオブジェクトです。このオブジェクトは、同時にアクティブ化できる動的な空間オーディオ オブジェクトの数が変化しようとしていることをクライアントに通知するために使用されます。
OptionsSPATIAL_AUDIO_STREAM_OPTIONS4+68+52xref:NE:spatialaudioclient.SPATIAL_AUDIO_STREAM_OPTIONS 列挙型のメンバーで、アクティブ化されるオーディオ ストリームのオプションを指定します。

公式ドキュメント

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

解説(Remarks)

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

void CreateSpatialAudioObjectRenderStreamForMetadata(
    _In_ ISpatialAudioClient2* spatialAudioClient,
    _In_ WAVEFORMATEX const* objectFormat,
    AudioObjectType staticObjectTypeMask,
    UINT32 minDynamicObjectCount,
    UINT32 maxDynamicObjectCount,
    AUDIO_STREAM_CATEGORY streamCategory,
    _In_ HANDLE eventHandle,
    REFGUID metadataFormatId,
    UINT32 maxMetadataItemCount,
    _In_opt_ PROPVARIANT const* metadataActivationParams,
    _In_opt_ ISpatialAudioObjectRenderStreamNotify* notifyObject,
    bool enableOffload,
    _COM_Outptr_ ISpatialAudioObjectRenderStreamForMetadata** stream)
{
    SpatialAudioObjectRenderStreamForMetadataActivationParams2 streamActivationParams =
    {
        objectFormat,
        staticObjectTypeMask,
        minDynamicObjectCount,
        maxDynamicObjectCount,
        streamCategory,
        eventHandle,
        metadataFormatId,
        maxMetadataItemCount,
        metadataActivationParams,
        notifyObject,
        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>

// SpatialAudioObjectRenderStreamForMetadataActivationParams2  (x64 72 / x86 56 バイト)
#pragma pack(push, 1)
typedef struct SpatialAudioObjectRenderStreamForMetadataActivationParams2 {
    WAVEFORMATEX* ObjectFormat;
    AudioObjectType StaticObjectTypeMask;
    DWORD MinDynamicObjectCount;
    DWORD MaxDynamicObjectCount;
    AUDIO_STREAM_CATEGORY Category;
    HANDLE EventHandle;
    GUID MetadataFormatId;
    DWORD MaxMetadataItemCount;
    PROPVARIANT* MetadataActivationParams;
    ISpatialAudioObjectRenderStreamNotify* NotifyObject;
    SPATIAL_AUDIO_STREAM_OPTIONS Options;
} SpatialAudioObjectRenderStreamForMetadataActivationParams2;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SpatialAudioObjectRenderStreamForMetadataActivationParams2
{
    public IntPtr ObjectFormat;
    public int StaticObjectTypeMask;
    public uint MinDynamicObjectCount;
    public uint MaxDynamicObjectCount;
    public int Category;
    public IntPtr EventHandle;
    public Guid MetadataFormatId;
    public uint MaxMetadataItemCount;
    public IntPtr MetadataActivationParams;
    public IntPtr NotifyObject;
    public int Options;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SpatialAudioObjectRenderStreamForMetadataActivationParams2
    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 MetadataFormatId As Guid
    Public MaxMetadataItemCount As UInteger
    Public MetadataActivationParams As IntPtr
    Public NotifyObject As IntPtr
    Public Options As Integer
End Structure
import ctypes
from ctypes import wintypes

class SpatialAudioObjectRenderStreamForMetadataActivationParams2(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),
        ("MetadataFormatId", GUID),
        ("MaxMetadataItemCount", wintypes.DWORD),
        ("MetadataActivationParams", ctypes.c_void_p),
        ("NotifyObject", ctypes.c_void_p),
        ("Options", ctypes.c_int),
    ]
#[repr(C, packed(1))]
pub struct SpatialAudioObjectRenderStreamForMetadataActivationParams2 {
    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 MetadataFormatId: GUID,
    pub MaxMetadataItemCount: u32,
    pub MetadataActivationParams: *mut core::ffi::c_void,
    pub NotifyObject: *mut core::ffi::c_void,
    pub Options: i32,
}
import "golang.org/x/sys/windows"

type SpatialAudioObjectRenderStreamForMetadataActivationParams2 struct {
	ObjectFormat uintptr
	StaticObjectTypeMask int32
	MinDynamicObjectCount uint32
	MaxDynamicObjectCount uint32
	Category int32
	EventHandle uintptr
	MetadataFormatId windows.GUID
	MaxMetadataItemCount uint32
	MetadataActivationParams uintptr
	NotifyObject uintptr
	Options int32
}
type
  SpatialAudioObjectRenderStreamForMetadataActivationParams2 = packed record
    ObjectFormat: Pointer;
    StaticObjectTypeMask: Integer;
    MinDynamicObjectCount: DWORD;
    MaxDynamicObjectCount: DWORD;
    Category: Integer;
    EventHandle: Pointer;
    MetadataFormatId: TGUID;
    MaxMetadataItemCount: DWORD;
    MetadataActivationParams: Pointer;
    NotifyObject: Pointer;
    Options: Integer;
  end;
const SpatialAudioObjectRenderStreamForMetadataActivationParams2 = extern struct {
    ObjectFormat: ?*anyopaque,
    StaticObjectTypeMask: i32,
    MinDynamicObjectCount: u32,
    MaxDynamicObjectCount: u32,
    Category: i32,
    EventHandle: ?*anyopaque,
    MetadataFormatId: GUID,
    MaxMetadataItemCount: u32,
    MetadataActivationParams: ?*anyopaque,
    NotifyObject: ?*anyopaque,
    Options: i32,
};
type
  SpatialAudioObjectRenderStreamForMetadataActivationParams2 {.packed.} = object
    ObjectFormat: pointer
    StaticObjectTypeMask: int32
    MinDynamicObjectCount: uint32
    MaxDynamicObjectCount: uint32
    Category: int32
    EventHandle: pointer
    MetadataFormatId: GUID
    MaxMetadataItemCount: uint32
    MetadataActivationParams: pointer
    NotifyObject: pointer
    Options: int32
align(1)
struct SpatialAudioObjectRenderStreamForMetadataActivationParams2
{
    void* ObjectFormat;
    int StaticObjectTypeMask;
    uint MinDynamicObjectCount;
    uint MaxDynamicObjectCount;
    int Category;
    void* EventHandle;
    GUID MetadataFormatId;
    uint MaxMetadataItemCount;
    void* MetadataActivationParams;
    void* NotifyObject;
    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 レイアウト)
; SpatialAudioObjectRenderStreamForMetadataActivationParams2 サイズ: 56 バイト(x86)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 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 も可)
; MetadataFormatId : GUID (+24, 16byte)  varptr(st)+24 を基点に操作(16byte:入れ子/配列)
; MaxMetadataItemCount : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; MetadataActivationParams : PROPVARIANT* (+44, 4byte)  varptr(st)+44 を基点に操作(4byte:入れ子/配列)
; NotifyObject : ISpatialAudioObjectRenderStreamNotify* (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; Options : SPATIAL_AUDIO_STREAM_OPTIONS (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SpatialAudioObjectRenderStreamForMetadataActivationParams2 サイズ: 72 バイト(x64)
dim st, 18    ; 4byte整数×18(構造体サイズ 72 / 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,上位
; MetadataFormatId : GUID (+32, 16byte)  varptr(st)+32 を基点に操作(16byte:入れ子/配列)
; MaxMetadataItemCount : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; MetadataActivationParams : PROPVARIANT* (+52, 8byte)  varptr(st)+52 を基点に操作(8byte:入れ子/配列)
; NotifyObject : ISpatialAudioObjectRenderStreamNotify* (+60, 8byte)  qpoke st,60,値 / qpeek(st,60)  ※IronHSPのみ。3.7/3.8は lpoke st,60,下位 : lpoke st,64,上位
; Options : SPATIAL_AUDIO_STREAM_OPTIONS (+68, 4byte)  st.17 = 値  /  値 = st.17   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global SpatialAudioObjectRenderStreamForMetadataActivationParams2, pack=1
    #field intptr ObjectFormat
    #field int StaticObjectTypeMask
    #field int MinDynamicObjectCount
    #field int MaxDynamicObjectCount
    #field int Category
    #field intptr EventHandle
    #field GUID MetadataFormatId
    #field int MaxMetadataItemCount
    #field intptr MetadataActivationParams
    #field intptr NotifyObject
    #field int Options
#endstruct

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