Document onTimedMetadata

This commit is contained in:
Hampton Maxwell 2018-06-25 12:00:34 -07:00
parent 0853bbd65a
commit 4d2c39ea6e

View File

@ -196,7 +196,6 @@ using System.Collections.Generic;
onFullscreenPlayerWillDismiss={this.fullScreenPlayerWillDismiss} // Callback before fullscreen stops onFullscreenPlayerWillDismiss={this.fullScreenPlayerWillDismiss} // Callback before fullscreen stops
onFullscreenPlayerDidDismiss={this.fullScreenPlayerDidDismiss} // Callback after fullscreen stopped onFullscreenPlayerDidDismiss={this.fullScreenPlayerDidDismiss} // Callback after fullscreen stopped
onProgress={this.setTime} // Callback every ~250ms with currentTime onProgress={this.setTime} // Callback every ~250ms with currentTime
onTimedMetadata={this.onTimedMetadata} // Callback when the stream receive some metadata
style={styles.backgroundVideo} /> style={styles.backgroundVideo} />
// Later to trigger fullscreen // Later to trigger fullscreen
@ -243,6 +242,7 @@ var styles = StyleSheet.create({
### Event props ### Event props
* [onLoad](#onload) * [onLoad](#onload)
* [onLoadStart](#onloadstart) * [onLoadStart](#onloadstart)
* [onTimedMetadata](#ontimedmetadata)
### Methods ### Methods
* [seek](#seek) * [seek](#seek)
@ -511,6 +511,28 @@ Example:
Platforms: all Platforms: all
#### onTimedMetadata
Callback function that is called when timed metadata becomes available
Payload:
Property | Type | Description
--- | --- | ---
metadata | array | Array of metadata objects
Example:
```
{
metadata: [
{ value: 'Streaming Encoder', identifier: 'TRSN' },
{ value: 'Internet Stream', identifier: 'TRSO' },
{ value: 'Any Time You Like', identifier: 'TIT2' }
]
}
```
Platforms: Android ExoPlayer, iOS
### Methods ### Methods
Methods operate on a ref to the Video element. You can create a ref using code like: Methods operate on a ref to the Video element. You can create a ref using code like:
``` ```