Documentation updates
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gsttimecache.sgml
1 <!-- ##### SECTION Title ##### -->
2 GstTimeCache
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Cache time and byteoffsets.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 This class is used by plugins to manage time vs byte offsets. It is mainly
10 used for efficient seeking.
11 </para>
12
13 <!-- ##### SECTION See_Also ##### -->
14 <para>
15
16 </para>
17
18 <!-- ##### STRUCT GstTimeCacheEntry ##### -->
19 <para>
20
21 </para>
22
23 @location: 
24 @timestamp: 
25
26 <!-- ##### STRUCT GstTimeCacheGroup ##### -->
27 <para>
28
29 </para>
30
31 @groupnum: 
32 @entries: 
33 @certainty: 
34 @peergroup: 
35 @mintimestamp: 
36 @maxtimestamp: 
37 @minlocation: 
38 @maxlocation: 
39
40 <!-- ##### ENUM GstTimeCacheCertainty ##### -->
41 <para>
42
43 </para>
44
45 @GST_TIMECACHE_UNKNOWN: 
46 @GST_TIMECACHE_CERTAIN: 
47 @GST_TIMECACHE_FUZZY_LOCATION: 
48 @GST_TIMECACHE_FUZZY_TIMESTAMP: 
49 @GST_TIMECACHE_FUZZY: 
50
51 <!-- ##### FUNCTION gst_timecache_new ##### -->
52 <para>
53
54 </para>
55
56 @Returns: 
57
58
59 <!-- ##### FUNCTION gst_timecache_get_group ##### -->
60 <para>
61
62 </para>
63
64 @tc: 
65 @Returns: 
66
67
68 <!-- ##### FUNCTION gst_timecache_new_group ##### -->
69 <para>
70
71 </para>
72
73 @tc: 
74 @Returns: 
75
76
77 <!-- ##### FUNCTION gst_timecache_set_group ##### -->
78 <para>
79
80 </para>
81
82 @tc: 
83 @groupnum: 
84 @Returns: 
85
86
87 <!-- ##### FUNCTION gst_timecache_set_certainty ##### -->
88 <para>
89
90 </para>
91
92 @tc: 
93 @certainty: 
94
95
96 <!-- ##### FUNCTION gst_timecache_get_certainty ##### -->
97 <para>
98
99 </para>
100
101 @tc: 
102 @Returns: 
103
104
105 <!-- ##### FUNCTION gst_timecache_add_entry ##### -->
106 <para>
107
108 </para>
109
110 @tc: 
111 @location: 
112 @timestamp: 
113
114
115 <!-- ##### FUNCTION gst_timecache_find_location ##### -->
116 <para>
117
118 </para>
119
120 @tc: 
121 @location: 
122 @timestamp: 
123 @Returns: 
124
125
126 <!-- ##### FUNCTION gst_timecache_find_timestamp ##### -->
127 <para>
128
129 </para>
130
131 @tc: 
132 @timestamp: 
133 @location: 
134 @Returns: 
135
136