Bus Class

Members

---

void setPaused ( int paused ) #

Sets the pause state for the bus.

Arguments

• int paused - 1 to pause the bus, 0 to unpause it.

int isPaused ( ) #

Returns the pause state.

Return value

1 if the bus is paused, otherwise, 0.

void setVolume ( float volume ) #

Sets the volume level.

Arguments

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

float getVolume ( ) #

Returns the current volume level.

Return value

Volume level.

void setMuted ( int muted ) #

Sets the mute state.

Arguments

• int muted - 1to mute the bus, 0 to unmute it.

int isMuted ( ) #

Returns the mute state.

Return value

1 if the bus is muted, otherwise, 0.

void stopAllEvents ( ) #

Stops all event instances that are routed into the bus.

void release ( ) #

Releases the bus object.

String getPath ( ) #

Returns the bus object's path.

Return value

Object's path.

int isValid ( ) #

Returns a value indicating if the bus reference is valid.

Return value

1 if the bus reference is valid, otherwise, 0.

ChannelGroup getChannelGroup ( ) #

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.