Skip to content

Latest commit

 

History

History
555 lines (318 loc) · 12.1 KB

Id3v2PopularimeterFrame.md

File metadata and controls

555 lines (318 loc) · 12.1 KB

node-taglib-sharp / Exports / Id3v2PopularimeterFrame

Class: Id3v2PopularimeterFrame

This class extends Frame implementing support for ID3v2 popularimeter (POPM) frames.

Hierarchy

Table of contents

Accessors

Methods

Accessors

encryptionId

• get encryptionId(): number

Gets the encryption ID applied to the current instance.

Returns

number

Value containing the encryption identifier for the current instance or undefined if not set.

Inherited from

Frame.encryptionId

• set encryptionId(value): void

Sets the encryption ID applied to the current instance.

Parameters

Name Type Description
value number Value containing the encryption identifier for the current instance. Must be an 8-bit unsigned integer. Setting to undefined will remove the encryption header and ID

Returns

void

Inherited from

Frame.encryptionId

flags

• get flags(): Id3v2FrameFlags

Gets the frame flags applied to the current instance.

Returns

Id3v2FrameFlags

Inherited from

Frame.flags

• set flags(value): void

Sets the frame flags applied to the current instance. If the value includes either Encryption or Compression, render will throw.

Parameters

Name Type
value Id3v2FrameFlags

Returns

void

Inherited from

Frame.flags

frameClassType

• get frameClassType(): Id3v2FrameClassType

Gets a flag indicating which type of frame the current instance is.

Returns

Id3v2FrameClassType

Overrides

Frame.frameClassType

frameId

• get frameId(): Id3v2FrameIdentifier

Gets the frame ID for the current instance.

Returns

Id3v2FrameIdentifier

Object representing of the identifier of the frame

Inherited from

Frame.frameId

groupId

• get groupId(): number

Gets the grouping ID applied to the current instance.

Returns

number

Value containing the grouping identifier for the current instance, or undefined if not set.

Inherited from

Frame.groupId

• set groupId(value): void

Sets the grouping ID applied to the current instance.

Parameters

Name Type Description
value number Grouping identifier for the current instance. Must be an 8-bit unsigned integer. Setting to undefined will remove the grouping identity header and ID

Returns

void

Inherited from

Frame.groupId

header

• Protected get header(): Id3v2FrameHeader

Gets the header for the frame. For new frames this should not exist.

Returns

Id3v2FrameHeader

Inherited from

Frame.header

• Protected set header(value): void

Sets the header for the frame.

Parameters

Name Type Description
value Id3v2FrameHeader Header for the frame

Returns

void

Inherited from

Frame.header

playCount

• get playCount(): bigint

Gets the play count of the current instance

Returns

bigint

• set playCount(value): void

Sets the play count of the current instance

Parameters

Name Type Description
value bigint Play count of the current instance

Returns

void

rating

• get rating(): number

Gets the rating of the current instance

Returns

number

• set rating(value): void

Sets the rating of the current instance

Parameters

Name Type Description
value number Rating of the current instance, must be an 8-bit unsigned integer.

Returns

void

size

• get size(): number

Gets the size of the current instance as it was last stored on disk. NOTE: This value is not used outside of reading a frame from disk, so newly created frames should not have this value set.

Returns

number

Inherited from

Frame.size

user

• get user(): string

Gets the email address of the user to whom the current instance belongs

Returns

string

• set user(value): void

Sets the email address of the user to whom the current instance belongs

Parameters

Name Type
value string

Returns

void

Methods

clone

▸ clone(): Id3v2Frame

Creates a deep copy of the current instance. This method is implemented by rendering the current instance as an ID3v2.4 frame and using the frame factory to create a new frame. As such, this method should be overridden by child classes.

Returns

Id3v2Frame

Overrides

Id3v2Frame.clone

fieldData

▸ Protected fieldData(frameData, offset, version, dataIncludesHeader): ByteVector

Extracts the field data from the raw portion of an ID3v2 frame. This method is necessary for extracting extra data prepended to the frame such the as grouping ID.

Parameters

Name Type Description
frameData ByteVector Raw frame data
offset number Index at which the data is contained
version number Version of the ID3v2 tag the data was originally encoded with
dataIncludesHeader boolean true if frameData includes the header, false otherwise

Returns

ByteVector

Inherited from

Id3v2Frame.fieldData

parseFields

▸ Protected parseFields(data): void

Populates the values in this frame by parsing its field data in a specified version.

Parameters

Name Type Description
data ByteVector Extracted field data

Returns

void

Overrides

Id3v2Frame.parseFields

render

▸ render(version): ByteVector

Renders the current instance, encoded in a specified ID3v2 version.

Parameters

Name Type Description
version number Version of ID3v2 to use when encoding the current instance

Returns

ByteVector

Inherited from

Id3v2Frame.render

renderFields

▸ Protected renderFields(): ByteVector

Renders the values in the current instance into field data for a specified version.

Returns

ByteVector

Overrides

Id3v2Frame.renderFields

setData

▸ Protected setData(data, offset, readHeader, version): void

Populates the current instance by reading the raw frame from disk, optionally reading the header.

Parameters

Name Type Description
data ByteVector Raw ID3v2 frame
offset number Offset in data at which the frame begins.
readHeader boolean Whether or not to read the reader into the current instance.
version number Version of the ID3v2 tag the data was encoded with

Returns

void

Inherited from

Id3v2Frame.setData

correctEncoding

▸ Static Protected correctEncoding(type, version): StringType

Converts an encoding to be a supported encoding for a specified tag version.

Parameters

Name Type Description
type StringType Value containing the original encoding
version number Value containing the ID3v2 version to be encoded.

Returns

StringType

Value containing the correct encoding to use, based on forceDefaultEncoding and what is supported by version

Inherited from

Id3v2Frame.correctEncoding

find

▸ Static find(frames, user): Id3v2PopularimeterFrame

Gets a popularimeter frame from a specified tag that matches the given parameters

Parameters

Name Type Description
frames Id3v2PopularimeterFrame[] List of frames to search
user string User email to use to match the frame in the tag

Returns

Id3v2PopularimeterFrame

Frame containing the matching user or undefined if a match was not found

fromOffsetRawData

▸ Static fromOffsetRawData(data, offset, header, version): Id3v2PopularimeterFrame

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 byte vector.

Parameters

Name Type Description
data ByteVector Raw representation of the new frame
offset number What offset in data the frame actually begins. Must be positive, safe integer
header Id3v2FrameHeader Header of the frame found at data in the data
version number ID3v2 version the frame was originally encoded with

Returns

Id3v2PopularimeterFrame

fromRawData

▸ Static fromRawData(data, version): Id3v2PopularimeterFrame

Constructs and initializes a new instance by reading its raw data in a specified ID3v2 version.

Parameters

Name Type Description
data ByteVector Raw representation of the new frame
version number ID3v2 version the raw frame is encoded with, must be a positive 8-bit integer

Returns

Id3v2PopularimeterFrame

fromUser

▸ Static fromUser(user): Id3v2PopularimeterFrame

Constructs and initializes a new instance for a specified user with a rating and play count of zero.

Parameters

Name Type Description
user string Email of the user that gave the rating

Returns

Id3v2PopularimeterFrame