From 0e0238e0ed4818d4679bfc48ad0f085a954f7239 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Tue, 6 Dec 2022 18:00:28 +0000 Subject: [PATCH] Document the `onError` prop --- API.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index cb781e2c..f3c6a129 100644 --- a/API.md +++ b/API.md @@ -321,6 +321,7 @@ var styles = StyleSheet.create({ |[onBandwidthUpdate](#onbandwidthupdate)|Android| |[onBuffer](#onbuffer)|Android, iOS| |[onEnd](#onend)|All| +|[onError](#onerror)|Android, iOS| |[onExternalPlaybackChange](#onexternalplaybackchange)|iOS| |[onFullscreenPlayerWillPresent](#onfullscreenplayerwillpresent)|Android, iOS| |[onFullscreenPlayerDidPresent](#onfullscreenplayerdidpresent)|Android, iOS| @@ -1014,6 +1015,17 @@ Payload: none Platforms: all +#### onError +Callback function that is called when the player experiences a playback error. + +Payload: + +Property | Type | Description +--- | --- | --- +error | object | Object containing properties with information about the error + +Platforms: all + #### onExternalPlaybackChange Callback function that is called when external playback mode for current playing video has changed. Mostly useful when connecting/disconnecting to Apple TV – it's called on connection/disconnection. @@ -1618,4 +1630,4 @@ allprojects { } ``` If you encounter an error `Could not find com.android.support:support-annotations:27.0.0.` reinstall your Android Support Repository. - \ No newline at end of file +