Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document prefer_mms param #1065

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Document prefer_mms param #1065

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c715b4d
Document prefer_mms query param
mcintyrehh Jan 22, 2025
0ab23a7
Add prefer_mms to table of contents
mcintyrehh Jan 22, 2025
1ec46d9
Expand MSE acronym
mcintyrehh Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Alternatively, you can reference an up‐to‐date version on our CDN:
<script src="https://player.vimeo.com/api/player.js"></script>
```

**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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`.
Loading