How can a host change the role of a remote user?
Introduction
In a live interactive streaming channel, the host can invite an audience to take on the role of co-host, or change role back to audience.
You can implement this function by combining the following features:
- Signaling and channel attributes using methods from the Agora Signaling SDK.
- Setting the user role using methods from the Agora Video SDK.
Implementation
Before proceeding, ensure that you have integrated both the Agora Signaling SDK and Video SDK in your project. For how to integrate these SDKs, see the following guides:
The basic API call sequence is as follows:
Refer to the detailed steps for implementation:
- The host calls
sendMessage
to send a peer-to-peer message that invites an audience to take on the role of co-host. - The audience receives the invitation message in the
onMessageReceived
callback. - The audience calls
setClientRole
to change the user role toCLIENT_ROLE_BROADCASTER
. - After successfully changing the user role, the audience receives the
onClientRoleChanged
callback, and becomes a co-host. - The new co-host calls
addOrUpdateChannelAttributes
to notify the role change to all users in the channel. - The host receives the
onAttributesUpdated
callback, and starts co-hosting with the new co-host.
To change a co-host back to an audience, follow the same steps, except when calling setClientRole
, set the user role as CLIENT_ROLE_AUDIENCE
.
Relative methods in different programming languages
The methods mentioned in this article are in Java. Refer to the following table if you are programming in a different language:
Java/C++ | Objective-C | JavaScript |
---|---|---|
sendMessageToPeer | sendMessage | sendMessage |
onMessageReceived | messageReceived | MessageFromPeer |
setClientRole | setClientRole | setClientRole |
onClientRoleChanged | didClientRoleChanged | Client.on("client-role-changed") |
addOrUpdateChannelAttributes | addOrUpdateChannelAttributes | addOrUpdateChannelAttributes |
onAttributesUpdated | attributeUpdate | AttributesUpdated |