Skip to main content
Version: 3.2

PlayerOptions

All parameters are optional. You also only need to specify the ones you want to update.

ParamTypeDescriptionAndroidiOS
minBuffernumberMinimum time in seconds that needs to be buffered.✅✅
maxBuffernumberMaximum time in seconds that needs to be buffered.✅✅
backBuffernumberTime in seconds that should be kept in the buffer behind the current playhead time.✅✅
playBuffernumberMinimum time in seconds that needs to be buffered to start playing.✅✅
maxCacheSizenumberMaximum cache size in kilobytes.✅✅
iosCategoryIOSCategoryAn IOSCategory. Sets on play().❌✅
iosCategoryModeIOSCategoryModeThe 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().❌✅
iosCategoryOptionsIOSCategoryOptions[]An array of IOSCategoryOptions. Sets on play().❌✅
waitForBufferbooleanIndicates whether the player should automatically delay playback in order to minimize stalling. Defaults to true. @deprecated This option has been nominated for removal in a future version of RNTP. If you have this set to true, you can safely remove this from the options. If you are setting this to false and have a reason for that, please post a comment in the following discussion: https://github.com/doublesymmetry/react-native-track-player/pull/1695 and describe why you are doing so.✅✅
autoUpdateMetadatabooleanIndicates whether the player should automatically update now playing metadata data in control center / notification. Defaults to true.✅✅