配置录制规则

注意事项

• 一个应用在相同区域仅支持配置一个录制规则。
• 若OBS服务欠费停服，将会导致实时音视频录制失败。建议您在录制启动前，确认OBS服务是正常服务的。
• OBS服务会因欠费停服，从而导致实时音视频录制失败，建议您购买OBS存储包。

前提条件

• 已添加应用。
• 因录制生成的音视频文件是存储在OBS桶中的，因此，您需要先开通对象存储服务，具体请参见OBS快速入门。

费用说明

• SparkRTC录制功能为计费项，将会根据生成的录制文件的总时长收取费用。具体价格详情请参见SparkRTC产品价格详情。
• SparkRTC录制生成的音视频文件最终存储在OBS桶中，因此，产生的存储使用量费用将由对象存储服务单独收取。具体价格详情请参见OBS价格详情。

步骤一：创建桶

若您未有存储录制文件的OBS桶，请参见OBS帮助中心创建桶。否则，请直接执行步骤二：云资源授权。

须知：

暂只支持录制存储在华北-北京四的OBS桶中。

步骤二：云资源授权

将OBS桶授权给SparkRTC服务，允许录制文件存储在OBS桶中。具体授权方法请参见云资源授权。

步骤三：配置录制规则

1. 登录实时音视频控制台。
2. 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。
3. 在需要创建录制规则的应用行，单击“配置”，进入录制配置页面。
4. 在“录制规则”区域，单击“添加”，进入添加录制规则页面。
   说明：

   一个应用ID在相同区域仅支持创建一个录制规则。

5. 请您按照实际需求配置录制参数，参数说明如表1所示。

   表1 录制参数说明

   参数名		描述
   存储-桶		存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。
   区域		OBS桶所在的区域。
   存储-路径		存储录制文件的OBS桶路径。
   录制格式		录制文件的格式，支持HLS和MP4文件格式。
   HLS规则	m3u8命名规则	录制m3u8文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。
   	录制周期	录制时长支持0-720分钟，最小录制周期为1分钟，最大录制周期为12小时，超过12小时，系统将按照命名规则生成新文件。如果录制周期为0，则整个流录制为一个文件。
   	最大断流合并时长	支持如下三种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 断流后不生成新文件：是指录制的直播流中断后，会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。
   MP4规则	mp4命名规则	录制mp4文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。
   	录制周期	录制时长支持1-180分钟，最小录制周期为1分钟，最大录制周期为3小时，超过3小时，系统将按照命名规则生成新文件。
   	最大断流合并时长	支持如下两种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。

6. 单击“确定”，在录制规则列表中会增加一条新的录制规则。
   图2 录制规则
   
7. 您可以在录制规则列表中，根据实际需求选择是否开启自动录制功能。自动录制功能开启后，若该应用下有新创建的房间，则会按照已配置的录制规则自动对该房间中的实时音视频互动过程进行单流录制。
   说明：

   自动录制功能开启后，仅对同一应用下新创建的房间生效，自动录制功能开启前已创建的房间不生效。

步骤四：录制

录制规则配置完成后，您可以根据实际需求调用实时音视频API启动云端录制任务。SparkRTC服务会根据API中的录制规则ID对实时音视频内容进行录制。

步骤五：查看录制文件

录制完成后，您可以在OBS控制台中或通过回调消息查看录制文件。

• 通过OBS控制台查看录制文件
  1. 在OBS管理控制台左侧导航栏选择“对象存储”。
  2. 在桶列表中单击存储SparkRTC录制文件的桶，进入“概览”页面。
  3. 在左侧导航栏，单击“对象”，查看录制文件信息。
  4. 您还可以对录制文件进行下载、分享等操作，具体请参见OBS帮助中心。
• 通过回调消息查看录制文件

  若您设置了录制回调地址，则每生成一个录制文件都将收到录制回调消息。具体录制回调配置方法及消息字段说明请参见配置录制回调。