@byomakase/omakase-react-components 1.1.1 → 1.2.0-SNAPSHOT.1764842944

package/README.md

@@ -196,11 +196,10 @@ return (
   <OmakaseTamsPlayerComponent
     flow={flow}
     childFlows={childFlows}
-    flowSegments={flowSegments}
-    childFlowsSegments={childFlowsSegments}
+    flowsSegments={flowsSegments}
     videoLoadOptions={videoLoadOptions}
-    onVideoLoadedCallback={(omakasePlayer, video) =>
-      handleVideoLoaded(omakasePlayer, video)
+    onVideoLoadedCallback={(omakasePlayer, video, mediaInfo) =>
+      handleVideoLoaded(omakasePlayer, video, mediaInfo)
     }
     config={{ mediaChrome: "enabled" }}
     timerange={timeRange}
@@ -216,7 +215,7 @@ The following properties are present:
 - `flowSegments`: A list of [flow Segments](https://bbc.github.io/tams/main/index.html#/schemas/flow-segment) of the main flow
 - `childFlowSegments`: A map of subflow Ids and sublfow segments
 - `timerange`: A [timerange](https://bbc.github.io/tams/main/index.html#/schemas/timerange) string of flows to be included in HLS manifest
-- `videoLoadOptions`: Object representing [options](https://api.player.byomakase.org/interfaces/VideoLoadOptions.html) used for video loading.
+- `videoLoadOptions`: Object representing [options](https://api.player.byomakase.org/interfaces/VideoLoadOptions.html) used for video loading. These options will override inferred options from the TAMS flow. `protocol` property must NOT be set.
 - `onVideoLoadedCallback`: Callback called after initial video load. Useful for retrieving OmakasePlayer instance.
 - `config`: Object representing the omakase player's [configuration](https://api.player.byomakase.org/interfaces/OmakasePlayerConfig.html). If `playerHTMLElementId` property is not set it will default to `omakase-player`.
 - `enableHotkeys`: A boolean used to enable or disable hot keys. Defaults to `true`