ISMeetingChannel meeting API

ISMeetingChannel represents one meeting object. It is created by ISMeetingEngine::createChannel() or createChannelByMeetingId() and destroyed by ISMeetingEngine::leaveChannel().

Channel basics

Get the channel ID

virtual std::string getChannelId() = 0;

Returns the room number / meeting ID passed in when the channel object was created. The ID stays the same even if the object switches to entering by meeting ID midway because of the waiting room, and it is the key leaveChannel() uses to release the object.

Get the channel settings object

virtual StatusCode getSetting(ISMeetingChannelSetting** sett) = 0;

Parameters

Parameter	Type	Description
sett	ISMeetingChannelSetting**	Output pointer to the settings object

Returns StatusCode - Error code

Set the channel event handler

virtual StatusCode setEventHandler(ISMeetingChannelEvent* e) = 0;

Parameters

Parameter	Type	Description
e	ISMeetingChannelEvent*	Event handler object

Returns StatusCode - Error code

You must set the handler before enter(): events raised while entering the meeting (member list, camera state, and so on) fire before enter() returns.

Enter / exit APIs

Enter the meeting

virtual StatusCode enter(std::string pass = "", Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
pass	std::string	Meeting password
back	Callback	Asynchronous callback

enter() calls /v1/meet/enter and joins the underlying SRTC channel. Set the display name, avatar, streaming vendor, and so on for entering the meeting through ISMeetingChannelSetting before calling enter(). Returns StatusCode - Error code

Exit the waiting room

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

Parameters

Parameter	Type	Description
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Room info APIs

Get your own info

virtual StatusCode getMe(std::string& s) = 0;

Parameters

Parameter	Type	Description
s	std::string&	Output your own info as a JSON string

Returns StatusCode - Error code

Get the room info

virtual StatusCode getRoom(std::string& s) = 0;

Parameters

Parameter	Type	Description
s	std::string&	Output the room info as a JSON string

Returns StatusCode - Error code

Get info for all members

virtual StatusCode getMembers(std::string& s) = 0;

Parameters

Parameter	Type	Description
s	std::string&	Output member info as a JSON string

Returns StatusCode - Error code

Get info for a specific member

virtual StatusCode getMember(std::string uid, std::string& s) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
s	std::string&	Output member info as a JSON string

Returns StatusCode - Error code

Get extended info

virtual StatusCode getOpt(std::string& opt) = 0;

Parameters

Parameter	Type	Description
opt	std::string&	Output extended info as a JSON string

Returns StatusCode - Error code

User operation APIs

Update your own name

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

Parameters

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

Returns StatusCode - Error code

Send a chat message

virtual StatusCode sendRoomChatMessage(int tp, std::string msg, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
tp	int	Message type
msg	std::string	Message content
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Send a custom message

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

Parameters

Parameter	Type	Description
First parameter	std::string	Message key
Second parameter	std::string	Message content
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Raise a hand

virtual StatusCode requestHandup(int code, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
code	int	Raise-hand type code
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Lower a raised hand

virtual StatusCode cancelHandup(int code, Callback back = NULL) = 0;

Parameters

Parameter	Type	Description
code	int	Raise-hand type code
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Get the online member list

virtual StatusCode listOnlineMember(std::string _meetid, Callback back = nullptr) = 0;

Parameters

Parameter	Type	Description
_meetid	std::string	Meeting ID
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Waiting room APIs

Update the waiting room state

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

Parameters

Parameter	Type	Description
v	bool	Waiting room state
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Get the waiting room user list

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

Parameters

Parameter	Type	Description
back	Callback	Asynchronous callback

Returns StatusCode - Error code

Move into the waiting room

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

Parameters

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

Returns StatusCode - Error code

Move out of the waiting room

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

Parameters

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

Returns StatusCode - Error code

Overview

Low-code integration

Web SDK

Android SDK

Windows SDK

Swift SDK (iOS/macOS)

iOS SDK (Objective-C)

Server API

ISMeetingChannel meeting API

Channel basics

Get the channel ID

Get the channel settings object

Set the channel event handler

Enter / exit APIs

Enter the meeting

Exit the waiting room

Room info APIs

Get your own info

Get the room info

Get info for all members

Get info for a specific member

Get extended info

User operation APIs

Update your own name

Send a chat message

Send a custom message

Raise a hand

Lower a raised hand

Get the online member list

Waiting room APIs

Update the waiting room state

Get the waiting room user list

Move into the waiting room

Move out of the waiting room

​Channel basics

​Get the channel ID

​Get the channel settings object

​Set the channel event handler

​Enter / exit APIs

​Enter the meeting

​Exit the waiting room

​Room info APIs

​Get your own info

​Get the room info

​Get info for all members

​Get info for a specific member

​Get extended info

​User operation APIs

​Update your own name

​Send a chat message

​Send a custom message

​Raise a hand

​Lower a raised hand

​Get the online member list

​Waiting room APIs

​Update the waiting room state

​Get the waiting room user list

​Move into the waiting room

​Move out of the waiting room

Channel basics

Get the channel ID

Get the channel settings object

Set the channel event handler

Enter / exit APIs

Enter the meeting

Exit the waiting room

Room info APIs

Get your own info

Get the room info

Get info for all members

Get info for a specific member

Get extended info

User operation APIs

Update your own name

Send a chat message

Send a custom message

Raise a hand

Lower a raised hand

Get the online member list

Waiting room APIs

Update the waiting room state

Get the waiting room user list

Move into the waiting room

Move out of the waiting room