ZegoMediaRecorder Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | zego-api-media-recorder-oc.h |
– startRecord:recordType:storagePath:
开始录制 (Deprecated: 请使用 - startRecord:recordType:storagePath:enableStatusUpdate:interval: 或者 - startRecord:recordType:storagePath:enableStatusUpdate:interval:recordFormat:)
- (BOOL)startRecord:(ZegoAPIMediaRecordChannelIndex)channelIndex recordType:(ZegoAPIMediaRecordType)recordType storagePath:(NSString *)storagePathParameters
channelIndex |
录制通道，详见 enum ZegoAPIMediaRecordChannelIndex。 |
|---|---|
recordType |
录制类型，详见 enum ZegoAPIMediaRecordType。 |
storagePath |
录制文件存储路径，传入的路径需要包含文件名 |
Return Value
true 调用成功，false 调用失败
Discussion
- 注意：必须在初始化 SDK之后调用。
Declared In
zego-api-media-recorder-oc.h
– startRecord:recordType:storagePath:enableStatusUpdate:interval:
开始录制
- (BOOL)startRecord:(ZegoAPIMediaRecordChannelIndex)channelIndex recordType:(ZegoAPIMediaRecordType)recordType storagePath:(NSString *)storagePath enableStatusUpdate:(BOOL)enable interval:(int)intervalParameters
channelIndex |
录制通道，详见 ZegoAPIMediaRecordChannelIndex。 |
|---|---|
recordType |
录制类型，，详见 ZegoAPIMediaRecordType；如果填写的类型是 ZEGOAPI_MEDIA_RECORD_NONE，实际上 SDK 会采用 ZEGOAPI_MEDIA_RECORD_BOTH。 |
storagePath |
录制文件存储路径，传入的路径需要包含文件名，存储的路径必须是应用有权限读写的，如果传入目录路径， - onMediaRecord:channelIndex:storagePath: 回调会返回写文件失败。 |
enable |
是否开启录制信息更新回调；YES: 开启，NO: 关闭；开启后，在已设置媒体录制代理后会收到 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。 |
interval |
录制文件时状态回调的间隔，单位毫秒，有效范围：[1000,10000]；此参数决定了 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 的回调频率。 |
Return Value
true 调用成功，false 调用失败
Discussion
- 1.必须在初始化 SDK 之后调用, 默认的生成的录制文件格式为 FLV。
- 2.如果开启了录制信息更新回调（enableStatusUpdate 参数值为 YES），请实现 -onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。
- 3.设置了录制回调代理(setMediaRecordDelegage:)后，才能收到媒体录制是否成功的通知。
- 注意：
- 1.在开始录制之前需要启动采集，调用 SDK 的 startPreview 或者 startPublishing 启动采集设备，麦克风、摄像头等。
- 2.若需要录制 ZEGOAPI_MEDIA_RECORD_AUDIO 类型媒体，在开始录制之前必须开启麦克风或者带麦克风的摄像头，不开启则不能正常返回录制的音频文件；同理，录制 ZEGOAPI_MEDIA_RECORD_VIDEO 类型媒体，必须开启摄像头，录制 ZEGOAPI_MEDIA_RECORD_BOTH 类型媒体，麦克风和摄像头都需要开启。
See Also
Declared In
zego-api-media-recorder-oc.h
– startRecord:recordType:storagePath:enableStatusUpdate:interval:recordFormat:
开始录制
- (BOOL)startRecord:(ZegoAPIMediaRecordChannelIndex)channelIndex recordType:(ZegoAPIMediaRecordType)recordType storagePath:(NSString *)storagePath enableStatusUpdate:(BOOL)enable interval:(int)interval recordFormat:(ZegoAPIMediaRecordFormat)recordFormatParameters
channelIndex |
录制通道，详见 enum ZegoAPIMediaRecordChannelIndex。 |
|---|---|
recordType |
录制类型，详见 enum ZegoAPIMediaRecordType，如果填写的类型是 ZEGOAPI_MEDIA_RECORD_NONE，实际上 SDK 会采用 ZEGOAPI_MEDIA_RECORD_BOTH。 |
storagePath |
录制文件存储路径，传入的路径需要包含文件名，存储的路径必须是应用有权限读写的，如果传入目录路径， - onMediaRecord:channelIndex:storagePath: 回调会返回写文件失败。 |
enable |
是否开启录制信息更新回调；YES: 开启，NO: 关闭；开启后，在已设置媒体录制代理后（ - setMediaRecordDelegage:）会收到 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。 |
interval |
录制文件时状态回调的间隔，单位毫秒，有效范围：[1000,10000]，此参数决定了 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 的回调频率。 |
recordFormat |
录制文件的文件格式，详见 enum ZegoAPIMediaRecordFormat。 |
Return Value
true 调用成功，false 调用失败
Discussion
- 1.必须在初始化 SDK 之后调用, 默认的生成的录制文件格式为 FLV。
- 2.如果开启了录制信息更新回调（enableStatusUpdate 参数值为 YES），请实现 -onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。
- 3.设置了录制回调代理(setMediaRecordDelegage:)后，才能收到媒体录制是否成功的通知。
- 注意：
- 1.在开始录制之前需要启动采集，调用 SDK 的 startPreview 或者 startPublishing 启动采集设备，麦克风、摄像头等。
- 2.若需要录制 ZEGOAPI_MEDIA_RECORD_AUDIO 类型媒体，在开始录制之前必须开启麦克风或者带麦克风的摄像头，不开启则不能正常返回录制的音频文件；同理，录制 ZEGOAPI_MEDIA_RECORD_VIDEO 类型媒体，必须开启摄像头，录制 ZEGOAPI_MEDIA_RECORD_BOTH 类型媒体，麦克风和摄像头都需要开启。
See Also
Declared In
zego-api-media-recorder-oc.h
– startRecord:recordType:storagePath:enableStatusUpdate:interval:recordFormat:isFragment:
开始录制
- (BOOL)startRecord:(ZegoAPIMediaRecordChannelIndex)channelIndex recordType:(ZegoAPIMediaRecordType)recordType storagePath:(NSString *)storagePath enableStatusUpdate:(BOOL)enable interval:(int)interval recordFormat:(ZegoAPIMediaRecordFormat)recordFormat isFragment:(BOOL)isFragmentParameters
channelIndex |
录制通道，详见 enum ZegoAPIMediaRecordChannelIndex。 |
|---|---|
recordType |
录制类型，详见 enum ZegoAPIMediaRecordType，如果填写的类型是 ZEGOAPI_MEDIA_RECORD_NONE，实际上 SDK 会采用 ZEGOAPI_MEDIA_RECORD_BOTH。 |
storagePath |
录制文件存储路径，传入的路径需要包含文件名，存储的路径必须是应用有权限读写的，如果传入目录路径， - onMediaRecord:channelIndex:storagePath: 回调会返回写文件失败。 |
enable |
是否开启录制信息更新回调；YES: 开启，NO: 关闭；开启后，在已设置媒体录制代理后（ - setMediaRecordDelegage:）会收到 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。 |
interval |
录制文件时状态回调的间隔，单位毫秒，有效范围：[1000,10000]，此参数决定了 - onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 的回调频率。 |
recordFormat |
录制文件的文件格式，详见 enum ZegoAPIMediaRecordFormat |
isFragment |
录制文件是否分片，只在录制文件格式被设置为 MP4 格式时才有效，默认分片间隔为2s。进行分片能保证录制发生异常中断等问题时，已保存的录制文件可以正常播放；注意，这儿的分片是 SDK 内部处理录制文件的一个逻辑概念，而不是将录制文件按间隔时间分成多个小文件存储。 |
Return Value
true 调用成功，false 调用失败
Discussion
- 1.必须在初始化 SDK 之后调用, 默认的生成的录制文件格式为 FLV。
- 2.如果开启了录制信息更新回调（enableStatusUpdate 参数值为 YES），请实现 -onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。
- 3.设置了录制回调代理(setMediaRecordDelegage:)后，才能收到媒体录制是否成功的通知。
- 注意：
- 1.在开始录制之前需要启动采集，调用 SDK 的 startPreview 或者 startPublishing 启动采集设备，麦克风、摄像头等。
- 2.若需要录制 ZEGOAPI_MEDIA_RECORD_AUDIO 类型媒体，在开始录制之前必须开启麦克风或者带麦克风的摄像头，不开启则不能正常返回录制的音频文件；同理，录制 ZEGOAPI_MEDIA_RECORD_VIDEO 类型媒体，必须开启摄像头，录制 ZEGOAPI_MEDIA_RECORD_BOTH 类型媒体，麦克风和摄像头都需要开启。
See Also
Declared In
zego-api-media-recorder-oc.h
– startRecord:
开始录制
- (BOOL)startRecord:(ZegoAPIMediaRecordConfig *)configParameters
config |
媒体录制配置，详见 ZegoAPIMediaRecordConfig |
|---|
Return Value
true 调用成功，false 调用失败
Discussion
- 1.必须在初始化 SDK 之后调用, 默认的生成的录制文件格式为 FLV。
- 2.如果开启了录制信息更新回调（enableStatusUpdate 参数值为 YES），请实现 -onRecordStatusUpdateFromChannel:index storagePath:duration:fileSize: 回调。
- 3.设置了录制回调代理(setMediaRecordDelegage:)后，才能收到媒体录制是否成功的通知。
- 注意：
- 1.在开始录制之前需要启动采集，调用 SDK 的 startPreview 或者 startPublishing 启动采集设备，麦克风、摄像头等。
- 2.若需要录制 ZEGOAPI_MEDIA_RECORD_AUDIO 类型媒体，在开始录制之前必须开启麦克风或者带麦克风的摄像头，不开启则不能正常返回录制的音频文件；同理，录制 ZEGOAPI_MEDIA_RECORD_VIDEO 类型媒体，必须开启摄像头，录制 ZEGOAPI_MEDIA_RECORD_BOTH 类型媒体，麦克风和摄像头都需要开启。
Declared In
zego-api-media-recorder-oc.h
– stopRecord:
停止录制
- (void)stopRecord:(ZegoAPIMediaRecordChannelIndex)channelIndexParameters
channelIndex |
录制通道，详见 enum ZegoAPIMediaRecordChannelIndex。 |
|---|
Declared In
zego-api-media-recorder-oc.h
– setMediaRecordDelegage:
设置录制代理对象
- (void)setMediaRecordDelegage:(id<ZegoMediaRecordDelegage>)delegateParameters
delegate |
媒体录制代理，详见 delegate ZegoMediaRecordDelegage。 |
|---|
Discussion
- 设置录制代理后，在启动录制（startRecord）之后才能收到录制回调。
Declared In
zego-api-media-recorder-oc.h