Host management APIs - STMLink Docs

All of the following APIs are called on ISMeetingChannel and can only be executed by the host or members with the corresponding permission.

Room controls

End the meeting

virtual StatusCode adminDestroyRoom(Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the room name

virtual StatusCode adminUpdateRoomName() = 0;

Returns StatusCode - Error code

Update the room video state

virtual StatusCode adminUpdateRoomVideoState() = 0;

Returns StatusCode - Error code

Update the room audio state

virtual StatusCode adminUpdateRoomAudioState() = 0;

Returns StatusCode - Error code

Update the room camera state

virtual StatusCode adminUpdateRoomCameraState(bool self_unmute_camera_disabled, bool camera_disabled, Callback back = NULL) = 0;
virtual StatusCode adminUpdateRoomCameraState(bool self_unmute_camera_disabled, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
self_unmute_camera_disabled	bool	Whether members are prevented from turning their cameras back on themselves
camera_disabled	bool	Whether cameras are disabled
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the room microphone state

virtual StatusCode adminUpdateRoomMicState(bool self_unmute_mic_disabled, bool mic_disabled, Callback back = NULL) = 0;
virtual StatusCode adminUpdateRoomMicState(bool self_unmute_mic_disabled, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
self_unmute_mic_disabled	bool	Whether members are prevented from unmuting themselves
mic_disabled	bool	Whether microphones are disabled
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the room chat state

virtual StatusCode adminUpdateRoomChatDisabled(bool chat_disabled, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
chat_disabled	bool	Whether chat is disabled
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the room screenshot state

virtual StatusCode adminUpdateRoomScreenshotDisabled(bool screenshot_disabled, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
screenshot_disabled	bool	Whether screenshots are disabled
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the room MCU mode

virtual StatusCode adminUpdateRoomMCUMode() = 0;

Returns StatusCode - Error code

Update the room lock state

virtual StatusCode adminUpdateRoomLocked(bool locked, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
locked	bool	Whether the room is locked
back	Callback	Asynchronous callback

Returns StatusCode - Error code

virtual StatusCode adminStopRoomShare(Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
back	Callback	Asynchronous callback

Returns StatusCode - Error code

virtual StatusCode adminUpdateRoomShareState(bool v, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
v	bool	Sharing state
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update whether entering before the host is disabled

virtual StatusCode adminUpdateEnterBeforeHostDisabled(bool v, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
v	bool	Whether members are prevented from entering before the host
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Member controls

Update a member’s name

virtual StatusCode adminUpdateUserName(std::string uid, std::string name, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
name	std::string	New name
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update a member’s role

virtual StatusCode adminUpdateUserRole(std::string uid, int role, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
role	int	Role type
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update a member’s chat permission

virtual StatusCode adminUpdateUserChatDisabled(std::string uid, bool chat_disabled, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
chat_disabled	bool	Whether chat is disabled
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Disable a member’s camera

virtual StatusCode adminDisableUserCamera() = 0;

Returns StatusCode - Error code

Disable a member’s microphone

virtual StatusCode adminDisableUserMic() = 0;

Returns StatusCode - Error code

Turn off a member’s camera

virtual StatusCode adminCloseUserCamera(std::string uid, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Turn off a member’s microphone

virtual StatusCode adminCloseUserMic(std::string uid, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Ask a member to turn on the camera

virtual StatusCode adminRequestUserOpenCamera(std::string uid, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Ask a member to turn on the microphone

virtual StatusCode adminRequestUserOpenMic(std::string uid, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Remove a member

virtual StatusCode adminKickUserOut(std::string uid, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Respond to a raised hand

virtual StatusCode adminConfirmHandup(std::string uid, int code, bool approve, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
code	int	Raise-hand type code
approve	bool	Whether to approve
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Invite devices to the meeting

virtual StatusCode adminInviteAgent(std::string no, int tp, std::vector<std::string> devs, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
no	std::string	Room number
tp	int	Type
devs	`std::vector<std::string>`	List of devices
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the invitee list

virtual StatusCode adminUpdateConferee(std::vector<std::string> conferee, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
conferee	`std::vector<std::string>`	List of invitees
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Update the layout

virtual StatusCode adminUpdateLayout(std::string layout, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
layout	std::string	Layout configuration
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Call users

virtual StatusCode adminCallUsers(std::vector<std::string> users, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
users	`std::vector<std::string>`	List of users
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Remind users

virtual StatusCode adminRemind(std::vector<std::string> users, bool sms, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
users	`std::vector<std::string>`	List of users
sms	bool	Whether to send an SMS
back	Callback	Asynchronous callback

Returns StatusCode - Error code