/**
 * Sound asset descriptor used by the audio loader
 */
interface SoundAsset {
    name: string;
    src: string;
    autoplay?: boolean;
    loop?: boolean;
    stream?: boolean;
    html5?: boolean;
}
/**
 * Load settings for audio resources
 */
interface LoadSettings {
    nocache?: string;
    withCredentials?: boolean;
}
/**
 * Panner attributes for spatial audio
 */
interface PannerAttributes {
    coneInnerAngle?: number;
    coneOuterAngle?: number;
    coneOuterGain?: number;
    distanceModel?: string;
    maxDistance?: number;
    refDistance?: number;
    rolloffFactor?: number;
    panningModel?: string;
}
/**
 * Specify either to stop on audio loading error or not<br>
 * if true, melonJS will throw an exception and stop loading<br>
 * if false, melonJS will disable sounds and output a warning message
 * in the console<br>
 * @default true
 */
export declare let stopOnAudioError: boolean;
/**
 * Initialize and configure the audio support.<br>
 * For a maximum browser coverage the recommendation is to use at least two of them,
 * typically default to webm and then fallback to mp3 for the best balance of small filesize and high quality,
 * webm has nearly full browser coverage with a great combination of compression and quality, and mp3 will fallback gracefully for other browsers.
 * It is important to remember that melonJS selects the first compatible sound based on the list of extensions and given order passed here.
 * So if you want webm to be used before mp3, you need to put the audio format in that order.
 * @param [format="mp3"] - audio format to prioritize ("mp3"|"mpeg"|"opus"|"ogg"|"oga"|"wav"|"aac"|"caf"|"m4a"|"m4b"|"mp4"|"weba"|"webm"|"dolby"|"flac")
 * @returns Indicates whether audio initialization was successful
 * @example
 * // initialize the "sound engine", giving "webm" as default desired audio format, and "mp3" as a fallback
 * if (!me.audio.init("webm,mp3")) {
 *     alert("Sorry but your browser does not support html 5 audio !");
 *     return;
 * }
 * @category Audio
 */
export declare function init(format?: string): boolean;
/**
 * check if the given audio format is supported
 * @param codec - the audio format to check for support
 * @returns return true if the given audio format is supported
 * @category Audio
 */
export declare function hasFormat(codec: string): boolean;
/**
 * check if audio (HTML5 or WebAudio) is supported
 * @returns return true if audio (HTML5 or WebAudio) is supported
 * @category Audio
 */
export declare function hasAudio(): boolean;
/**
 * enable audio output <br>
 * only useful if audio supported and previously disabled through
 * @see {@link disable}
 * @category Audio
 */
export declare function enable(): void;
/**
 * disable audio output
 * @category Audio
 */
export declare function disable(): void;
/**
 * Load an audio file
 * @param sound - sound asset descriptor
 * @param [onloadcb] - function to be called when the resource is loaded
 * @param [onerrorcb] - function to be called in case of error
 * @param [settings] - custom settings to apply to the request (@link https://developer.mozilla.org/en-US/docs/Web/API/fetch#options)
 * @returns the amount of asset loaded (always 1 if successful)
 * @category Audio
 */
export declare function load(sound: SoundAsset, onloadcb?: () => void, onerrorcb?: () => void, settings?: LoadSettings): number;
/**
 * play the specified sound
 * @param sound_name - audio clip name - case sensitive
 * @param [loop=false] - loop audio
 * @param [onend] - Function to call when sound instance ends playing.
 * @param [volume=default] - Float specifying volume (0.0 - 1.0 values accepted).
 * @returns the sound instance ID.
 * @example
 * // play the "cling" audio clip
 * me.audio.play("cling");
 * // play & repeat the "engine" audio clip
 * me.audio.play("engine", true);
 * // play the "gameover_sfx" audio clip and call myFunc when finished
 * me.audio.play("gameover_sfx", false, myFunc);
 * // play the "gameover_sfx" audio clip with a lower volume level
 * me.audio.play("gameover_sfx", false, null, 0.5);
 * @category Audio
 */
export declare function play(sound_name: string, loop?: boolean, onend?: (() => void) | null, volume?: number): number;
/**
 * Fade a currently playing sound between two volumes.
 * @param sound_name - audio clip name - case sensitive
 * @param from - Volume to fade from (0.0 to 1.0).
 * @param to - Volume to fade to (0.0 to 1.0).
 * @param duration - Time in milliseconds to fade.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will fade.
 * @category Audio
 */
export declare function fade(sound_name: string, from: number, to: number, duration: number, id?: number): void;
/**
 * get/set the position of playback for a sound.
 * @param sound_name - audio clip name - case sensitive
 * @param args - optional seek position (in seconds) and optional sound instance ID
 * @returns return the current seek position (if no extra parameters were given)
 * @example
 * // return the current position of the background music
 * let current_pos = me.audio.seek("dst-gameforest");
 * // set back the position of the background music to the beginning
 * me.audio.seek("dst-gameforest", 0);
 * @category Audio
 */
export declare function seek(sound_name: string, ...args: number[]): number;
/**
 * get or set the rate of playback for a sound.
 * @param sound_name - audio clip name - case sensitive
 * @param args - optional playback rate (0.5 to 4.0, with 1.0 being normal speed) and optional sound instance ID
 * @returns return the current playback rate (if no extra parameters were given)
 * @example
 * // get the playback rate of the background music
 * let rate = me.audio.rate("dst-gameforest");
 * // speed up the playback of the background music
 * me.audio.rate("dst-gameforest", 2.0);
 * @category Audio
 */
export declare function rate(sound_name: string, ...args: number[]): number;
/**
 * get or set the stereo panning for the specified sound.
 * @param sound_name - audio clip name - case sensitive
 * @param [pan] - the panning value - A value of -1.0 is all the way left and 1.0 is all the way right.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
 * @returns the current panning value
 * @example
 * me.audio.stereo("cling", -1);
 * @category Audio
 */
export declare function stereo(sound_name: string, pan?: number, id?: number): number;
/**
 * get or set the 3D spatial position for the specified sound.
 * @param sound_name - audio clip name - case sensitive
 * @param x - the x-position of the audio source.
 * @param y - the y-position of the audio source.
 * @param z - the z-position of the audio source.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
 * @returns the current 3D spatial position: [x, y, z]
 * @category Audio
 */
export declare function position(sound_name: string, x: number, y: number, z: number, id?: number): number[];
/**
 * Get/set the direction the audio source is pointing in the 3D cartesian coordinate space.
 * Depending on how direction the sound is, based on the `cone` attributes, a sound pointing away from the listener can be quiet or silent.
 * @param sound_name - audio clip name - case sensitive
 * @param x - the x-orientation of the audio source.
 * @param y - the y-orientation of the audio source.
 * @param z - the z-orientation of the audio source.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
 * @returns the current 3D spatial orientation: [x, y, z]
 * @category Audio
 */
export declare function orientation(sound_name: string, x: number, y: number, z: number, id?: number): number[];
/**
 * get or set the panner node's attributes for a sound or group of sounds.
 * See {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics#creating_a_panner_node}
 * @param sound_name - audio clip name - case sensitive
 * @param [attributes] - the panner attributes to set
 * @param [attributes.coneInnerAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, inside of which there will be no volume reduction.
 * @param [attributes.coneOuterAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, outside of which the volume will be reduced to a constant value of `coneOuterGain`.
 * @param [attributes.coneOuterGain=0] - A parameter for directional audio sources, this is the gain outside of the `coneOuterAngle`. It is a linear value in the range `[0, 1]`.
 * @param [attributes.distanceModel="inverse"] - Determines algorithm used to reduce volume as audio moves away from listener. Can be `linear`, `inverse` or `exponential.
 * @param [attributes.maxDistance=10000] - The maximum distance between source and listener, after which the volume will not be reduced any further.
 * @param [attributes.refDistance=1] - A reference distance for reducing volume as source moves further from the listener. This is simply a variable of the distance model and has a different effect depending on which model is used and the scale of your coordinates. Generally, volume will be equal to 1 at this distance.
 * @param [attributes.rolloffFactor=1] - How quickly the volume reduces as source moves from listener. This is simply a variable of the distance model and can be in the range of `[0, 1]` with `linear` and `[0, ∞]` with `inverse` and `exponential`.
 * @param [attributes.panningModel="HRTF"] - Determines which spatialization algorithm is used to position audio. Can be `HRTF` or `equalpower`.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
 * @returns current panner attributes.
 * @example
 * me.audio.panner("cling", {
 *    panningModel: 'HRTF',
 *    refDistance: 0.8,
 *    rolloffFactor: 2.5,
 *    distanceModel: 'exponential'
 * });
 * @category Audio
 */
export declare function panner(sound_name: string, attributes?: PannerAttributes, id?: number): PannerAttributes;
/**
 * stop the specified sound on all channels
 * @param [sound_name] - audio clip name (case sensitive). If none is passed, all sounds are stopped.
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will stop.
 * @example
 * me.audio.stop("cling");
 * @category Audio
 */
export declare function stop(sound_name?: string, id?: number): void;
/**
 * pause the specified sound on all channels<br>
 * this function does not reset the currentTime property
 * @param sound_name - audio clip name - case sensitive
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will pause.
 * @example
 * me.audio.pause("cling");
 * @category Audio
 */
export declare function pause(sound_name: string, id?: number): void;
/**
 * resume the specified sound on all channels<br>
 * @param sound_name - audio clip name - case sensitive
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will resume.
 * @example
 * // play an audio clip
 * let id = me.audio.play("myClip");
 * ...
 * // pause it
 * me.audio.pause("myClip", id);
 * ...
 * // resume
 * me.audio.resume("myClip", id);
 * @category Audio
 */
export declare function resume(sound_name: string, id?: number): void;
/**
 * play the specified audio track<br>
 * this function automatically set the loop property to true<br>
 * and keep track of the current sound being played.
 * @param sound_name - audio track name - case sensitive
 * @param [volume=default] - Float specifying volume (0.0 - 1.0 values accepted).
 * @returns the sound instance ID.
 * @example
 * me.audio.playTrack("awesome_music");
 * @category Audio
 */
export declare function playTrack(sound_name: string, volume?: number): number;
/**
 * stop the current audio track
 * @see {@link playTrack}
 * @example
 * // play an awesome music
 * me.audio.playTrack("awesome_music");
 * // stop the current music
 * me.audio.stopTrack();
 * @category Audio
 */
export declare function stopTrack(): void;
/**
 * pause the current audio track
 * @example
 * me.audio.pauseTrack();
 * @category Audio
 */
export declare function pauseTrack(): void;
/**
 * resume the previously paused audio track
 * @example
 * // play an awesome music
 * me.audio.playTrack("awesome_music");
 * // pause the audio track
 * me.audio.pauseTrack();
 * // resume the music
 * me.audio.resumeTrack();
 * @category Audio
 */
export declare function resumeTrack(): void;
/**
 * returns the current track Id
 * @returns audio track name
 * @category Audio
 */
export declare function getCurrentTrack(): string | null;
/**
 * set the default global volume
 * @param volume - Float specifying volume (0.0 - 1.0 values accepted).
 * @category Audio
 */
export declare function setVolume(volume: number): void;
/**
 * get the default global volume
 * @returns current volume value in Float [0.0 - 1.0] .
 * @category Audio
 */
export declare function getVolume(): number;
/**
 * mute or unmute the specified sound, but does not pause the playback.
 * @param sound_name - audio clip name - case sensitive
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will mute.
 * @param [shouldMute=true] - True to mute and false to unmute
 * @example
 * // mute the background music
 * me.audio.mute("awesome_music");
 * @category Audio
 */
export declare function mute(sound_name: string, id?: number, shouldMute?: boolean): void;
/**
 * unmute the specified sound
 * @param sound_name - audio clip name
 * @param [id] - the sound instance ID. If none is passed, all sounds in group will unmute.
 * @category Audio
 */
export declare function unmute(sound_name: string, id?: number): void;
/**
 * mute all audio
 * @category Audio
 */
export declare function muteAll(): void;
/**
 * unmute all audio
 * @category Audio
 */
export declare function unmuteAll(): void;
/**
 * Returns true if audio is muted globally.
 * @returns true if audio is muted globally
 * @category Audio
 */
export declare function muted(): boolean;
/**
 * unload specified audio track to free memory
 * @param sound_name - audio track name - case sensitive
 * @returns true if unloaded
 * @example
 * me.audio.unload("awesome_music");
 * @category Audio
 */
export declare function unload(sound_name: string): boolean;
/**
 * unload all audio to free memory
 * @example
 * me.audio.unloadAll();
 * @category Audio
 */
export declare function unloadAll(): void;
export {};
//# sourceMappingURL=audio.d.ts.map