~ubuntu-branches/ubuntu/precise/liboggz/precise

« back to all changes in this revision

Viewing changes to doc/liboggz/latex/oggz__seek_8h.tex

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Wilkinson
  • Date: 2005-04-16 01:19:44 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050416011944-5ipwrrc260ihkpp8
Tags: 0.9.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\section{oggz\_\-seek.h File Reference}
 
2
\label{oggz__seek_8h}\index{oggz_seek.h@{oggz\_\-seek.h}}
 
3
 
 
4
 
 
5
\subsection{Detailed Description}
 
6
Seeking within files. 
 
7
 
 
8
 
 
9
 
 
10
\subsection*{Typedefs}
 
11
\begin{CompactItemize}
 
12
\item 
 
13
typedef ogg\_\-int64\_\-t($\ast$ {\bf Oggz\-Metric} )({\bf OGGZ} $\ast$oggz, long serialno, ogg\_\-int64\_\-t granulepos, void $\ast$user\_\-data)
 
14
\begin{CompactList}\small\item\em This is the signature of a function to correlate Ogg streams. \item\end{CompactList}\end{CompactItemize}
 
15
\subsection*{Functions}
 
16
\begin{CompactItemize}
 
17
\item 
 
18
ogg\_\-int64\_\-t {\bf oggz\_\-tell\_\-units} ({\bf OGGZ} $\ast$oggz)
 
19
\begin{CompactList}\small\item\em Query the current offset in milliseconds, or custom units as specified by a Metric function you have provided. \item\end{CompactList}\item 
 
20
ogg\_\-int64\_\-t {\bf oggz\_\-seek\_\-units} ({\bf OGGZ} $\ast$oggz, ogg\_\-int64\_\-t units, int whence)
 
21
\begin{CompactList}\small\item\em Seek to an offset in milliseconds, or custom units as specified by a Metric function you have provided. \item\end{CompactList}\item 
 
22
off\_\-t {\bf oggz\_\-tell} ({\bf OGGZ} $\ast$oggz)
 
23
\begin{CompactList}\small\item\em Query the file offset in bytes corresponding to the data read. \item\end{CompactList}\item 
 
24
off\_\-t {\bf oggz\_\-seek} ({\bf OGGZ} $\ast$oggz, off\_\-t offset, int whence)
 
25
\begin{CompactList}\small\item\em Seek to a specific byte offset. \item\end{CompactList}\item 
 
26
int {\bf oggz\_\-get\_\-granuleshift} ({\bf OGGZ} $\ast$oggz, long serialno)
 
27
\begin{CompactList}\small\item\em Retrieve the granuleshift of a logical bitstream. \item\end{CompactList}\item 
 
28
int {\bf oggz\_\-set\_\-granuleshift} ({\bf OGGZ} $\ast$oggz, long serialno, int granuleshift)
 
29
\begin{CompactList}\small\item\em Specify the granuleshift of a logical bitstream. \item\end{CompactList}\item 
 
30
int {\bf oggz\_\-get\_\-granulerate} ({\bf OGGZ} $\ast$oggz, long serialno, ogg\_\-int64\_\-t $\ast$granulerate\_\-n, ogg\_\-int64\_\-t $\ast$granulerate\_\-d)
 
31
\begin{CompactList}\small\item\em Retrieve the granulerate of a logical bitstream. \item\end{CompactList}\item 
 
32
int {\bf oggz\_\-set\_\-granulerate} ({\bf OGGZ} $\ast$oggz, long serialno, ogg\_\-int64\_\-t granule\_\-rate\_\-numerator, ogg\_\-int64\_\-t granule\_\-rate\_\-denominator)
 
33
\begin{CompactList}\small\item\em Specify the granulerate of a logical bitstream. \item\end{CompactList}\item 
 
34
int {\bf oggz\_\-set\_\-metric} ({\bf OGGZ} $\ast$oggz, long serialno, {\bf Oggz\-Metric} metric, void $\ast$user\_\-data)
 
35
\begin{CompactList}\small\item\em Set the Oggz\-Metric to use for an OGGZ handle. \item\end{CompactList}\item 
 
36
int {\bf oggz\_\-set\_\-data\_\-start} ({\bf OGGZ} $\ast$oggz, off\_\-t offset)
 
37
\begin{CompactList}\small\item\em Tell OGGZ to remember the given offset as the start of data. \item\end{CompactList}\end{CompactItemize}