RecorderBaseBehaviour Class

RecorderBaseBehaviour 是控制录屏功能的component。

Public Types

enum Status{OnStarted, OnStopped, FailedToStart, FileSucceeded, FileFailed, LogInfo, LogError}

enum RecorderZoomMode{NoZoomAndClip, ZoomInWithAllContent}

enum RecorderProfile{Quality_1080P_Low, Quality_1080P_Middle, Quality_1080P_High, Quality_720P_Low, Quality_720P_Middle, Quality_720P_High, Quality_480P_Low, Quality_480P_Middle, Quality_480P_High, Quality_Default}

Public Fields

bool RequestPlatformPermission

RecorderProfile Profile

RecorderZoomMode Mode

Public Properties

string OutputFile

Public Functions

void StartRecording()

void StopRecording()

bool RecordFrame(RenderTexture texture)

Public Events

event Action<RecorderBaseBehaviour, RenderTexture> FrameUpdate

event Action<RecorderBaseBehaviour, Status, string> StatusUpdate

Overwritten MonoBahaviour Functions

protected virtual void OnDestroy()

protected virtual void Start()

protected virtual void Update()

enum Status

Constant	Value	Description
OnStarted	0x00000002	录屏开始
OnStopped	0x00000004	录屏结束
FailedToStart	0x00000202	开始录屏失败
FileSucceeded	0x00000400	文件存储成功
FileFailed	0x00000401	文件存储失败
LogInfo	0x00000800	运行时信息，包含描述
LogError	0x00001000	运行时错误，包含错误描述

enum RecorderZoomMode

Constant	Value	Description
NoZoomAndClip	0x00000000	如果输出宽高比与输入不符，内容会被剪裁到适合输出比例。
ZoomInWithAllContent	0x00000001	如果输出宽高比与输入不符，内容将不会被剪裁，在某个维度上会有黑边。

enum RecorderProfile

Constant	Value	Description
Quality_1080P_Low	0x00000001	1080P，低质量
Quality_1080P_Middle	0x00000002	1080P，中质量
Quality_1080P_High	0x00000004	1080P，高质量
Quality_720P_Low	0x00000008	720P，低质量
Quality_720P_Middle	0x00000010	720P，中质量
Quality_720P_High	0x00000020	720P，高质量
Quality_480P_Low	0x00000040	480P，低质量
Quality_480P_Middle	0x00000080	480P，中质量
Quality_480P_High	0x00000100	480P，高质量
Quality_Default	0x00000010	默认分辨率与质量，与 Quality_720P_Middle 相同

bool RequestPlatformPermission

是否在开始录屏的时候请求设备所需的系统权限。如果false，你必须手动保证系统权限已经被申请。

默认值为 true.

RecorderProfile Profile

录屏配置。修改将在StartRecording之后生效。

默认值为 Quality_720P_Middle.

RecorderZoomMode Mode

缩放模式。修改将在StartRecording之后生效。

默认值为 NoZoomAndClip.

string OutputFile

录屏输出文件。修改将在StartRecording之后生效。在StartRecording之前必须设置。

void StartRecording()

开始录屏。

void StopRecording()

结束录屏。

bool RecordFrame(RenderTexture texture)

录制输入纹理的当前帧数据。应该在StartRecording之后每帧调用。

event Action<RecorderBaseBehaviour, RenderTexture> FrameUpdate

frame 更新事件。将在纹理被发送用于录制之前调用。可以在事件中修改texture。

event Action<RecorderBaseBehaviour, Status, string> StatusUpdate

状态更新事件。可以用来检查录屏是否停止或输出文件是否成功保存等。