Merge branch 'release/v3.1.0'

benrr101 · Dec 31, 2020 · 6d60d60 · 6d60d60
2 parents 682965b + 3fc0245
commit 6d60d60
Show file tree

Hide file tree

Showing 55 changed files with 1,877 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,14 @@ improved on the original TagLib, hence why this project exists.
 * [APE](http://wiki.hydrogenaud.io/index.php?title=APE_key): `AAC`, `APE`, `M2A`, `MP1`, `MP2`, `MP3`
 * [ID3v1](https://id3.org/ID3v1): `AAC`, `M2A`, `MP1`, `MP2`, `MP3`
 * [ID3v2](https://id3.org/Developer%20Information): `M2A`, `MP1`, `MP2`, `MP3`
+* ... More coming soon
+
+## Supported Codecs
+* Advanced Audio Codec (AAC): `AAC`
+* MPEG-1/2 Audio: `M2A`, `MP1`, `MP2`, `MP3`
+* MPEG-1/2 Video: `M2V`, `MPE`, `MPEG`, `MPG`, `MPV2`
+* Monkey's Audio: `APE`
+* ... More coming soon
 
 ## Installation
 ```
@@ -59,4 +67,5 @@ myFile.tag.title = "Time Won't Let Me Go";
 myFile.tag.album = "The Sun And The Moon";
 myFile.tag.performers = ["The Bravery"];
 myFile.save();
+myFile.dispose();
 ```
diff --git a/docs/README.md b/docs/README.md
@@ -22,6 +22,14 @@ improved on the original TagLib, hence why this project exists.
 * [APE](http://wiki.hydrogenaud.io/index.php?title=APE_key): `AAC`, `APE`, `M2A`, `MP1`, `MP2`, `MP3`
 * [ID3v1](https://id3.org/ID3v1): `AAC`, `M2A`, `MP1`, `MP2`, `MP3`
 * [ID3v2](https://id3.org/Developer%20Information): `M2A`, `MP1`, `MP2`, `MP3`
+* ... More coming soon
+
+## Supported Codecs
+* Advanced Audio Codec (AAC): `AAC`
+* MPEG-1/2 Audio: `M2A`, `MP1`, `MP2`, `MP3`
+* MPEG-1/2 Video: `M2V`, `MPE`, `MPEG`, `MPG`, `MPV2`
+* Monkey's Audio: `APE`
+* ... More coming soon
 
 ## Installation
 ```
@@ -63,4 +71,5 @@ myFile.tag.title = "Time Won't Let Me Go";
 myFile.tag.album = "The Sun And The Moon";
 myFile.tag.performers = ["The Bravery"];
 myFile.save();
+myFile.dispose();
 ```
diff --git a/docs/classes/_src_aac_aacaudioheader_.aacaudioheader.md b/docs/classes/_src_aac_aacaudioheader_.aacaudioheader.md
@@ -73,7 +73,7 @@ An empty an unset header
 
 • get **audioBitrate**(): number
 
-Bitrate of the audio in kilibits per second represented by the current instance.
+Bitrate of the audio in kilobits per second represented by the current instance.
 
 **`inheritdoc`** 
 

diff --git a/docs/classes/_src_ape_apestreamheader_.apestreamheader.md b/docs/classes/_src_ape_apestreamheader_.apestreamheader.md
@@ -78,7 +78,7 @@ Size of a Monkey Audio Header
 
 • get **audioBitrate**(): number
 
-Bitrate of the audio in kilibits per second represented by the current instance.
+Bitrate of the audio in kilobits per second represented by the current instance.
 
 **`inheritdoc`** 
 

diff --git a/docs/classes/_src_bytevector_.bytevector.md b/docs/classes/_src_bytevector_.bytevector.md
@@ -912,7 +912,7 @@ method reads from the current offset of the stream, not the beginning of the str
 Name | Type | Default value | Description |
 ------ | ------ | ------ | ------ |
 `stream` | [IStream](../interfaces/_src_stream_.istream.md) | - | TagLibSharp-node internal stream object |
-`isReadOnly` | boolean | false | Whether or not the bytevector is readonly  |
+`isReadOnly` | boolean | false | Whether or not the byte vector is readonly  |
 
 **Returns:** [ByteVector](_src_bytevector_.bytevector.md)
 

diff --git a/docs/classes/_src_errors_.unsupportedformaterror.md b/docs/classes/_src_errors_.unsupportedformaterror.md
@@ -0,0 +1,95 @@
+**[node-taglib-sharp](../README.md)**
+
+> [Globals](../globals.md) / ["src/errors"](../modules/_src_errors_.md) / UnsupportedFormatError
+
+# Class: UnsupportedFormatError
+
+## Hierarchy
+
+* [Error](_src_errors_.corruptfileerror.md#error)
+
+  ↳ **UnsupportedFormatError**
+
+## Index
+
+### Constructors
+
+* [constructor](_src_errors_.unsupportedformaterror.md#constructor)
+
+### Properties
+
+* [isNotSupportedError](_src_errors_.unsupportedformaterror.md#isnotsupportederror)
+* [message](_src_errors_.unsupportedformaterror.md#message)
+* [name](_src_errors_.unsupportedformaterror.md#name)
+* [stack](_src_errors_.unsupportedformaterror.md#stack)
+* [Error](_src_errors_.unsupportedformaterror.md#error)
+
+### Methods
+
+* [errorIs](_src_errors_.unsupportedformaterror.md#erroris)
+
+## Constructors
+
+### constructor
+
+\+ **new UnsupportedFormatError**(`message?`: string): [UnsupportedFormatError](_src_errors_.unsupportedformaterror.md)
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`message?` | string |
+
+**Returns:** [UnsupportedFormatError](_src_errors_.unsupportedformaterror.md)
+
+## Properties
+
+### isNotSupportedError
+
+• `Readonly` **isNotSupportedError**: boolean = true
+
+___
+
+### message
+
+•  **message**: string
+
+*Inherited from [CorruptFileError](_src_errors_.corruptfileerror.md).[message](_src_errors_.corruptfileerror.md#message)*
+
+___
+
+### name
+
+•  **name**: string
+
+*Inherited from [CorruptFileError](_src_errors_.corruptfileerror.md).[name](_src_errors_.corruptfileerror.md#name)*
+
+___
+
+### stack
+
+• `Optional` **stack**: string
+
+*Inherited from [CorruptFileError](_src_errors_.corruptfileerror.md).[stack](_src_errors_.corruptfileerror.md#stack)*
+
+*Overrides [CorruptFileError](_src_errors_.corruptfileerror.md).[stack](_src_errors_.corruptfileerror.md#stack)*
+
+___
+
+### Error
+
+▪ `Static` **Error**: ErrorConstructor
+
+## Methods
+
+### errorIs
+
+▸ `Static`**errorIs**(`e`: [Error](_src_errors_.corruptfileerror.md#error)): boolean
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`e` | [Error](_src_errors_.corruptfileerror.md#error) |
+
+**Returns:** boolean
diff --git a/docs/classes/_src_id3v2_frames_commentsframe_.commentsframe.md b/docs/classes/_src_id3v2_frames_commentsframe_.commentsframe.md
@@ -517,7 +517,7 @@ ___
 ▸ `Static`**fromOffsetRawData**(`data`: [ByteVector](_src_bytevector_.bytevector.md), `offset`: number, `header`: [Id3v2FrameHeader](_src_id3v2_frames_frameheader_.id3v2frameheader.md), `version`: number): [CommentsFrame](_src_id3v2_frames_commentsframe_.commentsframe.md)
 
 Constructs and initializes a new CommentsFrame by reading its raw data in a specified ID3v2
-version. This method allows for offset reading from the data bytevector.
+version. This method allows for offset reading from the data byte vector.
 
 #### Parameters:
 

diff --git a/docs/classes/_src_id3v2_frames_eventtimecodeframe_.eventtimecodeframe.md b/docs/classes/_src_id3v2_frames_eventtimecodeframe_.eventtimecodeframe.md
@@ -378,7 +378,7 @@ ___
 ▸ `Static`**fromOffsetRawData**(`data`: [ByteVector](_src_bytevector_.bytevector.md), `offset`: number, `header`: [Id3v2FrameHeader](_src_id3v2_frames_frameheader_.id3v2frameheader.md), `version`: number): [EventTimeCodeFrame](_src_id3v2_frames_eventtimecodeframe_.eventtimecodeframe.md)
 
 Constructs and initializes a new instance by reading its raw data in a specified ID3v2
-version. This method allows for offset reading from the data bytevector.
+version. This method allows for offset reading from the data byte vector.
 
 #### Parameters:
 

diff --git a/docs/classes/_src_mpeg_mpegaudioheader_.mpegaudioheader.md b/docs/classes/_src_mpeg_mpegaudioheader_.mpegaudioheader.md
@@ -59,7 +59,7 @@ header, see http://www.mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm
 
 • get **audioBitrate**(): number
 
-Bitrate of the audio in kilibits per second represented by the current instance.
+Bitrate of the audio in kilobits per second represented by the current instance.
 
 **`inheritdoc`** IAudioCodec.audioBitrate