Bug 31160 - Sparse documentation for Call.Stream
Summary: Sparse documentation for Call.Stream
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-spec (show other bugs)
Version: git master
Hardware: Other All
: medium normal
Assignee: Telepathy bugs list
QA Contact: Telepathy bugs list
URL:
Whiteboard: Call
Keywords:
Depends on:
Blocks:
 
Reported: 2010-10-27 08:01 UTC by Jonathon Jongsma
Modified: 2011-07-19 12:11 UTC (History)
2 users (show)

See Also:
i915 platform:
i915 features:


Attachments

Description Jonathon Jongsma 2010-10-27 08:01:02 UTC
Currently, the only class-level documentation for the Call.Stream class is:

"One stream inside a Content.DRAFT."

This doesn't really provide a very nice conceptual overview of what a stream class is supposed to be.  
In addition, the documentation for the "Streams" property on the Content class doesn't shed a lot more light on things.  

The class-level documentation for Call.Content does have a *little* more information about streams ("Each content has one or more Stream.DRAFT objects which represent the actual transport to one or more remote contacts.").  At the very least, this description should be copied into the documentation for the Stream class itself.  But it would be nice if it was expanded a bit more as well.
Comment 1 Olivier Crête 2010-10-31 18:39:15 UTC
Yes, what exactly is a stream in unclear.. and how it is different from an Endpoint, etc..

Especially since a stream is not a FsStream...
Comment 2 Olivier Crête 2011-02-11 11:28:42 UTC
A stream is a single flow of packets to and from a single remote endpoint, you may start with many endpoints, but you will chose one before the call proceeds. If your call connects to multiple people, you could have multiple streams.
Comment 3 Olivier Crête 2011-02-14 06:42:51 UTC
This should be mostly fixed in

http://git.collabora.co.uk/?p=user/tester/telepathy-spec.git;a=shortlog;h=refs/heads/stream-etc

(which is also references in bug #28705
Comment 4 David Laban 2011-02-14 10:12:22 UTC
++
Comment 5 David Laban 2011-03-11 05:22:59 UTC
Abusing Assigned to mean "merged in alsuren/call and available at
http://people.freedesktop.org/~alsuren/telepathy-spec-call/spec/".
Comment 6 David Laban 2011-07-19 12:11:49 UTC
merged to master


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.