@capacitor-community/native-audio

{ "api": { "name": "NativeAudio", "slug": "nativeaudio", "docs": "", "tags": [], "methods": [ { "name": "configure", "signature": "(options: ConfigureOptions) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "ConfigureOptions" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [ "ConfigureOptions" ], "slug": "configure" }, { "name": "preload", "signature": "(options: PreloadOptions) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "PreloadOptions" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [ "PreloadOptions" ], "slug": "preload" }, { "name": "play", "signature": "(options: { assetId: string; time?: number; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; time?: number | undefined; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "play" }, { "name": "pause", "signature": "(options: { assetId: string; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "pause" }, { "name": "resume", "signature": "(options: { assetId: string; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "resume" }, { "name": "loop", "signature": "(options: { assetId: string; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "loop" }, { "name": "stop", "signature": "(options: { assetId: string; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "stop" }, { "name": "unload", "signature": "(options: { assetId: string; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "unload" }, { "name": "setVolume", "signature": "(options: { assetId: string; volume: number; }) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; volume: number; }" } ], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "setvolume" }, { "name": "getCurrentTime", "signature": "(options: { assetId: string; }) => Promise<{ currentTime: number; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<{ currentTime: number; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "getcurrenttime" }, { "name": "getDuration", "signature": "(options: { assetId: string; }) => Promise<{ duration: number; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<{ duration: number; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "getduration" }, { "name": "isPlaying", "signature": "(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ assetId: string; }" } ], "returns": "Promise<{ isPlaying: boolean; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "isplaying" }, { "name": "addListener", "signature": "(eventName: 'complete', listenerFunc: (event: { assetId: string; }) => void) => Promise<PluginListenerHandle>", "parameters": [ { "name": "eventName", "docs": "", "type": "'complete'" }, { "name": "listenerFunc", "docs": "", "type": "(event: { assetId: string; }) => void" } ], "returns": "Promise<PluginListenerHandle>", "tags": [ { "name": "since", "text": "5.0.1" } ], "docs": "Listen for asset completed playing event", "complexTypes": [ "PluginListenerHandle" ], "slug": "addlistenercomplete-" } ], "properties": [] }, "interfaces": [ { "name": "ConfigureOptions", "slug": "configureoptions", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "fade", "tags": [ { "text": "false", "name": "default" } ], "docs": "Indicating whether or not to fade audio.", "complexTypes": [], "type": "boolean | undefined" }, { "name": "focus", "tags": [ { "text": "false", "name": "default" } ], "docs": "Indicating whether or not to disable mixed audio.", "complexTypes": [], "type": "boolean | undefined" } ] }, { "name": "PreloadOptions", "slug": "preloadoptions", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "assetPath", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "assetId", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "volume", "tags": [], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "audioChannelNum", "tags": [], "docs": "", "complexTypes": [], "type": "number | undefined" }, { "name": "isUrl", "tags": [], "docs": "", "complexTypes": [], "type": "boolean | undefined" } ] }, { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise<void>" } ] } ], "enums": [], "typeAliases": [], "pluginConfigs": [] }