Files
cocos4/@types/pal/audio.d.ts
T
PP 86f20da0f0 support pal/input (#8472)
* support pal/input

update

* update

* fix esLint

* support minigame

* support  pal/input on  minigame

* remove minigame.isSubContext

* support native

update

* deprecate static property on EventMouse

* deprecated static property in  EventTouch

* remove TODO

* remove  x y position in MouseWheel Event

* remove TODO

* remove temp code

* fix esLint

* update AccelerometerIntervalMode

* remove legacy code in JSB

* fix esLint

* optimize AccelerometerInputSource.setInterval

* fix esLint

* optimize code

* add more details for documentation

* update

* don't pass game.canvas to inputManager.registerSystemEvent

* optimize

* Revert "remove  x y position in MouseWheel Event"

This reverts commit b521ec4948d693b420887cdeb2f5f3afc1500066.

# Conflicts:
#	@types/pal/input.d.ts

* update

* fix esLint

* fix esLint
2021-04-19 16:24:42 +08:00

163 lines
5.2 KiB
TypeScript

declare module 'pal/audio' {
/**
* Each audio instance needs to be managed, but should not take up too much memory.
* The `OneShotAudio` is a lite version of audio interface designed for audio manager.
*/
export interface OneShotAudio {
/**
* Stops playing the audio.
*/
stop (): void;
/**
* Register an callback which would be called when the play starts.
* @param cb The callback.
* @returns This audio.
*/
onPlay (cb: () => void): OneShotAudio;
/**
* Register an callback which would be called when the play ends.
* @param cb The callback.
* @returns This audio.
*/
onEnded (cb: () => void): OneShotAudio;
}
export class AudioPlayer {
private constructor (nativeAudio: unknown);
/**
* Destroys the player.
*/
destroy (): void;
/**
* Asynchronously creates an audio player to load an audio.
* @param url URL to the audio.
* @param opts Load options.
* @returns The audio player.
*/
static load (url: string, opts?: import('pal/audio/type').AudioLoadOptions): Promise<AudioPlayer>;
/**
* Asynchronously load a native audio for playing one shot.
* @param url URL to the audio.
* @param opts Load options.
* @returns The native audio such as `HTMLAudioElement` or `AudioBuffer`.
*/
static loadNative (url: string, opts?: import('pal/audio/type').AudioLoadOptions): Promise<unknown>;
/**
* Max audio channel count allowed on current platform.
* If the amount of playing audios exceeds the limit,
* some audio instances would be discarded by audio manager.
*/
static readonly maxAudioChannel: number;
/**
* Readonly property to get the url of audio src.
*/
get src (): string;
/**
* The type of this player.
* For WEB platform, it can be `WEB_AUDIO` or `DOM_AUDIO`.
*/
get type (): import('pal/audio/type').AudioType;
/**
* The state of this player.
* The state would be restored to `INIT` when the audio finished its playing.
*/
get state (): import('pal/audio/type').AudioState;
/**
* Gets or sets whether if the playing audio should be looped.
*/
get loop (): boolean;
set loop (val: boolean);
/**
* The volume of this player, ranged from 0 to 1.
*/
get volume (): number;
set volume (val: number);
/**
* The duration of this audio player.
*/
get duration (): number;
/**
* The current time of this player, in seconds, ranged from 0 to its total duration.
* Note this field is immutable, if you want to set the current time, please call the seek() method instead.
*/
get currentTime (): number;
/**
* Asynchronously seeks the player's playing time onto specified location.
* @param time Desired playing time.
*/
seek (time: number): Promise<void>;
/**
* Plays one shot of the audio, the returned `OneShotAudio` can be managed by audio manager.
* @param volume Specifies the volume. If not specified...
* @returns The one shot audio.
*/
playOneShot (volume?: number): OneShotAudio;
/**
* Asynchronously plays the audio or resumes the audio while it is paused.
*/
play (): Promise<void>;
/**
* Asynchronously pauses the playing.
*/
pause (): Promise<void>;
/**
* Asynchronously stops the playing.
*/
stop (): Promise<void>;
/**
* Registers an callback which would be called at an interruption begin.
* The interruption includes the show/hide events, phone call/alarm, earphones un-plugging.
* @param cb The callback.
*/
onInterruptionBegin (cb: () => void): void;
/**
* Unregister the callback that registered to `onInterruptionBegin`.
* @param cb The callback. If not specified, all callback would be unregistered.
*/
offInterruptionBegin (cb?: () => void): void;
/**
* Register an callback which would be called at an interruption end.
* @param cb The callback.
*/
onInterruptionEnd (cb: () => void): void;
/**
* Unregister the callback that registered to `onInterruptionEnd`.
* @param cb The callback. If not specified, all callback would be unregistered.
*/
offInterruptionEnd (cb?: () => void): void;
/**
* Register an callback which would be called when the player finished its playing.
* @param cb The callback.
*/
onEnded (cb: () => void): void;
/**
* Unregister the callback that registered to `onEnded`.
* @param cb The callback. If not specified, all callback would be unregistered.
*/
offEnded (cb?: () => void): void;
}
}