Class: OggTheoraCodec
October 29, 2023 · View on GitHub
node-taglib-sharp / Exports / OggTheoraCodec
Class: OggTheoraCodec
Represents an Ogg Theora bitstream for use in an Ogg file.
Implements
Table of contents
Constructors
Accessors
Methods
Constructors
constructor
• new OggTheoraCodec(headerPacket)
Constructs and initializes a new instance using the provided header packet.
Parameters
| Name | Type | Description |
|---|---|---|
headerPacket | ByteVector | Packet that contains the Theora header data |
Accessors
commentData
• get commentData(): ByteVector
Gets the raw Xiph comment data contained in the codec.
Returns
Implementation of
IOggCodec.commentData
description
• get description(): string
Gets a text description of the media represented by the current instance.
Returns
string
Implementation of
durationMilliseconds
• get durationMilliseconds(): number
Duration of the media in milliseconds represented by the current instance.
Returns
number
Implementation of
IVideoCodec.durationMilliseconds
mediaTypes
• get mediaTypes(): MediaTypes
Types of media represented by the current instance, bitwise combined.
Returns
Implementation of
videoHeight
• get videoHeight(): number
Height of the video in pixels represented by the current instance.
Returns
number
Implementation of
videoWidth
• get videoWidth(): number
Width of the video in pixels represented by the current instance.
Returns
number
Implementation of
Methods
readPacket
▸ readPacket(packet): boolean
Reads an Ogg packet that has been encountered in the stream, looking for the comment data.
Parameters
| Name | Type | Description |
|---|---|---|
packet | ByteVector | Packet to read |
Returns
boolean
Implementation of
setDuration
▸ setDuration(firstGranularPosition, lastGranularPosition): void
Sets the file offset information necessary for calculating the duration of the stream. Once called, the duration can be accessed by calling durationMilliseconds.
Parameters
| Name | Type | Description |
|---|---|---|
firstGranularPosition | ByteVector | First granular position of the stream |
lastGranularPosition | ByteVector | Last granular position of the stream |
Returns
void
Implementation of
writeCommentPacket
▸ writeCommentPacket(packets, comment): void
Renders and write the provided comment into the provided list of packets.
Parameters
| Name | Type | Description |
|---|---|---|
packets | ByteVector[] | List of packets the comment packet should be written into. |
comment | XiphComment | Xiph comment to write into the list of packets. |
Returns
void
Implementation of
isHeaderPacket
▸ Static isHeaderPacket(packet): boolean
Checks to see if packet is a Theora header packet.
Parameters
| Name | Type | Description |
|---|---|---|
packet | ByteVector | Packet to check |
Returns
boolean