This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
专业(SIM)
UnigineEditor
界面概述
资产工作流程
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
双精度坐标
应用程序接口
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
创建内容
内容优化
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Plugins::FMOD::FMODStudio Class

Header: #include <plugins/UnigineFMOD.h>
Notice
This set of functions is available when the FMOD plugin is loaded.

This class is intended to interact with the data driven projects created via FMOD Studio at run time.

FMODStudio Class

Members


Bank * loadBank ( const char * path ) #

Loads a bank at a given path.

Arguments

  • const char * path - Path to the bank file.

Return value

Bank object.

VCA * getVCA ( const char * path ) #

Auxiliary function, not to be used.

Arguments

  • const char * path

Bus * getBus ( const char * path ) #

Auxiliary function, not to be used.

Arguments

  • const char * path

EventInstance * getEvent ( const char * path ) #

Returns the EventInstance object at a given path.

Arguments

  • const char * path - Path of the EventInstance.

Return value

EventInstance object.

EventDescription * getEventDescription ( const char * path ) #

Auxiliary function, not to be used.

Arguments

  • const char * path

void setListener3DAttributes ( int listener, const Math::Vec3 & position, const Math::Vec3 & up, const Math::Vec3 & forward, const Math::Vec3 & velocity ) #

Sets the 3D attributes of the listener. Vectors must be provided in the correct handedness.

Arguments

  • int listener - Listener index.
  • const Math::Vec3 & position - Position in world space used for panning and attenuation.
  • const Math::Vec3 & up - Upwards orientation, must be of unit length (1.0) and perpendicular to forward.
  • const Math::Vec3 & forward - Forwards orientation, must be of unit length (1.0) and perpendicular to up.
  • const Math::Vec3 & velocity - Velocity in world space used for doppler.

void getListener3DAttributes ( int listener, Math::Vec3 & position, Math::Vec3 & up, Math::Vec3 & forward, Math::Vec3 & velocity ) #

Returns the 3D attributes of the listener.

Arguments

  • int listener - Listener index.
  • Math::Vec3 & position - Position in world space.
  • Math::Vec3 & up - Upwards orientation.
  • Math::Vec3 & forward - Forwards orientation.
  • Math::Vec3 & velocity - Velocity in world space.

void setListenerVelocity ( const Math::Vec3 & velocity ) #

Sets the velocity of the listener.

Arguments

  • const Math::Vec3 & velocity - Velocity in world space.

void setListenerTransform ( const Math::Mat4& transform ) #

Sets the transformation matrix of the listener. Currently the listener only works with the standard camera.

Arguments

  • const Math::Mat4& transform - Transformation matrix.

void setParentForListener ( const Ptr<Node> & parent ) #

Sets a parent node for the listener.

Arguments

  • const Ptr<Node> & parent - Node to be set as a parent.

void useStudioLiveUpdateFlag ( ) #

Enables live update.

void useStudioSyncUpdateFlag ( ) #

Disables asynchronous processing and perform all processing on the calling thread instead.

void useStudioLoadFromUpdateFlag ( ) #

No additional threads are created for bank and resource loading.

void useCoreStreamFromUpdateFlag ( ) #

No stream thread is created internally. Mainly used with non-realtime outputs.

void update ( ) #

Updates the FMOD system.

void initStudio ( ) #

Studio initialization.

Bank * getBank ( int id ) #

Auxiliary function, not to be used.

Arguments

  • int id

EventDescription * getEventDescription ( int id ) #

Auxiliary function, not to be used.

Arguments

  • int id

Bus * getBus ( int id ) #

Auxiliary function, not to be used.

Arguments

  • int id

VCA * getVCA ( int id ) #

Auxiliary function, not to be used.

Arguments

  • int id

int getBankCount ( ) #

Returns the number of loaded banks.

Return value

Number of banks.

int getEventDescriptionCount ( ) #

Returns the number of event descriptions.

Return value

Event description count.

int getBusCount ( ) #

Returns the number of buses.

Return value

Number of buses.

int getVCACount ( ) #

Returns the number of VCAs.

Return value

VCA count.

FMODStudio::BufferUsage getBufferUsage ( ) #

Returns buffer usage information.

Return value

Buffer usage information.

void resetBufferUsage ( ) #

Resets memory buffer usage statistics.

FMODStudio::CPUUsageTotal getCPUUsageTotal ( ) #

Returns the total amount of CPU used.

Return value

Total CPU usage.

void getMemoryUsage ( int & exclusive, int & inclusive, int & sample_data ) #

Returns memory usage statistics.

Arguments

  • int & exclusive - Size of memory belonging to the bus or event instance.
  • int & inclusive - Size of memory belonging exclusively to the bus or event plus the inclusive memory sizes of all buses and event instances which route into it.
  • int & sample_data - Size of shared sample memory referenced by the bus or event instance, inclusive of all sample memory referenced by all buses and event instances which route into it.

void release ( ) #

Shuts down and frees the Studio System object.

void releaseBuses ( ) #

Releases bus objects.

void releaseVCAs ( ) #

Releases VCA objects.

void releaseEventDescriptions ( ) #

Releases event description objects.

void releaseBanks ( ) #

Releases bank objects.
Last update: 2021-11-30
Build: ()