IAudioService 接口

命名空间

ClassIsland.Core.Abstractions.Services

程序集

ClassIsland.Core.dll

音频服务，用于提供播放音频的 AudioEngine。

public interface IAudioService : IDisposable

继承成员

IDisposable.Dispose()

字段

DefaultAudioFormat

默认的音频格式

public static readonly AudioFormat DefaultAudioFormat

字段值

AudioFormat

属性

AudioEngine

当前的音频引擎。

AudioEngine AudioEngine { get; }

属性值

AudioEngine

备注

出于线程安全考虑，请从 MTA 线程调用此方法。详细请见 https://github.com/ClassIsland/ClassIsland/issues/1333#issuecomment-3505591836

异常

InvalidOperationException

当调用线程不是 MTA 线程时，抛出此异常。

方法

PlayAudioAsync(Stream, float, CancellationToken?)

播放音频并等待。

Task PlayAudioAsync(Stream audio, float volume, CancellationToken? cancellationToken = null)

参数

audio Stream

音频流

volume float

音频音量

cancellationToken CancellationToken?

用于停止音频播放的取消令牌

返回

Task

TryInitializeDefaultPlaybackDevice()

尝试初始化默认的音频设备。如果初始化失败，则返回 null。

AudioPlaybackDevice? TryInitializeDefaultPlaybackDevice()

返回

AudioPlaybackDevice

初始化的音频设备。

TryInitializeDefaultPlaybackDeviceAsync()

尝试初始化默认的音频设备。如果初始化失败，则返回 null。

Task<AudioPlaybackDevice?> TryInitializeDefaultPlaybackDeviceAsync()

返回

Task<AudioPlaybackDevice>

初始化的音频设备。