Commit 8f5836df authored by conrad's avatar conrad

clarify use of FLAC_final_metadata_block in oggz_comment_generate()


git-svn-id: http://svn.annodex.net/liboggz/trunk@2959 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent c3207ed5
......@@ -243,22 +243,22 @@ oggz_comment_remove_byname (OGGZ * oggz, long serialno, char * name);
* \param serialno Identify a logical bitstream within \a oggz
* \param packet_type Type of comment packet to generate,
* FLAC, OggPCM, Speex, Theora and Vorbis are supported
* \param FLAC_final_metadata_block Non-zero if there are no FLAC
* metadata blocks to follow (see note)
* \param FLAC_final_metadata_block Set this to zero unless the packet_type is
* FLAC, and there are no further metadata blocks to follow. See note below
* for details.
* \returns A comment packet for the stream. When no longer needed it
* should be freed with oggz_packet_destroy().
* \retval NULL content type does not support comments, not enough memory
* or comment was too long for FLAC
* \note FLAC users: FLAC streams may contain multiple metadata blocks
* of different types. When encapsulated in Ogg the first of these must
* be a Vorbis comment packet but PADDING, APPLICATION, SEEKTABLE,
* CUESHEET and PICTURE may follow. The last metadata block must have its
* first bit set to 1. Since liboggz does not know whether you will supply
* more metadata blocks you must tell it if this is the last (and only
* block) via FLAC_final_metadata_block.
* \n Additionally FLAC metadata blocks are limited to 16MB minus 1 byte of
* content, this function will refuse to produce longer comment packets
* for FLAC.
* \note FLAC streams may contain multiple metadata blocks of different types.
* When encapsulated in Ogg the first of these must be a Vorbis comment packet
* but PADDING, APPLICATION, SEEKTABLE, CUESHEET and PICTURE may follow.
* The last metadata block must have its first bit set to 1. Since liboggz does
* not know whether you will supply more metadata blocks you must tell it if
* this is the last (or only) metadata block by setting
* FLAC_final_metadata_block to 1.
* \n As FLAC metadata blocks are limited in size to 16MB minus 1 byte, this
* function will refuse to produce longer comment packets for FLAC.
* \n See http://flac.sourceforge.net/format.html for more details.
*/
ogg_packet *
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment