plAudioTranslationLayer Class Reference

The Audio Translation Layer. More...

#include <AudioTranslationLayer.h>

Public Member Functions
plResult	Startup ()
	Initializes the audio translation layer.
void	Shutdown ()
	Shuts down the audio translation layer.
void	Update ()
	Updates the audio translation layer. This will also trigger an update of the audio middleware.
plAudioSystemDataID	GetTriggerId (plStringView sTriggerName) const
	Returns the ID of a trigger control identified by its name.
plAudioSystemDataID	GetRtpcId (plStringView sRtpcName) const
	Returns the ID of a real-time parameter control identified by its name.
plAudioSystemDataID	GetSwitchStateId (plStringView sSwitchStateName) const
	Returns the ID of a switch state control identified by its name.
plAudioSystemDataID	GetEnvironmentId (plStringView sEnvironmentName) const
	Returns the ID of an environment control identified by its name.

Friends
class	plAudioSystem

Detailed Description

The Audio Translation Layer.

This class is the bridge between the audio system and the audio middleware and it is responsible of the execution of audio requests. It also stores the registered audio controls so they can be retrieved during runtime by their names.

Member Function Documentation

GetEnvironmentId()

plAudioSystemDataID plAudioTranslationLayer::GetEnvironmentId ( plStringView sEnvironmentName ) const

nodiscard

Returns the ID of an environment control identified by its name.

Parameters

sEnvironmentName

The name of the environment control.

Returns

The ID of the environment, or 0 if an environment control with the given name is not registered.

GetRtpcId()

plAudioSystemDataID plAudioTranslationLayer::GetRtpcId ( plStringView sRtpcName ) const

nodiscard

Returns the ID of a real-time parameter control identified by its name.

Parameters

sRtpcName

The name of the RTPC.

Returns

The ID of the RTPC, or 0 if a RTPC with the given name is not registered.

GetSwitchStateId()

plAudioSystemDataID plAudioTranslationLayer::GetSwitchStateId ( plStringView sSwitchStateName ) const

nodiscard

Returns the ID of a switch state control identified by its name.

Parameters

sSwitchStateName

The name of the switch state control.

Returns

The ID of the switch state, or 0 if a switch state control with the given name is not registered.

GetTriggerId()

plAudioSystemDataID plAudioTranslationLayer::GetTriggerId ( plStringView sTriggerName ) const

nodiscard

Returns the ID of a trigger control identified by its name.

Parameters

sTriggerName

The name of the trigger control.

Returns

The ID of the trigger, or 0 if a trigger control with the given name is not registered.

---

The documentation for this class was generated from the following files:

• Code/EnginePlugins/AudioSystem/AudioSystemPlugin/ATL/AudioTranslationLayer.h
• Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Implementation/ATL/AudioTranslationLayer.cpp