SharedAudioSession#

通过 SharedAudioSession，你可以在脚本中方便地管理和操作共享音频会话（audio session）。音频会话充当脚本、Scripting 应用、操作系统和底层音频硬件之间的中介，允许你有效地配置和控制音频的行为。

功能简介#

• 获取和设置音频会话的类别（category）、模式（mode）和选项（options）。
• 配置音频输入和输出的首选采样率（sample rate）。
• 处理音频中断事件。
• 查询设备所支持的类别和模式。
• 根据具体的应用场景（如视频录制、语音聊天、后台播放等）来定制音频行为。

方法和属性#

1. 会话类别与选项#

category#

获取当前音频会话的类别（Category）。

1const category = await SharedAudioSession.category
2console.log(category) // 示例输出：'playback'

categoryOptions#

获取当前音频会话类别的选项（Options）。

1const options = await SharedAudioSession.categoryOptions
2console.log(options) // 示例输出：['mixWithOthers', 'allowAirPlay']

setCategory(category: AudioSessionCategory, options: AudioSessionCategoryOptions[])#

设置音频会话的类别并指定其选项。

1await SharedAudioSession.setCategory('playback', ['mixWithOthers'])

2. 会话模式#

mode#

获取当前音频会话模式（Mode）。

1const mode = await SharedAudioSession.mode
2console.log(mode) // 示例输出：'videoChat'

setMode(mode: AudioSessionMode)#

设置音频会话模式。

1await SharedAudioSession.setMode('voiceChat')

3. 采样率 (Sample Rate)#

preferredSampleRate#

获取当前首选采样率（单位为 Hz）。

1const sampleRate = await SharedAudioSession.preferredSampleRate
2console.log(sampleRate) // 示例输出：44100

setPreferredSampleRate(sampleRate: number)#

设置音频输入和输出的首选采样率。

1await SharedAudioSession.setPreferredSampleRate(48000)

4. 音频中断处理#

addInterruptionListener(listener: AudioSessionInterruptionListener)#

监听音频中断事件。

1SharedAudioSession.addInterruptionListener((type) => {
2  if (type === 'began') {
3    console.log('音频中断开始')
4  } else if (type === 'ended') {
5    console.log('音频中断结束')
6  }
7})

removeInterruptionListener(listener: AudioSessionInterruptionListener)#

移除音频中断监听器。

1SharedAudioSession.removeInterruptionListener(myListener)

5. 设备功能查询#

availableCategories#

获取设备上可用的音频会话类别列表。

1const categories = await SharedAudioSession.availableCategories
2console.log(categories) // 示例输出：['playback', 'record', 'soloAmbient']

availableModes#

获取设备上可用的音频会话模式列表。

1const modes = await SharedAudioSession.availableModes
2console.log(modes) // 示例输出：['default', 'videoChat', 'voiceChat']

6. 其他属性#

isOtherAudioPlaying#

检查设备上是否有其他音频正在播放。

1const isPlaying = await SharedAudioSession.isOtherAudioPlaying
2console.log(isPlaying) // 示例输出：true

secondaryAudioShouldBeSilencedHint#

检查次要音频是否应该被静音。

1const shouldSilence = await SharedAudioSession.secondaryAudioShouldBeSilencedHint
2console.log(shouldSilence) // 示例输出：false

allowHapticsAndSystemSoundsDuringRecording#

检查录音期间是否允许触觉反馈和系统声音。

1const allowHaptics = await SharedAudioSession.allowHapticsAndSystemSoundsDuringRecording
2console.log(allowHaptics) // 示例输出：true

prefersNoInterruptionsFromSystemAlerts#

检查音频会话是否偏好不被系统警报打断。

1const prefersNoInterruptions = await SharedAudioSession.prefersNoInterruptionsFromSystemAlerts
2console.log(prefersNoInterruptions) // 示例输出：false

7. 会话激活#

setActive(active: boolean)#

激活或停用共享音频会话。

1await SharedAudioSession.setActive(true)

8. 系统设置#

setAllowHapticsAndSystemSoundsDuringRecording(value: boolean)#

启用或禁用在录音期间允许触觉反馈和系统声音。

1await SharedAudioSession.setAllowHapticsAndSystemSoundsDuringRecording(true)

setPrefersNoInterruptionsFromSystemAlerts(value: boolean)#

设置是否偏好不被系统警报打断。

1await SharedAudioSession.setPrefersNoInterruptionsFromSystemAlerts(true)

枚举（Enumerations）#

AudioSessionCategory#

定义音频会话的类别：

• 'ambient'
• 'multiRoute'
• 'playAndRecord'
• 'playback'
• 'record'
• 'soloAmbient'

AudioSessionCategoryOptions#

定义类别的可选行为：

• 'mixWithOthers'
• 'duckOthers'
• 'interruptSpokenAudioAndMixWithOthers'
• 'allowBluetooth'
• 'allowBluetoothA2DP'
• 'allowAirPlay'
• 'defaultToSpeaker'
• 'overrideMutedMicrophoneInterruption'

AudioSessionMode#

指定会话模式：

• 'default'
• 'gameChat'
• 'measurement'
• 'moviePlayback'
• 'spokenAudio'
• 'videoChat'
• 'videoRecording'
• 'voiceChat'
• 'voicePrompt'

AudioSessionInterruptionType#

指定中断类型：

• 'began'
• 'ended'
• 'unknown'

通过此接口，你可以在 Scripting 应用中对音频会话进行深度管理，非常适合构建对音频依赖较高的脚本，如音乐播放器和视频会议工具等。