Skip to content

Short Codes

Hermes edited this page Oct 15, 2021 · 2 revisions

Agora Channel Shortcode

Once you have created your channel, a shortcode is created for you. Wp Agora.io has two shortcodes, depending on which channel type you are using.

Basic

For communication use:

[agora-communication channel_id=""]

For broadcasting use:

[agora-broadcast channel_id=""]

Make sure to fill in the Channel ID value with the ID from when you created the channel.

Advnaced

The Agora Video for WordPress plugin also exposes the videoProfile setting as part of the shortcode. If the setting is omitted, then the plugin will not set a profile and the Agora SDK will use its default profile.

For communication use:

[agora-communication channel_id="" videoProfile="720p_3"]

For broadcasting use:

[agora-broadcast channel_id="" videoProfile="720p_3"]

Full list of available video profiles: https://docs.agora.io/en/Video/video_profile_web?platform=Web#recommended-video-profiles

Agora Recordings Shortcode

Once you have recorded a video session, use a shortcode to embed the recording into a post or page,

[agora-recordings channel_id=""]
Clone this wiki locally