Updated on 2024-12-27 GMT+08:00

Customizing the Icon for a Specific Scenario

Function

This API is used to customize the icon for a specific scenario.

Function Prototype

setCustomUIImage(customSceneImageInfoList: CustomSceneImageInfoList, onSetCustomUIImageResult?: (ret: SDKERR, reason: string) => void): voidsetCustomUIImage(customSceneImageInfoList: CustomSceneImageInfoList, onSetCustomUIImageResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
customSceneImageInfoList Yes CustomSceneImageInfoList Custom icon details.
onSetCustomUIImageResult Yes (ret: SDKERR, reason: string) => void Callback of customizing icons for specific scenarios.
Table 2 CustomSceneImageInfoList
Parameter Mandatory Type Description
customSceneImageInfoListSize Yes number Number of scenarios requiring icon customization.
customSceneImageInfoList Yes CustomSceneImageInfo Custom icon details.
Table 3 CustomSceneImageInfo
Parameter Mandatory Type Description
scene Yes UICustomImageScene Scenario requiring icon customization.
imagePath Yes string Custom icon path.
width Yes number Custom icon width.
height Yes number Custom icon height.
Table 4 Enumerated values of UICustomImageScene
Enumeration Name Enumerated Value Description
CLOUD_RECORD_ICON_IMAGE_SCENE 0 Main icon of cloud recording in a meeting (in the recording pop-up menu, participant list, and sharing toolbar).
MAIN_WINDOW_CLOUD_RECORD_ICON_SCENE 1 Small cloud recording icon in the main window.
MAIN_WINDOW_CLOUD_RECORD_LOGO_SCENE 2 Large cloud recording logo in the main window.

Return Values

void

Callback Method Parameters

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

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