design: mention timeout in the progress message
authorWim Taymans <wim.taymans@collabora.co.uk>
Tue, 15 Feb 2011 17:14:16 +0000 (18:14 +0100)
committerWim Taymans <wim.taymans@collabora.co.uk>
Tue, 15 Feb 2011 17:55:23 +0000 (18:55 +0100)
docs/design/part-progress.txt

index 6ec73a9..bb8fe6e 100644 (file)
@@ -158,6 +158,12 @@ Messages
       - GST_PROGRESS_TYPE_CANCELED, GST_PROGRESS_TYPE_ERROR and
         GST_PROGRESS_TYPE_COMPLETE always have a 100% value.
 
+  - "timeout", G_TYPE_INT  in milliseconds
+
+     The timeout of the async operation. -1 if unknown/unlimited..
+     This field can be interesting to the application when it wants to display
+     some sort of progress indication.
+
   - ....
 
      Depending on the code, more fields can be put here.