Class TagLib::Ogg::PageHeader
In: lib/TagLib_doc.rb
Parent: Object
AudioProperties Properties Properties Properties Properties Properties Properties Properties File File File File File File File Tag Tag Tag Tag XiphComment File File File Frame AttachedPictureFrame CommentsFrame Header ByteVectorList ByteVector FrameList ItemListMap GenreMap FileRef FrameListMap StringList FieldListMap String Item Footer FrameFactory GeneralEncapsulatedObjectFrame Page PageHeader XingHeader Header MPC APE Vorbis ID3v1 FLAC ID3v2 Flac Speex Ogg MPEG WavPack TrueAudio TagLib dot/f_3.png

An implementation of the page headers associated with each Ogg::Page. .

This class implements Ogg page headers which contain the information about Ogg pages needed to break them into packets which can be passed on to the codecs.

Methods

Public Instance methods

A special value of containing the position of the packet to be interpreted by the codec. In the case of Vorbis this contains the PCM value and is used to calculate the length of the stream.setAbsoluteGranularPosition()

[Source]

# File lib/TagLib_doc.rb, line 1246
          def absoluteGranularPosition()
          end

Returns the size of the data portion of the page — i.e. the size of the page less the header size.

[Source]

# File lib/TagLib_doc.rb, line 1281
          def dataSize()
          end

Some packets can be continued across multiple pages. If the first packet in the current page is a continuation this will return true. If this is page starts with a new packet this will return false.lastPacketCompleted() setFirstPacketContinued()

[Source]

# File lib/TagLib_doc.rb, line 1276
          def firstPacketContinued()
          end

This returns true if this is the first page of the Ogg (logical) stream.setFirstPageOfStream()

[Source]

# File lib/TagLib_doc.rb, line 1264
          def firstPageOfStream()
          end

Returns true if the header parsed properly and is valid.

[Source]

# File lib/TagLib_doc.rb, line 1199
          def isValid()
          end

Returns true if the last packet of this page is completely contained in this page.firstPacketContinued() setLastPacketCompleted()

[Source]

# File lib/TagLib_doc.rb, line 1211
          def lastPacketCompleted()
          end

This returns true if this is the last page of the Ogg (logical) stream.setLastPageOfStream()

[Source]

# File lib/TagLib_doc.rb, line 1188
          def lastPageOfStream()
          end

Ogg pages contain a list of packets (which are used by the contained codecs). The sizes of these pages is encoded in the page header. This returns a list of the packet sizes in bytes.setPacketSizes()

[Source]

# File lib/TagLib_doc.rb, line 1228
          def packetSizes()
          end

Returns the index of the page within the Ogg stream. This helps make it possible to determine if pages have been lost.setPageSequenceNumber()

[Source]

# File lib/TagLib_doc.rb, line 1234
          def pageSequenceNumber()
          end

Render the page header to binary data.The checksum — bytes 22 - 25 — will be left empty and must be filled in when rendering the entire page.

[Source]

# File lib/TagLib_doc.rb, line 1205
          def render()
          end

A special value of containing the position of the packet to be interpreted by the codec. It is only supported here so that it may be coppied from one page to another.absoluteGranularPosition()

[Source]

# File lib/TagLib_doc.rb, line 1270
          def setAbsoluteGranularPosition(long long agp)
          end

Sets the internal flag indicating if the first packet in this page is continued to continued.firstPacketContinued()

[Source]

# File lib/TagLib_doc.rb, line 1182
          def setFirstPacketContinued(bool continued)
          end

Marks this page as the first page of the Ogg stream.firstPageOfStream()

[Source]

# File lib/TagLib_doc.rb, line 1287
          def setFirstPageOfStream(bool first)
          end

Sets the internal flag indicating if the last packet in this page is complete to completed.lastPacketCompleted()

[Source]

# File lib/TagLib_doc.rb, line 1240
          def setLastPacketCompleted(bool completed)
          end

Marks this page as the last page of the Ogg stream.lastPageOfStream()

[Source]

# File lib/TagLib_doc.rb, line 1217
          def setLastPageOfStream(bool last)
          end

Sets the sizes of the packets in this page to sizes. Internally this updates the lacing values in the header.packetSizes()

[Source]

# File lib/TagLib_doc.rb, line 1252
          def setPacketSizes( List< int >  sizes)
          end

Sets the page's position in the stream to sequenceNumber.pageSequenceNumber()

[Source]

# File lib/TagLib_doc.rb, line 1258
          def setPageSequenceNumber(int sequenceNumber)
          end

Every Ogg logical stream is given a random serial number which is common to every page in that logical stream. This sets this pages serial number. This method should be used when adding new pages to a logical stream.streamSerialNumber()

[Source]

# File lib/TagLib_doc.rb, line 1194
          def setStreamSerialNumber(uint n)
          end

Returns the complete header size.

[Source]

# File lib/TagLib_doc.rb, line 1222
          def size()
          end

Every Ogg logical stream is given a random serial number which is common to every page in that logical stream. This returns the serial number of the stream associated with this packet.setStreamSerialNumber()

[Source]

# File lib/TagLib_doc.rb, line 1293
          def streamSerialNumber()
          end

[Validate]