需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

音视频录制

  • iOS

更新时间不可用

createMediaRecorder:

创建一个媒体录制器实例。

Objective-C
- (AgoraMediaRecorder * _Nullable)createMediaRecorder:(AgoraRecorderStreamInfo * _Nonnull)info NS_SWIFT_NAME(createMediaRecorder(withInfo:));

在开始音视频流录制之前，你需要调用该方法创建一个媒体录制器实例。SDK 支持录制来自本地或远端用户的多个音视频流。你可以多次调用该方法创建多个录制器实例，并使用 info 参数指定要录制的频道名和远端用户 ID。

成功创建录制器实例后，你需要调用 setMediaRecorderDelegate: 方法为该录制器注册一个观察者，以监听相关回调，然后调用 startRecording: 方法开始录制。

参数

参数名描述
info

要录制的音视频流的信息，详见 AgoraRecorderStreamInfo。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 方法调用成功，返回 AgoraMediaRecorder 对象。
  • 方法调用失败，返回 nil。

所属接口类

destroyMediaRecorder:

销毁音视频录制器实例。

Objective-C
- (int)destroyMediaRecorder:(AgoraMediaRecorder * _Nullable)mediaRecorder;

当你不再需要录制音视频流时，可以调用此方法销毁对应的音视频录制器实例。如果录制正在进行中，请先调用 stopRecording 停止录制，然后再调用此方法销毁录制器实例。

参数

参数名描述
mediaRecorder

要销毁的 AgoraMediaRecorder 实例。详见 AgoraMediaRecorder。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。请参阅错误码获取详细信息和排查建议。

所属接口类

enableMainQueueDispatch:

设置是否将回调方法派发到主线程。

Objective-C
- (int)enableMainQueueDispatch:(BOOL)enabled NS_SWIFT_NAME(enableMainQueueDispatch(_:));

如果不将回调方法派发到主线程，应用应将 UI 操作派发到主线程。

参数

参数名描述
enabled

是否将回调方法派发到主线程：

  • YES：将回调方法派发到主线程。
  • NO：不将回调方法派发到主线程。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。详见错误码获取详情和排查建议。

所属接口类

setMediaRecorderDelegate:

注册 AgoraMediaRecorderDelegate 观察者。

Objective-C
- (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate;

自从

自 v4.0.0 版本新增。

该方法用于设置音视频录制的回调，使你在录制过程中能够获取音视频流的录制状态和相关信息。

在调用该方法前，请确保已创建并初始化 AgoraRtcEngineKit 对象，并使用 createMediaRecorder: 创建录制器实例。

参数

参数名描述
delegate

音视频流录制的回调。详见 AgoraMediaRecorderDelegate。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

startAudioRecording:quality:

开始客户端录音。

Objective-C
- (int)startAudioRecording:(NSString * _Nonnull)filePath
                   quality:(AgoraAudioRecordingQuality)quality NS_SWIFT_NAME(startAudioRecording(_:quality:));

你可以在通话过程中调用该方法进行客户端录音。该方法会录制频道中所有用户的音频，并生成包含所有用户声音的录音文件。录音文件仅支持以下格式：

  • .wav：文件体积大，音频保真度高。
  • .aac：文件体积小，音频保真度有损。

注： 调用该方法时，默认的录音采样率为 32 kHz，且无法修改。

参数

参数名描述
filePath

录音文件保存的本地绝对路径。路径必须包含文件名和扩展名，例如：/var/mobile/Containers/Data/audio.aac。

注： 请确保指定路径存在且可写。

quality

录音质量，详见 AgoraAudioRecordingQuality。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

startAudioRecordingWithConfig:

开始客户端录制并配置录制设置。

Objective-C
- (int)startAudioRecordingWithConfig:(AgoraAudioRecordingConfiguration * _Nonnull)config NS_SWIFT_NAME(startAudioRecording(withConfig:));

调用该方法后，你可以录制频道中用户的音频并生成录音文件。录音文件仅支持以下格式：

  • WAV：音频保真度较高但文件较大。例如，采样率为 32000 Hz 的 10 分钟录音文件约为 73 MB。
  • AAC：音频保真度较低但文件较小。例如，采样率为 32000 Hz 且录音质量为 AgoraAudioRecordingQualityMedium 的 10 分钟录音文件约为 2 MB。

当你离开频道时，录制会自动停止。该方法支持在通话过程中进行客户端录制。

调用时机

该方法必须在加入频道后调用。

参数

参数名描述
config

录制配置，详见 AgoraAudioRecordingConfiguration。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

startRecording:

开始录制音视频流。

Objective-C
- (int)startRecording:(AgoraMediaRecorderConfiguration* _Nonnull)config NS_SWIFT_NAME(startRecording(_:));

自从

自 v4.0.0 版本新增。

该方法用于开始录制音频和视频流。声网 SDK 支持同时录制本地和远端用户的音视频流。 在开始录制前，请确保：

该方法支持录制以下数据：

  • 通过麦克风采集的音频，编码格式为 AAC。
  • 通过摄像头采集的视频，编码格式为 H.264 或 H.265。

录制开始后，如果录制过程中视频分辨率发生变化，SDK 会停止录制。如果音频采样率或声道数发生变化，SDK 会继续录制并生成一个 MP4 文件。仅当检测到可录制的音视频流时，才会生成录制文件。如果在录制过程中未检测到可录制的音视频流，或音视频流中断超过 5 秒，SDK 会停止录制并触发 mediaRecorder:stateDidChanged:uid:state:reason: 回调（AgoraMediaRecorderStateError，AgoraMediaRecorderReasonCodeNoStream）。

注：

  • 如果需要录制本地音视频流，请确保本地用户角色在开始录制前已设置为主播。
  • 如果需要录制远端用户的音视频流，请确保在开始录制前已订阅目标用户的音视频流。

参数

参数名描述
config

用于配置音视频流录制的参数，详见 AgoraMediaRecorderConfiguration。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。详见错误码：

    • -2：参数无效。请确保：

      • 指定的录制文件保存路径正确且可写。
      • 指定的录制文件格式正确。
      • 最大录制时长设置正确。

    • -4：当前 AgoraRtcEngineKit 的状态不支持该操作。可能是由于已有录制任务正在进行，或录制错误导致录制已停止。

    • -7：调用该方法时 AgoraRtcEngineKit 尚未初始化。请确保在调用该方法前已创建 AgoraMediaRecorder 对象。

所属接口类

stopAudioRecording

停止客户端录制音频。

Objective-C
- (int)stopAudioRecording NS_SWIFT_NAME(stopAudioRecording());

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

stopRecording

停止录制音视频流。

Objective-C
- (int)stopRecording NS_SWIFT_NAME(stopRecording());

自从

自 v4.0.0 版本新增。

注： 调用 startRecording: 后，如果你想停止录制，必须调用此方法；否则生成的录制文件可能无法正常播放。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败：

    • -7：在初始化 AgoraRtcEngineKit 之前调用该方法。请确保在调用此方法之前已创建 Recorder 对象。

所属接口类

mediaRecorder:informationDidUpdated:uid:info:

录制信息更新回调。

Objective-C
- (void)mediaRecorder:(AgoraMediaRecorder* _Nonnull)recorder informationDidUpdated:(NSString * _Nonnull)channelId uid:(NSUInteger)uid info:(AgoraMediaRecorderInfo* _Nonnull)info;

自从

自 v4.0.0 版本新增。

在你成功注册该回调并开始音视频流录制后，SDK 会根据你在 AgoraMediaRecorderConfiguration 中设置的 recorderInfoUpdateInterval 的值，周期性地触发该回调，报告当前录制文件的名称、时长和大小。

触发时机

该回调在你成功注册并开始音视频流录制后，SDK 会周期性地触发。

参数

参数名描述
recorder

AgoraMediaRecorder 实例。详见 AgoraMediaRecorder。

channelId

频道名。

uid

用户 ID。

info

录制文件信息，详见 AgoraMediaRecorderInfo。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

mediaRecorder:stateDidChanged:uid:state:reason:

录制状态发生变化时的回调。

Objective-C
- (void)mediaRecorder:(AgoraMediaRecorder* _Nonnull)recorder stateDidChanged:(NSString * _Nonnull)channelId uid:(NSUInteger)uid state:(AgoraMediaRecorderState)state reason:(AgoraMediaRecorderReasonCode)reason;

自从

自 v4.0.0 版本新增。

触发时机

当音视频流的录制状态发生变化时触发。

参数

参数名描述
recorder

录制器实例。详见 AgoraMediaRecorder。

channelId

频道名。

uid

用户 ID。

state

当前的录制状态，详见 AgoraMediaRecorderState。

reason

录制状态变化的原因，详见 AgoraMediaRecorderReasonCode。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利