Browse Source

Changed documentation to make a distinction between user and session.

pull/28/head
Simon Eisenmann 11 years ago committed by Simon Eisenmann
parent
commit
b8a5854428
  1. 22
      doc/CHANNELING-API.txt

22
doc/CHANNELING-API.txt

@ -253,7 +253,7 @@ Peer connection documents @@ -253,7 +253,7 @@ Peer connection documents
If you do not want to give a reason just send Bye as empty JSON mapping.
Additional types for user listing and notifications
Additional types for session listing and notifications
Left
@ -291,6 +291,10 @@ Additional types for user listing and notifications @@ -291,6 +291,10 @@ Additional types for user listing and notifications
Rev is the status update sequence for this status update entry. It
is a positive integer. Higher numbers are later status updates.
When the current session is in a room (means sent Hello), a Users request
can be sent, to receive a list of sessions in that particular room. This
always returns the sessions in the same room as the calling session.
Users (Request uses empty data)
{
@ -531,7 +535,7 @@ Data channel only messages @@ -531,7 +535,7 @@ Data channel only messages
"Talking": true
}
The talking state sent by a given user as boolean value in "Talking"
The talking state sent by a given session as boolean value in "Talking"
key (true, false).
Screenshare (data channel only)
@ -545,21 +549,21 @@ Data channel only messages @@ -545,21 +549,21 @@ Data channel only messages
}
The Id field is the peer where this screen sharing token is valid. Essentially
it defines the user which started screensharing. It will be empty string when
it defines the session which started screensharing. It will be empty string when
received in peer to peer data channel mode.
The id is the token to be used to establish a token peer connection
to the user which sent the Screenshare document.
to the session which sent the Screenshare document.
Conferences and how to use them
There is a new data document "Conference" to share information about
conference participants. It is to be sent to the server, containing an Id
for this conference, and the user ids for the conference participants.
for this conference, and the session ids for the conference participants.
Once a client recieves such a Conference document, it has to check state
for all User ids in the Conference document Conference list like this:
for all session ids in the Conference document Conference list like this:
- If not in a call already -> ignore.
- If in a call, and own Id is not in the Conference list -> ignore.
@ -597,12 +601,12 @@ Conferences and how to use them @@ -597,12 +601,12 @@ Conferences and how to use them
"Type": "Conference",
"Id": "the-conference-id",
"Conference": [
"user-a-id",
"user-b-id"
"session-a-id",
"session-b-id"
]
}
Use Conference documents, to create a conference / add new users to a
Use Conference documents, to create a conference / add new session to a
conference.
The Id is to be generated by the client and needs to be unique. It

Loading…
Cancel
Save