Skip to content

Commit 3201945

Browse files
committed
Merge branch 'release/v5.2.0'
2 parents eb2ed43 + 16aec60 commit 3201945

166 files changed

Lines changed: 25134 additions & 8106 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/classes/AacFile.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@
44

55
This class extends [File](File.md) to provide tagging and properties for ADTS AAC audio files.
66

7-
**`Remarks`**
8-
9-
A [Id3v1Tag](Id3v1Tag.md) and [Id3v2Tag](Id3v2Tag.md) will be added automatically to any file
10-
that doesn't contain one. This change does not affect the file until it is saved and can be
11-
reversed using the following method:
12-
`file.removeTags(file.tagTypes & ~file.tagTypesOnDisk);`
13-
147
## Hierarchy
158

169
- [`SandwichFile`](SandwichFile.md)
@@ -811,7 +804,7 @@ with. Optionally, the MimeType can be forcefully overridden if it was already re
811804
| :------ | :------ | :------ | :------ |
812805
| `mimeType` | `string` | `undefined` | MimeType to register this subclass constructor to. |
813806
| `constructor` | [`FileTypeConstructor`](../modules.md#filetypeconstructor) | `undefined` | Constructor for a subclass of [File](File.md) that will be called if a file with a MimeType of `mimeType` is created. |
814-
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an Error will be thrown if a subclass already registered to the MimeType. |
807+
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an `Error` will be thrown if a subclass already registered to the MimeType. |
815808

816809
#### Returns
817810

docs/classes/AiffFile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -763,7 +763,7 @@ with. Optionally, the MimeType can be forcefully overridden if it was already re
763763
| :------ | :------ | :------ | :------ |
764764
| `mimeType` | `string` | `undefined` | MimeType to register this subclass constructor to. |
765765
| `constructor` | [`FileTypeConstructor`](../modules.md#filetypeconstructor) | `undefined` | Constructor for a subclass of [File](File.md) that will be called if a file with a MimeType of `mimeType` is created. |
766-
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an Error will be thrown if a subclass already registered to the MimeType. |
766+
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an `Error` will be thrown if a subclass already registered to the MimeType. |
767767

768768
#### Returns
769769

docs/classes/ApeFile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -807,7 +807,7 @@ with. Optionally, the MimeType can be forcefully overridden if it was already re
807807
| :------ | :------ | :------ | :------ |
808808
| `mimeType` | `string` | `undefined` | MimeType to register this subclass constructor to. |
809809
| `constructor` | [`FileTypeConstructor`](../modules.md#filetypeconstructor) | `undefined` | Constructor for a subclass of [File](File.md) that will be called if a file with a MimeType of `mimeType` is created. |
810-
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an Error will be thrown if a subclass already registered to the MimeType. |
810+
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an `Error` will be thrown if a subclass already registered to the MimeType. |
811811

812812
#### Returns
813813

docs/classes/ApeTag.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1494,7 +1494,7 @@ identify a particular album artist credited with the album.
14941494

14951495
**`Remarks`**
14961496

1497-
Stored in the `MUSICBRAINZ_ARTISTID` item
1497+
Stored in the `MUSICBRAINZ_ALBUMARTISTID` item
14981498

14991499
#### Returns
15001500

@@ -1513,7 +1513,7 @@ identify a particular album artist credited with the album.
15131513

15141514
**`Remarks`**
15151515

1516-
Stored in the `MUSICBRAINZ_ARTISTID` item
1516+
Stored in the `MUSICBRAINZ_ALBUMARTISTID` item
15171517

15181518
#### Parameters
15191519

@@ -1736,9 +1736,9 @@ ___
17361736
Gets the MusicBrainz release type of the media represented by the current instance.
17371737

17381738
This field represents the MusicBrainz ReleaseType that describes what kind of release
1739-
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1740-
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1741-
must be given when using this field to decide if a particular track "is a compilation".
1739+
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1740+
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1741+
must be given when using this field to decide if a particular track "is a compilation".
17421742

17431743
@returns
17441744
MusicBrainz ReleaseType of the media represented by the current instance or

docs/classes/AsfFile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ with. Optionally, the MimeType can be forcefully overridden if it was already re
710710
| :------ | :------ | :------ | :------ |
711711
| `mimeType` | `string` | `undefined` | MimeType to register this subclass constructor to. |
712712
| `constructor` | [`FileTypeConstructor`](../modules.md#filetypeconstructor) | `undefined` | Constructor for a subclass of [File](File.md) that will be called if a file with a MimeType of `mimeType` is created. |
713-
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an Error will be thrown if a subclass already registered to the MimeType. |
713+
| `override` | `boolean` | `false` | If `true` and a subclass of [File](File.md) was already registered to `mimeType`, it will be forcefully overridden. If `false`, an `Error` will be thrown if a subclass already registered to the MimeType. |
714714

715715
#### Returns
716716

docs/classes/AsfTag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1776,9 +1776,9 @@ ___
17761776
Gets the MusicBrainz release type of the media represented by the current instance.
17771777

17781778
This field represents the MusicBrainz ReleaseType that describes what kind of release
1779-
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1780-
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1781-
must be given when using this field to decide if a particular track "is a compilation".
1779+
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1780+
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1781+
must be given when using this field to decide if a particular track "is a compilation".
17821782

17831783
@returns
17841784
MusicBrainz ReleaseType of the media represented by the current instance or

docs/classes/AviFileSettings.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[node-taglib-sharp](../README.md) / [Exports](../modules.md) / AviFileSettings
2+
3+
# Class: AviFileSettings
4+
5+
This class contains settings related to AVI file operations. Open files will need to be re-read
6+
in order for changes to take effect.
7+
8+
## Table of contents
9+
10+
### Constructors
11+
12+
- [constructor](AviFileSettings.md#constructor)
13+
14+
### Properties
15+
16+
- [SUPPORTED\_TAG\_TYPES](AviFileSettings.md#supported_tag_types)
17+
18+
### Accessors
19+
20+
- [defaultTagTypes](AviFileSettings.md#defaulttagtypes)
21+
22+
## Constructors
23+
24+
### constructor
25+
26+
**new AviFileSettings**()
27+
28+
## Properties
29+
30+
### SUPPORTED\_TAG\_TYPES
31+
32+
`Static` `Readonly` **SUPPORTED\_TAG\_TYPES**: `number`
33+
34+
The types of tags that are supported by AVI files.
35+
36+
## Accessors
37+
38+
### defaultTagTypes
39+
40+
`Static` `get` **defaultTagTypes**(): [`TagTypes`](../enums/TagTypes.md)
41+
42+
Gets the default types of tags for an AVI file. When opening a file, if these tag types do
43+
not exist on the file, they will be created.
44+
45+
#### Returns
46+
47+
[`TagTypes`](../enums/TagTypes.md)
48+
49+
`Static` `set` **defaultTagTypes**(`value`): `void`
50+
51+
Sets the default types of tags for an AVI file. When opening a file, if these tag types do
52+
not exist on the file, they will be created. See [SUPPORTED_TAG_TYPES](AviFileSettings.md#supported_tag_types) for a list of tag
53+
types that are supported by node-taglib-sharp for AVI files.
54+
55+
#### Parameters
56+
57+
| Name | Type |
58+
| :------ | :------ |
59+
| `value` | [`TagTypes`](../enums/TagTypes.md) |
60+
61+
#### Returns
62+
63+
`void`

docs/classes/ByteVector.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Implementation of this class uses a single `Uint8Array` to store bytes. Due to
7878
- [empty](ByteVector.md#empty)
7979
- [equals](ByteVector.md#equals-1)
8080
- [fromBase64String](ByteVector.md#frombase64string)
81+
- [fromByte](ByteVector.md#frombyte)
8182
- [fromByteArray](ByteVector.md#frombytearray)
8283
- [fromFileAbstraction](ByteVector.md#fromfileabstraction)
8384
- [fromInt](ByteVector.md#fromint)
@@ -929,6 +930,24 @@ Creates a [ByteVector](ByteVector.md) from a base64 string.
929930

930931
___
931932

933+
### fromByte
934+
935+
`Static` **fromByte**(`value`): [`ByteVector`](ByteVector.md)
936+
937+
Creates a 1 byte [ByteVector](ByteVector.md) with an unsigned 8-bit integer as the data
938+
939+
#### Parameters
940+
941+
| Name | Type | Description |
942+
| :------ | :------ | :------ |
943+
| `value` | `number` | Unsigned 8-bit integer to use as the data. |
944+
945+
#### Returns
946+
947+
[`ByteVector`](ByteVector.md)
948+
949+
___
950+
932951
### fromByteArray
933952

934953
`Static` **fromByteArray**(`bytes`, `length?`): [`ByteVector`](ByteVector.md)

docs/classes/CombinedTag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,9 +1519,9 @@ ___
15191519
Gets the MusicBrainz release type of the media represented by the current instance.
15201520

15211521
This field represents the MusicBrainz ReleaseType that describes what kind of release
1522-
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1523-
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1524-
must be given when using this field to decide if a particular track "is a compilation".
1522+
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1523+
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1524+
must be given when using this field to decide if a particular track "is a compilation".
15251525

15261526
@returns
15271527
MusicBrainz ReleaseType of the media represented by the current instance or

docs/classes/DivxTag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1600,9 +1600,9 @@ ___
16001600
Gets the MusicBrainz release type of the media represented by the current instance.
16011601

16021602
This field represents the MusicBrainz ReleaseType that describes what kind of release
1603-
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1604-
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1605-
must be given when using this field to decide if a particular track "is a compilation".
1603+
a release is. Common types are: `Single`, `Album`, `EP`, `Compilation`, `Soundtrack,
1604+
`SpokenWord`, `Interview`, `Audiobook`, `Live`, `Remix`, and `Other`. Careful thought
1605+
must be given when using this field to decide if a particular track "is a compilation".
16061606

16071607
@returns
16081608
MusicBrainz ReleaseType of the media represented by the current instance or

0 commit comments

Comments
 (0)