drm-native-audio

A Capacitor plugin for playing native audio with DRM implementation.

Install

npm install drm-native-audio
npx cap sync

API

• loadPallyconSound(...)
• pauseAudio()
• setAudioPlaybackRate(...)
• seekToTime(...)
• stopCurrentAudio()
• addListener('soundEnded', ...)
• addListener('isBuffering', ...)
• addListener('audioLoaded', ...)
• addListener('notificationPreviousCalled', ...)
• addListener('notificationNextCalled', ...)
• addListener('playerError', ...)
• addListener('isAudioPlaying', ...)
• addListener('isAudioPause', ...)
• playAudio()
• getPaused()
• getCurrentTime()
• removeNotificationAndClearAudio()
• Interfaces

loadPallyconSound(...)

loadPallyconSound(options: { audioURL: String; author: String; token: String; notificationThumbnail: String; title: String; seekTime: number; contentId: String; isSampleAudio: Boolean; email: String; }) => Promise<void>

Param	Type
options	{ audioURL: String; author: String; token: String; notificationThumbnail: String; title: String; seekTime: number; contentId: String; isSampleAudio: Boolean; email: String; }

---

pauseAudio()

pauseAudio() => Promise<void>

---

setAudioPlaybackRate(...)

setAudioPlaybackRate(options: { speed: number; }) => Promise<void>

Param	Type
options	{ speed: number; }

---

seekToTime(...)

seekToTime(options: { seekTime: number; }) => Promise<void>

Param	Type
options	{ seekTime: number; }

---

stopCurrentAudio()

stopCurrentAudio() => Promise<void>

---

addListener('soundEnded', ...)

addListener(eventName: 'soundEnded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'soundEnded'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

---

addListener('isBuffering', ...)

addListener(eventName: 'isBuffering', listenerFunc: () => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'isBuffering'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

---

addListener('audioLoaded', ...)

addListener(eventName: 'audioLoaded', listenerFunc: (soundDuration: number) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'audioLoaded'
listenerFunc	(soundDuration: number) => void

Returns: Promise<PluginListenerHandle>

---

addListener('notificationPreviousCalled', ...)

addListener(eventName: 'notificationPreviousCalled', listenerFunc: () => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'notificationPreviousCalled'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

---

addListener('notificationNextCalled', ...)

addListener(eventName: 'notificationNextCalled', listenerFunc: () => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'notificationNextCalled'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

---

addListener('playerError', ...)

addListener(eventName: 'playerError', listenerFunc: (message: any) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'playerError'
listenerFunc	(message: any) => void

Returns: Promise<PluginListenerHandle>

---

addListener('isAudioPlaying', ...)

addListener(eventName: 'isAudioPlaying', listenerFunc: (error: any) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'isAudioPlaying'
listenerFunc	(error: any) => void

Returns: Promise<PluginListenerHandle>

---

addListener('isAudioPause', ...)

addListener(eventName: 'isAudioPause', listenerFunc: (error: any) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'isAudioPause'
listenerFunc	(error: any) => void

Returns: Promise<PluginListenerHandle>

---

playAudio()

playAudio() => Promise<void>

---

getPaused()

getPaused() => Promise<{ paused: boolean; }>

Returns: Promise<{ paused: boolean; }>

---

getCurrentTime()

getCurrentTime() => Promise<{ time: number; }>

Returns: Promise<{ time: number; }>

---

removeNotificationAndClearAudio()

removeNotificationAndClearAudio() => Promise<void>

---

Interfaces

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Prop	Type	Description
length	number	Returns the length of a String object.

Method	Signature	Description
toString	() => string	Returns a string representation of a string.
charAt	(pos: number) => string	Returns the character at the specified index.
charCodeAt	(index: number) => number	Returns the Unicode value of the character at the specified location.
concat	(...strings: string[]) => string	Returns a string that contains the concatenation of two or more strings.
indexOf	(searchString: string, position?: number | undefined) => number	Returns the position of the first occurrence of a substring.
lastIndexOf	(searchString: string, position?: number | undefined) => number	Returns the last occurrence of a substring in the string.
localeCompare	(that: string) => number	Determines whether two strings are equivalent in the current locale.
match	(regexp: string | RegExp) => RegExpMatchArray | null	Matches a string with a regular expression, and returns an array containing the results of that search.
replace	(searchValue: string | RegExp, replaceValue: string) => string	Replaces text in a string, using a regular expression or search string.
replace	(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string) => string	Replaces text in a string, using a regular expression or search string.
search	(regexp: string | RegExp) => number	Finds the first substring match in a regular expression search.
slice	(start?: number | undefined, end?: number | undefined) => string	Returns a section of a string.
split	(separator: string | RegExp, limit?: number | undefined) => string[]	Split a string into substrings using the specified separator and return them as an array.
substring	(start: number, end?: number | undefined) => string	Returns the substring at the specified location within a String object.
toLowerCase	() => string	Converts all the alphabetic characters in a string to lowercase.
toLocaleLowerCase	(locales?: string | string[] | undefined) => string	Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
toUpperCase	() => string	Converts all the alphabetic characters in a string to uppercase.
toLocaleUpperCase	(locales?: string | string[] | undefined) => string	Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
trim	() => string	Removes the leading and trailing white space and line terminator characters from a string.
substr	(from: number, length?: number | undefined) => string	Gets a substring beginning at the specified location and having the specified length.
valueOf	() => string	Returns the primitive value of the specified object.

RegExpMatchArray

Prop	Type
index	number
input	string

RegExp

Prop	Type	Description
source	string	Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal.
global	boolean	Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only.
ignoreCase	boolean	Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only.
multiline	boolean	Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only.
lastIndex	number

Method	Signature	Description
exec	(string: string) => RegExpExecArray | null	Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.
test	(string: string) => boolean	Returns a Boolean value that indicates whether or not a pattern exists in a searched string.
compile	() => this

RegExpExecArray

Prop	Type
index	number
input	string

Boolean

Method	Signature	Description
valueOf	() => boolean	Returns the primitive value of the specified object.

PluginListenerHandle

Prop	Type
remove	() => Promise<void>