Documentation Index
Fetch the complete documentation index at: https://sdk.sleepcycle.com/llms.txt
Use this file to discover all available pages before exploring further.
版本 1.1.1
新功能
- 智能闹钟:通过
SmartAlarmConfig配置唤醒时段,并通过新增的smartAlarmFlow: SharedFlow<SmartAlarmEvent>观察闹钟生命周期事件(Armed、Triggered)。触发原因包括OPTIMAL_WAKE_UP、USER_INTERACTION和WINDOW_END。智能闹钟受SleepAnalysisFeatures.smartAlarm限制,仅在主声道上支持。 - 立体声声道分离:新增
ChannelSeparationConfig,控制立体声音频声道如何分配到分析声道,内置预设为BED_SIDE_MICS、CENTERED_MIC_ARRAY和DETECTION_STRENGTH_ONLY。
API 变更
- 在
startAnalysis()和startMultiChannelAnalysis()中新增smartAlarmConfig: SmartAlarmConfig?参数。 - 在
startAnalysis()、startDataSource()和resumeAnalysis()中新增channelSeparationConfig: ChannelSeparationConfig参数。 - 在
initialize()中新增forceTokenRefresh: Boolean参数,即使存在缓存令牌也可强制重新获取。 resumeAnalysis()现在返回List<ResumedSession>(不再是Boolean),为每个恢复的会话提供会话 ID、声道和智能闹钟配置。- 当启用加速度计时,
createLiveDataSource()现在会同时启用陀螺仪。 - 当 SDK 未初始化时,
stopDataSource()和stopAnalysis()不再抛出异常,而是平稳返回。
版本 1.1.0
新功能
- 多声道分析:使用立体声音频同时分析两个声道。新增
startDataSource()/stopDataSource()方法,将数据源生命周期与会话生命周期分离;通过startMultiChannelAnalysis(channel:)在各声道上分别启动会话,通过stopAnalysis(sessionId:)单独停止某个会话。 - 音频运行状况监测:新增
audioHealthFlow: SharedFlow<AudioHealthUpdate>,实时发出音频输入运行状况的变化(HEALTHY、FLATLINE、MISSING_INPUT)。分析结果中包含AudioStatistics和AudioHealthInterval。 - 所有公共类型上的会话 ID:
Event、BreathingRate、SleepStageInterval、AudioClip和AudioHealthUpdate现在都包含sessionId: UUID属性,用于标识它们所属的会话。
API 变更
startAnalysis()现在返回一个标识会话的UUID。- 在
startAnalysis()中新增tag: String?参数,用于为会话打标签。 AudioEventListener.onAudioAnalysisBatchCompleted()现在包含sessionId: UUID参数。AnalysisResult现在包含sleepStageIntervals、audioStatistics和sessionId属性。- 在
SleepAnalysisFeatures中新增multiChannelAnalysis。
版本 1.0.10
发布日期: 2026 年 1 月 26 日新功能
- 磁盘空间检查:SDK 现在会在开始分析前检查是否有足够的磁盘空间,若空间不足则抛出
SdkNotEnoughDiskSpaceException。
API 变更
- 新增
SdkNotInitializedException异常,当在初始化之前调用 SDK 方法时抛出。 - 在
startAnalysis()上为SdkNotInitializedException和SdkNotEnoughDiskSpaceException增加了@throws文档说明。
错误修复
- 改进了写入数据库时的错误处理,避免在磁盘空间不足时崩溃。
版本 1.0.9
发布日期: 2026 年 1 月 15 日新功能
- 首选音频设备:可通过
createLiveDataSource()中的preferredDevice参数指定首选音频输入设备。
API 变更
- 新增对立体声音频输入的支持。
startAnalysis()和resumeAnalysis()中的dataSource参数现在是必填的(非空),默认值为createLiveDataSource()。- 新增
createLiveDataSource()工厂方法,用于创建从设备传感器采集数据的实时数据源。 - 将
LiveDataSource类公开,允许直接实例化以进行自定义配置。 - 扩展了
DataSource接口,新增以下方法:audioOutputEnabled()- 检查是否启用了音频输出accelerometerOutputEnabled()- 检查是否启用了加速度计输出getAudioFormat()- 返回音频声道配置(MONO 或 STEREO)
- 发布的工件现在包含源文件(不含内部包),便于调试。