crunchyroll-js-api/dist/types/services/music.d.ts

JavaScript API consumer for crunchyroll

declare namespace _default {
    export { getArtist };
    export { getArtistConcerts };
    export { getArtistVideos };
    export { getConcerts };
    export { getFeed };
    export { getStreams };
    export { getStreamsWithURL };
    export { getVideo };
    export { getFeatured };
}
export default _default;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.artistIds]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getArtist({ account, artistIds, fnConfig }: {
    account: import("../types").AccountAuth;
    artistIds?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.artistId]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getArtistConcerts({ account, artistId, fnConfig }: {
    account: import("../types").AccountAuth;
    artistId?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.artistId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getArtistVideos({ account, artistId, fnConfig }: {
    account: import("../types").AccountAuth;
    artistId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.concertIds]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getConcerts({ account, concertIds, fnConfig }: {
    account: import("../types").AccountAuth;
    concertIds?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getFeed({ account, quantity, start, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity?: number;
    start?: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @deprecated
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getStreams({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @deprecated
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.streamUrl
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getStreamsWithURL({ account, streamUrl, fnConfig }: {
    account: import("../types").AccountAuth;
    streamUrl: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.musicIds]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getVideo({ account, musicIds, fnConfig }: {
    account: import("../types").AccountAuth;
    musicIds?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.contentId Number of records in a result
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getFeatured({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;