### Standard Method Run `$ react-native link react-native-media-suite` to link the react-native-media-suite library. You only need to do this once, it will link both Android and iOS ### Manually 1. Right click on **Libraries** and choose 'Add files to "Project Name"'. 2. Navigate to `project_name/node_modules/react-native-media-suite/ios/` and add the file `react-native-media-suite.xcodeproj`. 3. Open project settings and at the top choose '**Build Phases**' 4. Expand the '**Link Binary With Libraries**' section. 5. Click the + at the bottom of the list 6. Add the `libreact-native-media-suite.a` file
### Standard Method Run `$ react-native link react-native-media-suite` to link the react-native-media-suite library. You only need to do this once, it will link both Android and iOS. ### Manually ##### `android/settings.gradle` ``` include ':react-native-media-suite' project(':react-native-media-suite').projectDir = new File('../node_modules/react-native-media-suite/android') ``` ##### `android/app/build.gradle` ``` dependencies { ... compile project(':react-native-media-suite') } ``` ##### `android/app/src/main/java/.../MainApplication.java` (or `MainActivity.java` on RN <= 0.29) ``` import za.co.digitalwaterfall.reactnativemediasuite.MediaSuitePackage; ... protected List getPackages() { return Arrays.asList( new MainReactPackage(), new MediaKitPackage() ); } ```
`play()` Resumes playback. Example: ``` this.videoRef.play(); ``` Platforms: **All**
`pause()` Pauses playback. Example: ``` this.videoRef.pause(); ``` Platforms: **All**
`seekTo(milliseconds)` Seek to the specified position represented by milliseconds, milliseconds is a integer value. Example: ``` this.videoRef.seekTo(33300); //Seek to 33.3 seconds ``` Platforms: **All**
`presentFullscreenPlayer()` Puts the player into fullscreen mode. On Android, this puts the navigation controls in fullscreen mode. Note this does not put the video into fullscreen, will still need to apply a style that makes the width and height match your screen dimensions to get a fullscreen video. Example: ``` this.videoRef.presentFullscreenPlayer(); ``` Platforms: **Android**
`dismissFullscreenPlayer()` Takes the player out of fullscreen mode. Example: ``` this.videoRef.dismissFullscreenPlayer(); ``` Platforms: **Android**
``` restoreMediaDownloader() ``` Restores the downloader. Should be called when app starts. Returns a `Promise` object, if the promise resolves it will return all the downloaded contents IDs. Platforms: **All** ---
``` setMaxSimultaneousDownloads(maxSimultaneousDownloads: integer) ``` Sets the maximum number of downloads that can download concurrently. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | maxSimultaneousDownloads | integer | Yes | The maximum simultaneous downloads. | **Platforms:** iOS (Android is fixed at 2). ---
``` createNewDownload(url: string, downloadID: string, title: string, assetArtworkURL: string, bitRate: number) ``` Creates a new download. Returns a `Promise` object, if the promise resolves it will return a new `Download` object. _Please note: You need to still start the download using the `start()` method of the `Download` object._ | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | url | string | Yes | The url of the HLS or Dash manifest file to be played. | | downloadID | string | Yes | The ID to be assigned to the download. | | title | string | Yes | The title of the asset being downloaded. | | assetArtworkURL | string | Yes | The url of the artwork to save. May be null. | | bitRate | string | No | The bitrate of the asset to download. | **Platforms:** All ---
``` addUpdateListener(listener: ?(() => \[Download\]), options: Object) ``` Adds an update listener for a particular download or list of downloads. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | downloadID | listener: ?(() => \[Download\]) | Yes | The callback called when the download or any of the downlods in the array are updated. | | options | Object | Yes | Options that can be passed when adding an update listener. The options that can be given are `downloadIDs: string[]` and `updateImmediately: boolean`. `downloadIDs` is an array of the downloads which should be listened to. `updateImmediately` calls the listener directly after it has been added. **Platforms:** All ---
``` removeUpdateListener(listener: ?(() => \[Download\])) ``` Removes an update listener. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | downloadID | listener: ?(() => \[Download\]) | Yes | The callback function that should be removed. (The same callback function that was added using addUpdateListener)). | **Platforms:** All ---
``` getDownload(downloadIDs: string[], returnWithLabels: boolean) ``` Retrieves all the `download` objects with the given IDs. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | downloadIDs | string[] | Yes | The download IDs of the `download` objects to be retrieved. | | returnWithLabels | boolean | No | Boolean indicating whether the downloads returned should be labeled with their download IDs. | **Platforms:** All ---
``` isDownloaded(downloadID: string) ``` Retrieves all the `download` objects with the given IDs. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | downloadID | string | Yes | The download ID of the download to be checked. | **Platforms:** All ---
``` start(retry: boolean) ``` Starts the download. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | retry | boolean | No | Retry the download (it already exists but has failed). | **Platforms:** All ---
``` pause() ``` Pauses the download. **Platforms:** All ---
``` resume() ``` Resumes the download. **Platforms:** All ---
``` cancel() ``` Cancels the download. **Platforms:** All ---
``` delete() ``` Deletes the download. **Platforms:** All ---
``` retry() ``` Retries the download. **Platforms:** All ---
``` isDestroyed() ``` Checks if the download has been deleted. **Platforms:** All ---
``` addEventListener(type: EVENT_LISTENER_TYPE, listener: ?(() => data)) ``` Adds event listener to be called when a specific event occurs on the download. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | type | EVENT_LISTENER_TYPE | Yes | The type of event to listen for. | | listener | () => data | Yes | The callback function that will be called when the specific event for the download occurs. | **Platforms:** All ---
``` removeEventListener(listener: ?(() => data)) ``` Removes the event listener. | Name | Type | Required | Description | |--------------------------|---------|----------|------------------------------------------------| | listener | () => data | Yes | The callback function that should be removed. | **Platforms:** All ---