UshiSoft.SM.SoundPlayer Class Reference

音を再生するクラス More...

Inheritance diagram for UshiSoft.SM.SoundPlayer:

Public Member Functions
void	Initialize (SoundData data, int id, float volume=1f, float pitch=1f, bool loop=false, int priority=128, float panStereo=0f, float spatialBlend=0f, Vector3 position=default)
	初期化する。絶対呼び出さないとダメ
void	Play (float fadeDuration=0f)
	再生する
void	Pause (float fadeDuration=0f)
	一時停止する
void	Resume (float fadeDuration=0f)
	一時停止から再開する
void	Stop (float fadeDuration=0f)
	停止する。一時停止と違い再開できない。再利用の対象に
void	FadeIn (float duration)
	フェードイン
void	FadeOut (float duration)
	フェードアウト
void	SetCategoryVolume (float volume)
	カテゴリー音量を設定する

Properties
SoundData	Data [get]
	音データ
int	Id [get]
	ID.
bool	IsActive [get]
	アクティブか。再生前、停止した、再生が完了した場合にalseになる
bool	IsPlaying [get]
	再生中か
bool	IsFinished [get]
	再生が完了したか
UnityEvent	OnFinish [get]
	再生が完了した際に発火するイベント
float	Volume [get, set]
	音量
float	Pitch [get, set]
	ピッチ
int	Priority [get, set]
	優先度
float	PanStereo [get, set]
	ステレオパン
float	SpatialBlend [get, set]
	3D効果
Vector3	Position [get, set]
	座標

Private Types
enum	FadeOutCompletedAction { Pause , Stop }
	フェードアウトが完了した際のアクション More...

Private Member Functions
void	Awake ()
void	Update ()
void	Pause ()
	一時停止する
void	Stop ()
	停止する。一時停止と違い再開できない。再利用の対象に
void	Fade ()
	フェード処理
void	UpdateVolume ()
	音量を更新する
void	FadeComplete ()
	フェードが完了した時に呼ぶ
void	Complete ()
	再生が完了した際に呼ぶ

Private Attributes
AudioSource	_audioSource
	オーディオソース。あらかじめアタッチしておく
SoundData	_data
	音データ
int	_id
	ID。再生が完了すると-1になる
bool	_hasStarted
	再生が開始されたか
bool	_isPaused
	ポーズ中か
bool	_isFinished
	再生が完了したか
float	_fadeDuration
	フェードの時間
float	_fadeTimer
	フェードの経過時間
bool	_isFadeOut
	フェードの種類はフェードアウトか
FadeOutCompletedAction	_fadeOutCompletedAction
	フェードアウトが完了した際のアクション
bool	_isFading
	フェード中か
float	_categoryVolume = 1f
	カテゴリーごとに調整する音量
float	_volume = 1f
	サウンドプレイヤーの音量
UnityEvent	_onFinish = new()
	再生が完了した際に発火するイベント

Detailed Description

音を再生するクラス

Member Enumeration Documentation

FadeOutCompletedAction

enum UshiSoft.SM.SoundPlayer.FadeOutCompletedAction

private

フェードアウトが完了した際のアクション

Enumerator
Pause	ポーズ
Stop	停止

Member Function Documentation

Awake()

void UshiSoft.SM.SoundPlayer.Awake ( )

private

Complete()

void UshiSoft.SM.SoundPlayer.Complete ( )

private

再生が完了した際に呼ぶ

Fade()

void UshiSoft.SM.SoundPlayer.Fade ( )

private

フェード処理

FadeComplete()

void UshiSoft.SM.SoundPlayer.FadeComplete ( )

private

フェードが完了した時に呼ぶ

FadeIn()

void UshiSoft.SM.SoundPlayer.FadeIn

(

float

duration

)

フェードイン

Parameters

duration

時間

FadeOut()

void UshiSoft.SM.SoundPlayer.FadeOut

(

float

duration

)

フェードアウト

Parameters

duration

時間

Initialize()

void UshiSoft.SM.SoundPlayer.Initialize	(	SoundData	data,
		int	id,
		float	volume = 1f,
		float	pitch = 1f,
		bool	loop = false,
		int	priority = 128,
		float	panStereo = 0f,
		float	spatialBlend = 0f,
		Vector3	position = default )

初期化する。絶対呼び出さないとダメ

Parameters

data	音データ
id	ID
volume	音量
pitch	ピッチ
loop	ループさせるか
priority	優先度。0~256。値が小さい方が優先度が高くなる
panStereo	左右のバランス。-1~1
spatialBlend	3D効果。0で完全に2D、1で完全に3D
position	ワールド座標

Pause() [1/2]

void UshiSoft.SM.SoundPlayer.Pause ( )

private

一時停止する

Pause() [2/2]

void UshiSoft.SM.SoundPlayer.Pause

(

float

fadeDuration = 0f

)

一時停止する

Parameters

fadeDuration

フェードの時間

Play()

void UshiSoft.SM.SoundPlayer.Play

(

float

fadeDuration = 0f

)

再生する

Resume()

void UshiSoft.SM.SoundPlayer.Resume

(

float

fadeDuration = 0f

)

一時停止から再開する

Parameters

fadeDuration

フェードの時間

SetCategoryVolume()

void UshiSoft.SM.SoundPlayer.SetCategoryVolume

(

float

volume

)

カテゴリー音量を設定する

Parameters

volume

音量

Stop() [1/2]

void UshiSoft.SM.SoundPlayer.Stop ( )

private

停止する。一時停止と違い再開できない。再利用の対象に

Stop() [2/2]

void UshiSoft.SM.SoundPlayer.Stop

(

float

fadeDuration = 0f

)

停止する。一時停止と違い再開できない。再利用の対象に

Parameters

fadeDuration

フェードの時間

Update()

void UshiSoft.SM.SoundPlayer.Update ( )

private

UpdateVolume()

void UshiSoft.SM.SoundPlayer.UpdateVolume ( )

private

音量を更新する

Member Data Documentation

_audioSource

AudioSource UshiSoft.SM.SoundPlayer._audioSource

private

オーディオソース。あらかじめアタッチしておく

_categoryVolume

float UshiSoft.SM.SoundPlayer._categoryVolume = 1f

private

カテゴリーごとに調整する音量

_data

SoundData UshiSoft.SM.SoundPlayer._data

private

音データ

_fadeDuration

float UshiSoft.SM.SoundPlayer._fadeDuration

private

フェードの時間

_fadeOutCompletedAction

FadeOutCompletedAction UshiSoft.SM.SoundPlayer._fadeOutCompletedAction

private

フェードアウトが完了した際のアクション

_fadeTimer

float UshiSoft.SM.SoundPlayer._fadeTimer

private

フェードの経過時間

_hasStarted

bool UshiSoft.SM.SoundPlayer._hasStarted

private

再生が開始されたか

_id

int UshiSoft.SM.SoundPlayer._id

private

ID。再生が完了すると-1になる

_isFadeOut

bool UshiSoft.SM.SoundPlayer._isFadeOut

private

フェードの種類はフェードアウトか

_isFading

bool UshiSoft.SM.SoundPlayer._isFading

private

フェード中か

_isFinished

bool UshiSoft.SM.SoundPlayer._isFinished

private

再生が完了したか

_isPaused

bool UshiSoft.SM.SoundPlayer._isPaused

private

ポーズ中か

_onFinish

UnityEvent UshiSoft.SM.SoundPlayer._onFinish = new()

private

再生が完了した際に発火するイベント

_volume

float UshiSoft.SM.SoundPlayer._volume = 1f

private

サウンドプレイヤーの音量

Property Documentation

Data

SoundData UshiSoft.SM.SoundPlayer.Data

get

音データ

Id

int UshiSoft.SM.SoundPlayer.Id

get

ID.

IsActive

bool UshiSoft.SM.SoundPlayer.IsActive

get

アクティブか。再生前、停止した、再生が完了した場合にalseになる

IsFinished

bool UshiSoft.SM.SoundPlayer.IsFinished

get

再生が完了したか

IsPlaying

bool UshiSoft.SM.SoundPlayer.IsPlaying

get

再生中か

OnFinish

UnityEvent UshiSoft.SM.SoundPlayer.OnFinish

get

再生が完了した際に発火するイベント

PanStereo

float UshiSoft.SM.SoundPlayer.PanStereo

getset

ステレオパン

Pitch

float UshiSoft.SM.SoundPlayer.Pitch

getset

ピッチ

Position

Vector3 UshiSoft.SM.SoundPlayer.Position

getset

座標

Priority

int UshiSoft.SM.SoundPlayer.Priority

getset

優先度

SpatialBlend

float UshiSoft.SM.SoundPlayer.SpatialBlend

getset

3D効果

Volume

float UshiSoft.SM.SoundPlayer.Volume

getset

音量