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: src/essentials-for-yootheme-pro/v3.0-beta/addons/dynamic/sources/youtube.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,19 +40,29 @@ Fetches public videos with advanced query params resolving to a list of [Video T
40
40
41
41
| Setting | Description | Default | Dynamic |
42
42
| --- | --- | --- | :---: |
43
-
|*Videos ID*| Restricts the results to videos created by a specific channel ID. ||✓|
43
+
|*Playable*| Restricts results to videos that can be played outside YouTube. |`true`||
44
+
|*Embeddable*| Restricts results to videos that can be embedded in external sites. |`true`||
45
+
|*Videos ID*| Set videos ID separated by comma, or use below filters to specify which videos should be loaded. ||✓|
44
46
|*Channel ID*| Restricts the results to videos created by a specific channel ID. ||✓|
47
+
|*Category ID*| Restricts results to a particular video category. ||✓|
48
+
|*Topic ID*| Restricts search results to only include resources associated with the specified topic. ||✓|
45
49
|*Query Term*| The list of terms the videos should be associated with. Use the Boolean NOT (`-`) and OR (`\|`) operators to exclude or find videos that are associated with one of several search terms. For example, to match either "boating" or "sailing", set as `boating\|sailing`. Similarly, to exclude "fishing", set as `boating\|sailing -fishing`. ||✓|
46
-
|*Since/Until*| Restricts the results to videos that have been published within the specified range of dates. ||✓|
47
-
|*Location/Radius*| Location in conjunction with radius, defines a circular geographic area to which to restrict the videos. The location points the center of the area with latitude/longitude coordinates e.g. `37.42307,-122.08427`, while the radius is the maximum distance from the location in `m`, `km`, `ft`, or `mi` units, e.g `5km`. ||✓|
48
-
|*Region*| Restricts the results to videos that can be viewed in the specified country. The value is an [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code, e.g `ES`. ||✓|
50
+
|*Captions*| Restricts results based on caption availability. Options are _With Captions_ (`closedCaption`) or _Without Captions_ (`none`). ||✓|
51
+
|*Safe Search*| Content filtering level, either _Moderate_ (`moderate`), _Strict_ (`strict`), or _None_ (`none`). ||✓|
52
+
|*Video Type*| Restricts results to a particular video type. Options are _Movie_ (`movie`) or _Episode_ (`episode`). ||✓|
53
+
|*Broadcast*| Restricts results to a particular event type. Options are _Live_ (`live`), _Upcoming_ (`upcoming`), or _Completed_ (`completed`). ||✓|
54
+
|*Since*| Restricts results to videos published at or after the specified date. ||✓|
55
+
|*Until*| Restricts results to videos published before or at the specified date. ||✓|
56
+
|*Location*| The coordinates (latitude,longitude) that point at the center of the area, e.g. `37.42307,-122.08427`. ||✓|
57
+
|*Radius*| The maximum distance from the location in `m`, `km`, `ft`, or `mi` units, e.g. `5km`. ||✓|
58
+
|*Region*| Restricts the results to videos that can be viewed in the specified country. The value is an [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code, e.g. `ES`. ||✓|
49
59
|*Language*| Restricts the results to videos that are most relevant to the specified language. The value is typically an [ISO 639-1 two-letter](https://www.loc.gov/standards/iso639-2/php/code_list.php) language code, however, you should use the values `zh-Hans` for simplified Chinese and `zh-Hant` for traditional Chinese. Note that results in other languages will still be returned if they are highly relevant to the search query term. ||✓|
50
-
|*Definition*| Restricts the results based on the videos quality, either _High Definition_, _Standard Definition_, or _Any_. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. |`Any`|
51
-
|*Duration*| Restricts the results based on the videos duration, either _Long_, longer than 20 minutes, `Medium`, between four and 20 minutes, _Short_, less than four minutes, or _Any_. |`Any`|
52
-
|*Start*| The starting point, e.g of a list of 20 videos start from the number 2. |`1`|✓|
60
+
|*Definition*| Restricts the results based on the videos quality, either _High (HD)_, _Standard (SD)_, or _Any_. |`Any`||
61
+
|*Duration*| Restricts the results based on the videos duration, either _Longer than 20m_, _Between 4 and 20m_, _Shorter than 4m_, or _Any_. |`Any`||
62
+
|*Start*| The starting point from which to retrieve videos. |`1`|✓|
53
63
|*Quantity*| The maximum amount of videos to retrieve. |`20`|✓|
54
-
|*Order*| The order in which the videos will be returned, within *Date*, reverse chronological order based on the date the videos were created, _Rating_, from highest to lowest rating, _Relevance_, based on their relevance to the search query, _Title_, alphabetically by title, or _View Count_, from highest to lowest number of views. |`Relevance`|
55
-
|*Cache*| The duration in seconds before the cache is invalidated and the query re-executed. |`3600`|
64
+
|*Order*| The order in which the videos will be returned, within _Relevance_, _Rating Descendant_, _Created Date Reversed_, _Title Alphabetical_, or _View Count Descendant_. |`Relevance`||
65
+
|*Cache*| The duration in seconds before the cache is invalidated and the query re-executed. |`3600`||
0 commit comments