@5stones/react-native-audio-browser 0.1.0

package/lib/typescript/src/features/player/setup.d.ts

@@ -0,0 +1,471 @@
+/**
+ * AndroidAudioContentType options:
+ * - `'music'`: Content type value to use when the content type is music. See
+ *   https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_MUSIC
+ * - `'speech'`: Content type value to use when the content type is speech. See
+ *   https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SPEECH
+ * - `'sonification'`: Content type value to use when the content type is a
+ *   sound used to accompany a user action, such as a beep or sound effect
+ *   expressing a key click, or event, such as the type of a sound for a bonus
+ *   being received in a game. These sounds are mostly synthesized or short
+ *   Foley sounds. See
+ *   https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SONIFICATION
+ * - `'movie'`: Content type value to use when the content type is a soundtrack,
+ *   typically accompanying a movie or TV program.
+ * - `'unknown'`: Content type value to use when the content type is unknown, or
+ *   other than the ones defined. See
+ *   https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_UNKNOWN
+ */
+export type AndroidAudioContentType = 'music' | 'speech' | 'sonification' | 'movie' | 'unknown';
+/**
+ * IOSCategory options:
+ * - `'playback'`: The category for playing recorded music or other sounds that
+ *   are central to the successful use of your app. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616509-playback
+ * - `'playAndRecord'`: The category for recording (input) and playback (output)
+ *   of audio, such as for a Voice over Internet Protocol (VoIP) app. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616568-playandrecord
+ * - `'multiRoute'`: The category for routing distinct streams of audio data to
+ *   different output devices at the same time. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616484-multiroute
+ * - `'ambient'`: The category for an app in which sound playback is nonprimary
+ *   — that is, your app also works with the sound turned off. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616560-ambient
+ * - `'soloAmbient'`: The default audio session category. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616488-soloambient
+ * - `'record'`: The category for recording audio while also silencing playback
+ *   audio. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616451-record
+ */
+export type IOSCategory = 'playback' | 'playAndRecord' | 'multiRoute' | 'ambient' | 'soloAmbient' | 'record';
+/**
+ * IOSCategoryMode options:
+ * - `'default'`: The default audio session mode. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616579-default
+ * - `'gameChat'`: A mode that the GameKit framework sets on behalf of an
+ *   application that uses GameKit's voice chat service. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616511-gamechat
+ * - `'measurement'`: A mode that indicates that your app is performing
+ *   measurement of audio input or output. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616608-measurement
+ * - `'moviePlayback'`: A mode that indicates that your app is playing back
+ *   movie content. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616623-movieplayback
+ * - `'spokenAudio'`: A mode used for continuous spoken audio to pause the audio
+ *   when another app plays a short audio prompt. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616510-spokenaudio
+ * - `'videoChat'`: A mode that indicates that your app is engaging in online
+ *   video conferencing. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616590-videochat
+ * - `'videoRecording'`: A mode that indicates that your app is recording a
+ *   movie. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616535-videorecording
+ * - `'voiceChat'`: A mode that indicates that your app is performing two-way
+ *   voice communication, such as using Voice over Internet Protocol (VoIP). See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616455-voicechat
+ * - `'voicePrompt'`: A mode that indicates that your app plays audio using
+ *   text-to-speech. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/2962803-voiceprompt
+ */
+export type IOSCategoryMode = 'default' | 'gameChat' | 'measurement' | 'moviePlayback' | 'spokenAudio' | 'videoChat' | 'videoRecording' | 'voiceChat' | 'voicePrompt';
+/**
+ * IOSCategoryOptions options:
+ * - `'mixWithOthers'`: An option that indicates whether audio from this session
+ *   mixes with audio from active sessions in other audio apps. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616611-mixwithothers
+ * - `'duckOthers'`: An option that reduces the volume of other audio sessions
+ *   while audio from this session plays. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616618-duckothers
+ * - `'interruptSpokenAudioAndMixWithOthers'`: An option that determines whether
+ *   to pause spoken audio content from other sessions when your app plays its
+ *   audio. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616534-interruptspokenaudioandmixwithot
+ * - `'allowBluetooth'`: An option that determines whether Bluetooth hands-free
+ *   devices appear as available input routes. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616518-allowbluetooth
+ * - `'allowBluetoothA2DP'`: An option that determines whether you can stream
+ *   audio from this session to Bluetooth devices that support the Advanced
+ *   Audio Distribution Profile (A2DP). See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771735-allowbluetootha2dp
+ * - `'allowAirPlay'`: An option that determines whether you can stream audio
+ *   from this session to AirPlay devices. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771736-allowairplay
+ * - `'defaultToSpeaker'`: An option that determines whether audio from the
+ *   session defaults to the built-in speaker instead of the receiver. See
+ *   https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616462-defaulttospeaker
+ */
+export type IOSCategoryOptions = 'mixWithOthers' | 'duckOthers' | 'interruptSpokenAudioAndMixWithOthers' | 'allowBluetooth' | 'allowBluetoothA2DP' | 'allowAirPlay' | 'defaultToSpeaker';
+/**
+ * IOSCategoryPolicy options:
+ * - `'default'`: See
+ *   https://developer.apple.com/documentation/avfoundation/avaudiosession/routesharingpolicy/default
+ * - `'longFormAudio'`: See
+ *   https://developer.apple.com/documentation/avfoundation/avaudiosession/routesharingpolicy/longformaudio
+ * - `'longFormVideo'`: See
+ *   https://developer.apple.com/documentation/avfoundation/avaudiosession/routesharingpolicy/longformvideo
+ */
+export type IOSCategoryPolicy = 'default' | 'longFormAudio' | 'longFormVideo';
+export interface AndroidAudioOffloadSettings {
+    /**
+     * Whether gapless playback support is required for offload.
+     * Enables smooth transitions between tracks without silence gaps.
+     * @default true
+     */
+    gaplessSupportRequired?: boolean;
+    /**
+     * Whether playback rate change support is required for offload.
+     * Enables variable playback speeds (0.5x, 1.25x, 2x, etc.) during offload.
+     * @default true
+     */
+    rateChangeSupportRequired?: boolean;
+}
+/**
+ * Configuration for retry behavior.
+ */
+export type RetryConfig = {
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    maxRetries: number;
+    /**
+     * Maximum duration in milliseconds to keep retrying before giving up.
+     * This prevents surprising playback resumption after long periods offline.
+     *
+     * @default 120000 (2 minutes)
+     */
+    maxRetryDurationMs?: number;
+};
+/**
+ * AndroidWakeMode options:
+ * - `'none'`: No wake locks are held. The device may go to sleep during playback.
+ * - `'local'`: Holds a PowerManager.WakeLock during playback to prevent CPU sleep.
+ *   Suitable for local media playback with the screen off.
+ * - `'network'`: Holds both PowerManager.WakeLock and WifiManager.WifiLock during playback.
+ *   Suitable for streaming media over WiFi with the screen off.
+ */
+export type AndroidPlayerWakeMode = 'none' | 'local' | 'network';
+/**
+ * Android-specific player setup options.
+ */
+export type PartialAndroidSetupPlayerOptions = {
+    /**
+     * Minimum duration of media that the player will attempt to buffer in ms.
+     *
+     * @throws Will throw if min buffer is higher than max buffer.
+     * @default 50000
+     */
+    minBuffer?: number;
+    /**
+     * Enable audio offload for power-efficient playback.
+     *
+     * When enabled, audio decoding is offloaded to dedicated hardware, reducing
+     * CPU usage and extending battery life during long playback sessions.
+     *
+     * - `true`: Enable with default settings (gapless + rate change support required)
+     * - `false`/`undefined`: Disabled
+     * - `{ gaplessSupportRequired: boolean, rateChangeSupportRequired: boolean }`:
+     *   Enable with specific requirements for gapless playback and playback rate changes
+     *
+     * @default false
+     */
+    audioOffload?: boolean | AndroidAudioOffloadSettings;
+    /**
+     * Maximum duration of media that the player will attempt to buffer in ms.
+     * Max buffer may not be lower than min buffer.
+     *
+     * @throws Will throw if max buffer is lower than min buffer.
+     * @default 50000
+     */
+    maxBuffer?: number;
+    /**
+     * Duration in ms that should be kept in the buffer behind the current
+     * playhead time.
+     *
+     * @default 0
+     */
+    backBuffer?: number;
+    /**
+     * Duration of media in ms that must be buffered for playback to start or
+     * resume following a user action such as a seek.
+     *
+     * @default 2500
+     */
+    playBuffer?: number;
+    /**
+     * Duration of media in ms that must be buffered for playback to resume
+     * after a rebuffer (when the buffer runs empty during playback).
+     *
+     * When null (the default), uses automatic mode:
+     * - Starts at `playBuffer` value
+     * - On rebuffer, measures how fast the buffer drained
+     * - Calculates how much buffer is needed to sustain 60s of playback
+     * - Increases threshold accordingly (up to 8000ms max)
+     * - Resets when changing tracks
+     *
+     * Set to a number for a fixed threshold in ms. Should be >= playBuffer,
+     * otherwise playback may rebuffer repeatedly (resuming with less buffer
+     * than initial start).
+     *
+     * @default null (automatic)
+     */
+    rebufferBuffer?: number | null;
+    /**
+     * Maximum cache size in MB.
+     *
+     * @default 0
+     */
+    maxCacheSize?: number;
+    /**
+     * The audio content type indicates to the android system how
+     * you intend to use audio in your app.
+     *
+     * With `audioContentType: AndroidAudioContentType.Speech`, the audio will be
+     * paused during short interruptions, such as when a message arrives.
+     * Otherwise the playback volume is reduced while the notification is playing.
+     *
+     * @default AndroidAudioContentType.Music
+     */
+    audioContentType?: AndroidAudioContentType;
+    /**
+     * Whether the player should automatically pause when audio becomes noisy
+     * (e.g., when headphones are unplugged).
+     *
+     * @default true
+     */
+    handleAudioBecomingNoisy?: boolean;
+    /**
+     * Wake mode for the player to use.
+     *
+     * Determines whether wake locks are held to keep the CPU and/or
+     * WiFi active during playback.
+     *
+     * @default 'none'
+     */
+    wakeMode?: AndroidPlayerWakeMode;
+};
+export interface AndroidSetupPlayerOptions {
+    /**
+     * Minimum duration of media that the player will attempt to buffer in ms.
+     *
+     * @throws Will throw if min buffer is higher than max buffer.
+     * @default 50000
+     */
+    minBuffer: number;
+    /**
+     * Audio offload configuration for power-efficient playback.
+     *
+     * - `true`: Enable with default settings (gapless and rate change support required)
+     * - `false`: Disable audio offload
+     * - `{ gaplessSupportRequired?, rateChangeSupportRequired? }`: Enable with custom requirements
+     *
+     * Audio offload moves audio processing to dedicated hardware when available, saving battery
+     * during longer playbacks, especially with screen off. Requirements determine which features
+     * must be supported for offload to activate:
+     * - `gaplessSupportRequired`: Smooth track transitions without silence
+     * - `rateChangeSupportRequired`: Variable playback speeds (0.5x, 1.25x, 2x, etc.)
+     *
+     * @see https://developer.android.com/media/media3/exoplayer/track-selection#audioOffload
+     */
+    audioOffload: boolean | AndroidAudioOffloadSettings;
+    /**
+     * Maximum duration of media that the player will attempt to buffer in ms.
+     * Max buffer may not be lower than min buffer.
+     *
+     * @throws Will throw if max buffer is lower than min buffer.
+     * @default 50000
+     */
+    maxBuffer: number;
+    /**
+     * Duration in ms that should be kept in the buffer behind the current
+     * playhead time.
+     *
+     * @default 0
+     */
+    backBuffer: number;
+    /**
+     * Duration of media in ms that must be buffered for playback to start or
+     * resume following a user action such as a seek.
+     *
+     * @default 2500
+     */
+    playBuffer: number;
+    /**
+     * Duration of media in ms that must be buffered for playback to resume
+     * after a rebuffer (when the buffer runs empty during playback).
+     *
+     * When null (the default), uses automatic mode:
+     * - Starts at `playBuffer` value
+     * - On rebuffer, measures how fast the buffer drained
+     * - Calculates how much buffer is needed to sustain 60s of playback
+     * - Increases threshold accordingly (up to 8000ms max)
+     * - Resets when changing tracks
+     *
+     * Set to a number for a fixed threshold in ms. Should be >= playBuffer,
+     * otherwise playback may rebuffer repeatedly (resuming with less buffer
+     * than initial start).
+     *
+     * @default null (automatic)
+     */
+    rebufferBuffer: number | null;
+    /**
+     * Maximum cache size in MB.
+     *
+     * @default 0
+     */
+    maxCacheSize: number;
+    /**
+     * The audio content type indicates to the android system how
+     * you intend to use audio in your app.
+     *
+     * With `audioContentType: AndroidAudioContentType.Speech`, the audio will be
+     * paused during short interruptions, such as when a message arrives.
+     * Otherwise the playback volume is reduced while the notification is playing.
+     *
+     * @default AndroidAudioContentType.Music
+     */
+    audioContentType: AndroidAudioContentType;
+    /**
+     * Whether the player should automatically pause when audio becomes noisy
+     * (e.g., when headphones are unplugged).
+     *
+     * @default true
+     */
+    handleAudioBecomingNoisy: boolean;
+    /**
+     * Wake mode for the player to use.
+     *
+     * Determines whether wake locks are held to keep the CPU and/or
+     * WiFi active during playback.
+     *
+     * @default 'none'
+     */
+    wakeMode: AndroidPlayerWakeMode;
+}
+export interface PartialIOSSetupPlayerOptions {
+    /**
+     * Preferred forward buffer duration in ms. When set to 0 (default), AVPlayer
+     * chooses an appropriate level of buffering automatically.
+     *
+     * Setting this to a value greater than 0 disables `automaticallyWaitsToMinimizeStalling`.
+     *
+     * [Read more from Apple Documentation](https://developer.apple.com/documentation/avfoundation/avplayeritem/1643630-preferredforwardbufferduration)
+     *
+     * @default 0
+     */
+    buffer?: number;
+    /**
+     * [AVAudioSession.Category](https://developer.apple.com/documentation/avfoundation/avaudiosession/1616615-category)
+     * for iOS. Sets on `play()`.
+     */
+    category?: IOSCategory;
+    /**
+     * The audio session mode, together with the audio session category,
+     * indicates to the system how you intend to use audio in your app. You can use
+     * a mode to configure the audio system for specific use cases such as video
+     * recording, voice or video chat, or audio analysis.
+     * Sets on `play()`.
+     *
+     * See https://developer.apple.com/documentation/avfoundation/avaudiosession/1616508-mode
+     */
+    categoryMode?: IOSCategoryMode;
+    /**
+     * [AVAudioSession.CategoryOptions](https://developer.apple.com/documentation/avfoundation/avaudiosession/1616503-categoryoptions) for iOS.
+     * Sets on `play()`.
+     */
+    categoryOptions?: IOSCategoryOptions[];
+    /**
+     * [AVAudioSession.RouteSharingPolicy](https://developer.apple.com/documentation/AVFAudio/AVAudioSession/RouteSharingPolicy-swift.enum) for iOS.
+     * Sets on `play()`.
+     */
+    categoryPolicy?: IOSCategoryPolicy;
+}
+export interface IOSSetupPlayerOptions {
+    /**
+     * Preferred forward buffer duration in ms. When set to 0 (default), AVPlayer
+     * chooses an appropriate level of buffering automatically.
+     *
+     * Setting this to a value greater than 0 disables `automaticallyWaitsToMinimizeStalling`.
+     *
+     * [Read more from Apple Documentation](https://developer.apple.com/documentation/avfoundation/avplayeritem/1643630-preferredforwardbufferduration)
+     *
+     * @default 0
+     */
+    buffer?: number;
+    /**
+     * [AVAudioSession.Category](https://developer.apple.com/documentation/avfoundation/avaudiosession/1616615-category)
+     * for iOS. Sets on `play()`.
+     */
+    category?: IOSCategory;
+    /**
+     * The audio session mode, together with the audio session category,
+     * indicates to the system how you intend to use audio in your app. You can use
+     * a mode to configure the audio system for specific use cases such as video
+     * recording, voice or video chat, or audio analysis.
+     * Sets on `play()`.
+     *
+     * See https://developer.apple.com/documentation/avfoundation/avaudiosession/1616508-mode
+     */
+    categoryMode?: IOSCategoryMode;
+    /**
+     * [AVAudioSession.CategoryOptions](https://developer.apple.com/documentation/avfoundation/avaudiosession/1616503-categoryoptions) for iOS.
+     * Sets on `play()`.
+     */
+    categoryOptions?: IOSCategoryOptions[];
+    /**
+     * [AVAudioSession.RouteSharingPolicy](https://developer.apple.com/documentation/AVFAudio/AVAudioSession/RouteSharingPolicy-swift.enum) for iOS.
+     * Sets on `play()`.
+     */
+    categoryPolicy?: IOSCategoryPolicy;
+}
+export interface PartialSetupPlayerOptions {
+    /** Android-specific configuration options for setup */
+    android?: PartialAndroidSetupPlayerOptions;
+    /** iOS-specific configuration options for setup */
+    ios?: PartialIOSSetupPlayerOptions;
+    /**
+     * Indicates whether the player should automatically update now playing metadata data in control center / notification.
+     * Defaults to `true`.
+     */
+    autoUpdateMetadata?: boolean;
+    /**
+     * Retry policy for load errors (network failures, timeouts, etc.)
+     * - `true`: Retry indefinitely with exponential backoff (2 minute timeout)
+     * - `false`/`undefined`: No automatic retry (default)
+     * - `{ maxRetries: n }`: Retry up to n times with exponential backoff
+     * - `{ maxRetries: n, maxRetryDurationMs: m }`: Retry with custom timeout
+     *
+     * Exponential backoff delays: 1s → 1.5s → 2.3s → 3.4s → 5s (capped)
+     *
+     * @default false
+     */
+    retry?: boolean | RetryConfig;
+}
+export interface PlayerOptions {
+    /** Android-specific configuration options for setup */
+    android?: AndroidSetupPlayerOptions;
+    /** iOS-specific configuration options for setup */
+    ios?: PartialIOSSetupPlayerOptions;
+    /**
+     * Indicates whether the player should automatically update now playing metadata data in control center / notification.
+     * Defaults to `true`.
+     */
+    autoUpdateMetadata: boolean;
+    /**
+     * Retry policy for load errors (network failures, timeouts, etc.)
+     * - `true`: Retry indefinitely with exponential backoff (2 minute timeout)
+     * - `false`/`undefined`: No automatic retry (default)
+     * - `{ maxRetries: n }`: Retry up to n times with exponential backoff
+     * - `{ maxRetries: n, maxRetryDurationMs: m }`: Retry with custom timeout
+     *
+     * Exponential backoff delays: 1s → 1.5s → 2.3s → 3.4s → 5s (capped)
+     *
+     * @default false
+     */
+    retry?: boolean | RetryConfig;
+}
+/**
+ * Initializes the player with the specified options.
+ * @param options - The options to initialize the player with.
+ */
+export declare function setupPlayer(options?: PartialSetupPlayerOptions): Promise<void>;
+//# sourceMappingURL=setup.d.ts.map

package/lib/typescript/src/features/player/setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../../../../src/features/player/setup.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,uBAAuB,GAC/B,OAAO,GACP,QAAQ,GACR,cAAc,GACd,OAAO,GACP,SAAS,CAAA;AAEb;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,WAAW,GACnB,UAAU,GACV,eAAe,GACf,YAAY,GACZ,SAAS,GACT,aAAa,GACb,QAAQ,CAAA;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,UAAU,GACV,aAAa,GACb,eAAe,GACf,aAAa,GACb,WAAW,GACX,gBAAgB,GAChB,WAAW,GACX,aAAa,CAAA;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,YAAY,GACZ,sCAAsC,GACtC,gBAAgB,GAChB,oBAAoB,GACpB,cAAc,GACd,kBAAkB,CAAA;AAEtB;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,eAAe,GAAG,eAAe,CAAA;AAE7E,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAEhE;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAEpD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,CAAA;IAE1C;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAElC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,qBAAqB,CAAA;CACjC,CAAA;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;OAcG;IACH,YAAY,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAEnD;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;OASG;IACH,gBAAgB,EAAE,uBAAuB,CAAA;IAEzC;;;;;OAKG;IACH,wBAAwB,EAAE,OAAO,CAAA;IAEjC;;;;;;;OAOG;IACH,QAAQ,EAAE,qBAAqB,CAAA;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;IAEtB;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;IAEtB;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC,uDAAuD;IACvD,OAAO,CAAC,EAAE,gCAAgC,CAAA;IAC1C,mDAAmD;IACnD,GAAG,CAAC,EAAE,4BAA4B,CAAA;IAClC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,OAAO,CAAC,EAAE,yBAAyB,CAAA;IACnC,mDAAmD;IACnD,GAAG,CAAC,EAAE,4BAA4B,CAAA;IAClC;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAA;IAE3B;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;CAC9B;AAID;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/lib/typescript/src/features/queue/activeTrack.d.ts

@@ -0,0 +1,38 @@
+import type { Track } from '../../types';
+import { NativeUpdatedValue } from '../../utils/NativeUpdatedValue';
+/**
+ * Event data for when the active track changes.
+ */
+export interface PlaybackActiveTrackChangedEvent {
+    /** The index of previously active track. */
+    lastIndex?: number;
+    /** The previously active track or undefined when there wasn't a previously active track. */
+    lastTrack?: Track;
+    /** The position of the previously active track in seconds. */
+    lastPosition: number;
+    /** The newly active track index or undefined if there is no longer an active track. */
+    index?: number;
+    /** The newly active track or undefined if there is no longer an active track. */
+    track?: Track;
+}
+/**
+ * Gets the active track or undefined if there is no current track.
+ */
+export declare function getActiveTrack(): Track | undefined;
+/**
+ * Gets the index of the active track in the queue or undefined if there is no
+ * current track.
+ */
+export declare function getActiveTrackIndex(): number | undefined;
+/**
+ * Subscribes to active track change events.
+ * @param callback - Called when the active track changes
+ * @returns Cleanup function to unsubscribe
+ */
+export declare const onActiveTrackChanged: NativeUpdatedValue<PlaybackActiveTrackChangedEvent>;
+/**
+ * Hook that returns the current active track and updates when it changes.
+ * @returns The current active track or undefined
+ */
+export declare function useActiveTrack(): Track | undefined;
+//# sourceMappingURL=activeTrack.d.ts.map

package/lib/typescript/src/features/queue/activeTrack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeTrack.d.ts","sourceRoot":"","sources":["../../../../../src/features/queue/activeTrack.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAGnE;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,KAAK,CAAA;IACjB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iFAAiF;IACjF,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAID;;GAEG;AACH,wBAAgB,cAAc,IAAI,KAAK,GAAG,SAAS,CAElD;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAExD;AAID;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,qDAG9B,CAAA;AAIH;;;GAGG;AACH,wBAAgB,cAAc,IAAI,KAAK,GAAG,SAAS,CAElD"}

package/lib/typescript/src/features/queue/index.d.ts

@@ -0,0 +1,5 @@
+export * from './queue';
+export * from './activeTrack';
+export * from './repeatMode';
+export * from './shuffle';
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/features/queue/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/queue/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA"}

package/lib/typescript/src/features/queue/queue.d.ts

@@ -0,0 +1,111 @@
+import type { Track } from '../../types';
+import { NativeUpdatedValue } from '../../utils/NativeUpdatedValue';
+/**
+ * Event data for when the playback queue has ended.
+ */
+export interface PlaybackQueueEndedEvent {
+    /** The index of the active track when the playback queue ended. */
+    track: number;
+    /** The playback position in seconds of the active track when the playback queue ended. */
+    position: number;
+}
+/**
+ * Adds one or more tracks to the queue.
+ * @param tracks - The tracks to add to the queue.
+ * @param insertBeforeIndex - (Optional) The index to insert the tracks before.
+ * By default the tracks will be added to the end of the queue.
+ */
+export declare function add(tracks: Track[], insertBeforeIndex?: number): void;
+/**
+ * Adds a track to the queue.
+ * @param track - The track to add to the queue.
+ * @param insertBeforeIndex - (Optional) The index to insert the track before.
+ * By default the track will be added to the end of the queue.
+ */
+export declare function add(track: Track, insertBeforeIndex?: number): void;
+/**
+ * Replaces the current track or loads the track as the first in the queue.
+ * @param track - The track to load.
+ */
+export declare function load(track: Track): void;
+/**
+ * Move a track within the queue.
+ * @param fromIndex - The index of the track to be moved.
+ * @param toIndex - The index to move the track to. If the index is larger than
+ * the size of the queue, then the track is moved to the end of the queue.
+ */
+export declare function move(fromIndex: number, toIndex: number): void;
+/**
+ * Removes multiple tracks from the queue by their indexes.
+ *
+ * If the current track is removed, the next track will activated. If the
+ * current track was the last track in the queue, the first track will be
+ * activated.
+ *
+ * @param indexes - The indexes of the tracks to be removed.
+ */
+export declare function remove(indexes: number[]): void;
+/**
+ * Removes a track from the queue by its index.
+ *
+ * If the current track is removed, the next track will activated. If the
+ * current track was the last track in the queue, the first track will be
+ * activated.
+ *
+ * @param index - The index of the track to be removed.
+ */
+export declare function remove(index: number): void;
+/**
+ * Clears any upcoming tracks from the queue.
+ */
+export declare function removeUpcomingTracks(): void;
+/**
+ * Skips to a track in the queue.
+ * @param index - The index of the track to skip to.
+ * @param initialPosition - (Optional) The initial position to seek to in seconds.
+ */
+export declare function skip(index: number, initialPosition?: number): void;
+/**
+ * Skips to the next track in the queue.
+ * @param initialPosition - (Optional) The initial position to seek to in seconds.
+ */
+export declare function skipToNext(initialPosition?: number): void;
+/**
+ * Skips to the previous track in the queue.
+ * @param initialPosition - (Optional) The initial position to seek to in seconds.
+ */
+export declare function skipToPrevious(initialPosition?: number): void;
+/**
+ * Sets the queue.
+ * @param tracks - The tracks to set as the queue.
+ */
+export declare function setQueue(tracks: Track[]): void;
+/**
+ * Gets a track object from the queue.
+ * @param index - The index of the track.
+ * @returns The track object or undefined if there isn't a track object at that index.
+ */
+export declare function getTrack(index: number): Track | undefined;
+/**
+ * Gets the whole queue.
+ */
+export declare function getQueue(): Track[];
+/**
+ * Subscribes to playback queue ended events.
+ * @param callback - Called when playback has paused due to reaching the end of the queue
+ * @returns Cleanup function to unsubscribe
+ */
+export declare const onQueueEnded: NativeUpdatedValue<PlaybackQueueEndedEvent>;
+/**
+ * Subscribes to queue change events.
+ * Called when tracks are added, removed, reordered, or when track metadata changes.
+ * @param callback - Called with the updated queue
+ * @returns Cleanup function to unsubscribe
+ */
+export declare const onQueueChanged: NativeUpdatedValue<Track[]>;
+/**
+ * Hook that returns the current queue and updates when it changes.
+ * @returns The current queue
+ */
+export declare function useQueue(): Track[];
+//# sourceMappingURL=queue.d.ts.map

package/lib/typescript/src/features/queue/queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../../../../src/features/queue/queue.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAKnE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAA;IACb,0FAA0F;IAC1F,QAAQ,EAAE,MAAM,CAAA;CACjB;AAID;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;AACtE;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;AAQnE;;;GAGG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAEvC;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAE7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;AAC/C;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;AAO3C;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAElE;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAE7D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAE9C;AAID;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAEzD;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,KAAK,EAAE,CAElC;AAID;;;;GAIG;AACH,eAAO,MAAM,YAAY,6CAGtB,CAAA;AAEH;;;;;GAKG;AACH,eAAO,MAAM,cAAc,6BAE1B,CAAA;AAID;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,KAAK,EAAE,CAElC"}