You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/uploadcare-video.adoc
+4-15Lines changed: 4 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,8 @@ tinymce.init({
47
47
[NOTE]
48
48
====
49
49
The {pluginname} plugin uses the same plugin code `+uploadcare+` as the Media Optimizer plugin. Video functionality is automatically enabled when video files are uploaded.
50
+
51
+
When bundling {productname} with webpack or similar tools, the xref:uploadcare.adoc#uploadcare-resources[uploadcare_resources] option is required for video functionality to work properly, as it tells the plugin where to find the additional JavaScript resources needed for video playback.
50
52
====
51
53
52
54
== Video Operations
@@ -68,48 +70,38 @@ Below is an overview of the features provided by the Video Optimizer plugin:
68
70
69
71
Below are the video player control options that are available to the video element:
70
72
71
-
[cols="1,1,4",options="header"]
73
+
[cols="2,4",options="header"]
72
74
|===
73
-
| Operation | Icon | Description
75
+
| Operation | Description
74
76
75
77
| Play
76
-
|
77
78
| Customize video player controls and behavior
78
79
79
80
| Mute
80
-
|
81
81
| Mute the video
82
82
83
83
| Unmute
84
-
|
85
84
| Unmute the video
86
85
87
86
| Slider
88
-
|
89
87
| Shows the progress of the video and allows users to move the slider to seek to a specific time in the video
90
88
91
89
| Resize
92
-
| image:icons/resize.svg[resize.svg]
93
90
| Changes the size of the video (when enabled)
94
91
95
92
| Remaining Time
96
-
|
97
93
| Shows the remaining time of the video
98
94
99
95
| Picture-in-Picture
100
-
|
101
96
| Enables picture-in-picture mode for the video
102
97
103
98
| Settings
104
-
|
105
99
| Opens the video settings menu
106
100
107
101
| Fullscreen
108
-
|
109
102
| Enables fullscreen mode for the video
110
103
111
104
| UC Logo
112
-
|
113
105
| Shows the Uploadcare logo
114
106
|===
115
107
@@ -137,14 +129,11 @@ The plugin creates a custom `+<uc-video>+` element that replaces the standard HT
Specifies the base path where the Uploadcare plugin resources are served from. This option is primarily used when bundling {productname} with webpack or other bundlers, where the plugin needs to know where to load additional resources such as the `ucvideo.min.js` file for video functionality.
5
+
6
+
When {productname} is bundled, the Uploadcare plugin cannot automatically determine where its additional resources are located. This option tells the plugin where to find these resources by specifying the root path to the Uploadcare plugin directory.
7
+
8
+
*Type:* `+String+`
9
+
10
+
*Default:* `+undefined+`
11
+
12
+
*Possible values:* A string that points to the root path of the Uploadcare plugin directory.
13
+
14
+
[NOTE]
15
+
This option is only required when using the **Media Optimizer** as a paid "addon" and bundling {productname} with webpack or similar bundling tools.
16
+
17
+
.Example: Setting `uploadcare_resources`
18
+
[source,js]
19
+
----
20
+
tinymce.init({
21
+
selector: 'textarea',
22
+
plugins: 'uploadcare',
23
+
toolbar: 'uploadcare uploadcare-video',
24
+
uploadcare_public_key: '<your-public-key>',
25
+
uploadcare_resources: 'uploadcare/uploadcare', // Points to the uploadcare plugin directory
26
+
license_key: '<your-license-key>'
27
+
});
28
+
----
29
+
30
+
=== Complete Bundled Setup Example
31
+
32
+
For a complete example of setting up {productname} with the Uploadcare addon, see the bundled setup example:
Copy file name to clipboardExpand all lines: modules/ROOT/partials/configuration/uploadcare_video_properties.adoc
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,18 @@ Configures the video player properties and behavior for video elements.
9
9
10
10
=== Properties
11
11
12
-
[cols="2,1,2,1,2"]
12
+
[cols="1,1,2,1,2"]
13
13
|===
14
14
|Property | Type | Valid Values | Default | Description
15
15
|`autoplay` | Boolean | `true`, `false`, `undefined` | `undefined` | Automatically starts video playback when the page loads.
16
16
|`controls` | Boolean | `true`, `false` | `true` | Displays the video player controls (play/pause, volume, timeline, fullscreen, etc.). When disabled, users can still control playback through keyboard shortcuts or programmatic methods.
17
-
|`controlsList` | String | `nodownload`, `nofullscreen`, `noremoteplayback` (space-separated) | `undefined` | Specifies which controls to hide from the video player interface. Use space-separated values to disable multiple controls (e.g., `"nodownload nofullscreen"`).
18
-
|`disablePictureInPicture` | Boolean | `true`, `false`, `undefined` | `undefined` | Prevents the video from entering picture-in-picture mode, which allows users to continue watching while using other applications or tabs.
19
-
|`disableRemotePlayback` | Boolean | `true`, `false`, `undefined` | `undefined` | Disables the ability to cast or stream the video to external devices like Chromecast or AirPlay.
20
17
|`height` | Number or String | Pixels or CSS value | `undefined` | Sets the video player height. Accepts numeric values (interpreted as pixels) or CSS values like `"100%"`, `"50vh"`, or `"auto"`.
21
18
|`loop` | Boolean | `true`, `false`, `undefined` | `undefined` | Automatically restarts video playback from the beginning when it reaches the end. Useful for background videos or continuous content loops.
22
19
|`muted` | Boolean | `true`, `false`, `undefined` | `undefined` | Mutes the video audio by default. Often used in combination with autoplay since most browsers require muted videos for autoplay to function.
23
-
|`playsInline` | Boolean | `true`, `false`, `undefined` | `undefined` | Forces the video to play inline within the page instead of opening in fullscreen mode on mobile devices. Essential for preventing unwanted fullscreen behavior on iOS Safari. Without this attribute, iOS devices will automatically enter fullscreen mode when video playback begins, which can disrupt the user experience in web applications or when videos are part of a larger content layout.
24
20
|`poster` | String | Valid URL | `undefined` | Sets a poster image (thumbnail) that displays before video playback begins. The image should match the video's aspect ratio for best results.
25
21
|`preload` | String | `auto`, `metadata`, `none` | `undefined` | Controls how much video data to preload: `auto` loads the entire video, `metadata` loads only basic information, `none` loads nothing until playback starts. Performance considerations: use `metadata` for better page load times and bandwidth conservation, `auto` for immediate playback without buffering delays, and `none` for maximum bandwidth savings when videos may not be played.
26
22
|`width` | Number or String | Pixels or CSS value | `undefined` | Sets the video player width. Accepts numeric values (interpreted as pixels) or CSS values like `"100%"`, `"50vw"`, or `"auto"`.
27
-
|`crossOrigin` | String | `anonymous`, `use-credentials` | `undefined` | Configures CORS (Cross-Origin Resource Sharing) for the video element. Use `anonymous` for basic cross-origin requests or `use-credentials` when cookies/credentials are needed.
28
23
|`showLogo` | Boolean | `true`, `false` | `true` | Displays the Uploadcare logo overlay on the video player.
29
-
|`posterOffset` | String | Time string (e.g., `5s`) | `undefined` | Sets a specific time offset (in seconds) for the poster image generation.
0 commit comments