Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ UI Configuration Management Objects/ Customizing a Watermark for a Meeting
Updated on 2023-03-23 GMT+08:00
View PDF

Customizing a Watermark for a Meeting

Function

This API is used to customize a watermark. If not specified, the internal priorities are used to display the watermark. 1. Call this API before a meeting. Calling this API during a meeting does not take effect. 2. If the enterprise-level watermark function is disabled, the custom watermark content injection does not take effect.

Function Prototype

setWaterMark(waterMarkInfo: WaterMarkInfo, onSetWaterMarkResult?: (ret: SDKERR, reason: string) => void): voidsetWaterMark(waterMarkInfo: WaterMarkInfo, onSetWaterMarkResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
waterMarkInfo Y WaterMarkInfo Watermark injection information.
onSetWaterMarkResult Y (ret: SDKERR, reason: string) => void Callback of configuring watermark injection information.
Table 2 WaterMarkInfo
Parameter Mandatory Type Description
content N string Custom watermark injection content.
color N WaterMarkColorType Watermark font color. 0: light; 1: standard; 2: dark.
Table 3 Enumerated values of WaterMarkColorType
Enumeration Name Enumerated Value Description
HWM_WATERMARK_COLOR_TYPE_LIGHT 0 Light #CCCCCC
HWM_WATERMARK_COLOR_TYPE_STANDARD 1 Standard #999999
HWM_WATERMARK_COLOR_TYPE_DARKER 2 Dark #666666

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string) => void

Table 4 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.