Function
This API is used to customize the text for a specific scenario.
Function Prototype
setCustomUIText(customSceneTextInfoList: CustomSceneTextInfoList, onSetCustomUITextResult?: (ret: SDKERR, reason: string) => void): voidsetCustomUIText(customSceneTextInfoList: CustomSceneTextInfoList, onSetCustomUITextResult?: (ret: SDKERR, reason: string) => void): void
Request Parameters
Table 1 Input parameter description
Parameter |
Mandatory |
Type |
Description |
customSceneTextInfoList |
Yes |
CustomSceneTextInfoList |
Custom text details. |
onSetCustomUITextResult |
Yes |
(ret: SDKERR, reason: string) => void |
Callback of customizing text for specific scenarios. |
Table 2 CustomSceneTextInfoList
Parameter |
Mandatory |
Type |
Description |
customSceneTextInfoList |
Yes |
Array<CustomSceneTextInfo> |
Custom text details. |
Table 3 CustomSceneTextInfo
Parameter |
Mandatory |
Type |
Description |
scene |
Yes |
UICustomTextScene |
Scenario requiring text customization. |
sceneTextList |
Yes |
Array<UICustomTextInfo> |
List of custom text strings. |
Table 4 Enumerated values of UICustomTextScene
Enumeration Name |
Enumerated Value |
Description |
CLOUD_RECORD_FINISHED_ALERT_SCENE |
0 |
Screen displayed when the host stops cloud recording during a meeting. |
CLOUD_RECORD_FINISHED_ALERT_IM_SCENE |
1 |
Screen displayed when cloud recording ends after the host leaves the meeting (valid only for the macOS platform). |
CLOUD_RECORD_MENU_TITLE_TEXT_SCENE |
2 |
Cloud recording title in the recording pop-up menu (for Windows only). |
CLOUD_RECORD_MENU_DES_TEXT_SCENE |
3 |
Cloud recording description in the recording pop-up menu (for Windows only). |
MAIN_WINDOW_CLOUD_RECORD_DES_TEXT_SCENE |
4 |
Cloud recording description in the main window (for Windows only). |
Table 5 UICustomTextInfo
Parameter |
Mandatory |
Type |
Description |
languageType |
Yes |
Language |
Language type. |
languageCode |
No |
string |
Code of the custom language. |
customText |
Yes |
string |
Custom text. |
Table 6 Enumerated values of Language
Enumeration Name |
Enumerated Value |
Description |
HWM_LANGUAGE_ZH_CN |
0 |
Chinese. |
HWM_LANGUAGE_EN_GB |
1 |
English. |
HWM_LANGUAGE_CUSTOMIZED |
2 |
Custom language. |
Callback Method Parameters
(ret: SDKERR, reason: string) => void
Table 7 Input parameter description
Parameter |
Type |
Description |
ret |
For details about SDKERR, see Error Code Reference. |
Error code. |
reason |
string |
Error description. |