Class SingleLoopingMusic

A BackgroundAudio representing a looping music and optionally an intro stinger.

Inheritance

Object

BackgroundAudio

SingleLoopingMusic

Inherited Members

BackgroundAudio.MENU_ORDER

BackgroundAudio.MainAudioSourcePrefab

Namespace: OmiyaGames.Audio

Assembly: cs.temp.dll.dll

Syntax

public class SingleLoopingMusic : BackgroundAudio

Remarks

The MIT License (MIT)

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: 1.0.0 Date: 4/16/2022 Author: Taro Omiya	Initial verison.
Version: 1.1.0 Date: 6/30/2022 Author: Taro Omiya	Adding new property, OmiyaGames.Audio.SingleLoopingMusic.SingleLoopingMusicPlayer.IsPausedOnTimeStop.

Properties

IntroSting

Gets the clip that plays once before Loop.

Declaration

public AudioClip IntroSting { get; }

Property Value

Type	Description
AudioClip

Remarks

This variable is set in the Unity Inspector.

Loop

Gets the clip that loops until Stop().

Declaration

public AudioClip Loop { get; }

Property Value

Type	Description
AudioClip

Remarks

This variable is set in the Unity Inspector.

PlayLoopAfterSeconds

Gets how many seconds playing Loop will be delayed if IntroSting is not null.

Declaration

public double PlayLoopAfterSeconds { get; }

Property Value

Type	Description
Double

Remarks

This variable is set in the Unity Inspector.

Methods

GeneratePlayer(GameObject)

Sets up attach with s and other items to play the music.

Declaration

public override BackgroundAudio.Player GeneratePlayer(GameObject attach)

Parameters

Type	Name	Description
GameObject	attach	The script generated s will be attached or be child of.

Returns

Type	Description
BackgroundAudio.Player

Overrides

BackgroundAudio.GeneratePlayer(GameObject)

Reset()

Resets this file. Primarily used in the Unity Inspector.

Declaration

public override void Reset()

Overrides

BackgroundAudio.Reset()

SetLoopDelayToIntroStingDuration()

Calculates how long IntroSting is, and sets PlayLoopAfterSeconds. This produces a more accurate value than .

Declaration

public void SetLoopDelayToIntroStingDuration()