This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
VR Development
Double Precision Coordinates
API
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Plugins::FMOD::Bus Class

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

Represents a global mixer bus.

Bus Class

Members


void setPaused ( bool paused ) #

Sets the pause state for the bus.

Arguments

  • bool paused - true to pause the bus, false to unpause it.

bool isPaused ( ) const#

Returns the pause state.

Return value

true if the bus is paused, otherwise, false.

void setVolume ( float volume ) #

Sets the volume level.

Arguments

  • float volume - Volume level in range [-inf; inf].

float getVolume ( ) const#

Returns the current volume level.

Return value

Volume level.

void setMuted ( bool muted ) #

Sets the mute state.

Arguments

  • bool muted - trueto mute the bus, false to unmute it.

bool isMuted ( ) const#

Returns the mute state.

Return value

true if the bus is muted, otherwise, false.

void stopAllEvents ( ) #

Stops all event instances that are routed into the bus.

void release ( ) #

Releases the bus object.

String getPath ( ) const#

Returns the bus object's path.

Return value

Object's path.

bool isValid ( ) const#

Returns a value indicating if the bus reference is valid.

Return value

true if the bus reference is valid, otherwise, false.

ChannelGroup * getChannelGroup ( ) const#

Returns the core ChannelGroup. By default the ChannelGroup will only exist when it is needed. If the ChannelGroup does not exist, this function will return ERR_STUDIO_NOT_LOADED.

Return value

The core ChannelGroup.

void lockChannelGroup ( ) #

Locks the core ChannelGroup. This function forces the system to create the ChannelGroup and keep it available until unlockChannelGroup is called.

void unlockChannelGroup ( ) #

Unlocks the core ChannelGroup. This function allows the system to destroy the ChannelGroup when it is not needed.
Last update: 2023-12-19
Build: ()