react-native-get-music-files
Instalation
$ npm i react-native-get-music-files-v3dev-test
Imports
;
Constants
{ SortBy: { Artist: 'ARTIST', Album: 'ALBUM', Title: 'TITLE', }, SortOrder: { Ascending: 'ASC', Descending: 'DESC', },}
example
; const sortBy = ConstantsSortByTitleconst sortOrder = ConstantsSortOrderAscending
Methods
search
options
all attributes of the options object are optional
{
searchParam?: string,
batchNumber?: string,
batchSize?: string,
sortBy?: string,
sortOrder?: string,
}
returns
{
"results": {
id: number,
path: string,
duration: number,
album: string,
artist: string,
title: string
}[],
"length": number
}
example
{ MusicFiles ; };
getAll
options
all attributes are optional
{
cover?: boolean,
coverFolder?: string,
minimumSongDuration?: number,
batchSize?: number,
batchNumber?: number,
sortBy?: string,
sortOrder?: string,
}
returns
{
"results":{
id: number,
path: string,
cover: string,
duration: number,
album: string,
artist: string,
title: string
}[],
"length" : number
}
example
{ MusicFiles ;};
getSongByPath
options
all attributes are optional
{
cover?: boolean,
coverFolder?: string,
path?: string,
}
returns
{
id: number,
path: string,
cover: string,
duration: number,
album: string,
artist: string,
title: string
}[]
example
{ MusicFiles ;};
getSongByPaths
scans a directory
options
{
path: string,
minFileSize: number,
maxFileSize: number,
extensionFilter: string,
}[]
returns
{
id: number,
path: string,
cover: string,
duration: number,
album: string,
artist: string,
title: string
}[]
example
{ MusicFiles ;};
getArtists
options
all attributes are optional
{
batchSize?: number,
batchNumber?: number,
sortBy?: string,
sortOrder?: string,
}
returns
{
"results": {
artist: string,
numberOfAlbums: number,
numberOfSongs: number,
}[],
"length": number
}
example
{ MusicFiles ;};
getAlbums
options
all attributes are optional
{
artist?: string,
batchSize?: number,
batchNumber?: number,
sortBy?: string,
sortOrder?: string,
}
returns
{
results": {
id: string,
album: string,
artist: string,
numberOfSongs: number,
firstYear: number,
lastYear: number,
}[],
"length": number
}
example
{ MusicFiles ;};
getSongs
options
all attributes are optional
{
artist?: string,
album?: string,
batchSize?: number,
batchNumber?: number,
sortBy?: string,
sortOrder?: string,
}
returns
{
"results": {
id: string,
title: string,
album: string,
artist: string,
duration: number,
path: string,
}[],
"length": number
}
example
{ MusicFiles ;};
Components
use this component instead of cover: true
for better performance.
inherits from Image.
<CoverImage src="pathToSong" width=120 height=120 />
Example
https://github.com/Drazail/react-native-get-music-files/blob/v3dev/example/App.js