hogg-0.2.0: Library and tools to manipulate the Ogg container formatContentsIndex
Codec.Container.Ogg.Packet
Synopsis
data OggPacket = OggPacket {
packetData :: !ByteString
packetTrack :: !OggTrack
packetGranulepos :: !Granulepos
packetBOS :: !Bool
packetEOS :: !Bool
packetSegments :: !(Maybe [OggSegment])
}
data OggSegment = OggSegment {
segmentLength :: !Int
segmentPageIx :: !Int
segmentEndsPage :: !Bool
}
uncutPage :: ByteString -> OggTrack -> Granulepos -> OggPage
uncutPacket :: ByteString -> OggTrack -> Granulepos -> OggPacket
packetsToPages :: [OggPacket] -> [OggPage]
pagesToPackets :: [OggPage] -> [OggPacket]
packetToBS :: OggPacket -> ByteString
Documentation
data OggPacket
Constructors
OggPacket
packetData :: !ByteString
packetTrack :: !OggTrack
packetGranulepos :: !Granulepos
packetBOS :: !Bool
packetEOS :: !Bool
packetSegments :: !(Maybe [OggSegment])
show/hide Instances
data OggSegment
Constructors
OggSegment
segmentLength :: !Int
segmentPageIx :: !Intpage index (NOT seqno) of this segment
segmentEndsPage :: !Boolwhether or not the segment ends a page
uncutPage :: ByteString -> OggTrack -> Granulepos -> OggPage
Create a page which contains only a single complete packet
uncutPacket :: ByteString -> OggTrack -> Granulepos -> OggPacket
Create a packet which spans a single page, ie. consists of only one segment
packetsToPages :: [OggPacket] -> [OggPage]
Pack packets into pages
pagesToPackets :: [OggPage] -> [OggPacket]
Pull the packets out of pages
packetToBS :: OggPacket -> ByteString
Create a dump of a packet, as used by hogg dump
Produced by Haddock version 0.8