Unigine::Plugins::FMOD::Bus Class

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.