diff --git a/README.md b/README.md index f25f07bc5..02177cab7 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,12 @@ Alternatively, you can reference an up‐to‐date version on our CDN: ``` -**Warning:** when used with RequireJS it's required to load the script dynamically via the RequireJS load system. +**Warning:** when used with RequireJS it is required to load the script dynamically via the RequireJS load system. https://requirejs.org/docs/api.html#jsfiles ## Getting Started -In order to control the Vimeo player, you need a player to control. There are a +In order to control the Vimeo Player, you need a player to control. There are a few ways to get a player: ### Pre-existing player @@ -251,7 +251,8 @@ it will also import the Player constructor directly: + [remoteplaybackdisconnect](#remoteplaybackdisconnect) + [interactivehotspotclicked](#interactivehotspotclicked) + [interactiveoverlaypanelclicked](#interactiveoverlaypanelclicked) - +* [Dev Options](#dev-options) + + [prefer_mms](#prefer_mms) ## Create a Player @@ -1815,3 +1816,11 @@ Triggered when the overlay panel (buttons or images) within the interactive over panelId: 'c47193a0-8320-4572-9bcd-8425851b36e9' } ``` + +## Dev Options + +### prefer_mms + +The Vimeo Player uses [Managed Media Source](https://developer.apple.com/videos/play/wwdc2023/10122/?time=762) (MMS) where available for [Media Source Extension](https://developer.mozilla.org/en-US/docs/Web/API/Media_Source_Extensions_API) powered playback on iOS devices. + +Unfortunately, there are [known issues](https://bugs.webkit.org/show_bug.cgi?id=266764) with MMS in certain versions of the Xcode iOS Simulator. Therefore, we have added a query parameter to disable MMS and force native HLS playback via: `prefer_mms=0` or `prefer_mms=false`.