Document the onError prop

This commit is contained in:
John Blackbourn 2022-12-06 18:00:28 +00:00 committed by GitHub
parent 394c43165a
commit 0e0238e0ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

12
API.md
View File

@ -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.