跳转到主要内容

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.

​
Sleep Cycle SDK - Android 文档

​
概览

Sleep Cycle SDK for Android 让开发者能够将先进的睡眠分析能力集成到他们的应用中。SDK 通过音频和运动传感器提供实时睡眠追踪，并在整夜过程中生成详细的睡眠洞察和事件。

​
系统要求

最低 Android API 级别：
  • Min SDK：API level 28（Android 9.0 Pie）
  • Compile SDK：API level 35
Kotlin：
  • Kotlin 版本：1.9+（JVM target 11）
  • SDK 使用 Kotlin 编写，并提供 Kotlin 优先的 API

​
安装

可以在 Maven Central 上找到最新版本。

​
Groovy DSL

将 Sleep Cycle SDK 依赖添加到您的 build.gradle： 
dependencies {
    implementation "com.sleepcycle.sdk:sdk-android:<latest-version>"
}

​
Kotlin DSL

将 Sleep Cycle SDK 依赖添加到您的 build.gradle.kts： 
dependencies {
    implementation("com.sleepcycle.sdk:sdk-android:<latest-version>")
}

​
前置条件

​
权限

SDK 需要麦克风权限以进行基于音频的睡眠分析： 
<uses-permission android:name="android.permission.RECORD_AUDIO"/>
SDK 在其清单文件中自动包含 WAKE_LOCK 权限，以便在分析期间保持设备唤醒： 
<uses-permission android:name="android.permission.WAKE_LOCK" />

​
使用前台服务保持分析处于活动状态

要确保整夜持续进行睡眠分析，您必须实现一个前台服务。这样可以防止 Android 在长时间运行期间终止分析进程。 正确启动前台服务由宿主应用负责。该服务必须在其清单中声明合适的前台服务类型，以指定它需要访问的系统资源。对于睡眠分析，您通常需要 health 或 microphone 服务类型，分别授予对健康传感器和麦克风的访问权限。

​
通用说明

SDK 是线程安全的，可以从任意线程调用。

​
初始化 SDK

SDK 在使用前需要进行身份验证。初始化过程会校验您的凭证并确定可用的功能。 
import com.sleepcycle.sdk.SleepCycleSdk

try {
    val features = SleepCycleSdk.initialize(
        context = applicationContext,
        apiKey = "your-api-key-here"
    )
    Log.d("SDK", "Authorized with features: $features")
} catch (e: Exception) {
    Log.e("SDK", "Authorization failed: ${e.message}")
}
返回的 SleepAnalysisFeatures 表示您的 API 密钥可用的能力：
sleepStaging Boolean - 睡眠分期分析
smartAlarm Boolean - 智能闹钟功能
audioEvents Boolean - 音频事件检测
snoringDetection Boolean - 鼾声检测
realTimeSleepStaging Boolean - 实时睡眠分期
multiChannelAnalysis Boolean - 多声道分析（立体声，两个声道）

​
获取 SDK 状态

通过 StateFlow 监听 SDK 状态的变化： 
import com.sleepcycle.sdk.SdkState

val sdkStateFlow: StateFlow<SdkState> = SleepCycleSdk.sdkStateFlow
获取当前状态： 
val currentState: SdkState = SleepCycleSdk.getState()

​
启动睡眠分析会话

初始化完成后，即可启动一次睡眠分析会话。该方法返回标识本次会话的 UUID。 
import com.sleepcycle.sdk.SleepAnalysisConfig

try {
    val sessionId: UUID = SleepCycleSdk.startAnalysis(
        config = SleepAnalysisConfig(
            useAudio = true,
            useAccelerometer = true
        )
    )
    Log.d("SDK", "Analysis started with session ID: $sessionId")
} catch (e: Exception) {
    Log.e("SDK", "Failed to start analysis: ${e.message}")
}
参数：
config SleepAnalysisConfig - 用于指定使用哪些传感器的配置对象
startMillisUtc Long - 分析的起始时间（UTC 毫秒，默认为当前时间）
dataSource DataSource? - 可选的自定义数据源；为 null 时，SDK 使用设备实时传感器
audioEventListeners List<AudioEventListener> - 可选监听器列表，在音频分析过程中接收回调

​
恢复会话

SDK 支持恢复先前启动的分析会话。当应用重启或前台服务被系统终止时，这一功能很有用。 
try {
    if (SleepCycleSdk.isResumePossible()) {
        SleepCycleSdk.resumeAnalysis()
    }
} catch (e: Exception) {
    Log.e("SDK", "Failed to resume analysis: ${e.message}")
}

​
停止会话

要停止当前的分析会话并获取结果： 
try {
    val result: AnalysisResult? = SleepCycleSdk.stopAnalysis()

    result?.let { analysisResult ->
        val events = analysisResult.events
        val breathingRates = analysisResult.breathingRates
        val sleepStageIntervals = analysisResult.sleepStageIntervals

        analysisResult.statistics?.let { statistics ->
            Log.d("SDK", "Sleep duration: ${statistics.totalSleepDurationSeconds}")
        }

        events.forEach { event ->
            Log.d("SDK", "${event.type} from ${event.startTime} to ${event.endTime}")
        }

        breathingRates.forEach { breathingRate ->
            Log.d("SDK", "Breathing rate: ${breathingRate.bpm} bpm at ${breathingRate.timestampSecondsUtc}")
        }

        analysisResult.audioStatistics?.let { audioStats ->
            audioStats.healthIntervals.forEach { interval ->
                Log.d("SDK", "Audio ${interval.status}: ${interval.interval}")
            }
        }
    }
} catch (e: Exception) {
    Log.e("SDK", "Failed to stop analysis: ${e.message}")
}

​
分析结果

AnalysisResult 包含一次睡眠分析会话的完整输出：
sessionId UUID - 唯一会话标识符
startSecondsUtc Double - 会话起始时间（UTC 秒）
endSecondsUtc Double - 会话结束时间（UTC 秒）
events List<Event> - 检测到的睡眠事件
breathingRates List<BreathingRate> - 呼吸频率测量值
sleepStageIntervals List<SleepStageInterval> - 睡眠阶段数据
statistics SleepStatistics? - 聚合的睡眠统计（可空）
audioStatistics AudioStatistics? - 音频运行状况统计（可空）

​
SleepStatistics

当存在时，statistics 包含本次睡眠会话的聚合指标：
totalSleepDurationSeconds Double - 总睡眠时长
sleepOnsetLatencySeconds Double? - 入睡所用时间
sleepEfficiency Double - 睡眠时长与在床时长的比值（0.0 到 1.0）
finalWakeTimeSecondsUtc Double? - 最终醒来时间（UTC 秒）
numberOfAwakenings Int - 整夜的醒来次数
snoreTimeSeconds Double - 鼾声总时长
snoreSessions List<SnoreSession> - 单次鼾声会话
sleepStageDurationsSeconds Map<SleepStage, Double> - 每个睡眠阶段的时长

​
AudioStatistics

当存在时，audioStatistics 包含整个会话期间音频输入运行状况的相关信息。

​
实时事件

SDK 在分析过程中通过 Flow API 提供实时事件更新： 
import com.sleepcycle.sdk.Event
import com.sleepcycle.sdk.EventType

lifecycleScope.launch {
    SleepCycleSdk.eventFlow.collect { events: List<Event> ->
        events.forEach { event ->
            when (event.type) {
                EventType.MOVEMENT -> handleMovement(event)
                EventType.SNORING -> handleSnoring(event)
                EventType.TALKING -> handleTalking(event)
                EventType.COUGHING -> handleCoughing(event)
            }
        }
    }
}
每个 Event 包含：
type EventType - 事件类型
startTime Double - 起始时间戳（UTC 秒）
endTime Double - 结束时间戳（UTC 秒）
probability Float - 置信度分数（0.0 到 1.0）
source EventSource - 检测来源
sessionId UUID - 该事件所属的会话
signature FloatArray? - 可选特征向量（用于鼾声事件）

​
实时呼吸频率

SDK 在分析过程中提供实时呼吸频率测量： 
import com.sleepcycle.sdk.BreathingRate

lifecycleScope.launch {
    SleepCycleSdk.breathingRateFlow.collect { breathingRate: BreathingRate ->
        Log.d("SDK", "Breathing rate: ${breathingRate.bpm} bpm (confidence: ${breathingRate.confidence})")
    }
}
每个 BreathingRate 包含：
timestampSecondsUtc Double - 测量时间（自 Unix 纪元起的秒数）
bpm Float - 呼吸频率（每分钟呼吸次数）
confidence Float - 测量的置信度（0.0 到 1.0）
sessionId UUID - 该测量所属的会话

​
实时睡眠分期（实验性）

此功能为实验性功能，未来版本中可能会发生变更。API 和行为可能在未通知的情况下被修改。
SDK 可在分析过程中提供实时睡眠阶段预测。此功能要求您的 API 密钥启用了 realTimeSleepStaging 功能。 
import com.sleepcycle.sdk.SleepStage
import com.sleepcycle.sdk.SleepStageInterval

lifecycleScope.launch {
    SleepCycleSdk.sleepStageFlow.collect { stageInterval: SleepStageInterval ->
        when (stageInterval.stage) {
            SleepStage.AWAKE -> Log.d("SDK", "Awake: ${stageInterval.interval}")
            SleepStage.LIGHT -> Log.d("SDK", "Light sleep: ${stageInterval.interval}")
            SleepStage.DEEP -> Log.d("SDK", "Deep sleep: ${stageInterval.interval}")
            SleepStage.REM -> Log.d("SDK", "REM sleep: ${stageInterval.interval}")
        }
    }
}
该 Flow 在分析过程中大约每 30 秒发出一个 SleepStageInterval 对象，从而以接近实时的方式反馈睡眠状态的转换。

​
实时音频运行状况

SDK 在分析期间监测音频输入的运行状况，并在状态变化时发出更新： 
import com.sleepcycle.sdk.AudioHealthUpdate
import com.sleepcycle.sdk.AudioHealthStatus

lifecycleScope.launch {
    SleepCycleSdk.audioHealthFlow.collect { update: AudioHealthUpdate ->
        when (update.status) {
            AudioHealthStatus.HEALTHY -> Log.d("SDK", "Audio input healthy")
            AudioHealthStatus.FLATLINE -> Log.w("SDK", "Audio flatline detected")
            AudioHealthStatus.MISSING_INPUT -> Log.w("SDK", "Audio input missing")
        }
    }
}
AudioHealthStatus 取值：
HEALTHY - 音频输入包含有变化的信号
FLATLINE - 检测到恒定值（麦克风失效或输入静音）
MISSING_INPUT - 较长时间内未收到任何音频输入

​
事件签名

对于鼾声事件，Event.signature 属性包含一个 16 维特征向量，表示所检测到鼾声的独特特征。来自同一人的鼾声事件在签名空间中彼此聚集，因此可以按人对事件进行聚类。

​
音频事件监听器

AudioEventListener 接口允许您在会话过程中接收实时的音频分析更新。实现该接口可在分析进行时访问原始音频样本、事件检测以及音量信息。 
val audioEventListener = object : AudioEventListener {
    override fun onAudioAnalysisBatchCompleted(
        audioSamples: FloatArray,
        audioSampleRate: Int,
        audioStartTime: Double,
        audioEndTime: Double,
        eventsStarted: List<EventStartedInfo>,
        eventsEnded: List<EventEndedInfo>,
        rms: FloatArray,
        sessionId: UUID
    ) {
        // Process audio samples and events
    }
}

try {
    SleepCycleSdk.startAnalysis(
        config = SleepAnalysisConfig(useAudio = true),
        audioEventListeners = listOf(audioEventListener)
    )
} catch (e: Exception) {
    Log.e("SDK", "Failed to start analysis: ${e.message}")
}
audioSamples 参数顺序包含所有已处理的音频数据，批次之间没有间隙或重叠。每个批次都从前一个批次结束的位置精确接续，从而对所有分析过的音频实现完整覆盖。

​
音频片段

当检测到特定的睡眠事件（例如鼾声、梦话或咳嗽）时，SDK 可以捕获短音频录音。 要使用音频片段，需创建一个音频片段生成器，并将其传入 startAnalysis： 
import com.sleepcycle.sdk.*

// Configure which events trigger audio clips
val audioClipsConfig = AudioClipsConfig(
    activeTypes = hashMapOf(
        EventType.SNORING to EventTypeConfig(minDuration = 0.5),
        EventType.TALKING to EventTypeConfig(minDuration = 0.5)
    ),
    clipLength = 10.0  // Clip duration in seconds
)

// Implement receiver to handle captured clips
val audioClipsReceiver = object : AudioClipsReceiver {
    override fun onAudioClipReceived(audioClip: AudioClip) {
        // Process or store the audio clip
    }
}

try {
    // Create audio clips producer
    val audioClipsProducer = SleepCycleSdk.createAudioClipsProducer(
        config = audioClipsConfig,
        receiver = audioClipsReceiver
    )

    // Pass to startAnalysis
    SleepCycleSdk.startAnalysis(
        config = SleepAnalysisConfig(useAudio = true),
        audioEventListeners = listOf(audioClipsProducer)
    )
} catch (e: Exception) {
    Log.e("SDK", "Failed to start analysis with audio clips: ${e.message}")
}
每个 AudioClip 包含：
startTime Double - 起始时间戳（秒）
type EventType - 触发本次捕获的事件类型
samples FloatArray - 原始音频样本
sampleRate Int - 采样率（Hz）
sessionId UUID - 该片段所属的会话

​
多声道分析

SDK 支持使用立体声音频源同时分析两个声道。多声道分析将数据源生命周期与各个会话生命周期分离，使您可以独立启动和停止每个声道上的会话。 立体声流应来自两个独立的单声道麦克风，每个麦克风占用一个声道，再合并为单个立体声流。 此功能要求您的 API 密钥启用了 multiChannelAnalysis 功能。

​
声道分离

使用立体声输入时，ChannelSeparationConfig 控制如何将音频事件分配到各个声道。内置预设：
  • BED_SIDE_MICS — 分离放置的床头麦克风（默认值）
  • CENTERED_MIC_ARRAY — 间距很近的麦克风阵列
  • DETECTION_STRENGTH_ONLY — 不进行空间过滤，仅依据检测置信度
所有参数（麦克风间距、模糊区、置信度阈值、各事件类型设置）都可以单独调节，以适配您的具体硬件配置和使用场景。

​
数据源生命周期

在启动各个会话之前，使用立体声音频配置启动数据源： 
try {
    val dataSource = SleepCycleSdk.createLiveDataSource(
        audioFormat = DataSource.AudioFormat.STEREO
    )

    SleepCycleSdk.startDataSource(
        dataSource = dataSource,
        channelSeparationConfig = ChannelSeparationConfig.BED_SIDE_MICS
    )
} catch (e: Exception) {
    Log.e("SDK", "Failed to start data source: ${e.message}")
}

​
在每个声道上启动会话

数据源运行后，在每个声道上启动一个会话： 
import com.sleepcycle.sdk.AnalysisChannel

try {
    val primarySessionId: UUID = SleepCycleSdk.startMultiChannelAnalysis(
        channel = AnalysisChannel.PRIMARY,
        config = SleepAnalysisConfig(useAudio = true, useAccelerometer = true)
    )

    val secondarySessionId: UUID = SleepCycleSdk.startMultiChannelAnalysis(
        channel = AnalysisChannel.SECONDARY,
        config = SleepAnalysisConfig(useAudio = true, useAccelerometer = false)
    )
} catch (e: Exception) {
    Log.e("SDK", "Failed to start multi-channel analysis: ${e.message}")
}
AnalysisChannel 取值：
PRIMARY - 第一个音频声道（或单声道）
SECONDARY - 立体声中的第二个音频声道

​
独立停止各个会话

每个会话都可以独立停止以获取其结果： 
try {
    val primaryResult: AnalysisResult? = SleepCycleSdk.stopAnalysis(
        sessionId = primarySessionId
    )

    val secondaryResult: AnalysisResult? = SleepCycleSdk.stopAnalysis(
        sessionId = secondarySessionId
    )
} catch (e: Exception) {
    Log.e("SDK", "Failed to stop analysis: ${e.message}")
}

​
停止数据源

所有会话都已停止后，再停止数据源： 
try {
    SleepCycleSdk.stopDataSource()
} catch (e: Exception) {
    Log.e("SDK", "Failed to stop data source: ${e.message}")
}
如果在仍有会话处于活动状态时调用 stopDataSource()，会强制停止这些会话并丢弃其结果。要保留结果，请先停止每个会话。