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

音视频录制

  • Unity

更新时间不可用

CreateMediaRecorder

创建音视频录制对象。

C#
public abstract IMediaRecorder CreateMediaRecorder(RecorderStreamInfo info);

在开始音视频流录制前，你需要调用该方法创建一个音视频录制对象。SDK 支持录制本地或远端用户的多个音视频流，你可以多次调用该方法创建录制对象，并通过 info 参数指定需要录制的频道名称和发流的用户 ID。 成功创建后，你需要调用 SetMediaRecorderObserver 注册录制对象的观测器来监听录制的相关回调，然后再调用 StartRecording 开始录制。

参数

参数名描述
info

需要录制的音视频流相关信息，详见 RecorderStreamInfo。

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

返回值

  • 方法调用成功：返回一个 IMediaRecorder 对象。
  • 方法调用失败：返回空指针。

所属接口类

DestroyMediaRecorder

销毁音视频录制对象。

C#
public abstract int DestroyMediaRecorder(IMediaRecorder mediaRecorder);

当你不需要再录制音视频流时，可以调用该方法销毁对应的音视频录制对象。如果你正在录制，请先调用 StopRecording 停止录制，再调用该方法来销毁音视频录制对象。

参数

参数名描述
mediaRecorder

待销毁的 IMediaRecorder 对象。

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

返回值

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

所属接口类

SetMediaRecorderObserver

注册 IMediaRecorderObserver 观测器。

C#
public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback);

该方法用于设置音视频录制的回调，以便在录制过程中向 App 通知音视频流的录制状态和信息。 调用该方法前请确保：

参数

参数名描述
callback

音视频流录制回调，详见 IMediaRecorderObserver。

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

返回值

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

所属接口类

StartAudioRecording [1/3]

开始客户端录音。

C#
public abstract int StartAudioRecording(string filePath, AUDIO_RECORDING_QUALITY_TYPE quality);

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

  • .wav: 文件大，音质保真度高；
  • .aac: 文件小，有一定的音质保真度损失。

请确保指定的目录存在且可写。该接口需在 JoinChannel [2/2] 之后调用。如果调用 LeaveChannel [2/2] 时还在录音，录音会自动停止。

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

参数

参数名描述
filePath

录音文件在本地保存的绝对路径，需精确到文件名及格式。例如：C:\music\audio.aac。

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

quality

录音质量。详见 AUDIO_RECORDING_QUALITY_TYPE。

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

返回值

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

所属接口类

StartAudioRecording [2/3]

开始客户端录音并设置录音采样率。

C#
public abstract int StartAudioRecording(string filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality);

SDK 支持通话过程中在客户端进行录音。调用该方法后，你可以录制频道内所有用户的音频，并得到一个包含所有用户声音的录音文件。录音文件仅支持下列格式：

  • .wav: 文件大，音质保真度较高。
  • .aac: 文件小，音质保真度较低。

注：

  • 请确保你在该方法中指定的路径存在并且可写。
  • 该接口需在 JoinChannel [2/2] 之后调用。如果调用 LeaveChannel [2/2] 时还在录音，录音会自动停止。
  • 为保证录音效果，当 sampleRate 设为 44.1 kHz 或 48 kHz 时，建议将 quality 设为 AUDIO_RECORDING_QUALITY_MEDIUM 或 AUDIO_RECORDING_QUALITY_HIGH。

参数

参数名描述
filePath

录音文件在本地保存的绝对路径，需精确到文件名及格式。例如：C:\music\audio.aac。

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

sampleRate

录音采样率（Hz），可以设为以下值：

  • 16000
  • 32000（默认）
  • 44100
  • 48000
quality

录音音质。详见 AUDIO_RECORDING_QUALITY_TYPE 。

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

返回值

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

所属接口类

StartAudioRecording [3/3]

开始客户端录音并进行录音配置。

C#
public abstract int StartAudioRecording(AudioRecordingConfiguration config);

SDK 支持通话过程中在客户端进行录音。调用该方法后，你可以录制频道内用户的音频，并得到一个录音文件。录音文件仅支持下列格式：

  • WAV: 音质保真度较高，文件较大。例如，采样率为 32000 Hz，录音时长为 10 分钟的文件大小约为 73 M。
  • AAC: 音质保真度较低，文件较小。例如，采样率为 32000 Hz，录音音质为 AUDIO_RECORDING_QUALITY_MEDIUM，录音时长为 10 分钟的文件大小约为 2 M。

用户离开频道后，录音会自动停止。

调用时机

该方法需要在加入频道后调用。

参数

参数名描述
config

录音配置。详见 AudioFileRecordingConfig。

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

返回值

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

所属接口类

StartRecording

开启音视频流录制。

C#
public abstract int StartRecording(MediaRecorderConfiguration config);

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

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

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

开启音视频流录制后，当视频分辨率在录制过程中发生变化时，SDK 会停止录制；当音频采样率和声道数发生变化时，SDK 会持续录制并生成单个 MP4 录制文件。仅当检测到可录制的音视频流时，才能成功生成录制文件；如果没有可录制的音视频流，或在录制过程中的音视频流中断超过 5 秒后，SDK 会停止录制，并触发 OnRecorderStateChanged(RECORDER_STATE_ERROR, RECORDER_REASON_NO_STREAM) 回调。

注：

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

参数

参数名描述
config

音视频流录制配置。详见 MediaRecorderConfiguration。

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

返回值

  • 0: 方法调用成功。

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

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

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

    • -4: IRtcEngine 当前状态不支持该操作。可能因为录制正在进行中或录制出错停止。

    • -7: IRtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 IMediaRecorder 对象。

所属接口类

StopAudioRecording

停止客户端录音。

C#
public abstract int StopAudioRecording();

返回值

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

所属接口类

StopRecording

停止音视频流录制。

C#
public abstract int StopRecording();

注： 调用 StartRecording 后，如果要停止录制，请调用该方法停止录制；否则，生成的录制文件可能无法正常播放。

返回值

  • 0: 方法调用成功。

  • < 0: 方法调用失败：

所属接口类

OnRecorderInfoUpdated

录制信息更新回调。

C#
public virtual void OnRecorderInfoUpdated(string channelId, uint uid, RecorderInfo info) {}

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

参数

参数名描述
channelId

频道名称。

uid

用户 ID。

info

录制文件信息。详见 RecorderInfo。

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

所属接口类

OnRecorderStateChanged

录制状态发生改变回调。

C#
public virtual void OnRecorderStateChanged(string channelId, uint uid, RecorderState state, RecorderReasonCode reason)

音视频流录制状态发生改变时，SDK 会触发该回调，报告当前的录制状态和引起录制状态改变的原因。

参数

参数名描述
channelId

频道名称。

uid

用户 ID。

state

当前的录制状态。详见 RecorderState。

reason

录制状态出错的原因。详见 RecorderReasonCode。

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

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利