A class to help use an audio asset loaded from the file system as AudioClip for the current skin in multiple languages. More...

Inheritance diagram for AudioClipFromFile:

Public Member Functions
override void	Load (string language)

Public Member Functions inherited from AssetFromFile
void	Load (string language)
	Loads the asset from FAST.Application.assets dictionary using `language` and FAST.AssetFromFile.fileName.

Public Attributes
AudioClip	audioClip
	Inspector, Runtime The `AudioClip` that the audio asset is loaded into.

Public Attributes inherited from AssetFromFile
string	baseFileName
	Inspector, Code The name of the asset with the file extension, but without the prefix or suffix.

Protected Member Functions
override void	SetNameWithFileExtension ()
	When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of the `AudioClip` if it is assigned to FAST.AudioClipFromFile.audioClip.

Protected Member Functions inherited from AssetFromFile
virtual void	Awake ()
	When the script is loaded, FAST.AssetFromFile.UpdateFileName(string) is called to initialize FAST.AssetFromFile.fileName.

void	LogAssetNotLoadedError ()
	Call this to log an error when an FAST.AssetFromFile cannot be loaded.

void	SetNameWithFileExtension ()
	When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of an asset assigned to a corresponding `Component`.

void	UpdateFileName (string language)
	Updates FAST.AssetFromFile.fileName using `language`, FAST.AssetSettings, FAST.AssetFromFile.prefixFileName, FAST.AssetFromFile.baseFileName, and FAST.AssetFromFile.suffixFileName.

Additional Inherited Members
Static Public Attributes inherited from AssetFromFile
const string	kSharedLanguage = "Shared"
	Use this string as the language name for assets that are the same across all languages and can be shared.

Protected Attributes inherited from AssetFromFile
string	fileName
	Runtime The full file name combined from the FAST.AssetFromFile.prefixFileName, FAST.AssetFromFile.baseFileName, and FAST.AssetFromFile.suffixFileName at runtime.

bool	isSharedByAllLanguages
	Inspector Set to true if this asset is the same across all languages and can be shared.

string	prefixFileName
	Settings A string loaded from FAST.AssetSettings that will be added to the front of the FAST.AssetFromFile.baseFileName at runtime.

string	suffixFileName
	Settings A string loaded from FAST.AssetSettings that will be inserted to the end of the FAST.AssetFromFile.baseFileName, but before the extension, at runtime.

Static Protected Attributes inherited from AssetFromFile
const string	kLanguageTag = "#Language"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the FAST.Application.language at runtime.

const string	kProductNameTag = "#ProductName"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the `UnityEngine.Application.productName` at runtime.

const string	kSkinTag = "#Skin"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the FAST.AssetSettings.skin at runtime.

Detailed Description

A class to help use an audio asset loaded from the file system as AudioClip for the current skin in multiple languages.

Assets are stored in FAST.Application.assets dictionary. This class will load the asset by looking it up in the dictionary using language in FAST.AssetFromFile.Load(string) and FAST.AssetFromFile.fileName.

See also: UnityEngine.Application; UnityEngine.AudioClip

Member Function Documentation

◆ Load()

override void Load ( string language )

Loads the asset from FAST.Application.assets dictionary using language and FAST.AssetFromFile.fileName.

Parameters

language The language of the asset to load.

The audio asset is loaded as a AudioClip into FAST.AudioClipFromFile.audioClip.

◆ SetNameWithFileExtension()

override void SetNameWithFileExtension ( )

protected

When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of the AudioClip if it is assigned to FAST.AudioClipFromFile.audioClip.

Member Data Documentation

◆ audioClip

AudioClip audioClip

Inspector, Runtime
The AudioClip that the audio asset is loaded into.

Assigned at runtime in FAST.AudioClipFromFile.Load(string).

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

C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Assets From File/AudioClipFromFile.cs

Public Member Functions

Public Attributes