MoodleDocs - User contributions [en]

tiny fastpix

2026-07-09T06:30:10Z

Fastpix-devs: Initial documentation for tiny_fastpix plugin

{{DISPLAYTITLE:tiny_fastpix — FastPix Video picker}}
{{FastPix}}
{{Infobox plugin
|type = TinyMCE editor plugin
|entry = https://moodle.org/plugins/tiny_fastpix
|tracker = https://github.com/FastPix/moodle-tiny_fastpix/issues
|discussion = https://github.com/FastPix/moodle-tiny_fastpix/discussions
|maintainer = [[User:Tharun Budidha|Tharun Budidha]] (FastPix Inc)
}}

The '''tiny_fastpix''' plugin adds a single toolbar button, '''Insert FastPix Video''', to every TinyMCE editor in Moodle. When an author selects the button, a modal opens with a searchable list of the FastPix videos they own. Picking a video inserts a FastPix short code at the cursor. When the page is viewed, [[filter_fastpix]] swaps that short code for a working video player.

tiny_fastpix is the ''authoring'' half of the FastPix embed system; [[filter_fastpix]] is the ''rendering'' half. The plugin uploads nothing and plays nothing itself — it only helps an author reference a video that already exists. It never contacts FastPix directly; every video read goes through [[local_fastpix]].

== Requirements ==

Before you begin, make sure you have:

* A Moodle site running version 4.5 LTS or later, with '''TinyMCE''' set as the editor at '''Site administration -> Plugins -> Text editors -> Manage editors'''. Atto and other editors are not supported in version 1.0.
* PHP 8.1 or later (tested through PHP 8.3).
* Site administrator access to your Moodle dashboard.
* [[local_fastpix]] 1.0.0 or later, installed and connected to a FastPix account.
* [[mod_fastpix]] 1.0.0 or later, installed. The picker reuses its <code>mod/fastpix:uploadmedia</code> capability.
* [[filter_fastpix]] 1.0.0 or later, installed '''and enabled'''. Without the filter, the short code that tiny_fastpix inserts stays as plain text instead of becoming a player.
* At least one ready, non-DRM video uploaded to a FastPix activity.

:: '''Note:''' You cannot install tiny_fastpix standalone. Moodle blocks the install with a dependency error until local_fastpix, mod_fastpix, and filter_fastpix are present. The plugin adds no database tables, holds no FastPix credentials, and pulls in no Composer packages.

FastPix credentials are configured once in [[local_fastpix]], and every plugin in the suite reads through it from there. If video listings do not work, check the credentials in local_fastpix first.

== Installation ==

The plugin follows standard Moodle installation guidelines. You can install it from the Moodle plugins directory or from a ZIP file.

=== Install from the Moodle plugins directory ===

# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Search for '''FastPix Video picker''' and follow the prompts.

=== Install from a ZIP file ===

# Download the latest release from the [https://github.com/FastPix/moodle-tiny_fastpix/releases GitHub releases page].
# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Drag the ZIP onto the drop zone, or select '''Choose a file''' to upload it. Do not unzip the file first; Moodle installs the package directly from the ZIP.
# Select '''Install plugin from the ZIP file''', then continue through the validation screen.
# On the '''Plugins requiring attention''' screen, select '''Upgrade Moodle database now'''.
# When the upgrade finishes, select '''Continue'''.

More information on how to install a plugin can be found [[Installing plugins|here]].

:: '''Note:''' No further admin configuration is needed. The toolbar button registers automatically with TinyMCE, and the picker uses the existing <code>mod/fastpix:uploadmedia</code> capability, which editing teachers and managers hold by default.

To confirm the install, sign in as an editing teacher in any course, open any rich-text editor, and look for the '''Insert FastPix Video''' button on the toolbar.

== Inserting a video ==

After the plugin is installed and filter_fastpix is enabled, teachers can insert a video from any TinyMCE editor in Moodle — forum posts, Pages, Book chapters, labels, course and section summaries, quiz feedback, and anywhere else Moodle uses rich text.

# Open any page that has a TinyMCE editor.
# Place the cursor where you want the video to appear.
# Select '''Insert FastPix Video''' on the toolbar. The button shows the FastPix icon.
# In the modal that opens, browse or search for the video by name.
# Select the video card. The modal closes and a FastPix short code is inserted at the cursor.
# Save the form. When the page is viewed, filter_fastpix renders the player in place of the short code.

You can also reach the picker from the editor's '''Insert''' menu, which is useful if your toolbar is full or if you prefer keyboard navigation.

The plugin inserts a single short code wherever the cursor is, for example:

<pre>{fastpix:pb_96df2713-bd26-4815-8b8d-8ab7674aa751}</pre>

You can type around it, place several on one page, or delete it like any other text. The short code is ordinary text, so content created with the button behaves exactly like content where the short code was typed by hand. For the short-code syntax, see [[filter_fastpix]].

=== Searching for a video ===

If you have more than a handful of videos, search by name from the picker:

# Open the picker. The modal shows your most recent videos by default.
# Start typing in the search box. The list refreshes as you type, matching against both the activity name and the asset title.
# Select the video you want.

Searches match anywhere in the name, are case-insensitive, and handle accented characters. Clear the search box to return to the full list. Searches do not handle typos or partial-word matches, and they match the activity name and asset title, not the original filename.

== Verifying the embed renders ==

After you insert a short code and save the page:

# Reload the saved page as a student or other enrolled user. The short code should be replaced with a working video player.
# Select '''Play'''. The video should stream from FastPix.
# As a teacher in the same course, reload the page. You should see the same player as the student, because the embed view is the same regardless of role.

If the short code appears as raw text instead of a player, the most likely cause is that filter_fastpix is not enabled.

== What appears in the picker ==

The list is deliberately narrow, so an author can only insert a video that will actually play. All of these rules are enforced on the server.

{| class="wikitable"
! Rule !! Why
|-
| '''Your videos only''' || The picker is scoped to the signed-in user, so you never see another teacher's library.
|-
| '''This course only''' || Only videos uploaded through a FastPix activity in the current course are listed.
|-
| '''Ready only''' || Videos still uploading or processing are hidden until FastPix finishes them.
|-
| '''Playable only''' || DRM-protected videos are excluded, because filter_fastpix cannot embed them.
|-
| '''Named, not numbered''' || Each result shows the video's activity name (falling back to ''Untitled video''), not a raw UUID.
|-
| '''Most recent first''' || The list is capped at the most-recent videos. Search by name if you have a large library.
|}

If the picker is empty, the message tells you why:

* '''"You have no ready videos to embed yet."''' You have not uploaded any qualifying videos. Upload one through a FastPix activity.
* '''"No videos match your search."''' Clear the search box, or check the spelling of the activity name or video title.
* '''"Could not load your videos. Please try again."''' The web service did not respond. Close the modal and reopen it.

== Who can use it ==

The button and the web service behind it share one gate, so there is no separate capability to manage.

{| class="wikitable"
! Capability !! Effect !! Owned by
|-
| <code>mod/fastpix:uploadmedia</code> || Checked at the '''course context'''. Holders see the toolbar button and can list their own videos in that course; everyone else gets no button at all. || [[mod_fastpix]]
|}

== Limitations ==

tiny_fastpix does one thing — insert a FastPix short code into TinyMCE — and is intentionally narrow.

* '''TinyMCE only.''' Version 1.0 does not add the button to Atto or other editors. This is an ''authoring'' limit; filter_fastpix still renders short codes whatever produced them, so content written by hand still plays.
* '''No uploads from the picker.''' New videos come in through a [[mod_fastpix]] activity and surface in the picker once they are ready.
* '''No DRM videos.''' DRM-protected videos need short-lived playback tokens that a rich-text field cannot refresh, so they are excluded. Use a [[mod_fastpix|FastPix Video activity]] for them.
* '''No edit-in-place.''' To change an embedded video, delete the short code and insert a new one.

== Privacy ==

tiny_fastpix stores no personal data of its own. It declares a <code>null_provider</code> under Moodle's Privacy API and leaves all storage to [[local_fastpix]], which is the only plugin in the suite that talks to FastPix. For full privacy details, see the [[local_fastpix#Privacy|local_fastpix privacy section]].

== Troubleshooting ==

# '''The Insert FastPix Video button does not appear.''' Confirm that TinyMCE is the active editor for your account at '''Preferences -> Editor preferences'''. If only Atto appears, set TinyMCE as the site default at '''Site administration -> Plugins -> Text editors -> Manage editors'''. Confirm that you hold <code>mod/fastpix:uploadmedia</code> in the course or system context where you are editing. Then reload the page to pick up the latest editor configuration.
# '''The picker is empty.''' If you have never uploaded a FastPix video, the list is empty; upload one in a FastPix activity and wait for it to finish processing. If you have uploaded videos, check the activity for a '''Preparing your video''' card, which means the video is not ready. If the videos are ready but still absent, check whether they are DRM-protected; DRM videos are excluded by design.
# '''The short code appears as plain text on the saved page.''' filter_fastpix is not enabled, or is not placed correctly in the filter order. Go to '''Site administration -> Plugins -> Filters -> Manage filters''', confirm that '''FastPix video embeds''' is set to '''On''', and confirm it sits above '''Multimedia plugins''' in the order list.
# '''Searching does not find a video I know I uploaded.''' The picker matches the activity name in Moodle and the asset title stored in FastPix, not the original filename. Searches are case-insensitive and accent-insensitive, but do not handle typos or partial-word matches.
# '''Another course's videos do not appear in my picker.''' This is expected. The picker only shows videos that the signed-in user uploaded, in the current course. There is no cross-author sharing in version 1.0. To share a video, the original uploader can pass you the short code directly.

== License ==

© 2026 FastPix Inc. Distributed under the [https://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3.0 or later].

== See also ==

* [[local_fastpix]] - foundation plugin (required)
* [[mod_fastpix]] - FastPix Video activity (required; owns the capability and uploads)
* [[filter_fastpix]] - renders the inserted short codes (required, must be enabled)
* [https://github.com/FastPix/moodle-tiny_fastpix Source code on GitHub]
* [https://github.com/FastPix/moodle-tiny_fastpix/blob/main/CHANGELOG.md Release notes]

[[Category:Plugins]]
[[Category:Text editors]]
[[Category:Plugin documentation]]

Template:FastPix

2026-07-09T06:24:05Z

Fastpix-devs: Add tiny_fastpix to navigation template

<div style="float:right; clear:right; margin:0 0 1em 1em; padding:0.6em 0.9em; border:1px solid #ccc; background:#f7f7f7; border-radius:4px; width:18em; font-size:0.9em;">
'''[[local_fastpix|FastPix for Moodle]]'''
----
'''Plugins'''
* [[local_fastpix]] — foundation plugin
* [[mod_fastpix]] — FastPix Video activity
* [[filter_fastpix]] — video embeds filter
* [[tiny_fastpix]] — TinyMCE video picker
----
'''Resources'''
* [https://moodle.org/plugins/local_fastpix Plugins directory]
* [https://github.com/FastPix Source on GitHub]
* [https://fastpix.com/docs FastPix documentation]
* [https://www.fastpix.com/technical-support Support]
</div><noinclude>
This is the shared navigation template for the FastPix Moodle plugin documentation pages. Include it at the top of a plugin page with <code><nowiki>{{FastPix}}</nowiki></code>.

[[Category:Templates]]
[[Category:Plugin documentation]]
</noinclude>

filter fastpix

2026-06-24T09:10:39Z

Fastpix-devs: Created page with "{{DISPLAYTITLE:filter_fastpix — FastPix video embeds}} {{FastPix}} {{Infobox plugin |type = Filter |entry = https://moodle.org/plugins/filter_fastpix |tracker = https://github.com/FastPix/moodle-filter_fastpix/issues |discussion = https://github.com/FastPix/moodle-filter_fastpix/discussions |maintainer = Tharun Budidha (FastPix Inc) }} The '''filter_fastpix''' plugin is a Moodle text filter. It looks for FastPix short codes in any rich-text con..."

{{DISPLAYTITLE:filter_fastpix — FastPix video embeds}}
{{FastPix}}
{{Infobox plugin
|type = Filter
|entry = https://moodle.org/plugins/filter_fastpix
|tracker = https://github.com/FastPix/moodle-filter_fastpix/issues
|discussion = https://github.com/FastPix/moodle-filter_fastpix/discussions
|maintainer = [[User:Tharun Budidha|Tharun Budidha]] (FastPix Inc)
}}

The '''filter_fastpix''' plugin is a Moodle text filter. It looks for FastPix short codes in any rich-text content Moodle renders and replaces each one with a video player. Teachers can drop a video into a forum reply, a course summary, a Page, a Book chapter, a label, or quiz feedback without creating a separate activity.

It is a display-only plugin: it stores nothing, tracks nothing, and grades nothing. For graded, completion-tracked videos, use the [[mod_fastpix|FastPix Video activity]] instead. The filter builds on [[local_fastpix]] (FastPix credentials, HTTP gateway, and asset metadata) and [[mod_fastpix]] (the view capability and player markup it reuses).

== Requirements ==

Before you begin, make sure you have:

* A Moodle site running version 4.5 LTS or later.
* PHP 8.1 or later (tested through PHP 8.3).
* Site administrator access to your Moodle dashboard.
* [[local_fastpix]] 1.0.0 or later, installed and connected to a FastPix account.
* [[mod_fastpix]] 1.0.0 or later, installed. The filter reuses its view capability and its player.
* At least one public FastPix video to embed for verification, with its playback ID copied from the FastPix Dashboard.

:: '''Note:''' filter_fastpix cannot be installed standalone. Moodle blocks the install with a dependency error until local_fastpix and mod_fastpix are present. If you have not set those up yet, see [[local_fastpix]] and [[mod_fastpix]] first.

== Installation ==

The plugin follows standard Moodle installation guidelines. You can install it from the Moodle plugins directory or from a ZIP file.

=== Install from the Moodle plugins directory ===

# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Search for '''FastPix video embeds''' and follow the prompts.

=== Install from a ZIP file ===

# Download the latest release from the [https://github.com/FastPix/moodle-filter_fastpix/releases GitHub releases page].
# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Drag the ZIP onto the drop zone, or select '''Choose a file''' to upload it. Do not unzip the file first; Moodle installs the package directly from the ZIP.
# Select '''Install plugin from the ZIP file''', then continue through the validation screen.
# On the '''Plugins requiring attention''' screen, select '''Upgrade Moodle database now'''.
# When the upgrade finishes, select '''Continue'''.

More information on how to install a plugin can be found [[Installing plugins|here]].

== Enabling and ordering the filter ==

Filters are inactive until you switch them on.

# Go to '''Site administration -> Plugins -> Filters -> Manage filters'''.
# Find '''FastPix video embeds''' in the list.
# In the '''Active?''' column, select '''On'''.
# Use the up arrow to place '''FastPix video embeds''' above the '''Multimedia plugins''' filter.

The ordering matters because some HTML-rewriting filters can transform the short code before filter_fastpix reaches it, which breaks the match. Running FastPix first guarantees the short code is recognised.

== Adding a video to a page ==

After the filter is enabled, you can embed a video by inserting a short code into any rich-text field. Both methods produce the same result.

=== Using the editor button ===

If the ''tiny_fastpix'' editor plugin is installed, the toolbar shows an '''Insert FastPix video''' button.

# Place your cursor where you want the video.
# Select '''Insert FastPix video'''.
# Pick a video from the picker. Videos are listed by name.
# Save the form. When the page is viewed, the filter renders the player in place of the short code.

=== Pasting a short code ===

# In the FastPix Dashboard, open the video and copy its '''playback ID'''.
# In your Moodle rich-text editor, type or paste the short code, replacing the placeholder with the value you copied:
#: <code>{fastpix:pb_YOUR_PLAYBACK_ID}</code>
# Save the form. When the page is viewed, the filter renders the player in place of the short code.

For example:

<pre>{fastpix:pb_a1c229cb-fb6f-41b1-b4cd-d676585077d5}</pre>

The short code has three parts:

{| class="wikitable"
! Part !! Meaning
|-
| <code>{fastpix: ... }</code> || Marks the text as a FastPix short code.
|-
| <code>pb_</code> || Declares that what follows is a playback ID.
|-
| YOUR_PLAYBACK_ID || The video's playback ID. Letters, digits, hyphens, and underscores.
|}

You can put as many short codes as you want on a single page. Each one becomes its own player, and the surrounding text is left untouched.

== Verifying the embed works ==

# Save the page or post that contains your short code.
# Reload the page as a learner or other enrolled user. The short code should be replaced with a working video player.
# Select '''Play'''. The video should stream from FastPix.

== What each viewer sees ==

The filter renders a different result depending on the viewer's permissions and the state of the video.

{| class="wikitable"
! Situation !! What the viewer sees
|-
| Viewer has <code>mod/fastpix:view</code> and the video is public and ready || The video player.
|-
| Viewer does not have <code>mod/fastpix:view</code> || The plain short-code text (no player, no error).
|-
| Video not found (wrong ID, deleted, or different FastPix account) || "This video is unavailable."
|-
| Video still processing || "This video is unavailable." The player appears automatically when processing finishes.
|-
| Video is private (non-DRM) || A notice pointing the viewer to the FastPix activity that hosts the video.
|-
| Video is DRM-protected || A notice pointing the viewer to the FastPix activity that hosts the video.
|}

The capability check runs per short code, in the place where the text appears.

== Limitations ==

The filter is intentionally narrow — it handles casual embedding, while the activity plugin handles graded viewing. The filter does not:

* '''Embed private or DRM videos.''' Both require short-lived playback tokens refreshed during the session, and a forum post or course summary has no session bound to it. Use the FastPix activity instead.
* '''Track viewing.''' Watch progress, completion, and grades are not recorded for embedded videos.
* '''Upload videos.''' The filter only renders videos that already exist in FastPix.

== Filter ordering with other filters ==

Several Moodle filters rewrite content as it renders. Place '''FastPix video embeds''' above any filter that touches HTML, so FastPix can match its short code before the text is rewritten. The recommended order, from highest to lowest:

<pre>
FastPix video embeds <- place here
Multimedia plugins
Activity names auto-linking
...
</pre>

If you have already enabled the filter but short codes appear as plain text instead of players, the most common cause is filter ordering. Confirm that '''FastPix video embeds''' sits above '''Multimedia plugins'''.

== Privacy ==

The plugin stores no personal data. It declares a ''null_provider'' under Moodle's Privacy API and delegates all video operations to local_fastpix. For full privacy details, see the [[local_fastpix#Privacy|local_fastpix privacy section]].

== Troubleshooting ==

# '''The short code appears as plain text instead of a player.''' Confirm the filter is '''On''', sits above '''Multimedia plugins''', the short code is well-formed (<code>{fastpix:pb_<id>}</code> with no spaces inside the braces), and the field is not '''Plain text''' format.
# '''The player loads but shows "This video is unavailable".''' The playback ID cannot be resolved. Re-copy it from the Dashboard, confirm the video was not deleted, or wait for processing to finish.
# '''The player loads but shows a "watch in FastPix activity" notice.''' The video is private or DRM-protected, so the filter cannot embed it. Open the FastPix activity that hosts it, or change the video's access policy to '''Public''' if it does not need protection.
# '''Some viewers see a player and others see the short code.''' This is expected. The filter checks <code>mod/fastpix:view</code> per short code. Grant the capability if appropriate.
# '''The player is a blank box.''' Usually a transient asset-loading issue — reload the page. If it persists, confirm the page is served over HTTPS (the player needs a secure context).

== See also ==

* [[local_fastpix]] - foundation plugin (required)
* [[mod_fastpix]] - graded FastPix Video activity
* [https://github.com/FastPix/moodle-filter_fastpix Source code on GitHub]
* [https://github.com/FastPix/moodle-filter_fastpix/blob/main/CHANGELOG.md Release notes]

[[Category:Plugins]]
[[Category:Filters]]
[[Category:Plugin documentation]]

mod fastpix

2026-06-24T08:52:29Z

Fastpix-devs: Created page with "{{DISPLAYTITLE:mod_fastpix — FastPix Video activity}} {{FastPix}} {{Infobox plugin |type = Activity module |entry = https://moodle.org/plugins/mod_fastpix |tracker = https://github.com/FastPix/moodle-mod_fastpix/issues |discussion = https://github.com/FastPix/moodle-mod_fastpix/discussions |maintainer = Tharun Budidha (FastPix Inc) }} The '''mod_fastpix''' plugin adds a '''FastPix Video''' activity type to Moodle. Teachers can upload a video or..."

{{DISPLAYTITLE:mod_fastpix — FastPix Video activity}}
{{FastPix}}
{{Infobox plugin
|type = Activity module
|entry = https://moodle.org/plugins/mod_fastpix
|tracker = https://github.com/FastPix/moodle-mod_fastpix/issues
|discussion = https://github.com/FastPix/moodle-mod_fastpix/discussions
|maintainer = [[User:Tharun Budidha|Tharun Budidha]] (FastPix Inc)
}}

The '''mod_fastpix''' plugin adds a '''FastPix Video''' activity type to Moodle. Teachers can upload a video or pull one from a URL directly from a course, set a completion threshold based on how much of the video a learner has watched, and have Moodle write the grade automatically when the threshold is met.

It is a consumer plugin built on [[local_fastpix]], which owns the FastPix credentials, the HTTP gateway, the asset cache, webhook ingestion, and playback-token signing. mod_fastpix never talks to FastPix directly — every video operation goes through local_fastpix. It provides the activity edit form, the player view, the watch tracker, the fraud checks, completion handling, gradebook integration, and backup and restore.

== Requirements ==

Before you begin, make sure you have:

* A Moodle site running version 4.5 LTS or later.
* PHP 8.1 or later (tested through PHP 8.3).
* Site administrator access (to install) and editing-teacher access (to add activities).
* [[local_fastpix]] 1.0.0 or later, installed and connected to a FastPix account. The '''Test connection''' button on the FastPix settings page must return a green ''Authenticated'' result.
* A short test video (MP4, under 100 MB) for verification.

:: '''Note:''' mod_fastpix cannot be installed standalone. Moodle blocks the install with a dependency error until local_fastpix is present. If you have not set up the foundation plugin yet, see [[local_fastpix]] first. The plugin has no runtime Composer dependencies.

== Installation ==

The plugin follows standard Moodle installation guidelines. You can install it from the Moodle plugins directory or from a ZIP file.

=== Install from the Moodle plugins directory ===

# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Search for '''FastPix Video''' and follow the prompts.

=== Install from a ZIP file ===

# Download the latest release from the [https://github.com/FastPix/moodle-mod_fastpix/releases GitHub releases page].
# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Drag the ZIP onto the drop zone, or select '''Choose a file''' to upload it. Do not unzip the file first; Moodle installs the package directly from the ZIP.
# Select '''Install plugin from the ZIP file''', then continue through the validation screen.
# On the '''Plugins requiring attention''' screen, select '''Upgrade Moodle database now'''.
# When the upgrade finishes, select '''Continue'''.

To confirm the install, go to '''Site administration -> Plugins -> Activity modules -> Manage activities'''. '''FastPix Video''' appears in the list. More information on how to install a plugin can be found [[Installing plugins|here]].

== Adding a video activity ==

Teachers add videos directly from a course; no admin involvement is needed once local_fastpix is connected.

# Open a course and turn '''Edit mode''' on.
# Select '''Add an activity or resource''', then '''FastPix Video'''. It appears under the '''Assessment''' group, because the activity supports completion and writes a grade.
# Enter a '''Name''' and an optional '''Description'''.
# Set the access policy and captions in '''Media settings'''.
# Add the video in the '''Video source''' section.
# Set the playback, completion, and grade options.
# Select '''Save and display'''.

:: '''Important:''' The video is uploaded to FastPix when you save the activity, not while you are still filling in the form. If you choose a file and then leave without saving, nothing is uploaded.

=== Media settings ===

Choose how the video is protected and captioned before you add it. These choices are applied when the video is uploaded to FastPix.

* '''Access policy''' — ''Private'' (default, recommended): only signed-in learners can play. ''Public'': anyone with the link can play. ''DRM'': encrypted playback on licensed devices, selectable only when local_fastpix has DRM configured.
* '''Captions & transcript''' — off by default. When enabled, either auto-generate (FastPix transcribes the audio in the chosen language; subtitles match the spoken language and are not translated) or upload your own WebVTT (.vtt) file.

=== Adding the video ===

You can add a video by uploading a file or by pulling one from a URL.

* '''Upload a video.''' Drag a file onto the drop zone in '''Video source'''. The upload runs in resumable chunks with a live progress bar, so large files survive a flaky connection. Uploading requires the <code>mod/fastpix:uploadmedia</code> capability, which editing teachers hold by default.
* '''Pull from a URL.''' Paste a direct video URL into the '''Video URL''' field and select '''Upload'''; FastPix fetches the file. local_fastpix includes an SSRF guard that rejects malformed or unreachable URLs.

=== Playback options ===

{| class="wikitable"
! Setting !! Effect
|-
| Disable seeking || Blocks forward seeks during playback, so learners watch through. Backward seeks are still allowed.
|-
| Show captions by default || Turns captions on when the player loads. Learners can still toggle them off.
|}

=== Completion and grading ===

Completion and grading work through Moodle's standard activity-completion and grade APIs. The activity adds one custom completion condition.

# In the '''Activity completion''' section, set '''Completion tracking''' to '''Show activity as complete when conditions are met'''.
# Select '''Students must watch the video''' and enter a percentage (the default is 90%).
# In the '''Grade''' section, set the maximum grade (the default is 100).

When a learner crosses the threshold, Moodle marks the activity complete and writes the grade once, at the maximum. Watching past the threshold does not rewrite the grade.

:: '''Note:''' Completion is based on ''coverage'' — the unique seconds a learner actually watched, merged and deduplicated — not on the position of the playhead. Dragging the timeline to the end does not complete the activity, and rewatching the same minute counts only once.

== Verifying your installation ==

After you save the activity, run these checks to confirm that the integration is healthy.

# From the course, open the activity you just created. You should see a '''Preparing your video''' card. It swaps to the player automatically when the video is ready, usually within a minute.
# Switch to a learner view through '''Switch role to -> Student''', or sign in as a test student in a different browser.
# Open the activity and play past the completion threshold. The activity should be marked complete.
# Open '''Grades''' for the course and confirm that the test student has a grade for the activity.

== How playback and completion work ==

Learners see a modern adaptive player that works across browsers, mobile, and slow networks, with a progress indicator and a '''Completed''' marker after the threshold is met. Watch progress is saved server-side every 10 seconds and on tab close, so the video resumes where the learner left off on any device. A freshly uploaded video shows a '''Preparing your video''' card until processing finishes.

Coverage drives completion: it only ever grows, rewinding does not change it, and seeking forward past unwatched content does not count those seconds.

== Fraud prevention ==

Each watch-progress callback runs six server-side checks. A failed check does not silently block the learner; it increments a per-attempt fraud counter and records a typed reason.

# Watched time cannot exceed the video duration.
# Watched time cannot exceed wall-clock time since the session started, with a 10-second tolerance.
# Coverage cannot decrease.
# A single callback's gain cannot exceed the elapsed time, with a 10-second tolerance.
# The learner's view capability is re-verified on every callback.
# On activities with '''Disable seeking''' enabled, the server rejects any forward seek.

When the per-attempt fraud counter passes 20, a badge appears on the learner's attempt, visible to anyone with the <code>mod/fastpix:viewallattempts</code> capability. Any correction is a human decision, made with <code>mod/fastpix:graderoverride</code>.

== Watch report ==

Teachers with the <code>mod/fastpix:viewallattempts</code> capability can open a read-only '''Watch report''' tab on any FastPix Video activity. It surfaces already-recorded watch data with no extra tracking and no calls to FastPix.

* '''Per-video view''' — unique viewers, average watched percentage, completion rate, the biggest drop-off point, an engagement curve, and a per-student table.
* '''Per-user view''' — a single learner's engagement across every FastPix Video activity in the course.

Both views can be exported to CSV.

== Backup and restore ==

The plugin supports Moodle's standard course backup and restore. A backup captures the activity settings and the per-user attempt rows, and preserves the asset reference. It does not capture the video bytes, which stay on FastPix.

* Restoring onto the same Moodle site, pointing at the same FastPix account, plays normally.
* Restoring onto a site that points at a different FastPix account shows '''Video unavailable''', because the asset does not exist in the new account. This is expected behaviour, not a bug.

Deleting an activity, including through the recycle bin, soft-deletes the underlying asset through local_fastpix.

== Privacy ==

The plugin includes a full Moodle Privacy API provider declaring every personal-data column in the attempt table — watch progress, seek count, fraud count, completion state, and session timestamps. GDPR export and per-user delete requests are handled from Moodle's standard data-request UI. For full details, go to '''Site administration -> Users -> Privacy and policies -> Data registry'''.

== Troubleshooting ==

# '''The video stays on "Preparing your video".''' The asset is not ready yet. Confirm Moodle cron is running and that the local_fastpix webhook is registered with its signing secret saved.
# '''The player is a blank box.''' Usually a transient asset-loading issue — reload the page. If it persists, confirm the page is served over HTTPS (DRM playback requires a secure context).
# '''A video shows "Video unavailable".''' The course was restored onto a site pointing at a different FastPix account, or the asset was deleted on the FastPix side.
# '''Seek buttons still appear after enabling "Disable seeking".''' Save the activity again, reload the player, and purge caches at '''Site administration -> Development -> Purge caches'''.
# '''The completion condition does not appear.''' Set '''Completion tracking''' to '''Show activity as complete when conditions are met''', and confirm completion is enabled at both site and course level.
# '''Private videos do not play, but public ones do.''' The issue is on the foundation-plugin side. Confirm local_fastpix has minted its signing key and that the asset carries a playback ID.

== See also ==

* [[local_fastpix]] - foundation plugin (required)
* [[filter_fastpix]] - short-code video embeds
* [https://github.com/FastPix/moodle-mod_fastpix Source code on GitHub]
* [https://github.com/FastPix/moodle-mod_fastpix/blob/main/CHANGELOG.md Release notes]

[[Category:Plugins]]
[[Category:Activity modules]]
[[Category:Plugin documentation]]

local fastpix

2026-06-24T08:44:07Z

Fastpix-devs: Created page with "{{DISPLAYTITLE:local_fastpix — FastPix for Moodle}} {{FastPix}} {{Infobox plugin |type = Local plugin |entry = https://moodle.org/plugins/local_fastpix |tracker = https://github.com/FastPix/moodle-local_fastpix/issues |discussion = https://github.com/FastPix/moodle-local_fastpix/discussions |maintainer = Tharun Budidha (FastPix Inc) }} The '''local_fastpix''' plugin connects a Moodle site to [https://www.fastpix.com FastPix] for video hosting a..."

{{DISPLAYTITLE:local_fastpix — FastPix for Moodle}}
{{FastPix}}
{{Infobox plugin
|type = Local plugin
|entry = https://moodle.org/plugins/local_fastpix
|tracker = https://github.com/FastPix/moodle-local_fastpix/issues
|discussion = https://github.com/FastPix/moodle-local_fastpix/discussions
|maintainer = [[User:Tharun Budidha|Tharun Budidha]] (FastPix Inc)
}}

The '''local_fastpix''' plugin connects a Moodle site to [https://www.fastpix.com FastPix] for video hosting and delivery. It is a foundation plugin: it provides the shared HTTP gateway, asset cache, webhook ingestion, and playback-token signing that the other FastPix plugins rely on. On its own it ships an admin settings page, a webhook endpoint, and a health-check probe, and it adds no teacher- or learner-facing features by itself.

The consumer plugins that build on it are [[mod_fastpix]] (the FastPix Video activity) and [[filter_fastpix]] (short-code video embeds).

== Requirements ==

Before you begin, make sure you have:

* A Moodle site running version 4.5 LTS or later.
* PHP 8.1 or later (tested through PHP 8.3).
* Site administrator access to your Moodle dashboard.
* A FastPix account. If you do not have one, [https://dashboard.fastpix.com/signup sign up].
* A shared Moodle Universal Cache (MUC) backend — Redis, Memcached, or the file store on a single-server install.

The gateway circuit breaker and rate limiter rely on cache state shared across all PHP workers, so a shared MUC backend is required. The plugin bundles ''firebase/php-jwt'' (BSD-3-Clause) and has no runtime Composer dependencies.

== Getting your FastPix API credentials ==

To connect Moodle to your FastPix account, generate API credentials in the FastPix Dashboard:

# Sign in to your [https://dashboard.fastpix.com FastPix Dashboard].
# Go to '''Settings -> API Keys'''.
# Create a new key and give it a recognisable name, such as ''Moodle production''.
# Copy the '''API Key''' and the '''API Secret'''.

:: '''Important:''' FastPix shows the API Secret only once. If you leave the page without copying it, you have to create a new key.

== Installation ==

The plugin follows standard Moodle installation guidelines. You can install it from the Moodle plugins directory or from a ZIP file.

=== Install from the Moodle plugins directory ===

# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Search for ''FastPix'' and follow the prompts.

=== Install from a ZIP file ===

# Download the latest release from the [https://github.com/FastPix/moodle-local_fastpix/releases GitHub releases page].
# Sign in to Moodle as a site administrator.
# Go to '''Site administration -> Plugins -> Install plugins'''.
# Drag the ZIP onto the drop zone, or select '''Choose a file''' to upload it. Do not unzip the file first; Moodle installs the package directly from the ZIP.
# Select '''Install plugin from the ZIP file''', then continue through the validation screen.
# On the '''Plugins requiring attention''' screen, select '''Upgrade Moodle database now'''.
# When the upgrade finishes, select '''Continue'''.

More information on how to install a plugin can be found [[Installing plugins|here]].

== Connecting the plugin to FastPix ==

After you install the plugin and have your API credentials, open the settings page at '''Site administration -> Server -> FastPix''':

# In the '''API credentials''' section, paste your '''API Key''' and '''API Secret'''.
# Select '''Save changes'''.
# Select '''Test connection'''. A green check and an ''Authenticated'' message confirm that Moodle can authenticate with FastPix.

:: '''Important:''' The '''Test connection''' and '''Send test event''' buttons act on the ''saved'' settings, not on the values currently typed into the fields. Always select '''Save changes''' first.

Moodle stores the API Secret in the ''config_plugins'' table using the standard masked-password field. The browser hides the value, but the database does not encrypt it, so protect your database and backups accordingly.

== Settings ==

=== Upload defaults ===

These values are applied to every newly ingested video. Both are optional, and consumer plugins can override them per activity.

{| class="wikitable"
! Setting !! Values
|-
| Default access policy || ''public'' (no authentication), ''private'' (signed-token playback, the default), or ''drm'' (requires DRM configuration).
|-
| Default maximum resolution || Up to 1080p (the default).
|}

To enable DRM, select '''Enable DRM''' and paste your FastPix '''DRM Configuration ID''' into the matching field. If either is missing, DRM stays off. DRM adds cost on FastPix, so enable it only for content that needs Widevine or FairPlay protection.

=== Retention and cleanup ===

These settings control how long the plugin keeps abandoned uploads and unattached videos before sweeping them. The defaults are safe; adjust them only if your site has specific retention needs.

{| class="wikitable"
! Setting !! Description !! Default
|-
| Stale upload-session lifetime || How long an upload session that never became a video is kept before it is cancelled and removed. || 1 day
|-
| Unattached video grace period || How long a ready video may stay unattached to any activity before it is released and soft-deleted. || 1 week
|-
| Unattached video warning lead time || How long before release the owner is warned. Must be less than the grace period. || 2 days
|-
| Automatically remove unattached videos || When enabled, ready videos with no activity reference are soft-deleted, then purged. When disabled, owners are only notified. || Disabled
|}

:: '''Important:''' Keep '''Automatically remove unattached videos''' disabled until the FastPix filter and editor plugins report video usage. Otherwise a video embedded through one of those plugins could be removed while still in use.

== Registering the webhook ==

FastPix uses webhooks to tell Moodle when an upload finishes processing and when assets change. The webhook URL is fixed; the signing secret is generated by FastPix and pasted into Moodle so that Moodle can verify each event's signature.

# On the Moodle settings page, in the '''Webhooks''' section, select '''Copy''' next to the '''Webhook URL'''. The URL looks like <code>https://your.moodle.example/local/fastpix/webhook.php</code>.
# In the FastPix Dashboard, go to '''Webhooks''', add a new destination, and paste the URL.
# Subscribe the destination to at least the following events:
## <code>video.media.created</code>
## <code>video.media.ready</code>
## <code>video.media.updated</code>
## <code>video.media.failed</code>
## <code>video.media.deleted</code>
# Copy the '''signing secret''' that FastPix shows for the destination.
# Back on the Moodle settings page, paste the secret into '''Webhook signing secret''', then select '''Save changes'''.

:: '''Note:''' The secret must be at least 32 characters; FastPix generates 64-character secrets by default. Until a secret is saved, Moodle rejects all incoming events. When you rotate the secret later, Moodle continues to accept the previous value for 30 minutes, so you can update both sides without losing deliveries.

== Verifying your installation ==

After you configure the plugin, run these three checks to confirm that the integration is healthy.

=== Test the connection ===

On the settings page, select '''Test connection'''. A green check and an ''Authenticated'' message confirm success. If the test fails, Moodle shows a descriptive error; re-check your API Key and Secret, save, and try again.

=== Verify the webhook handshake ===

Select '''Send test event'''. This drives the full verify-record-enqueue pipeline without leaving Moodle. To confirm the event was ingested, go to '''Site administration -> Reports -> Logs''' and filter by the component ''local_fastpix''. If the same event arrives twice, the plugin silently ignores the duplicate.

=== Verify the scheduled tasks ===

Go to '''Site administration -> Server -> Scheduled tasks''' and confirm that the FastPix tasks are present and enabled with their default schedules. They run on Moodle's standard cron; no separate infrastructure is required.

== Monitoring the integration ==

The plugin exposes a public health-check endpoint for monitoring tools such as Pingdom, UptimeRobot, or a Prometheus blackbox exporter:

<pre>https://your.moodle.example/local/fastpix/health.php</pre>

The endpoint requires no authentication and is rate-limited to 30 requests per minute per IP address. It makes an authenticated check against FastPix and never returns a 500; every server-side problem surfaces as a 503. The response is JSON with ''status'', ''fastpix_reachable'', ''latency_ms'', and ''timestamp'' fields.

{| class="wikitable"
! Code !! status !! Meaning !! What to do
|-
| 200 || ok || Moodle reached FastPix and got an authenticated response. || Nothing. Treat this as "up".
|-
| 503 || degraded || The probe ran, but FastPix did not respond successfully. || Use '''Test connection''' to see the underlying error.
|-
| 503 || error || Something inside Moodle threw before the probe completed. || Usually the MUC cache backend is unreachable; confirm your shared cache is up.
|-
| 429 || rate_limited || More than 30 requests per minute from one IP. || Poll every 30-60 seconds, or spread checks across sources.
|}

A ''degraded'' response can mean FastPix is down or slow, the network path is blocked, or the API credentials are wrong or revoked. To tell these apart, select '''Test connection''' on the settings page; unlike the health endpoint, it surfaces the underlying error message.

== Scheduled tasks ==

The plugin registers the following scheduled tasks. All run on Moodle's standard cron and are enabled by default. To adjust the schedules, go to '''Site administration -> Server -> Scheduled tasks'''.

{| class="wikitable"
! Task !! Purpose !! Default schedule
|-
| Sweep expired upload sessions || Clears upload sessions that were never completed. || Daily, 03:17
|-
| Prune old processed webhook events || Trims the webhook ledger after a 90-day window. || Daily, 04:23
|-
| Hard-delete soft-deleted assets || Removes asset rows past the GDPR retention window. || Daily, 04:47
|-
| Retry pending GDPR deletions || Re-attempts remote deletions that previously failed. || Every 15 minutes
|-
| Hard-purge soft-deleted assets || Permanently purges assets after the 7-day grace window. || Daily, 02:30
|-
| Rotate JWT signing key || Rotates the playback signing key every 90 days. || Daily, 05:11
|}

== Privacy ==

The plugin includes a full Moodle Privacy API provider. It never sends raw Moodle user IDs to FastPix; instead, it sends a site-specific HMAC value. The webhook ledger is pruned after 90 days, and soft-deleted assets are permanently purged after a 7-day grace window. GDPR export and per-asset delete requests are handled on the Moodle side. For full details, go to '''Site administration -> Users -> Privacy and policies -> Data registry'''.

== Troubleshooting ==

# '''Test connection fails.''' Confirm the API Key and Secret are correct and not revoked, confirm Moodle can reach the FastPix API outbound, and save your changes before testing.
# '''Webhook returns 401.''' The signing secret in Moodle does not match FastPix. Re-copy the secret (watching for trailing whitespace), paste it in, and save. A freshly rotated secret keeps the old value working for 30 minutes.
# '''Webhook returns 400.''' Usually an unrecognised validation-probe body. Make sure you are on plugin version 2026051201 or later.
# '''Private videos do not play, but public ones do.''' The RS256 signing key has not been minted yet. It is created on first need - save valid credentials and load a private asset to trigger it.
# '''Videos show "Video unavailable".''' Expected if a course was restored onto a site pointing at a different FastPix account; the asset IDs do not exist in the new account.
# '''Scheduled tasks are not running.''' Confirm Moodle cron is configured and running.
# '''Moodle is slow or unresponsive.''' Confirm a shared MUC backend (Redis, Memcached, or the file store) is configured.

== See also ==

* [[mod_fastpix]] - FastPix Video activity
* [[filter_fastpix]] - FastPix video embeds
* [https://github.com/FastPix/moodle-local_fastpix Source code on GitHub]
* [https://www.fastpix.com/technical-support FastPix support]

[[Category:Plugins]]
[[Category:Local plugins]]
[[Category:Plugin documentation]]

Template:FastPix

2026-06-24T05:51:48Z

Fastpix-devs: Create FastPix navigation template for plugin docs

<div style="float:right; clear:right; margin:0 0 1em 1em; padding:0.6em 0.9em; border:1px solid #ccc; background:#f7f7f7; border-radius:4px; width:18em; font-size:0.9em;">
'''[[local_fastpix|FastPix for Moodle]]'''
----
'''Plugins'''
* [[local_fastpix]] — foundation plugin
* [[mod_fastpix]] — FastPix Video activity
* [[filter_fastpix]] — video embeds filter
----
'''Resources'''
* [https://moodle.org/plugins/local_fastpix Plugins directory]
* [https://github.com/FastPix Source on GitHub]
* [https://docs.fastpix.io FastPix documentation]
* [https://www.fastpix.com/technical-support Support]
</div><noinclude>
This is the shared navigation template for the FastPix Moodle plugin documentation pages. Include it at the top of a plugin page with <code><nowiki>{{FastPix}}</nowiki></code>.

[[Category:Templates]]
[[Category:Plugin documentation]]
</noinclude>