XACT_RUNTIME_PARAMETERS

Runtime parameters for initialization of the XACT engine.

typedef struct XACT_RUNTIME_PARAMETERS {
    DWORD lookAheadTime;
    void *pGlobalSettingsBuffer;
    DWORD globalSettingsBufferSize;
    DWORD globalSettingsFlags;
    DWORD globalSettingsAllocAttributes;
    XACT_FILEIO_CALLBACKS fileIOCallbacks;
    XACT_NOTIFICATION_CALLBACK fnNotificationCallback;
    PWSTR pRendererID;
} XACT_RUNTIME_PARAMETERS, *LPXACT_RUNTIME_PARAMETERS;

typedef const XACT_RUNTIME_PARAMETERS *LPCXACT_RUNTIME_PARAMETERS;

Members

lookAheadTime

Interactive audio and branch event look-ahead time, in milliseconds. This specifies how far ahead the XACT engine will look ahead when determining when to transition to another sound. XACT_ENGINE_LOOKAHEAD_DEFAULT is a good default value to use for this member.

pGlobalSettingsBuffer

Buffer containing the global file data. This file is generated when you build an XACT project file. It contains category, variable, and RPC information.

Xbox 360:  Memory for this member must be allocated using XMemAlloc when specifying the XACT_FLAG_API_CREATE_MANAGEDATA flag.

Windows:  Memory for this member must be allocated using CoTaskMemAlloc when specifying the XACT_FLAG_API_CREATE_MANAGEDATA flag.

globalSettingsBufferSize

Size of the data buffer associated with pGlobalSettingsBuffer.

globalSettingsFlags

Flag values indicating how global file data should be handled by XACT. This member can be zero or the value shown in the following table.

Value	Description
XACT_FLAG_API_CREATE_MANAGEDATA	Indicates that XACT should free the buffer pointed to by pGlobalSettingsBuffer when initialization is complete. Note    XACT will not attempt to free the memory if the buffer allocation fails.

globalSettingsAllocAttributes

Flag values that indicate the attributes of the memory buffer pointed to by pGlobalSettingsBuffer.

Xbox 360:  This member is needed only if XACT_FLAG_API_CREATE_MANAGEDATA is specified in globalSettingsFlags, so that XMemFree can receive the correct values when XACT frees the buffer. Otherwise, globalSettingsAllocAttributes is ignored.

These flags should match the XALLOC_ATTRIBUTES values that were specified to XMemAlloc when the memory buffer pointed to by pGlobalSettingsBuffer was allocated.

Windows:  This parameter has no relevance and is ignored.

fileIOCallbacks

File I/O callbacks.

fnNotificationCallback

Callback that receives notifications.

pRendererID

Pointer to the ID for the audio renderer the engine should connect to.

Xbox 360:  This parameter is undefined.

Requirements

Header: Declared in Xact.h.

See Also

XACT Structures, IXACTEngine::Initialize