Go Live On HLS
HLS allows participant to broadcast live streaming to other participants. This guide will provide an overview of how participant can start and stop broadcasting meeting.
HLS attributes
mode
: It should be any ofVIEWER
orCONFERENCE
, by default is set toCONFERENCE
toggleHLS
: When set totrue
it will enable you to click onStart HLS
button.hls.enabled
: When set totrue
, you can seeStart HLS
button.hls.autoStart
: If it istrue
then HLS will start automatically when the meeting starts, default value is false (You can't start HLS during the meeting).hls.playerControlsVisible
: If it istrue
then participant can view controls for the interactive meeting player.toggleParticipantMode
: When set totrue
, you can toggle other participant mode from an ongoing meeting by clicking onAdd as a Cohost
Icon button.
hls.playerControlsVisible
parameter will only work if the mode is set to viewer
, for conference
mode there will not be any interactive meeting player hence hls.playerControlsVisible
will be ignored if mode is set to conference
.
Better Understanding of Modes
1. CONFERENCE Mode
This mode is default mode if you do not give any mode, it will look similar as a normal meeting. when you pass hls.enabled
true you can see Start HLS
button. if you want to toggle the button then in permission
config pass other parameter toggleHLS
true so you can toggle button.
In CONFERENCE
mode you can toggle other participant mode also. like you can add other participant as a co-host. for that you need to pass parameter toggleParticipantMode
true in permission
config.
You can click on more button to see add as co-host icon.
When you click on Add as a Co-host
button other participant recive popup. whethere participant can accept or deny. if you accept than only participant add as a cohost.
const config = {
// ...
hls: {
enabled: true,
autoStart: false,
},
permissions: {
// ...other permissions
toggleParticipantMode: true,
toggleHls: true,
},
mode: "CONFERENCE", // VIEWER || CONFERENCE
// ...
};
2. VIEWER Mode
You can join meeting as a viewer. in this mode when you join the meeting you can see the waiting screen.
when host start HLS you can get hls stream in your player and you can see that stream. as a viewer you can do raise hand, chat and leave the meeting.
const config = {
// ...
hls: {
playerControlsVisible: true,
},
mode: "VIEWER", // VIEWER || CONFERENCE
// ...
};
Got a Question? Ask us on discord