npm - @videojs/react - Versions diffs - 10.0.0-beta.31 → 10.0.0-beta.32 - Mend

@videojs/react 10.0.0-beta.31 → 10.0.0-beta.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1552) hide show

package/docs/reference/vimeo-video.md CHANGED Viewed

@@ -2,9 +2,7 @@
 Video component that plays Vimeo videos and live events through the Vimeo player
-Video component that plays Vimeo videos and live events through the [Vimeo player SDK](https://developer.vimeo.com/player/sdk). Vimeo’s own chrome stays hidden by default, so it drops into a [player skin](../concepts/skins.md) like any other media component; set `controls` to use Vimeo’s UI instead.
-Of the embed-backed media components, this one comes closest to a native `<video>`: volume, mute, playback rate, seeking, looping, and picture-in-picture all work, and the embed pushes real events instead of being polled.
+Of the embed-backed media components, the [Vimeo player SDK](https://developer.vimeo.com/player/sdk) comes closest to a native `<video>`: volume, mute, playback rate, seeking, looping, and picture-in-picture all work, and the embed pushes real events instead of being polled. Vimeo’s own chrome stays hidden by default, so it drops into a [player skin](../concepts/skins.md) like any other media component; set `controls` to use Vimeo’s UI instead.
 ## Load a source
@@ -134,7 +132,7 @@ Details
 `source`
-`VimeoSource | null`
+`{ src?: string; engine?: VimeoSourceEngineConfig } | null`
 `null`
@@ -179,7 +177,7 @@ Details
 `airplay`
-`boolean`
+`boolean | undefined`
 ▸
@@ -189,7 +187,7 @@ Whether AirPlay is enabled in the embeddable player
 `audio_tracks`
-`boolean`
+`boolean | undefined`
 ▸
@@ -199,7 +197,7 @@ Whether multiple audio tracks can appear in the embeddable player
 `audiotrack`
-`string`
+`string | undefined`
 ▸
@@ -209,7 +207,7 @@ The initial audio track to play with the video. Can be language code (fr), langu
 `autopause`
-`boolean`
+`boolean | undefined`
 ▸
@@ -219,7 +217,7 @@ Whether to pause the current video when another Vimeo video on the same page sta
 `autoplay`
-`boolean`
+`boolean | undefined`
 ▸
@@ -229,7 +227,7 @@ Whether to start playback of the video automatically. This feature might not wor
 `background`
-`boolean`
+`boolean | undefined`
 ▸
@@ -239,7 +237,7 @@ Whether the player is in background mode, which hides the playback controls, ena
 `byline`
-`boolean`
+`boolean | undefined`
 ▸
@@ -249,7 +247,7 @@ Whether to display the video owner's name
 `cc`
-`boolean`
+`boolean | undefined`
 ▸
@@ -259,7 +257,7 @@ Whether closed captions are enabled in the embeddable player
 `chapter_id`
-`string`
+`string | undefined`
 ▸
@@ -269,7 +267,7 @@ The chapter by ID to start playback at. This is only available when the Player i
 `chapters`
-`boolean`
+`boolean | undefined`
 ▸
@@ -279,7 +277,7 @@ Whether chapters are enabled in the embeddable player
 `chromecast`
-`boolean`
+`boolean | undefined`
 ▸
@@ -289,7 +287,7 @@ Whether the Chromecast button appears in the embeddable player
 `color`
-`string`
+`HexColor | undefined`
 ▸
@@ -299,7 +297,7 @@ The hexadecimal accent color value of the playback controls (normally 00ADEF)
 `colors`
-`VimeoColors`
+`VimeoColors | undefined`
 ▸
@@ -309,7 +307,7 @@ The hexadecimal color values of the player in order: \[Primary, Accent, Text/Ico
 `controls`
-`boolean`
+`boolean | undefined`
 ▸
@@ -319,7 +317,7 @@ Whether to display the player's interactive elements, including the playbar and
 `disable_context_menu`
-`boolean`
+`boolean | undefined`
 ▸
@@ -329,7 +327,7 @@ Whether to disable the custom right-click context menu (which shows options like
 `dnt`
-`boolean`
+`boolean | undefined`
 ▸
@@ -339,7 +337,7 @@ Whether to prevent the player from tracking session data, including setting cook
 `end_time`
-`number`
+`Seconds | undefined`
 ▸
@@ -349,7 +347,7 @@ In Segmented Playback mode, the time in seconds where playback ends for the vide
 `fullscreen`
-`boolean`
+`boolean | undefined`
 ▸
@@ -359,7 +357,7 @@ Whether to show the fullscreen button in the embeddable player
 `height`
-`number`
+`Pixels | undefined`
 ▸
@@ -369,7 +367,7 @@ The height of the video in pixels
 `id`
-`VideoId`
+`VideoId | undefined`
 ▸
@@ -379,7 +377,7 @@ The Vimeo clip ID of video to load. Must be provided if not providing `url` or i
 `initial_quality`
-`string`
+`VideoQualityId | undefined`
 ▸
@@ -389,7 +387,7 @@ The playback quality of the first seconds of video loaded. Common values are 360
 `interactive_markers`
-`boolean`
+`boolean | undefined`
 ▸
@@ -399,7 +397,7 @@ Whether to display markers representing the timestamp where hotspots appear on a
 `interactive_params`
-`Record<string, string>`
+`Record<string, string> | undefined`
 ▸
@@ -409,7 +407,7 @@ Key-value pairs representing dynamic parameters that are utilized on interactive
 `keyboard`
-`boolean`
+`boolean | undefined`
 ▸
@@ -419,7 +417,7 @@ Whether to enable keyboard input to trigger player events
 `loop`
-`boolean`
+`boolean | undefined`
 ▸
@@ -429,7 +427,7 @@ Whether to restart the video automatically after reaching the end
 `max_quality`
-`string`
+`VideoQualityId | undefined`
 ▸
@@ -439,7 +437,7 @@ The highest possible quality that the player automatically switches to during vi
 `maxheight`
-`number`
+`Pixels | undefined`
 ▸
@@ -449,7 +447,7 @@ The height of the video in pixels, where the video won't exceed its native heigh
 `maxwidth`
-`number`
+`Pixels | undefined`
 ▸
@@ -459,7 +457,7 @@ The width of the video in pixels, where the video won't exceed its native width
 `min_quality`
-`string`
+`VideoQualityId | undefined`
 ▸
@@ -469,7 +467,7 @@ The lowest possible quality that the player automatically switches to during vid
 `muted`
-`boolean`
+`boolean | undefined`
 ▸
@@ -479,7 +477,7 @@ Whether the video is muted upon loading. The true value is required for the auto
 `pip`
-`boolean`
+`boolean | undefined`
 ▸
@@ -489,7 +487,7 @@ Whether to include the picture-in-picture button among the player controls
 `play_button_position`
-`"auto" | "bottom" | "center"`
+`'auto' | 'bottom' | 'center' | undefined`
 ▸
@@ -499,7 +497,7 @@ The position of the play button within the embeddable player. Other possible val
 `playsinline`
-`boolean`
+`boolean | undefined`
 ▸
@@ -509,7 +507,7 @@ Whether the video plays inline on supported mobile devices
 `portrait`
-`boolean`
+`boolean | undefined`
 ▸
@@ -519,7 +517,7 @@ Whether to display the video owner's portrait
 `prefer_mms`
-`boolean`
+`boolean | undefined`
 ▸
@@ -529,7 +527,7 @@ Whether to allow MMS (Managed Media Source) for video playback in Safari
 `preload`
-`"metadata" | "none" | "auto" | "metad...`
+`'metadata' | 'metadata_on_hover' | 'a...`
 ▸
@@ -539,11 +537,11 @@ The loading behavior for the player before playback is initiated. 'metadata' = l
 Type
-`"metadata" | "none" | "auto" | "metadata_on_hover" | "auto_on_hover"`
+`'metadata' | 'metadata_on_hover' | 'auto' | 'auto_on_hover' | 'none' | undefined`
 `progress_bar`
-`boolean`
+`boolean | undefined`
 ▸
@@ -553,7 +551,7 @@ Whether to show the progress bar in the embeddable player
 `quality`
-`string`
+`VideoQualityId | undefined`
 ▸
@@ -563,7 +561,7 @@ The playback quality of the video. Use 'auto' for best quality given available b
 `quality_selector`
-`boolean`
+`boolean | undefined`
 ▸
@@ -573,7 +571,7 @@ Whether to show the quality selector in the embeddable player
 `referrerPolicy`
-`ReferrerPolicy`
+`ReferrerPolicy | undefined`
 ▸
@@ -583,7 +581,7 @@ Description
 `responsive`
-`boolean`
+`boolean | undefined`
 ▸
@@ -593,7 +591,7 @@ Whether to return a responsive embed code
 `skipping_forward`
-`boolean`
+`boolean | undefined`
 ▸
@@ -603,7 +601,7 @@ Whether users can skip forward in the embeddable player
 `speed`
-`boolean`
+`boolean | undefined`
 ▸
@@ -613,7 +611,7 @@ Whether to include playback speed among the player preferences
 `start_time`
-`number`
+`Seconds | undefined`
 ▸
@@ -623,7 +621,7 @@ The time in seconds to start playback at. This is only available when the Player
 `texttrack`
-`string`
+`string | undefined`
 ▸
@@ -633,7 +631,7 @@ The text track to display with the video. Can be language code (en), language co
 `thumbnail_id`
-`string`
+`string | undefined`
 ▸
@@ -643,7 +641,7 @@ The ID of the thumbnail to load from the video's available thumbnail set
 `title`
-`boolean`
+`boolean | undefined`
 ▸
@@ -653,7 +651,7 @@ Whether to display the video's title
 `transcript`
-`boolean`
+`boolean | undefined`
 ▸
@@ -663,7 +661,7 @@ Whether transcript controls can appear in the embeddable player
 `transparent`
-`boolean`
+`boolean | undefined`
 ▸
@@ -673,7 +671,7 @@ Whether the responsive player and transparent background are enabled
 `unmute_button`
-`boolean`
+`boolean | undefined`
 ▸
@@ -683,7 +681,7 @@ Whether to display the unmute button
 `url`
-`VimeoUrl`
+`VimeoUrl | undefined`
 ▸
@@ -693,7 +691,7 @@ The Vimeo video URL to load. Must be provided if not providing `id` or iframe el
 `vimeo_logo`
-`boolean`
+`boolean | undefined`
 ▸
@@ -703,7 +701,7 @@ Whether to show the Vimeo logo in the embeddable player
 `volume`
-`boolean`
+`boolean | undefined`
 ▸
@@ -713,7 +711,7 @@ Whether to show the volume selector in the embeddable player
 `watch_full_video`
-`boolean`
+`boolean | undefined`
 ▸
@@ -723,7 +721,7 @@ Whether to show the Watch Full Video button when Segmented Playback mode is enab
 `width`
-`number`
+`Pixels | undefined`
 ▸