Meting API

The Meting class is the core class for interacting with the Meting API, providing methods to retrieve all music resources.

Constructor

declare class class MetingMeting {
  constructor(server: string | undefinedserver?: string);
}

Parameter	Type	Default	Description
`server`	`string`	`'netease'`	Music platform, e.g., `netease`

Configuration Methods

site

Set the music platform.

declare class class MetingMeting {
  Meting.site(server: string): thissite(server: stringserver: string): this;
}

Parameter	Type	Description
`server`	`string`	Platform name, e.g., `netease`

api

Set a custom API endpoint. Default is https://api.qijieya.cn/meting/.

declare class class MetingMeting {
  Meting.api(url: string): thisapi(url: stringurl: string): this;
}

Parameter	Type	Description
`url`	`string`	Meting API endpoint

Set a cookie for authenticated requests.

declare class class MetingMeting {
  Meting.cookie(cookie: string): thiscookie(cookie: stringcookie: string): this;
}

Parameter	Type	Description
`cookie`	`string`	Cookie string

format

Enable or disable formatted responses. When enabled, returned data will be unified to the Music interface format.

declare class class MetingMeting {
  Meting.format(enable: boolean): thisformat(enable: booleanenable: boolean): this;
}

Parameter	Type	Description
`enable`	`boolean`	Whether to enable formatting

Data Methods

All data methods return a Promise<string> (JSON string).

search

Search for songs.

interface SearchOptions {
  SearchOptions.type?: number | undefinedtype?: number;
  SearchOptions.page?: number | undefinedpage?: number;
  SearchOptions.limit?: number | undefinedlimit?: number;
}
declare class class MetingMeting {
  Meting.search(keyword: string, options?: SearchOptions): Promise<string>search(keyword: stringkeyword: string, options: SearchOptions | undefinedoptions?: SearchOptions): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Default	Description
`keyword`	`string`	—	Search keyword
`options.type`	`number`	`1`	Search type
`options.page`	`number`	`1`	Page number
`options.limit`	`number`	`30`	Results per page

song

Get single song information.

declare class class MetingMeting {
  Meting.song(id: string | number): Promise<string>song(id: string | numberid: string | number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Description
`id`	`string \| number`	Song ID

artist

Get a list of songs by an artist.

declare class class MetingMeting {
  Meting.artist(id: string | number, limit?: number): Promise<string>artist(id: string | numberid: string | number, limit: number | undefinedlimit?: number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Default	Description
`id`	`string \| number`	—	Artist ID
`limit`	`number`	`30`	Number of results

playlist

Get all songs in a playlist.

declare class class MetingMeting {
  Meting.playlist(id: string | number): Promise<string>playlist(id: string | numberid: string | number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Description
`id`	`string \| number`	Playlist ID

url

Get song playback URL.

declare class class MetingMeting {
  Meting.url(id: string | number, bitrate?: number): Promise<string>url(id: string | numberid: string | number, bitrate: number | undefinedbitrate?: number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Default	Description
`id`	`string \| number`	—	Song ID
`bitrate`	`number`	`320`	Audio bitrate

lyric

Get lyrics information.

declare class class MetingMeting {
  Meting.lyric(id: string | number): Promise<string>lyric(id: string | numberid: string | number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Description
`id`	`string \| number`	Lyrics ID

pic

Get cover image information.

declare class class MetingMeting {
  Meting.pic(id: string | number, size?: number): Promise<string>pic(id: string | numberid: string | number, size: number | undefinedsize?: number): interface Promise<T>Represents the completion of an asynchronous operationPromise<string>;
}

Parameter	Type	Default	Description
`id`	`string \| number`	—	Image ID
`size`	`number`	`300`	Image size (px)

Type Definitions

SearchOptions

interface SearchOptions {
  SearchOptions.type?: number | undefinedtype?: number;   // Search type: 1=song, 100=artist, 1000=album, 1004=playlist, 1006=lyrics, 1009=user
  SearchOptions.page?: number | undefinedpage?: number;   // Page number, default 1
  SearchOptions.limit?: number | undefinedlimit?: number;  // Results per page, default 30
}

Music

interface Music {
  Music.id: stringid: string;          // Song ID
  Music.name: stringname: string;        // Song name
  Music.artist: string[]artist: string[];    // Artist list
  Music.album: stringalbum: string;       // Album name
  Music.pic_id: stringpic_id: string;      // Cover image ID
  Music.pic: stringpic: string;         // Cover image URL
  Music.url_id: stringurl_id: string;      // Playback URL or ID
  Music.lyric_id: stringlyric_id: string;    // Lyrics ID
  Music.lrc: stringlrc: string;         // Lyrics URL
  Music.source: stringsource: string;      // Source platform
}

MusicResponse

interface MusicResponse {
  MusicResponse.id: stringid: string;
  MusicResponse.name: stringname: string;
  MusicResponse.artist: string[]artist: string[];
  MusicResponse.album: stringalbum: string;
  MusicResponse.pic: stringpic: string;
  MusicResponse.url: stringurl: string;
  MusicResponse.lrc: stringlrc: string;
  MusicResponse.source: stringsource: string;
  [key: stringkey: string]: unknown;
}

Complete Example

import { class MetingMeting } from 'music-getter';

const const meting: Metingmeting = new new Meting(server?: string): MetingMeting('netease');
const meting: Metingmeting.Meting.format(enable: boolean): Metingformat(true);

// Search
const const searchResults: anysearchResults = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(
  await const meting: Metingmeting.Meting.search(keyword: string, options?: SearchOptions): Promise<string>search('Jay Chou', { SearchOptions.type?: number | undefinedtype: 1, SearchOptions.limit?: number | undefinedlimit: 5 })
);

// Get song details
const const song: anysong = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.song(id: string | number): Promise<string>song('1372188635'));

// Get playlist
const const playlist: anyplaylist = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.playlist(id: string | number): Promise<string>playlist('7697114803'));

// Get playback URL
const const urlData: anyurlData = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.url(id: string | number, bitrate?: number): Promise<string>url('1372188635', 320));

// Get lyrics
const const lyricData: anylyricData = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.lyric(id: string | number): Promise<string>lyric('1372188635'));

// Get cover
const const picData: anypicData = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.pic(id: string | number, size?: number): Promise<string>pic('1372188635', 300));

#Meting API

#Constructor

#Configuration Methods

#site

#api

#cookie

#format

#Data Methods

#search

#song

#artist

#playlist

#url

#lyric

#pic

#Type Definitions

#SearchOptions

#Music

#MusicResponse

#Complete Example