diff options
| author | Ralph Giles <giles@xiph.org> | 2008-01-04 20:11:22 +0000 |
|---|---|---|
| committer | Ralph Giles <giles@xiph.org> | 2008-01-04 20:11:22 +0000 |
| commit | ab795cfc16ffb66caa60b7c6bd20aafb2e2168a0 (patch) | |
| tree | e2b512634d0313d96380943402c732660138c6d5 /doc/libogg/ogg_stream_packetin.html | |
| parent | f849f2cf8a2dbf2607aac86783dcf012600132ac (diff) | |
| download | ogg-ab795cfc16ffb66caa60b7c6bd20aafb2e2168a0.tar.gz | |
Document the memory ownership when passing ogg packets in and out.
git-svn-id: http://svn.xiph.org/trunk/ogg@14360 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc/libogg/ogg_stream_packetin.html')
| -rw-r--r-- | doc/libogg/ogg_stream_packetin.html | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/libogg/ogg_stream_packetin.html b/doc/libogg/ogg_stream_packetin.html index c1018dc..4005d9e 100644 --- a/doc/libogg/ogg_stream_packetin.html +++ b/doc/libogg/ogg_stream_packetin.html @@ -17,8 +17,15 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function takes a packet and submits it to the bitstream. After this is called, we can continue submitting packets, or we can write out pages. -<p>In a typical decoding situation, this should be used after filling a packet with data +<p>This function submits a packet to the bitstream for page +encapsulation. After this is called, more packets can be submitted, +or pages can be written out.</p> + +<p>In a typical encoding situation, this should be used after filling a +packet with data. +The data in the packet is copied into the internal storage managed by +the <a href="ogg_stream_state.html">ogg_stream_state</a>, so the caller +is free to alter the contents of <i>os</i> after this call has returned. <br><br> <table border=0 color=black cellspacing=0 cellpadding=7> |