| 1 |
<details class="vdo_docs"> |
| 2 |
<summary>How to use the shortcode? (attributes reference)</summary> |
| 3 |
<p>Minimal usage: <code>[vdo id="____"]</code>. It will be replaced by the video player.</p> |
| 4 |
<p>More attributes can be defined like <code>[vdo id="_____" key1="value"]</code>. List of supported attributes:</p> |
| 5 |
<table> |
| 6 |
<tr> |
| 7 |
<th>Key</th> |
| 8 |
<th>Description</th> |
| 9 |
</tr> |
| 10 |
<tr> |
| 11 |
<td>id</td> |
| 12 |
<td><strong>Required</strong> It is the 32 character video identifier which can be copied from your vdocipher dashboard.</td> |
| 13 |
</tr> |
| 14 |
<tr> |
| 15 |
<td>width</td> |
| 16 |
<td>Width of the video player. There will always be a <code>max-width: 100%</code> applied to the video player to avoid overflow. Hence, this is recommended to be set to the highest acceptable value. Do not append "px" at the end.</td> |
| 17 |
</tr> |
| 18 |
<tr> |
| 19 |
<td>height</td> |
| 20 |
<td>Recommended to be set to <code>auto</code>. Auto will mean that the height will be automatically adjusted according to the aspect ratio. If the height or width can not fit the available size, height will be adjusted using letter-boxing, meaning that black bars will be added in one-dimension until it fits.</td> |
| 21 |
</tr> |
| 22 |
<tr> |
| 23 |
<td>no_annotate</td> |
| 24 |
<td>Can be set to <code>true</code> if you want to disable watermark for a specific embed.</td> |
| 25 |
</tr> |
| 26 |
<tr><td colspan="2" style="text-align: center">Below attributes are only available on player v2 version.</td></tr> |
| 27 |
<tr> |
| 28 |
<td>vdo_theme</td> |
| 29 |
<td>Player ID to be applied to this video. Player customisation id is different for v1 and v2 of the player. Using a theme will use that particular player version irrespective of player version selected here.</td> |
| 30 |
</tr> |
| 31 |
<tr> |
| 32 |
<td>autoplay</td> |
| 33 |
<td>Acceptable value: <code>true</code>. If set, video will play automatically. But due to browser restrictions, it will be muted. A small banner on the video will prompt the viewer to "Tap To Unmute"</td> |
| 34 |
</tr> |
| 35 |
<tr> |
| 36 |
<td>controls</td> |
| 37 |
<td>Acceptable values: <code>on</code>(default), <code>off</code>, or <code>native</code>.</td> |
| 38 |
</tr> |
| 39 |
<!-- <tr>--> |
| 40 |
<!-- <td>litemode</td>--> |
| 41 |
<!-- <td>If you have to embed multiple videos in the same page, it can fail with error due to limited number of DRM sessions available on a device. To avoid this problem, it is recommended to set <code>litemode="true"</code> which will defer the loading of media and starting DRM session until it is clicked.</td>--> |
| 42 |
<!-- </tr>--> |
| 43 |
<tr> |
| 44 |
<td>cc_language</td> |
| 45 |
<td>You can upload the captions for the videos in VTT format from your vdocipher dashboard. These captions will be available from the player. This option sets the captions language to start with. Set this to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank">the two-letter representation of the language as defined in ISO 639-1</a>.</td> |
| 46 |
</tr> |
| 47 |
</table> |
| 48 |
</details> |
| 49 |
|
