Show / Hide Table of Contents

Class SoundAsset

Sound track asset type. This asset is used to play sound effects on mix channels. For music tracks, use the MusicAsset.

Inheritance
System.Object
IAsset
SoundAsset
Implements
System.IDisposable
Inherited Members
IAsset._handle
IAsset.Tag
IAsset.Dispose()
IAsset.HaveHandle
IAsset.IsValid
IAsset.FullPath
IAsset.Path
IAsset.FullIdentifier
Namespace: BonEngineSharp.Assets
Assembly: BonEngineSharp.dll
Syntax
public class SoundAsset : IAsset, IDisposable

Constructors

SoundAsset(IntPtr)

Create the asset.

Declaration
public SoundAsset(IntPtr handle)
Parameters
Type Name Description
System.IntPtr handle

Asset handle inside the low-level engine.

Properties

AssetType

Get asset type.

Declaration
public override AssetType AssetType { get; }
Property Value
Type Description
AssetType
Overrides
IAsset.AssetType

Length

Get sound track length.

Declaration
public float Length { get; }
Property Value
Type Description
System.Single

Methods

Finalize()

Dispose on destructor.

Declaration
protected override void Finalize()
Overrides
IAsset.Finalize()

IsPlaying()

Check if this sound track is currently playing.

Declaration
public bool IsPlaying()
Returns
Type Description
System.Boolean

True if sound track is playing.

Implements

System.IDisposable
Back to top Generated by DocFX