Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
API reference for IRTCRecord, the Windows SRTC local recording object (one per channel): output file name, watermark, output size, recording a window region, the user view layout, and starting, pausing, and stopping recording. Read when implementing local recording.
virtual StatusCode setRecordFileName(const char* filepath) = 0;
| Parameter | Type | Description |
|---|---|---|
| filepath | const char* | Path where the recording file is saved |
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode setWaterMask(const char* mask) = 0;
| Parameter | Type | Description |
|---|---|---|
| mask | const char* | Watermark configuration |
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode setOutputSize(int w, int h) = 0;
| Parameter | Type | Description |
|---|---|---|
| w | int | Output video width |
| h | int | Output video height |
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode startRecord() = 0;
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode setRecordHwnd(void* hwnd, int x, int y, int w, int h) = 0;
| Parameter | Type | Description |
|---|---|---|
| hwnd | void* | Handle of the window to record |
| x | int | x coordinate of the recording area |
| y | int | y coordinate of the recording area |
| w | int | Width of the recording area |
| h | int | Height of the recording area |
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode setRecordLayoutMemberView(const char* layout_json, int json_len) = 0;
| Parameter | Type | Description |
|---|---|---|
| layout_json | const char* | Layout configuration JSON string; see Recording layout user view configuration |
| json_len | int | Length of the JSON string |
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode pauseRecord() = 0;
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |
virtual StatusCode stopRecord() = 0;
| Return value | Description |
|---|---|
| StatusCode | Status code of the operation result |