Class AudioLayer
Base info on each audio category.
Namespace: OmiyaGames.Audio
Assembly: cs.temp.dll.dll
Syntax
public class AudioLayer : IDisposableRemarks
Copyright (c) 2022 Omiya Games Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
| Revision | Description |
|---|---|
|
Version: 0.1.0-exp.1 Date: 2/27/2022 Author: Taro Omiya | Initial draft. |
|
Version: 1.0.0 Date: 6/21/2022 Author: Taro Omiya | Adding documentation. |
Properties
IsMuted
Gets or sets whether this layer is muted.
Declaration
public bool IsMuted { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
IsMutedSaver
The settings to store user's mute preferences.
Declaration
public SaveBool IsMutedSaver { get; }Property Value
| Type | Description |
|---|---|
| SaveBool |
Remarks
This value is changed in Unity's Project Settings dialog.
See Also
Pitch
Gets or sets the pitch of this layer.
Declaration
public float Pitch { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
PitchParam
The parameter name to change
Declaration
public string PitchParam { get; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
This value is changed in Unity's Project Settings dialog.
VolumeDb
Gets the volume of this layer, in decibels.
Declaration
public float VolumeDb { get; }Property Value
| Type | Description |
|---|---|
| Single |
See Also
VolumeParam
The parameter name to change
Declaration
public string VolumeParam { get; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
This value is changed in Unity's Project Settings dialog.
VolumePercent
Gets or sets the volume of this layer as a
fraction between 0 and 1.
Declaration
public float VolumePercent { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
See Also
VolumeSaver
The settings to store user's volume preferences.
Declaration
public SaveFloat VolumeSaver { get; }Property Value
| Type | Description |
|---|---|
| SaveFloat |
Remarks
This value is changed in Unity's Project Settings dialog.
See Also
Methods
Dispose()
Cleans-up any events this object was listening to.
Declaration
public void Dispose()