Struct AudioInfo
A class to gather audio related data before loading it
Inherited Members
System.ValueType.Equals(System.Object)
System.ValueType.GetHashCode()
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: LLBML.Audio
Assembly: LLBModdingLib.dll
Syntax
public struct AudioInfo
Constructors
AudioInfo(FileInfo, AudioType, String, Single, Vector2)
Declaration
public AudioInfo(FileInfo fileInfo = null, AudioType audioType = AudioType.UNKNOWN, string clipNameHint = null, float volume = 1F, Vector2 loopData = default(Vector2))
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.FileInfo | fileInfo | The path of the audio file |
| UnityEngine.AudioType | audioType | The type of the audio file |
| System.String | clipNameHint | The name the clip should have when loaded |
| System.Single | volume | The volume of the audio file |
| UnityEngine.Vector2 | loopData | The start and end point of looping, in milliseconds |
Fields
clipNameHint
The name the resulting clip could have
Declaration
public string clipNameHint
Field Value
| Type | Description |
|---|---|
| System.String |
file
The audio file location
Declaration
public FileInfo file
Field Value
| Type | Description |
|---|---|
| System.IO.FileInfo |
loopData
How the resulting clip should loop when played
Declaration
public Vector2 loopData
Field Value
| Type | Description |
|---|---|
| UnityEngine.Vector2 |
type
The type of the audio file
Declaration
public AudioType type
Field Value
| Type | Description |
|---|---|
| UnityEngine.AudioType |
volume
How loud the resulting clip should be
Declaration
public float volume
Field Value
| Type | Description |
|---|---|
| System.Single |
Methods
GetAudioInfo(FileInfo, String)
Builds an AudioInfo from what can be gathered from the file
Declaration
public static AudioInfo GetAudioInfo(FileInfo file, string clipNameHint = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.FileInfo | file | The path of the audio file |
| System.String | clipNameHint | Uses this name instead of gathering it from the file name |
Returns
| Type | Description |
|---|---|
| AudioInfo | The resulting AudioInfo |
GetAudioInfo(String, String)
Builds an AudioInfo from what can be gathered from the file
Declaration
public static AudioInfo GetAudioInfo(string filePath, string clipNameHint = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filePath | The path of the audio file |
| System.String | clipNameHint | Uses this name instead of gathering it from the file name |
Returns
| Type | Description |
|---|---|
| AudioInfo | The resulting AudioInfo |