@mustafaj/capacitor-plugin-playlist 0.9.0

package/dist/esm/Constants.d.ts

@@ -0,0 +1,164 @@
+/**
+ * Enum describing the possible errors that may come from the plugins
+ */
+export declare enum RmxAudioErrorType {
+    RMXERR_NONE_ACTIVE = 0,
+    RMXERR_ABORTED = 1,
+    RMXERR_NETWORK = 2,
+    RMXERR_DECODE = 3,
+    RMXERR_NONE_SUPPORTED = 4
+}
+/**
+ * String descriptions corresponding to the RmxAudioErrorType values
+ */
+export declare const RmxAudioErrorTypeDescriptions: string[];
+/**
+ * Enumeration of all status messages raised by the plugin.
+ * NONE, REGISTER and INIT are structural and probably not useful to you.
+ */
+export declare enum RmxAudioStatusMessage {
+    /**
+     * The starting state of the plugin. You will never see this value;
+     * it changes before the callbacks are even registered to report changes to this value.
+     */
+    RMXSTATUS_NONE = 0,
+    /**
+     * Raised when the plugin registers the callback handler for onStatus callbacks.
+     * You will probably not be able to see this (nor do you need to).
+     */
+    RMXSTATUS_REGISTER = 1,
+    /**
+     * Reserved for future use
+     */
+    RMXSTATUS_INIT = 2,
+    /**
+     * Indicates an error is reported in the 'value' field.
+     */
+    RMXSTATUS_ERROR = 5,
+    /**
+     * The reported track is being loaded by the player
+     */
+    RMXSTATUS_LOADING = 10,
+    /**
+     * The reported track is able to begin playback
+     */
+    RMXSTATUS_CANPLAY = 11,
+    /**
+     * The reported track has loaded 100% of the file (either from disc or network)
+     */
+    RMXSTATUS_LOADED = 15,
+    /**
+     * (iOS only): Playback has stalled due to insufficient network
+     */
+    RMXSTATUS_STALLED = 20,
+    /**
+     * Reports an update in the reported track's buffering status
+     */
+    RMXSTATUS_BUFFERING = 25,
+    /**
+     * The reported track has started (or resumed) playing
+     */
+    RMXSTATUS_PLAYING = 30,
+    /**
+     * The reported track has been paused, either by the user or by the system.
+     * (iOS only): This value is raised when MP3's are malformed (but still playable).
+     * These require the user to explicitly press play again. This can be worked
+     * around and is on the TODO list.
+     */
+    RMXSTATUS_PAUSE = 35,
+    /**
+     * Reports a change in the reported track's playback position.
+     */
+    RMXSTATUS_PLAYBACK_POSITION = 40,
+    /**
+     * The reported track has seeked.
+     * On Android, only the plugin consumer can generate this (Notification controls on Android do not include a seek bar).
+     * On iOS, the Command Center includes a seek bar so this will be reported when the user has seeked via Command Center.
+     */
+    RMXSTATUS_SEEK = 45,
+    /**
+     * The reported track has completed playback.
+     */
+    RMXSTATUS_COMPLETED = 50,
+    /**
+     * The reported track's duration has changed. This is raised once, when duration is updated for the first time.
+     * For streams, this value is never reported.
+     */
+    RMXSTATUS_DURATION = 55,
+    /**
+     * All playback has stopped, probably because the plugin is shutting down.
+     */
+    RMXSTATUS_STOPPED = 60,
+    /**
+     * The playlist has skipped forward to the next track.
+     * On both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.
+     * It is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,
+     * so you can generalize your track change handling in one place.
+     */
+    RMX_STATUS_SKIP_FORWARD = 90,
+    /**
+     * The playlist has skipped back to the previous track.
+     * On both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.
+     * It is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,
+     * so you can generalize your track change handling in one place.
+     */
+    RMX_STATUS_SKIP_BACK = 95,
+    /**
+     * Reported when the current track has changed in the native player. This event contains full data about
+     * the new track, including the index and the actual track itself. The type of the 'value' field in this case
+     * is OnStatusTrackChangedData.
+     */
+    RMXSTATUS_TRACK_CHANGED = 100,
+    /**
+     * The entire playlist has completed playback.
+     * After this event has been raised, the current item is set to null and the current index to -1.
+     */
+    RMXSTATUS_PLAYLIST_COMPLETED = 105,
+    /**
+     * An item has been added to the playlist. For the setPlaylistItems and addAllItems methods, this status is
+     * raised once for every track in the collection.
+     */
+    RMXSTATUS_ITEM_ADDED = 110,
+    /**
+     * An item has been removed from the playlist. For the removeItems and clearAllItems methods, this status is
+     * raised once for every track that was removed.
+     */
+    RMXSTATUS_ITEM_REMOVED = 115,
+    /**
+     * All items have been removed from the playlist
+     */
+    RMXSTATUS_PLAYLIST_CLEARED = 120,
+    /**
+     * Just for testing.. you don't need this and in fact can never receive it, the plugin is destroyed before it can be raised.
+     */
+    RMXSTATUS_VIEWDISAPPEAR = 200
+}
+/**
+ * String descriptions corresponding to the RmxAudioStatusMessage values
+ */
+export declare const RmxAudioStatusMessageDescriptions: {
+    0: string;
+    1: string;
+    2: string;
+    5: string;
+    10: string;
+    11: string;
+    15: string;
+    20: string;
+    25: string;
+    30: string;
+    35: string;
+    40: string;
+    45: string;
+    50: string;
+    55: string;
+    60: string;
+    90: string;
+    95: string;
+    100: string;
+    105: string;
+    110: string;
+    115: string;
+    120: string;
+    200: string;
+};

package/dist/esm/Constants.js

@@ -0,0 +1,175 @@
+/**
+ * Enum describing the possible errors that may come from the plugins
+ */
+export var RmxAudioErrorType;
+(function (RmxAudioErrorType) {
+    RmxAudioErrorType[RmxAudioErrorType["RMXERR_NONE_ACTIVE"] = 0] = "RMXERR_NONE_ACTIVE";
+    RmxAudioErrorType[RmxAudioErrorType["RMXERR_ABORTED"] = 1] = "RMXERR_ABORTED";
+    RmxAudioErrorType[RmxAudioErrorType["RMXERR_NETWORK"] = 2] = "RMXERR_NETWORK";
+    RmxAudioErrorType[RmxAudioErrorType["RMXERR_DECODE"] = 3] = "RMXERR_DECODE";
+    RmxAudioErrorType[RmxAudioErrorType["RMXERR_NONE_SUPPORTED"] = 4] = "RMXERR_NONE_SUPPORTED";
+})(RmxAudioErrorType || (RmxAudioErrorType = {}));
+;
+/**
+ * String descriptions corresponding to the RmxAudioErrorType values
+ */
+export const RmxAudioErrorTypeDescriptions = [
+    'No Active Sources',
+    'Aborted',
+    'Network',
+    'Failed to Decode',
+    'No Supported Sources',
+];
+/**
+ * Enumeration of all status messages raised by the plugin.
+ * NONE, REGISTER and INIT are structural and probably not useful to you.
+ */
+export var RmxAudioStatusMessage;
+(function (RmxAudioStatusMessage) {
+    /**
+     * The starting state of the plugin. You will never see this value;
+     * it changes before the callbacks are even registered to report changes to this value.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_NONE"] = 0] = "RMXSTATUS_NONE";
+    /**
+     * Raised when the plugin registers the callback handler for onStatus callbacks.
+     * You will probably not be able to see this (nor do you need to).
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_REGISTER"] = 1] = "RMXSTATUS_REGISTER";
+    /**
+     * Reserved for future use
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_INIT"] = 2] = "RMXSTATUS_INIT";
+    /**
+     * Indicates an error is reported in the 'value' field.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_ERROR"] = 5] = "RMXSTATUS_ERROR";
+    /**
+     * The reported track is being loaded by the player
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_LOADING"] = 10] = "RMXSTATUS_LOADING";
+    /**
+     * The reported track is able to begin playback
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_CANPLAY"] = 11] = "RMXSTATUS_CANPLAY";
+    /**
+     * The reported track has loaded 100% of the file (either from disc or network)
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_LOADED"] = 15] = "RMXSTATUS_LOADED";
+    /**
+     * (iOS only): Playback has stalled due to insufficient network
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_STALLED"] = 20] = "RMXSTATUS_STALLED";
+    /**
+     * Reports an update in the reported track's buffering status
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_BUFFERING"] = 25] = "RMXSTATUS_BUFFERING";
+    /**
+     * The reported track has started (or resumed) playing
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_PLAYING"] = 30] = "RMXSTATUS_PLAYING";
+    /**
+     * The reported track has been paused, either by the user or by the system.
+     * (iOS only): This value is raised when MP3's are malformed (but still playable).
+     * These require the user to explicitly press play again. This can be worked
+     * around and is on the TODO list.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_PAUSE"] = 35] = "RMXSTATUS_PAUSE";
+    /**
+     * Reports a change in the reported track's playback position.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_PLAYBACK_POSITION"] = 40] = "RMXSTATUS_PLAYBACK_POSITION";
+    /**
+     * The reported track has seeked.
+     * On Android, only the plugin consumer can generate this (Notification controls on Android do not include a seek bar).
+     * On iOS, the Command Center includes a seek bar so this will be reported when the user has seeked via Command Center.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_SEEK"] = 45] = "RMXSTATUS_SEEK";
+    /**
+     * The reported track has completed playback.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_COMPLETED"] = 50] = "RMXSTATUS_COMPLETED";
+    /**
+     * The reported track's duration has changed. This is raised once, when duration is updated for the first time.
+     * For streams, this value is never reported.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_DURATION"] = 55] = "RMXSTATUS_DURATION";
+    /**
+     * All playback has stopped, probably because the plugin is shutting down.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_STOPPED"] = 60] = "RMXSTATUS_STOPPED";
+    /**
+     * The playlist has skipped forward to the next track.
+     * On both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.
+     * It is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,
+     * so you can generalize your track change handling in one place.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMX_STATUS_SKIP_FORWARD"] = 90] = "RMX_STATUS_SKIP_FORWARD";
+    /**
+     * The playlist has skipped back to the previous track.
+     * On both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.
+     * It is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,
+     * so you can generalize your track change handling in one place.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMX_STATUS_SKIP_BACK"] = 95] = "RMX_STATUS_SKIP_BACK";
+    /**
+     * Reported when the current track has changed in the native player. This event contains full data about
+     * the new track, including the index and the actual track itself. The type of the 'value' field in this case
+     * is OnStatusTrackChangedData.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_TRACK_CHANGED"] = 100] = "RMXSTATUS_TRACK_CHANGED";
+    /**
+     * The entire playlist has completed playback.
+     * After this event has been raised, the current item is set to null and the current index to -1.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_PLAYLIST_COMPLETED"] = 105] = "RMXSTATUS_PLAYLIST_COMPLETED";
+    /**
+     * An item has been added to the playlist. For the setPlaylistItems and addAllItems methods, this status is
+     * raised once for every track in the collection.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_ITEM_ADDED"] = 110] = "RMXSTATUS_ITEM_ADDED";
+    /**
+     * An item has been removed from the playlist. For the removeItems and clearAllItems methods, this status is
+     * raised once for every track that was removed.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_ITEM_REMOVED"] = 115] = "RMXSTATUS_ITEM_REMOVED";
+    /**
+     * All items have been removed from the playlist
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_PLAYLIST_CLEARED"] = 120] = "RMXSTATUS_PLAYLIST_CLEARED";
+    /**
+     * Just for testing.. you don't need this and in fact can never receive it, the plugin is destroyed before it can be raised.
+     */
+    RmxAudioStatusMessage[RmxAudioStatusMessage["RMXSTATUS_VIEWDISAPPEAR"] = 200] = "RMXSTATUS_VIEWDISAPPEAR";
+})(RmxAudioStatusMessage || (RmxAudioStatusMessage = {}));
+;
+/**
+ * String descriptions corresponding to the RmxAudioStatusMessage values
+ */
+export const RmxAudioStatusMessageDescriptions = {
+    0: 'No Status',
+    1: 'Plugin Registered',
+    2: 'Plugin Initialized',
+    5: 'Error',
+    10: 'Loading',
+    11: 'CanPlay',
+    15: 'Loaded',
+    20: 'Stalled',
+    25: 'Buffering',
+    30: 'Playing',
+    35: 'Paused',
+    40: 'Playback Position Changed',
+    45: 'Seeked',
+    50: 'Playback Completed',
+    55: 'Duration Changed',
+    60: 'Stopped',
+    90: 'Skip Forward',
+    95: 'Skip Backward',
+    100: 'Track Changed',
+    105: 'Playlist Completed',
+    110: 'Track Added',
+    115: 'Track Removed',
+    120: 'Playlist Cleared',
+    200: 'DEBUG_View_Disappeared',
+};
+//# sourceMappingURL=Constants.js.map

package/dist/esm/Constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IACzB,qFAAsB,CAAA;IACtB,6EAAkB,CAAA;IAClB,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;IACjB,2FAAyB,CAAA;AAC7B,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAAA,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IACzC,mBAAmB;IACnB,SAAS;IACT,SAAS;IACT,kBAAkB;IAClB,sBAAsB;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAN,IAAY,qBAuHX;AAvHD,WAAY,qBAAqB;IAC7B;;;OAGG;IACH,qFAAkB,CAAA;IAClB;;;OAGG;IACH,6FAAsB,CAAA;IACtB;;OAEG;IACH,qFAAkB,CAAA;IAClB;;OAEG;IACH,uFAAmB,CAAA;IAEnB;;OAEG;IACH,4FAAsB,CAAA;IACtB;;OAEG;IACH,4FAAsB,CAAA;IACtB;;OAEG;IACH,0FAAqB,CAAA;IACrB;;OAEG;IACH,4FAAsB,CAAA;IACtB;;OAEG;IACH,gGAAwB,CAAA;IACxB;;OAEG;IACH,4FAAsB,CAAA;IACtB;;;;;OAKG;IACH,wFAAoB,CAAA;IACpB;;OAEG;IACH,gHAAgC,CAAA;IAChC;;;;OAIG;IACH,sFAAmB,CAAA;IACnB;;OAEG;IACH,gGAAwB,CAAA;IACxB;;;OAGG;IACH,8FAAuB,CAAA;IACvB;;OAEG;IACH,4FAAsB,CAAA;IAEtB;;;;;OAKG;IACH,wGAA4B,CAAA;IAC5B;;;;;OAKG;IACH,kGAAyB,CAAA;IACzB;;;;OAIG;IACH,yGAA6B,CAAA;IAC7B;;;OAGG;IACH,mHAAkC,CAAA;IAClC;;;OAGG;IACH,mGAA0B,CAAA;IAC1B;;;OAGG;IACH,uGAA4B,CAAA;IAC5B;;OAEG;IACH,+GAAgC,CAAA;IAEhC;;OAEG;IACH,yGAA6B,CAAA;AACjC,CAAC,EAvHW,qBAAqB,KAArB,qBAAqB,QAuHhC;AAAA,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC7C,CAAC,EAAE,WAAW;IACd,CAAC,EAAE,mBAAmB;IACtB,CAAC,EAAE,oBAAoB;IACvB,CAAC,EAAE,OAAO;IAEV,EAAE,EAAE,SAAS;IACb,EAAE,EAAE,SAAS;IACb,EAAE,EAAE,QAAQ;IACZ,EAAE,EAAE,SAAS;IACb,EAAE,EAAE,WAAW;IACf,EAAE,EAAE,SAAS;IACb,EAAE,EAAE,QAAQ;IACZ,EAAE,EAAE,2BAA2B;IAC/B,EAAE,EAAE,QAAQ;IACZ,EAAE,EAAE,oBAAoB;IACxB,EAAE,EAAE,kBAAkB;IACtB,EAAE,EAAE,SAAS;IAEb,EAAE,EAAE,cAAc;IAClB,EAAE,EAAE,eAAe;IACnB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,kBAAkB;IAEvB,GAAG,EAAE,wBAAwB;CAChC,CAAC"}

package/dist/esm/RmxAudioPlayer.d.ts

@@ -0,0 +1,181 @@
+import { RmxAudioStatusMessage } from './Constants';
+import { AudioPlayerEventHandler, AudioPlayerEventHandlers, AudioPlayerOptions, AudioTrack, AudioTrackRemoval, OnStatusCallback, OnStatusCallbackUpdateData, OnStatusErrorCallbackData, OnStatusTrackChangedData, PlaylistItemOptions } from './interfaces';
+export declare class RmxAudioPlayer {
+    handlers: AudioPlayerEventHandlers;
+    options: AudioPlayerOptions;
+    private readonly _initPromise;
+    private _readyResolve;
+    private _readyReject;
+    private _currentState;
+    private _hasError;
+    private _hasLoaded;
+    private _currentItem;
+    /**
+     * The current summarized state of the player, as a string. It is preferred that you use the 'isX' accessors,
+     * because they properly interpret the range of these values, but this field is exposed if you wish to observe
+     * or interrogate it.
+     */
+    get currentState(): "error" | "stopped" | "unknown" | "paused" | "loading" | "playing" | "ready";
+    get currentTrack(): AudioTrack | null;
+    /**
+     * If the playlist is currently playling a track.
+     */
+    get isPlaying(): boolean;
+    /**
+     * True if the playlist is currently paused
+     */
+    get isPaused(): boolean;
+    /**
+     * True if the plugin is currently loading its *current* track.
+     * On iOS, many tracks are loaded in parallel, so this only reports for the *current item*, e.g.
+     * the item that will begin playback if you press pause.
+     * If you need track-specific data, it is better to watch the onStatus stream and watch for RMXSTATUS_LOADING,
+     * which will be raised independently & simultaneously for every track in the playlist.
+     * On Android, tracks are only loaded as they begin playback, so this value and RMXSTATUS_LOADING should always
+     * apply to the same track.
+     */
+    get isLoading(): boolean;
+    /**
+     * True if the *currently playing track* has been loaded and can be played (this includes if it is *currently playing*).
+     */
+    get hasLoaded(): boolean;
+    /**
+     * True if the *current track* has reported an error. In almost all cases,
+     * the playlist will automatically skip forward to the next track, in which case you will also receive
+     * an RMXSTATUS_TRACK_CHANGED event.
+     */
+    get hasError(): boolean;
+    /**
+     * Creates a new RmxAudioPlayer instance.
+     */
+    constructor();
+    /**
+     * Player interface
+     */
+    /**
+     * Returns a promise that resolves when the plugin is ready.
+     */
+    ready: () => Promise<void>;
+    initialize: () => Promise<void>;
+    /**
+     * Sets the player options. This can be called at any time and is not required before playback can be initiated.
+     */
+    setOptions: (options: AudioPlayerOptions) => Promise<void>;
+    /**
+     * Playlist item management
+     */
+    /**
+     * Sets the entire list of tracks to be played by the playlist.
+     * This will clear all previous items from the playlist.
+     * If you pass options.retainPosition = true, the current playback position will be
+     * recorded and used when playback restarts. This can be used, for example, to set the
+     * playlist to a new set of tracks, but retain the currently-playing item to avoid skipping.
+     */
+    setPlaylistItems: (items: AudioTrack[], options?: PlaylistItemOptions) => Promise<void>;
+    /**
+     * Add a single track to the end of the playlist
+     */
+    addItem: (trackItem: AudioTrack) => Promise<void>;
+    /**
+     * Adds the list of tracks to the end of the playlist.
+     */
+    addAllItems: (items: AudioTrack[]) => Promise<void>;
+    /**
+     * Removes a track from the playlist. If this is the currently playing item, the next item will automatically begin playback.
+     */
+    removeItem: (removeItem: AudioTrackRemoval) => Promise<void>;
+    /**
+     * Removes all given tracks from the playlist; these can be specified either by trackId or trackIndex. If the removed items
+     * include the currently playing item, the next available item will automatically begin playing.
+     */
+    removeItems: (items: AudioTrackRemoval[]) => Promise<void>;
+    /**
+     * Clear the entire playlist. This will result in the STOPPED event being raised.
+     */
+    clearAllItems: () => Promise<void>;
+    /**
+     * Playback management
+     */
+    /**
+     * Begin playback. If no tracks have been added, this has no effect.
+     */
+    play: () => Promise<void>;
+    /**
+     * Play the track at the given index. If the track does not exist, this has no effect.
+     */
+    playTrackByIndex: (index: number, position?: number) => Promise<void>;
+    /**
+     * Play the track matching the given trackId. If the track does not exist, this has no effect.
+     */
+    playTrackById: (id: string, position?: number) => Promise<void>;
+    /**
+     * Play the track matching the given trackId. If the track does not exist, this has no effect.
+     */
+    selectTrackByIndex: (index: number, position?: number) => Promise<void>;
+    /**
+     * Play the track matching the given trackId. If the track does not exist, this has no effect.
+     */
+    selectTrackById: (id: string, position?: number) => Promise<void>;
+    /**
+     * Pause playback
+     */
+    pause: () => Promise<void>;
+    /**
+     * Skip to the next track. If you are already at the end, and loop is false, this has no effect.
+     * If you are at the end, and loop is true, playback will begin at the beginning of the playlist.
+     */
+    skipForward: () => Promise<void>;
+    /**
+     * Skip to the previous track. If you are already at the beginning, this has no effect.
+     */
+    skipBack: () => Promise<void>;
+    /**
+     * Seek to the given position in the currently playing track. If the value exceeds the track length,
+     * the track will complete and playback of the next track will begin.
+     */
+    seekTo: (position: number) => Promise<void>;
+    /**
+     * Set the playback speed; a float value between [-1, 1] inclusive. If set to 0, this pauses playback.
+     */
+    setPlaybackRate: (rate: number) => Promise<void>;
+    /**
+     * Set the playback volume. Float value between [0, 1] inclusive.
+     * On both Android and iOS, this sets the volume of the media stream, which can be externally
+     * controlled by setting the overall hardware volume.
+     */
+    setVolume: (volume: number) => Promise<void>;
+    /**
+     * Sets a flag indicating whether the playlist should loop back to the beginning once it reaches the end.
+     */
+    setLoop: (loop: boolean) => Promise<void>;
+    /**
+     * Status event handling
+     */
+    /**
+     * @internal
+     * Call this function to emit an onStatus event via the on('status') handler.
+     * Internal use only, to raise events received from the native interface.
+     */
+    protected onStatus(trackId: string, type: RmxAudioStatusMessage, value: OnStatusCallbackUpdateData | OnStatusTrackChangedData | OnStatusErrorCallbackData): void;
+    /**
+     * Subscribe to events raised by the plugin, e.g. on('status', (data) => { ... }),
+     * For now, only 'status' is supported.
+     *
+     * @param eventName Name of event to subscribe to.
+     * @param callback The callback function to receive the event data
+     */
+    on(eventName: 'status', callback: OnStatusCallback): void;
+    /**
+     * Remove an event handler from the plugin
+     * @param eventName The name of the event whose subscription is to be removed
+     * @param handle The event handler to destroy. Ensure that this is the SAME INSTANCE as the handler
+     * that was passed in to create the subscription!
+     */
+    off(eventName: string, handle: AudioPlayerEventHandler): void;
+    /**
+     * @internal
+     * Raises an event via the corresponding event handler. Internal use only.
+     * @param args Event args to pass through to the handler.
+     */
+    protected emit(...args: any[]): boolean;
+}