| Summary: | Sparse documentation for Call.Stream | ||
|---|---|---|---|
| Product: | Telepathy | Reporter: | Jonathon Jongsma <jonathon> |
| Component: | tp-spec | Assignee: | Telepathy bugs list <telepathy-bugs> |
| Status: | RESOLVED FIXED | QA Contact: | Telepathy bugs list <telepathy-bugs> |
| Severity: | normal | ||
| Priority: | medium | CC: | david.laban, olivier.crete |
| Version: | git master | ||
| Hardware: | Other | ||
| OS: | All | ||
| Whiteboard: | Call | ||
| i915 platform: | i915 features: | ||
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... 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. 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 ++ Abusing Assigned to mean "merged in alsuren/call and available at http://people.freedesktop.org/~alsuren/telepathy-spec-call/spec/". 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.
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.