@javascriptcommon/react-native-track-player 1.2.9

package/index.d.ts

@@ -0,0 +1,174 @@
+import { Component } from 'react';
+
+export = RNTrackPlayer;
+
+declare namespace RNTrackPlayer {
+
+  export type EventType =
+    | "playback-state"
+    | "playback-error"
+    | "playback-queue-ended"
+    | "playback-track-changed"
+    | "remote-play"
+    | "remote-play-id"
+    | "remote-play-search"
+    | "remote-pause"
+    | "remote-stop"
+    | "remote-skip"
+    | "remote-next"
+    | "remote-previous"
+    | "remote-jump-forward"
+    | "remote-jump-backward"
+    | "remote-seek"
+    | "remote-set-rating"
+    | "remote-duck"
+    | "remote-like"
+    | "remote-dislike"
+    | "remote-bookmark"
+    | "remote-play-pause";
+
+  export type TrackType =
+    | "default"
+    | "dash"
+    | "hls"
+    | "smoothstreaming";
+
+  type ResourceObject = any;
+
+  type State = string | number;
+  type RatingType = string | number;
+  type Capability = string | number;
+
+  type EventHandler = (type: EventType, ...args: any[]) => void;
+  export function registerEventHandler(handler: EventHandler): void;
+
+  type ServiceHandler = () => Promise<void>;
+  export function registerPlaybackService(serviceFactory: () => ServiceHandler): void;
+
+  type EmitterSubscription = { remove: () => void; };
+  export function addEventListener(type: EventType, listener: (data: any) => void): EmitterSubscription;
+
+  export interface TrackMetadata {
+    duration?: number;
+    title: string;
+    artist: string;
+    album?: string;
+    description?: string;
+    genre?: string;
+    date?: string;
+    rating?: number | boolean;
+    artwork?: string | ResourceObject;
+  }
+
+  export interface Track extends TrackMetadata {
+    type?: TrackType;
+    userAgent?: string;
+    contentType?: string;
+    [key: string]: any;
+  }
+
+  export interface PlayerOptions {
+    minBuffer?: number;
+    maxBuffer?: number;
+    playBuffer?: number;
+    maxCacheSize?: number;
+    iosCategory?: 'playback' | 'playAndRecord' | 'multiRoute' | 'ambient' | 'soloAmbient' | 'record';
+    iosCategoryMode?: 'default' | 'gameChat' | 'measurement' | 'moviePlayback' | 'spokenAudio' | 'videoChat' | 'videoRecording' | 'voiceChat' | 'voicePrompt';
+    iosCategoryOptions?: Array<'mixWithOthers' | 'duckOthers' | 'interruptSpokenAudioAndMixWithOthers' | 'allowBluetooth' | 'allowBluetoothA2DP' | 'allowAirPlay' | 'defaultToSpeaker'>;
+    waitForBuffer?: boolean;
+  }
+
+  interface FeedbackOptions {
+    /** Marks wether the option should be marked as active or "done" */
+    isActive: boolean
+
+    /** The title to give the action (relevant for iOS) */
+    title: string
+  }
+
+  export interface MetadataOptions {
+    ratingType?: RatingType;
+    jumpInterval?: number;
+    likeOptions?: FeedbackOptions;
+    dislikeOptions?: FeedbackOptions;
+    bookmarkOptions?: FeedbackOptions;
+    stopWithApp?: boolean;
+    alwaysPauseOnInterruption?: boolean;
+    hideArtworkLockScreenBackground?: boolean;
+
+    capabilities?: Capability[];
+    notificationCapabilities?: Capability[];
+    compactCapabilities?: Capability[];
+
+    icon?: ResourceObject;
+    playIcon?: ResourceObject;
+    pauseIcon?: ResourceObject;
+    stopIcon?: ResourceObject;
+    previousIcon?: ResourceObject;
+    nextIcon?: ResourceObject;
+    rewindIcon?: ResourceObject;
+    forwardIcon?: ResourceObject;
+    color?: number;
+
+    placeholderImage?: ResourceObject;
+  }
+
+  // General
+
+  export function setupPlayer(options?: PlayerOptions): Promise<void>;
+
+  // Player Queue Commands
+
+  export function setNowPlaying(track: Track): Promise<void>;
+  export function updatePlayback(data: any): Promise<void>;
+  export function reset(): Promise<void>;
+
+  // Control Center / Notification Metadata Commands
+  export function updateOptions(options: MetadataOptions): Promise<void>;
+  export function updateMetadataForTrack(id: string, metadata: TrackMetadata) : Promise<void>;
+  // Components
+
+  export interface ProgressComponentState {
+    position: number;
+    bufferedPosition: number;
+    duration: number;
+  }
+
+  export class ProgressComponent<P = {}, S = {}> extends Component<P, ProgressComponentState & S> {
+    public getProgress: () => number;
+    public getBufferedProgress: () => number;
+  }
+
+  // Constants
+
+  export const STATE_NONE: State;
+  export const STATE_PLAYING: State;
+  export const STATE_PAUSED: State;
+  export const STATE_STOPPED: State;
+  export const STATE_BUFFERING: State;
+  export const STATE_READY: State;
+
+  export const RATING_HEART: RatingType;
+  export const RATING_THUMBS_UP_DOWN: RatingType;
+  export const RATING_3_STARS: RatingType;
+  export const RATING_4_STARS: RatingType;
+  export const RATING_5_STARS: RatingType;
+  export const RATING_PERCENTAGE: RatingType;
+
+  export const CAPABILITY_PLAY: Capability;
+  export const CAPABILITY_PLAY_FROM_ID: Capability;
+  export const CAPABILITY_PLAY_FROM_SEARCH: Capability;
+  export const CAPABILITY_PAUSE: Capability;
+  export const CAPABILITY_STOP: Capability;
+  export const CAPABILITY_SEEK_TO: Capability;
+  export const CAPABILITY_SKIP: Capability;
+  export const CAPABILITY_SKIP_TO_NEXT: Capability;
+  export const CAPABILITY_SKIP_TO_PREVIOUS: Capability;
+  export const CAPABILITY_SET_RATING: Capability;
+  export const CAPABILITY_JUMP_FORWARD: Capability;
+  export const CAPABILITY_JUMP_BACKWARD: Capability;
+  export const CAPABILITY_LIKE: Capability;
+  export const CAPABILITY_DISLIKE: Capability;
+  export const CAPABILITY_BOOKMARK: Capability;
+
+}

package/index.js

@@ -0,0 +1,4 @@
+// For documentation, check our wiki
+// https://github.com/react-native-kit/react-native-track-player/wiki
+
+module.exports = require('./lib/index.js');

package/ios/RNTrackPlayer/Models/Capabilities.swift

@@ -0,0 +1,17 @@
+//
+//  Capabilities.swift
+//  RNTrackPlayer
+//
+//  Created by David Chavez on 07.09.17.
+//  Copyright © 2017 David Chavez. All rights reserved.
+//
+
+import Foundation
+
+enum Capability: String {
+    case play, pause, stop, next, previous, jumpForward, jumpBackward, seek, like, dislike, bookmark
+}
+
+enum PlayState: String {
+    case none, playing, paused, stopped
+}

package/ios/RNTrackPlayer/Models/MediaURL.swift

@@ -0,0 +1,32 @@
+//
+//  MediaURL.swift
+//  RNTrackPlayer
+//
+//  Created by David Chavez on 12.08.17.
+//  Copyright © 2017 David Chavez. All rights reserved.
+//
+
+import Foundation
+import React
+
+struct MediaURL {
+    let value: URL
+    let isLocal: Bool
+    private let originalObject: Any
+    
+    init?(object: Any?) {
+        guard let object = object else { return nil }
+        originalObject = object
+        
+        if let localObject = object as? [String: Any] {
+            let uri = localObject["uri"] as! String
+            isLocal = uri.lowercased().contains("http") ? false : true
+            let encodedURI = uri.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!
+            value = RCTConvert.nsurl(encodedURI.replacingOccurrences(of: "file://", with: ""))
+        } else {
+            let url = object as! String
+            isLocal = url.lowercased().contains("http") ? false : true
+            value = RCTConvert.nsurl(url.replacingOccurrences(of: "file://", with: ""))
+        }
+    }
+}

package/ios/RNTrackPlayer/Models/Track.swift

@@ -0,0 +1,120 @@
+//
+//  Track.swift
+//  RNTrackPlayer
+//
+//  Created by David Chavez on 12.08.17.
+//  Copyright © 2017 David Chavez. All rights reserved.
+//
+
+import Foundation
+import MediaPlayer
+import AVFoundation
+
+class Track: NSObject {
+    let id: String
+    
+    @objc var title: String
+    @objc var artist: String
+    
+    var date: String?
+    var desc: String?
+    var genre: String?
+    var duration: Double?
+    var skipped: Bool = false
+    var artworkURL: MediaURL?
+    let headers: [String: Any]?
+    let pitchAlgorithm: String?
+    
+    @objc var album: String?
+    @objc var artwork: MPMediaItemArtwork?
+    
+    private var originalObject: [String: Any]
+    
+    init?(dictionary: [String: Any]) {
+        
+        let id = dictionary["id"] as? String
+        let title = dictionary["title"] as? String
+        let artist = dictionary["artist"] as? String
+        
+        self.id = id ?? "eSound"
+        self.title = title ?? "eSound"
+        self.artist = artist ?? "eSound"
+        
+        self.date = dictionary["date"] as? String
+        self.album = dictionary["album"] as? String
+        self.genre = dictionary["genre"] as? String
+        self.desc = dictionary["description"] as? String
+        self.duration = dictionary["duration"] as? Double
+        self.headers = dictionary["headers"] as? [String: Any]
+        self.artworkURL = MediaURL(object: dictionary["artwork"])
+        self.pitchAlgorithm = dictionary["pitchAlgorithm"] as? String
+        
+        self.originalObject = dictionary
+    }
+    
+    
+    // MARK: - Public Interface
+    
+    func toObject() -> [String: Any] {
+        return originalObject
+    }
+    
+    func updateMetadata(dictionary: [String: Any]) {
+        self.title = (dictionary["title"] as? String) ?? self.title
+        self.artist = (dictionary["artist"] as? String) ?? self.artist
+        
+        self.date = dictionary["date"] as? String
+        self.album = dictionary["album"] as? String
+        self.genre = dictionary["genre"] as? String
+        self.desc = dictionary["description"] as? String
+        self.duration = dictionary["duration"] as? Double
+        self.artworkURL = MediaURL(object: dictionary["artwork"])
+        
+        self.originalObject = self.originalObject.merging(dictionary) { (_, new) in new }
+    }
+    
+    // MARK: - AudioItem Protocol
+    
+    func getArtist() -> String? {
+        return artist
+    }
+    
+    func getTitle() -> String? {
+        return title
+    }
+    
+    func getAlbumTitle() -> String? {
+        return album
+    }
+
+    
+    func getArtwork(_ handler: @escaping (UIImage?) -> Void) {
+       if let artworkURL = artworkURL?.value {
+            if(self.artworkURL?.isLocal ?? false){
+              let image = UIImage.init(contentsOfFile: artworkURL.path);
+              handler(image);
+            } else {
+                URLSession.shared.dataTask(with: artworkURL, completionHandler: { (data, _, error) in
+                    if let data = data, let artwork = UIImage(data: data), error == nil {
+                        handler(artwork)
+                    }
+
+                    handler(nil)
+                }).resume()
+            }
+        }
+        
+        handler(nil)
+    }
+    
+    // MARK: - Authorizing Protocol
+    
+    func getAssetOptions() -> [String: Any] {
+        if let headers = headers {
+            return ["AVURLAssetHTTPHeaderFieldsKey": headers]
+        }
+        
+        return [:]
+    }
+    
+}