Video room plugin API doc..

1,037 views
Skip to first unread message

Viswa

unread,
Dec 24, 2015, 7:21:48 AM12/24/15
to meetecho-janus
Hi All,

Can you please help me having description of Video room API. I could see the list mentioned in this doc, But could not get the description of API's any where. Please point me to get this info.

https://janus.conf.meetecho.com/docs/janus__videoroom_8c.html


Video Room API

The Video Room API supports several requests, some of which are synchronous and some asynchronous. There are some situations, though, (invalid JSON, invalid request) which will always result in a synchronous error response even for asynchronous requests.

create , destroy , exists, list and listparticipants are synchronous requests, which means you'll get a response directly within the context of the transaction. create allows you to create a new video room dynamically, as an alternative to using the configuration file; destroy removes a video room and destroys it, kicking all the users out as part of the process; exists allows you to check whether a specific video room exists; finally, list lists all the available rooms, while listparticipants lists all the participants of a specific room and their details.

The join , joinandconfigure , configure , publish , unpublish , start , pause , switch , stop , add , remove and leave requests instead are all asynchronous, which means you'll get a notification about their success or failure in an event. join allows you to join a specific video room, specifying whether that specific PeerConnection will be used for publishing or watching; configure can be used to modify some of the participation settings (e.g., bitrate cap); joinandconfigure combines the previous two requests in a single one (just for publishers); publish can be used to start sending media to broadcast to the other participants, while unpublish does the opposite; start allows you to start receiving media from a publisher you've subscribed to previously by means of a join , while pause pauses the delivery of the media; the switch request can be used to change the source of the media flowing over a specific PeerConnection (e.g., I was watching Alice, I want to watch Bob now) without having to create a new handle for that; stop interrupts a viewer instance; add and remove are just used when involving "Plan B", and are used to add or remove publishers to be muxed in the single viewer PeerConnection; finally, leave allows you to leave a video room for good.

Actual API docs: TBD.


Thanks,
Viswanath..

Lorenzo Miniero

unread,
Dec 24, 2015, 10:31:40 AM12/24/15
to Viswa, meetecho-janus

They're not available right now, you'll have to study the demo to see how the API works there.

L.

--
You received this message because you are subscribed to the Google Groups "meetecho-janus" group.
To unsubscribe from this group and stop receiving emails from it, send an email to meetecho-janu...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

fm.mag...@campus.fct.unl.pt

unread,
May 6, 2016, 5:09:19 AM5/6/16
to meetecho-janus, viswanat...@gmail.com
Hey!
I've been reading audiobridge doc because it looks similar to the videoroom api.

However, I'd like to know the syntax of the switch request on videoroom, because there is no info on that.

Thanks

Lorenzo Miniero

unread,
May 6, 2016, 5:11:57 AM5/6/16
to meetecho-janus, viswanat...@gmail.com
You can study the APIs by looking at the code:

An upcoming change, currently in a pull request, will make that task easier.

L.

fm.mag...@campus.fct.unl.pt

unread,
Jun 23, 2016, 4:20:39 PM6/23/16
to meetecho-janus, viswanat...@gmail.com
Is there a better way to change a data-only channel to a video-audio-data channel without having to detach and create new offer?

Lorenzo Miniero

unread,
Jun 23, 2016, 5:24:03 PM6/23/16
to meetecho-janus, viswanat...@gmail.com
A recently added plugin called TextRoom allows you to exchange datachannels with multiple users over a single PeerConnection.
As to changing the purpose of an existing PeerConnection, we don't support renegotiation yet.

L.
Reply all
Reply to author
Forward
0 new messages