Class PlaybackArgs
Provides configuration details to BackgroundAudio.Player on how to play a BackgroundAudio.
Namespace: OmiyaGames.Audio
Assembly: cs.temp.dll.dll
Syntax
public class PlaybackArgs : EventArgsRemarks
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/18/2022 Author: Taro Omiya | Initial draft. |
|
Version: 1.1.0 Date: 6/30/2022 Author: Taro Omiya | Adding new property, IsPausedOnTimeStop. |
Properties
DelaySeconds
How long to delay playback (in seconds, normalized by
Declaration
public double DelaySeconds { get; set; }Property Value
| Type | Description |
|---|---|
| Double |
IsPausedOnTimeStop
If true, the BackgroundAudio.Player
will pause when
Declaration
public bool IsPausedOnTimeStop { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
SkipForwardToSeconds
Allows playing from the middle of an audio clip by skipping
forward in time by X seconds, normalized by
Declaration
public double SkipForwardToSeconds { get; set; }Property Value
| Type | Description |
|---|---|
| Double |
Methods
FixData()
Fixes any invalid property values.
Declaration
public virtual void FixData()