MetadataOptions
All parameters are optional. You also only need to specify the ones you want to update.
Param | Type | Description | Android | iOS | Windows |
---|---|---|---|---|---|
ratingType | RatingType | The rating type | β | β | β |
forwardJumpInterval | number | The interval in seconds for the jump forward buttons (if only one is given then we use that value for both) | β | β | β |
backwardJumpInterval | number | The interval in seconds for the jump backward buttons (if only one is given then we use that value for both) | β | β | β |
android | AndroidOptions | Whether the player will pause playback when the app closes | β | β | β |
alwaysPauseOnInterruption | boolean | Whether the remote-duck event will be triggered on every interruption | β | β | β |
likeOptions | FeedbackOptions | The media controls that will be enabled | β | β | β |
dislikeOptions | FeedbackOptions | The media controls that will be enabled | β | β | β |
bookmarkOptions | FeedbackOptions | The media controls that will be enabled | β | β | β |
capabilities | Capability[] | The media controls that will be enabled | β | β | β |
notificationCapabilities | Capability[] | The buttons that it will show in the notification. Defaults to data.capabilities | β | β | β |
compactCapabilities | Capability[] | The buttons that it will show in the compact notification | β | β | β |
icon | Resource Object | The notification iconΒΉ | β | β | β |
playIcon | Resource Object | The play iconΒΉ | β | β | β |
pauseIcon | Resource Object | The pause iconΒΉ | β | β | β |
stopIcon | Resource Object | The stop iconΒΉ | β | β | β |
previousIcon | Resource Object | The previous iconΒΉ | β | β | β |
nextIcon | Resource Object | The next iconΒΉ | β | β | β |
rewindIcon | Resource Object | The jump backward iconΒΉ | β | β | β |
forwardIcon | Resource Object | The jump forward iconΒΉ | β | β | β |
color | number | The notification color in an ARGB hex | β | β | β |
progressUpdateEventInterval | number | The interval (in seconds) that the Event.PlaybackProgressUpdated will be fired. undefined by default. | β | β | β |
ΒΉ - The custom icons will only work in release builds