From b1c49decbf5f2d5732dee952edfce1101277ea7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Konstantin=20Spa=CC=88th?= Date: Fri, 25 Aug 2023 13:13:04 +0200 Subject: [PATCH] docs: adapt API.md for new features --- API.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/API.md b/API.md index d8772410..a507fea7 100644 --- a/API.md +++ b/API.md @@ -457,6 +457,19 @@ bufferConfig={{ Platforms: Android +#### chapters +To provide a custom chapter source for tvOS. This prop takes an array of objects with the properties listed below. + +| Property | Type | Description | +|-----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| title | string | The title of the chapter to create | +| startTime | number | The start time of the chapter in seconds | +| endTime | number | The end time of the chapter in seconds | +| uri | string? | Optional: Provide an http orl or the some base64 string to override the image of the chapter. For some media files the images are generated automatically | + + +Platforms: tvOS + #### currentPlaybackTime When playing an HLS live stream with a `EXT-X-PROGRAM-DATE-TIME` tag configured, then this property will contain the epoch value in msec. @@ -954,6 +967,24 @@ source={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8' Platforms: iOS, Android +##### Overriding the metadata of a source + +Provide an optional `title`, `subtitle` and/or `description` properties for the video. +Useful when to adapt the tvOS playback experience. + +Example: + +``` +source={{ + uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', + title: 'Custom Title', + subtitle: 'Custom Subtitle', + description: 'Custom Description' + }} +``` + +Platforms: tvOS + #### subtitleStyle Property | Description | Platforms