Interface IMedia

Interface represents either a WebAudio source or an HTML5 AudioElement source

interface IMedia {
    context: IMediaContext;
    duration: number;
    filters: PixiSound.Filter[];
    isPlayable: boolean;
    create(): IMediaInstance;
    destroy(): void;
    init(sound: Sound): void;
    load(callback?: LoadedCallback): void;
}

Implemented by

Index

Properties

context duration filters isPlayable

Methods

create destroy init load

Properties

`Readonly`context

context: IMediaContext

Reference to the context.

`Readonly`duration

duration: number

Length of sound in seconds.

filters

filters: PixiSound.Filter[]

Collection of global filters

`Readonly`isPlayable

isPlayable: boolean

Flag to check if sound is currently playable (e.g., has been loaded/decoded).

Methods

create

create(): IMediaInstance
Returns IMediaInstance
- Defined in node_modules/@pixi/sound/lib/interfaces/IMedia.d.ts:26

destroy

destroy(): void
Returns void
- Defined in node_modules/@pixi/sound/lib/interfaces/IMedia.d.ts:29

init

init(sound: Sound): void
Parameters
- sound: Sound
Returns void
- Defined in node_modules/@pixi/sound/lib/interfaces/IMedia.d.ts:27

load

load(callback?: LoadedCallback): void
Parameters
- Optionalcallback: LoadedCallback
Returns void
- Defined in node_modules/@pixi/sound/lib/interfaces/IMedia.d.ts:28