PanoRecording类 参考

PanoRecording, 录制服务核心接口 更多...

#include <PanoRecording.h>

类
class	Callback
	PanoRecording 的回调函数，在使用 PanoRecording 之前必须要设置回调以获取事件通知。 更多...
struct	LocalRecordingOption
	本地录制参数 更多...

Public 类型
enum class	LayoutMode { Gallery = 0 , Floating = 1 , Speaker = 2 , ActiveSpeaker = 3 }
	录制布局模式 更多...
enum class	State {   Idle , Started , Paused , Resumed ,   Stopped , Error }
	录制状态
using	EnumCallback = bool(*)(void *context, const char *channelId, const char *filePath, const char *recordTime)
	本地录制文件枚举回调 更多...

Public 成员函数
virtual QResult	setCallback (Callback *callback)=0
	设置录制服务的回调。 更多...
virtual QResult	startRecording (const LocalRecordingOption &option)=0
	开启本地录制。 更多...
virtual QResult	pauseRecording ()=0
	暂停录制。 更多...
virtual QResult	resumeRecording ()=0
	恢复录制。 更多...
virtual QResult	stopRecording ()=0
	停止录制。 更多...
virtual QResult	updateLayout (LayoutMode layout)=0
	更改录制布局模式。 更多...
virtual QResult	setSpeakerUser (uint64_t userId)=0
	设置主讲人。 更多...
virtual void	enumLocalRecordingFiles (const char *recordingPath, EnumCallback cb, void *context) const =0
	枚举本地录制文件。 更多...

详细描述

PanoRecording, 录制服务核心接口

成员类型定义说明

EnumCallback

using PanoRecording::EnumCallback = bool(*) (void *context, const char *channelId, const char *filePath, const char *recordTime)

本地录制文件枚举回调

参数

context	用户自定义上下文
channelId	频道标识
filePath	录制文件路径名
recordTime	录制时间

返回

返回true继续, 返回false停止

成员枚举类型说明

LayoutMode

enum class PanoRecording::LayoutMode

strong

录制布局模式

枚举值
Gallery	画廊模式
Floating	悬浮模式
Speaker	演讲者模式
ActiveSpeaker	语音激励模式

成员函数说明

enumLocalRecordingFiles()

virtual void PanoRecording::enumLocalRecordingFiles ( const char *  recordingPath, EnumCallback  cb, void *  context  ) const

pure virtual

枚举本地录制文件。

参数

recordingPath	本地录制存储路径。
cb	回调函数
context	用户自定义上下文， 在回调函数中返回给用户

pauseRecording()

virtual QResult PanoRecording::pauseRecording ( )

pure virtual

暂停录制。

返回

• OK: 成功
• 其他: 失败

resumeRecording()

virtual QResult PanoRecording::resumeRecording ( )

pure virtual

恢复录制。

返回

• OK: 成功
• 其他: 失败

setCallback()

virtual QResult PanoRecording::setCallback ( Callback *  callback )

pure virtual

设置录制服务的回调。

参数

callback

回调。

返回

• OK: 成功
• 其他: 失败

setSpeakerUser()

virtual QResult PanoRecording::setSpeakerUser ( uint64_t  userId )

pure virtual

设置主讲人。

参数

userId

主讲人 ID。

返回

• OK: 成功
• 其他: 失败

startRecording()

virtual QResult PanoRecording::startRecording ( const LocalRecordingOption &  option )

pure virtual

开启本地录制。

参数

option

本地录制参数。

返回

• OK: 成功
• 其他: 失败

stopRecording()

virtual QResult PanoRecording::stopRecording ( )

pure virtual

停止录制。

返回

• OK: 成功
• 其他: 失败

updateLayout()

virtual QResult PanoRecording::updateLayout ( LayoutMode  layout )

pure virtual

更改录制布局模式。

参数

layout

布局模式。

返回

• OK: 成功
• 其他: 失败

---

该类的文档由以下文件生成:

• PanoRecording.h