Agora Setup
Agora Setup Guide
Add Your Agora Credentials
In WordPress, go to VideoHub360 > Settings.
Find Agora.io Settings and enter:
- Agora App ID
- Agora App Certificate
The App ID and App Certificate come from your Agora project dashboard.
Save the settings.
Create an Agora Livestream Video
Agora can be used when creating a livestream video.
- Go to the frontend dashboard.
- Open + Create.
- Set Currently Live Status to Yes – Livestream Mode.
- Set Stream Source Type to Agora.io WebRTC (Recommended for Interactive).
- Choose the Streaming Mode:
- Interactive Mode allows audience members to request to join as hosts and interact in real time.
- Broadcast Mode is for host-led streaming where the audience watches.
- Set the Channel Name or leave it blank to auto-generate one.
- Configure the optional host access settings.
- Save the video.
Configure Host Access
Agora livestreams include these host access options:
- Allow Everyone to be Host lets viewers directly join as hosts.
- Require Passcode To Join requires viewers to enter a passcode before joining as presenters.
Do not use Allow Everyone to be Host and Require Passcode To Join together. The dashboard identifies these as separate access-control choices.
Create a Live Room
The Live Rooms dashboard section also uses Agora livestream settings.
- Go to the frontend dashboard.
- Open Live Rooms.
- Create a new Live Room.
- Choose the Livestream Mode:
- Interactive for host and guest participation.
- Broadcast for host-led viewing.
- Configure the optional Live Room settings:
- Allow Everyone to be Host
- Require Passcode To Join
- Show Viewer Count
- Enable live chat for this video
- Chat Placement
- Save the Live Room.
Start and Test the Stream
After the Agora credentials are saved and an Agora livestream or Live Room is created:
- Open the livestream or Live Room from the frontend.
- Confirm the stream player loads.
- Test as the host.
- Test as a viewer.
- If using Require Passcode To Join, confirm the passcode is required before a viewer can join as a presenter.
- If using Allow Everyone to be Host, confirm viewers can join as hosts without a passcode.
Troubleshooting
The livestream says the Agora App ID is not configured
Go to VideoHub360 > Settings > Agora.io Settings and confirm the Agora App ID is saved.
The stream does not load
Confirm that:
- The Agora App ID is saved.
- The Agora App Certificate is saved.
- The video or Live Room is using Agora.io WebRTC as the stream source.
- The video is set to Yes – Livestream Mode when creating an Agora livestream video.
- The Agora channel name is present or was auto-generated.
Viewers cannot join as presenters
Check the host access setting for that livestream or Live Room.
Use one of these options:
- Enable Allow Everyone to be Host if viewers should join as hosts directly.
- Enable Require Passcode To Join if viewers should enter a passcode before joining as presenters.
Do not enable both options together.
