Skip to main content
Version: 4.0

Platform Support

Audio Sources​

FeatureAndroidiOSWindows
App bundleΒΉβœ…βœ…βœ…
Networkβœ…βœ…βœ…
File SystemΒ²βœ…βœ…βœ…

ΒΉ: Use require or import

Β²: Prefix the file path with file:///

Stream Types​

FeatureAndroidiOSWindows
Regular Streamsβœ…βœ…βœ…
DASHβœ…βŒβœ…
HLSβœ…βœ…βœ…
SmoothStreamingβœ…βŒβŒ

Casting​

FeatureAndroidiOSWindows
Google CastΒΉβœ…βŒβŒ
Miracast/DLNA❌❌❌
AirPlay❌❌❌

ΒΉ: Google Cast support has been moved to react-native-track-casting (WIP) which can be used in combination with react-native-track-player.

Miscellaneous​

FeatureAndroidiOSWindows
Media Controlsβœ…βœ…βœ…
Cachingβœ…βŒβŒ
Background ModeΒΉβœ…βœ…βœ…

ΒΉ: Read more in Background Mode

Functions​

FunctionAndroidiOSWindows
setupPlayerβœ…βœ…βœ…
updateOptionsβœ…βœ…βœ…
registerPlaybackServiceβœ…βœ…βœ…
addEventListenerβœ…βœ…βœ…
playβœ…βœ…βœ…
pauseβœ…βœ…βœ…
resetβœ…βœ…βœ…
setVolumeβœ…βœ…βœ…
getVolumeβœ…βœ…βœ…
setRateβœ…βœ…βœ…
getRateβœ…βœ…βœ…
seekToβœ…βœ…βœ…
getPositionβœ…βœ…βœ…
getBufferedPositionβœ…βœ…βœ…
getDurationβœ…βœ…βœ…
getStateβœ…βœ…βœ…
getQueueβœ…βœ…βœ…
getCurrentTrackβœ…βœ…βœ…
getTrackβœ…βœ…βœ…
addβœ…βœ…βœ…
removeβœ…βœ…βœ…
skipβœ…βœ…βœ…
skipToPreviousβœ…βœ…βœ…
skipToNextβœ…βœ…βœ…
removeUpcomingTracksβœ…βœ…βœ…

Events​

EventAndroidiOSWindows
remote-playβœ…βœ…βœ…
remote-play-idβœ…βŒβŒ
remote-play-searchβœ…βŒβŒ
remote-pauseβœ…βœ…βœ…
remote-stopβœ…βœ…βœ…
remote-skipβœ…βŒβŒ
remote-nextβœ…βœ…βœ…
remote-previousβœ…βœ…βœ…
remote-seekβœ…βœ…βœ…
remote-set-ratingβœ…βŒβŒ
remote-jump-forwardβœ…βœ…βœ…
remote-jump-backwardβœ…βœ…βœ…
remote-duckβœ…βœ…βŒ
playback-stateβœ…βœ…βœ…
playback-track-changedβœ…βœ…βœ…
playback-queue-endedβœ…βœ…βœ…
playback-errorβœ…βœ…βœ…
playback-metadata-receivedβœ…βœ…βŒ