snapshot of https://github.com/jitsi/jibri.git @ 3b45602c539ec69d128ea152ae587d0b6582191a (2026-09-15)
This commit is contained in:
9
doc/xmpp_api.md
Normal file
9
doc/xmpp_api.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Jibri XMPP API
|
||||
|
||||
Jibri can be configured to join multiple XMPP environments which can be used as a control surface for leveraging Jibri services. The configuration for these environments lives in config.json (a documented sample of config.json can be seen in the code [here](TODO)). For a given XMPP environment, Jibri will:
|
||||
* Connect to the provided XMPP domain on the provided XMPP host
|
||||
* Login to a given auth domain with the given credentials
|
||||
* Join a MUC on the given MUC domain with the given MUC jid using the given MUC nickname
|
||||
* Publish its status (defined by the status packet extension [here](https://github.com/jitsi/jitsi/blob/master/src/net/java/sip/communicator/impl/protocol/jabber/extensions/jibri/JibriStatusPacketExt.java)
|
||||
|
||||
At this point it will await an IQ message (defined by the custom IQ [here](https://github.com/jitsi/jitsi/blob/master/src/net/java/sip/communicator/impl/protocol/jabber/extensions/jibri/JibriIq.java)) asking it to start or stop a given service. Whenever Jibri's status changes, it will send a new presence to reflect its current state.
|
||||
Reference in New Issue
Block a user