Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define Shortcodes #1

Closed
digitallysavvy opened this issue Sep 1, 2019 · 6 comments
Closed

Define Shortcodes #1

digitallysavvy opened this issue Sep 1, 2019 · 6 comments
Assignees

Comments

@digitallysavvy
Copy link
Contributor

define what the short code will look like, consider what variables can be passed in

@digitallysavvy digitallysavvy self-assigned this Sep 1, 2019
@digitallysavvy
Copy link
Contributor Author

broadcast:

  • [agora id="123" client="audience"]
  • [agora id="123" client="broadcaster"]

communication:

  • [agora id="123"]

@digitallysavvy
Copy link
Contributor Author

@jalamprea let me know if you think the above short codes need any other attributes to be passed in.

@jalamprea
Copy link
Contributor

I think we can make something more detailed and easy to use for the end users, for instance
[agora-broadcast channel_id="34"]
And the role (host or audience) will be defined in the channel settings according to the selected user who is able to be the host.

For the communication shortcode, we can use something similar:
[agora-commnication channel_id="34"]

@digitallysavvy
Copy link
Contributor Author

@jalamprea can we pass commands through the shortcode?

For example:
Allow the user to set a broadcast with the audio disabled
[agora-broadcast channel_id="34" audio="false"]

or allow user to start a broadcast that is just the screen
[agora-broadcast channel_id="34" screen="true"]

this could be a simple setting in the stream.init

var localStream = AgoraRTC.createStream({
    streamID: uid,
    audio: true,
    video: true,
    screen: false
  });

@jalamprea
Copy link
Contributor

Absolutely!! great idea, let me know the list of supported commands and I will add to the shortcodes properties

@digitallysavvy
Copy link
Contributor Author

I think just these 3 for now. I will think more and add an new comment if I think of more.

    audio: (true/false),
    video: (true/false),
    screen: (true/false)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants