Home Reference Source Repository
import Blitzr from 'blitzr-js-sdk/src/blitzr.js'
public class | source

Blitzr

Blitzr provide methods to call API Blitzr

See:

Static Method Summary

Static Public Methods
public static

player(target: string, options: object): Player

Create an instance of Player

Constructor Summary

Public Constructor
public

constructor(keyAPI: string)

Create instance

Member Summary

Public Members
public

Provide artist methods - All methods return a promise

public

Provide event method - return a promise

public

Provide harmonia methods - All methods return a promise

public get

key: *

Get the current API Key

public set

key: *

Set a new API Key

public

Provide label methods - All methods return a promise

public

Provide radio methods - All methods return a promise

public

Provide releases methods - All methods return a promise

public

Provide search methods - All methods return a promise

public

Provide shop methods - All methods return a promise

public

Provide tag methods - All methods return a promise

public

Provides track methods - All methods return a promise

Static Public Methods

public static player(target: string, options: object): Player source

Create an instance of Player

Params:

NameTypeAttributeDescription
target string

id of DOM element

options object
  • optional
  • default: {}

More informations

Return:

Player

See:

Public Constructors

public constructor(keyAPI: string) source

Create instance

Params:

NameTypeAttributeDescription
keyAPI string

An API Key is required to use all methods

Public Members

public artist: object source

Provide artist methods - All methods return a promise

Properties:

NameTypeAttributeDescription
get function

Get artist

aliases function

Get artist aliases

bands function

Get bands for artist

biography function

Get artist biography

events function

Get artist events

harmonia function

Get harmonia

members function

Get artist members

related function

Get related artist

releases function

Get artist releases

similar function

Get similar artists

summary function

Get artist generated summary

websites function

Get artist websites

Example:

const result = []
blitzr.artist.get({ uuid: 'uuid' }).then(res => { result = res })

See:

public event: object source

Provide event method - return a promise

Properties:

NameTypeAttributeDescription
get function

Get event details

Example:

const event = {}
blitzr.event.get({ slug: 'slug' }).then(res => { event = res })

See:

public harmonia: object source

Provide harmonia methods - All methods return a promise

Properties:

NameTypeAttributeDescription
artist function

Get artist by service id

label function

Get label by service id

release function

Get release by service id

searchBySource function

Get tracks for source

Example:

const result = []
blitzr.harmonia.artist({ service_name: 'spotify', service_id: 'spotify_id' }).then(res => { result = res })

See:

public get key: * source

Get the current API Key

public set key: * source

Set a new API Key

public label: object source

Provide label methods - All methods return a promise

Properties:

NameTypeAttributeDescription
get function

Get label

artist function

Get label artist

biography function

Get label biography

harmonia function

Get harmonia

releases function

Get label releases

similar function

Get similar labels

websites function

Get artist websites

Example:

const result = []
blitzr.label.get({ uuid: 'uuid' }).then(res => { result = res })

See:

public radio: object source

Provide radio methods - All methods return a promise

Properties:

NameTypeAttributeDescription
artist function

Get artist radio

artistSimilar function

Get similar artists radio

event function

Get event radio

label function

Get label radio

tag function

Get track tag radio

Example:

const playlist = []
blitzr.radio.artist({ uuid: 'uuid' }).then(res => { playlist = res })

See:

public release: object source

Provide releases methods - All methods return a promise

Properties:

NameTypeAttributeDescription
get function

Get release

sources function

Get release sources

Example:

const result = []
blitzr.releases.get({ uuid: 'uuid' }).then(res => { result = res })

See:

Provide search methods - All methods return a promise

Properties:

NameTypeAttributeDescription
all function

Get search results

artist function

Get artist search results

label function

Get label search results

release function

Get release search results

track function

Get track search results

event function

Get event search results

Example:

const result = []
blitzr.search.artist({ query: 'myQuery' }).then(res => { result = res })

See:

public shop: object source

Provide shop methods - All methods return a promise

Properties:

NameTypeAttributeDescription
artist function

Get artist items

label function

Get label items

release function

Get release items

track function

Get track items

Example:

const result = []
blitzr.shop.artist('mp3', { uuid: 'uuid' }).then(res => { result = res })

See:

public tag: object source

Provide tag methods - All methods return a promise

Properties:

NameTypeAttributeDescription
get function

Get tag

artists function

Get tag artists

release function

Get tag releases

Example:

const tag = ''
blitzr.tag.get({ slug: 'slug' }).then(res => { tag = res })

See:

public track: object source

Provides track methods - All methods return a promise

Properties:

NameTypeAttributeDescription
get function

Get track

sources function

Get track sources

Example:

const track = {}
blitzr.track.get({ uuid: 'uuid' }).then(res => { track = res })

See: