node-taglib-sharp
December 13, 2024 · View on GitHub
node-taglib-sharp / Exports
node-taglib-sharp
Table of contents
References
Enumerations
- ApeTagItemType
- AsfObjectDataType
- AsfObjectType
- AviStreamType
- FileAccessMode
- FlacBlockType
- Id3v2EventType
- Id3v2FrameClassType
- Id3v2FrameFlags
- Id3v2RelativeVolumeFrameChannelType
- Id3v2SynchronizedTextType
- Id3v2TagHeaderFlags
- Id3v2TimestampFormat
- MediaTypes
- Mpeg4AppleDataBoxFlagType
- MpegAudioChannelMode
- MpegVersion
- PictureType
- ReadStyle
- SeekOrigin
- StringType
- TagTypes
Classes
- AacFile
- AacFileSettings
- AiffFile
- ApeFile
- ApeFileSettings
- ApeTag
- ApeTagItem
- AsfBaseObject
- AsfContentDescriptionObject
- AsfContentDescriptor
- AsfExtendedContentDescriptionObject
- AsfFile
- AsfFilePropertiesObject
- AsfHeaderExtensionObject
- AsfHeaderObject
- AsfMetadataDescriptor
- AsfMetadataLibraryObject
- AsfPaddingObject
- AsfStreamPropertiesObject
- AsfTag
- AsfUnknownObject
- AviFileSettings
- AviStream
- ByteVector
- CombinedTag
- CorruptFileError
- DivxTag
- EndTag
- File
- FlacBlock
- FlacFile
- FlacFileSettings
- FlacTag
- Genres
- Id3v1Tag
- Id3v2AttachmentFrame
- Id3v2CommentsFrame
- Id3v2EventTimeCode
- Id3v2EventTimeCodeFrame
- Id3v2ExtendedHeader
- Id3v2Frame
- Id3v2FrameFactory
- Id3v2FrameHeader
- Id3v2FrameIdentifier
- Id3v2MusicCdIdentifierFrame
- Id3v2PlayCountFrame
- Id3v2PopularimeterFrame
- Id3v2PrivateFrame
- Id3v2RelativeVolumeFrame
- Id3v2RelativeVolumeFrameChannelData
- Id3v2Settings
- Id3v2Synchronized
- Id3v2SynchronizedLyricsFrame
- Id3v2Tag
- Id3v2TagFooter
- Id3v2TagHeader
- Id3v2TermsOfUseFrame
- Id3v2TextInformationFrame
- Id3v2UniqueFileIdentifierFrame
- Id3v2UnknownFrame
- Id3v2UnsynchronizedLyricsFrame
- Id3v2UrlLinkFrame
- Id3v2UserTextInformationFrame
- Id3v2UserUrlLinkFrame
- InfoTag
- LocalFileAbstraction
- MatroskaFile
- MovieIdTag
- Mpeg4AppleAdditionalInfoBox
- Mpeg4AppleAnnotationBox
- Mpeg4AppleDataBox
- Mpeg4AppleElementaryStreamDescriptor
- Mpeg4AppleItemListBox
- Mpeg4AppleTag
- Mpeg4Box
- Mpeg4BoxHeader
- Mpeg4BoxType
- Mpeg4File
- Mpeg4FullBox
- Mpeg4IsoAudioSampleEntry
- Mpeg4IsoChunkLargeOffset
- Mpeg4IsoChunkOffsetBox
- Mpeg4IsoFreeSpaceBox
- Mpeg4IsoHandlerBox
- Mpeg4IsoMetaBox
- Mpeg4IsoMovieHeaderBox
- Mpeg4IsoSampleDescriptionBox
- Mpeg4IsoSampleEntry
- Mpeg4IsoSampleTableBox
- Mpeg4IsoUnknownSampleEntry
- Mpeg4IsoUserDataBox
- Mpeg4IsoVisualSampleEntry
- Mpeg4TextBox
- Mpeg4UnknownBox
- Mpeg4UrlBox
- MpegAudioFile
- MpegAudioFileSettings
- MpegAudioHeader
- MpegContainerFile
- MpegVbriHeader
- MpegVideoHeader
- MpegXingHeader
- NotImplementedError
- OggCodecFactory
- OggFile
- OggFileSettings
- OggOpusCodec
- OggTag
- OggTheoraCodec
- OggVorbisCodec
- Picture
- PictureLazy
- Properties
- RiffBitmapInfoHeader
- RiffFile
- RiffList
- RiffListTag
- RiffWaveFormatEx
- SandwichFile
- SandwichTag
- StartTag
- Tag
- UuidWrapper
- WaveFileSettings
- XiphComment
- XiphPicture
Interfaces
- IAudioCodec
- ICodec
- IDisposable
- IFileAbstraction
- ILazy
- ILosslessAudioCodec
- IOggCodec
- IPhotoCodec
- IPicture
- IRiffChunk
- ISandwichFile
- IStream
- IVideoCodec
Type Aliases
Variables
References
MpegContainerFileSettings
Renames and re-exports MpegAudioFileSettings
Type Aliases
AsfDescriptorValue
Ƭ AsfDescriptorValue: bigint | boolean | ByteVector | number | string | UuidWrapper
Type shortcut for all the types a descriptor can contain
FileTypeConstructor
Ƭ FileTypeConstructor: (abstraction: IFileAbstraction, style: ReadStyle) => File
Type declaration
• (abstraction, style)
Parameters
| Name | Type |
|---|---|
abstraction | IFileAbstraction |
style | ReadStyle |
FileTypeResolver
Ƭ FileTypeResolver: (abstraction: IFileAbstraction, mimetype: string, style: ReadStyle) => File
Type declaration
▸ (abstraction, mimetype, style): File
Delegate is used for intervening in createFromPath by resolving the filetype before any standard resolution operations.
Remarks
A FileTypeResolver is one way of altering the behavior of
createFromPath When createFromPath is called, the registered
resolvers are invoked in reverse order in which they were registered. The resolver may then
perform any operations necessary, including other type-finding methods. If the resolver
returns a new File it will instantly be returned, by createFromPath. If
it returns undefined, createFromPath will continue to process. If the resolver
throws an exception, it will be uncaught. To register a resolver, use
addFileTypeResolver.
Parameters
| Name | Type | Description |
|---|---|---|
abstraction | IFileAbstraction | File to be read. |
mimetype | string | - |
style | ReadStyle | How to read media properties from the file |
Returns
New instance of File or undefined if the resolver could not be matched
Id3v2FrameCreator
Ƭ Id3v2FrameCreator: (data: ByteVector, offset: number, header: Id3v2FrameHeader, version: number) => Id3v2Frame
Type declaration
▸ (data, offset, header, version): Id3v2Frame
Type shortcut for a method that returns a Frame.
Parameters
| Name | Type | Description |
|---|---|---|
data | ByteVector | Byte vector that contains the frame |
offset | number | Position into the byte vector where the frame begins |
header | Id3v2FrameHeader | The header that describes the frame |
version | number | ID3v2 version the frame is encoded with. Must be unsigned 8-bit int |
Returns
OggCodecProvider
Ƭ OggCodecProvider: (firstPacket: ByteVector) => IOggCodec | undefined
Type declaration
▸ (firstPacket): IOggCodec | undefined
Type shortcut for a method that can generate a codec object based on the first packet of the bit stream.
Parameters
| Name | Type | Description |
|---|---|---|
firstPacket | ByteVector | First packet in the bit stream |
Returns
IOggCodec | undefined
Generated IOggCodec is returned if a codec could be
constructed from the first packet, otherwise undefined is returned.
Variables
Id3v2FrameIdentifiers
• Const Id3v2FrameIdentifiers: Object
Collection of all well-known frame identifiers.
Index signature
▪ [key: string]: Id3v2FrameIdentifier