diff --git a/.github/workflows/moodle-ci.yml b/.github/workflows/moodle-ci.yml new file mode 100644 index 0000000..eb52915 --- /dev/null +++ b/.github/workflows/moodle-ci.yml @@ -0,0 +1,111 @@ +name: Moodle Plugin CI + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-22.04 + + services: + postgres: + image: postgres:13 + env: + POSTGRES_USER: 'postgres' + POSTGRES_HOST_AUTH_METHOD: 'trust' + ports: + - 5432:5432 + options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3 + mariadb: + image: mariadb:10 + env: + MYSQL_USER: 'root' + MYSQL_ALLOW_EMPTY_PASSWORD: "true" + MYSQL_CHARACTER_SET_SERVER: "utf8mb4" + MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci" + + ports: + - 3306:3306 + options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3 + + strategy: + fail-fast: false + matrix: + php: ['7.3', '7.4', '8.0'] + moodle-branch: ['master', 'MOODLE_401_STABLE', 'MOODLE_400_STABLE','MOODLE_311_STABLE', 'MOODLE_310_STABLE', 'MOODLE_39_STABLE'] + database: [pgsql, mariadb] + + steps: + - name: Check out repository code + uses: actions/checkout@v3 + with: + path: plugin + + - name: Setup PHP ${{ matrix.php }} + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: ${{ matrix.extensions }} + ini-values: max_input_vars=5000 + # none to use phpdbg fallback. Specify pcov (Moodle 3.10 and up) or xdebug to use them instead. + coverage: none + + - name: Initialise moodle-plugin-ci + run: | + composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3 + echo $(cd ci/bin; pwd) >> $GITHUB_PATH + echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH + sudo locale-gen en_AU.UTF-8 + echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV + - name: Install moodle-plugin-ci + run: | + moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1 + env: + DB: ${{ matrix.database }} + MOODLE_BRANCH: ${{ matrix.moodle-branch }} + + - name: PHP Lint + if: ${{ always() }} + run: moodle-plugin-ci phplint + + - name: PHP Copy/Paste Detector + continue-on-error: true # This step will show errors but will not fail + if: ${{ always() }} + run: moodle-plugin-ci phpcpd + + - name: PHP Mess Detector + continue-on-error: true # This step will show errors but will not fail + if: ${{ always() }} + run: moodle-plugin-ci phpmd + + - name: Moodle Code Checker + if: ${{ always() }} + run: moodle-plugin-ci codechecker --max-warnings 0 + + - name: Moodle PHPDoc Checker + if: ${{ always() }} + run: moodle-plugin-ci phpdoc + + - name: Validating + if: ${{ always() }} + run: moodle-plugin-ci validate + + - name: Check upgrade savepoints + if: ${{ always() }} + run: moodle-plugin-ci savepoints + + - name: Mustache Lint + if: ${{ always() }} + run: moodle-plugin-ci mustache + + - name: Grunt + if: ${{ always() }} + run: moodle-plugin-ci grunt --max-lint-warnings 0 + + - name: PHPUnit tests + if: ${{ always() }} + run: moodle-plugin-ci phpunit --fail-on-warning + + - name: Behat features + continue-on-error: true # This step will show errors but will not fail + if: ${{ always() }} + run: moodle-plugin-ci behat --profile chrome diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..fd0c14f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,66 @@ +# +# Whenever a new tag starting with "v" is pushed, add the tagged version +# to the Moodle Plugins directory at https://moodle.org/plugins +# +# revision: 2021070201 +# +name: Releasing in the Plugins directory + +on: + push: + tags: + - V* + + workflow_dispatch: + inputs: + tag: + description: 'Tag to be released' + required: true + +defaults: + run: + shell: bash + +jobs: + release-at-moodle-org: + runs-on: ubuntu-latest + env: + PLUGIN: mod_vimeoactivity + CURL: curl -s + ENDPOINT: https://moodle.org/webservice/rest/server.php + TOKEN: ${{ secrets.MOODLE_ORG_TOKEN }} + FUNCTION: local_plugins_add_version + + steps: + - name: Call the service function + id: add-version + run: | + if [[ ! -z "${{ github.event.inputs.tag }}" ]]; then + TAGNAME="${{ github.event.inputs.tag }}" + elif [[ $GITHUB_REF = refs/tags/* ]]; then + TAGNAME="${GITHUB_REF##*/}" + fi + if [[ -z "${TAGNAME}" ]]; then + echo "No tag name has been provided!" + exit 1 + fi + ZIPURL="https://api.github.com/repos/${{ github.repository }}/zipball/${TAGNAME}" + RESPONSE=$(${CURL} ${ENDPOINT} --data-urlencode "wstoken=${TOKEN}" \ + --data-urlencode "wsfunction=${FUNCTION}" \ + --data-urlencode "moodlewsrestformat=json" \ + --data-urlencode "frankenstyle=${PLUGIN}" \ + --data-urlencode "zipurl=${ZIPURL}" \ + --data-urlencode "vcssystem=git" \ + --data-urlencode "vcsrepositoryurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \ + --data-urlencode "vcstag=${TAGNAME}" \ + --data-urlencode "changelogurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commits/${TAGNAME}" \ + --data-urlencode "altdownloadurl=${ZIPURL}") + echo "::set-output name=response::${RESPONSE}" + + - name: Evaluate the response + id: evaluate-response + env: + RESPONSE: ${{ steps.add-version.outputs.response }} + run: | + jq <<< ${RESPONSE} + jq --exit-status ".id" <<< ${RESPONSE} > /dev/null diff --git a/vimeoactivity/LICENSE.txt b/LICENSE.txt similarity index 100% rename from vimeoactivity/LICENSE.txt rename to LICENSE.txt diff --git a/backup/moodle2/backup_vimeoactivity_activity_task.class.php b/backup/moodle2/backup_vimeoactivity_activity_task.class.php new file mode 100644 index 0000000..5dab0c3 --- /dev/null +++ b/backup/moodle2/backup_vimeoactivity_activity_task.class.php @@ -0,0 +1,72 @@ +. + +/** + * The task that provides all the steps to perform a complete backup is defined here. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @category backup + */ + +defined('MOODLE_INTERNAL') || die(); + +// More information about the backup process: {@link https://docs.moodle.org/dev/Backup_API}. +// More information about the restore process: {@link https://docs.moodle.org/dev/Restore_API}. + +require_once($CFG->dirroot.'//mod/vimeoactivity/backup/moodle2/backup_vimeoactivity_stepslib.php'); + +/** + * Provides all the settings and steps to perform a complete backup of mod_vimeoactivity. + */ +class backup_vimeoactivity_activity_task extends backup_activity_task { + + /** + * Defines particular settings for the plugin. + */ + protected function define_my_settings() { + return; + } + + /** + * Defines particular steps for the backup process. + */ + protected function define_my_steps() { + $this->add_step(new backup_vimeoactivity_activity_structure_step('vimeoactivity_structure', 'vimeoactivity.xml')); + } + + /** + * Codes the transformations to perform in the activity in order to get transportable (encoded) links. + * + * @param string $content + * @return string + */ + public static function encode_content_links($content) { + global $CFG; + + $base = preg_quote($CFG->wwwroot, '/'); + + $search = "/(".$base."\/mod\/vimeoactivity\/index.php\?id\=)([0-9]+)/"; + $content = preg_replace($search, '$@vimeoactivityINDEX*$2@$', $content); + + $search = "/(".$base."\/mod\/vimeoactivity\/view.php\?id\=)([0-9]+)/"; + $content = preg_replace($search, '$@vimeoactivityVIEWBYID*$2@$', $content); + + return $content; + } +} diff --git a/backup/moodle2/backup_vimeoactivity_stepslib.php b/backup/moodle2/backup_vimeoactivity_stepslib.php new file mode 100644 index 0000000..1ab4c89 --- /dev/null +++ b/backup/moodle2/backup_vimeoactivity_stepslib.php @@ -0,0 +1,66 @@ +. + +/** + * Backup steps for mod_vimeoactivity are defined here. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @category backup + */ + +// More information about the backup process: {@link https://docs.moodle.org/dev/Backup_API}. +// More information about the restore process: {@link https://docs.moodle.org/dev/Restore_API}. + +/** + * Define the complete structure for backup, with file and id annotations. + */ +class backup_vimeoactivity_activity_structure_step extends backup_activity_structure_step { + + /** + * Defines the structure of the resulting xml file. + * + * @return backup_nested_element The structure wrapped by the common 'activity' element. + */ + protected function define_structure() { + + // Build the tree with these elements with $root as the root of the backup tree. + $vimeoactivity = new backup_nested_element('vimeoactivity', ['id'], [ + 'course', + 'name', + 'intro', + 'introformat', + 'video', + 'color', + 'autoplay', + 'autoloop', + 'popupopen', + 'popupwidth', + 'popupheight', + 'completionenable', + 'visible', + 'completionprogress', + 'timecreated', + 'timemodified']); + + // Define the source tables for the elements. + $vimeoactivity->set_source_table('vimeoactivity', ['id' => backup::VAR_ACTIVITYID]); + + return $this->prepare_activity_structure($vimeoactivity); + } +} diff --git a/backup/moodle2/restore_vimeoactivity_activity_task.class.php b/backup/moodle2/restore_vimeoactivity_activity_task.class.php new file mode 100644 index 0000000..30b4c6c --- /dev/null +++ b/backup/moodle2/restore_vimeoactivity_activity_task.class.php @@ -0,0 +1,89 @@ +. + +/** + * The task that provides a complete restore of mod_vimeoactivity is defined here. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @category backup + */ + +// More information about the backup process: {@link https://docs.moodle.org/dev/Backup_API}. +// More information about the restore process: {@link https://docs.moodle.org/dev/Restore_API}. + +/** + * Restore task for mod_vimeoactivity. + */ +class restore_vimeoactivity_activity_task extends restore_activity_task { + + /** + * Defines particular settings that this activity can have. + */ + protected function define_my_settings() { + return; + } + + /** + * Defines particular steps that this activity can have. + */ + protected function define_my_steps() { + $this->add_step(new restore_vimeoactivity_activity_structure_step('vimeoactivity_structure', 'vimeoactivity.xml')); + } + + /** + * Defines the contents in the activity that must be processed by the link decoder. + * + * @return array. + */ + public static function define_decode_contents() { + $contents = array(); + + // Define the contents. + + return $contents; + } + + /** + * Defines the decoding rules for links belonging to the activity to be executed by the link decoder. + * + * @return array. + */ + public static function define_decode_rules() { + $rules = array(); + + // Define the rules. + + return $rules; + } + + /** + * Defines the restore log rules that will be applied by the + * {@see restore_logs_processor} when restoring mod_vimeoactivity logs. It + * must return one array of {@see restore_log_rule} objects. + * + * @return array. + */ + public static function define_restore_log_rules() { + $rules = array(); + + // Define the rules. + + return $rules; + } +} diff --git a/backup/moodle2/restore_vimeoactivity_stepslib.php b/backup/moodle2/restore_vimeoactivity_stepslib.php new file mode 100644 index 0000000..d4af89e --- /dev/null +++ b/backup/moodle2/restore_vimeoactivity_stepslib.php @@ -0,0 +1,76 @@ +. + +/** + * All the steps to restore mod_vimeoactivity are defined here. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @category backup + */ + +// More information about the backup process: {@link https://docs.moodle.org/dev/Backup_API}. +// More information about the restore process: {@link https://docs.moodle.org/dev/Restore_API}. + +/** + * Defines the structure step to restore one mod_vimeoactivity activity. + */ +class restore_vimeoactivity_activity_structure_step extends restore_activity_structure_step { + + /** + * Defines the structure to be restored. + * + * @return restore_path_element[]. + */ + protected function define_structure() { + global $CFG; + + require_once($CFG->dirroot.'/mod/vimeoactivity/lib.php'); + + $paths = []; + $userinfo = $this->get_setting_value('userinfo'); + + $vimeoactivity = new restore_path_element('vimeoactivity', '/activity/vimeoactivity'); + $paths[] = $vimeoactivity; + + if ($userinfo) { + $paths[] = new restore_path_element('vimeoactivity_session', '/activity/vimeoactivity/sessions/session'); + } + + // Return the paths wrapped into standard activity structure. + return $this->prepare_activity_structure($paths); + } + + + /** + * Processes the elt restore data. + * + * @param array $data Parsed element data. + */ + protected function process_vimeoactivity($data) { + global $DB; + + $data = (object)$data; + $data->course = $this->get_courseid(); + + $newitemid = $DB->insert_record('vimeoactivity', $data); + + $this->apply_activity_instance($newitemid); + } + +} diff --git a/classes/analytics/indicator/activity_base.php b/classes/analytics/indicator/activity_base.php new file mode 100644 index 0000000..d020168 --- /dev/null +++ b/classes/analytics/indicator/activity_base.php @@ -0,0 +1,45 @@ +. + +/** + * Activity base class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_vimeoactivity\analytics\indicator; + +/** + * Activity base class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +abstract class activity_base extends \core_analytics\local\indicator\community_of_inquiry_activity { + + /** + * No need to fetch grades for resources. + * + * @param \core_analytics\course $course + * @return void + */ + public function fetch_student_grades(\core_analytics\course $course) { + } +} diff --git a/classes/analytics/indicator/cognitive_depth.php b/classes/analytics/indicator/cognitive_depth.php new file mode 100644 index 0000000..cc2e0d2 --- /dev/null +++ b/classes/analytics/indicator/cognitive_depth.php @@ -0,0 +1,66 @@ +. + +/** + * Cognitive depth indicator - vimeoactivity. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_vimeoactivity\analytics\indicator; + +/** + * Activity base class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class cognitive_depth extends activity_base { + + /** + * Returns the name. + * + * If there is a corresponding '_help' string this will be shown as well. + * + * @return \lang_string + */ + public static function get_name() : \lang_string { + return new \lang_string('indicator:cognitivedepth', 'mod_vimeoactivity'); + } + + /** + * Defines indicator type. + * + * @return string + */ + public function get_indicator_type() { + return self::INDICATOR_COGNITIVE; + } + + /** + * Returns the potential level of social breadth. + * + * @param \cm_info $cm + * @return int + */ + public function get_cognitive_depth_level(\cm_info $cm) { + return self::COGNITIVE_LEVEL_1; + } +} diff --git a/classes/analytics/indicator/social_breadth.php b/classes/analytics/indicator/social_breadth.php new file mode 100644 index 0000000..bb5074e --- /dev/null +++ b/classes/analytics/indicator/social_breadth.php @@ -0,0 +1,64 @@ +. + +/** + * Social breadth indicator - vimeoactivity. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_vimeoactivity\analytics\indicator; +/** + * Activity base class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class social_breadth extends activity_base { + + /** + * Returns the name. + * + * If there is a corresponding '_help' string this will be shown as well. + * + * @return \lang_string + */ + public static function get_name() : \lang_string { + return new \lang_string('indicator:socialbreadth', 'mod_vimeoactivity'); + } + /** + * Define indicator typr + * + * @return string + */ + public function get_indicator_type() { + return self::INDICATOR_SOCIAL; + } + /** + * Returns the potential level of social breadth. + * + * @param \cm_info $cm + * @return int + */ + public function get_social_breadth_level(\cm_info $cm) { + return self::SOCIAL_LEVEL_1; + } +} diff --git a/classes/completion/custom_completion.php b/classes/completion/custom_completion.php new file mode 100644 index 0000000..732350c --- /dev/null +++ b/classes/completion/custom_completion.php @@ -0,0 +1,107 @@ +. + +declare(strict_types=1); + +namespace mod_vimeoactivity\completion; + +use core_completion\activity_custom_completion; +use mod_vimeoactivity\util\watchprog; + +/** + * Activity custom completion subclass for the Assign Tutor activity. + * + * Class for defining mod_vimeoactivity's custom completion rules and fetching the completion statuses + * of the custom completion rules for a given instance and a user. + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class custom_completion extends activity_custom_completion { + + /** + * Fetches the completion state for a given completion rule. + * + * @param string $rule The completion rule. + * @return int The completion state. + */ + public function get_state(string $rule): int { + global $DB; + + $this->validate_rule($rule); + $videoid = $this->cm->instance; + + if (!$vimeoactivity = $DB->get_record('vimeoactivity', ['id' => $videoid])) { + throw new \moodle_exception('Unable to find video with id ' . $videoid); + } + + if ($rule == 'completionprogress') { + $requiredprogress = $vimeoactivity->completionprogress; + + $progutil = new watchprog(); + + $userhighprogress = $progutil->vimeoactivity_fetch_progress($this->userid, $videoid); + + if ($userhighprogress >= $requiredprogress) { + return COMPLETION_COMPLETE; + } + } + + return COMPLETION_INCOMPLETE; + } + + /** + * Fetch the list of custom completion rules that this module defines. + * + * @return array + */ + public static function get_defined_custom_rules(): array { + return ['completionprogress']; + } + + /** + * Returns an associative array of the descriptions of custom completion rules. + * + * @return array + */ + public function get_custom_rule_descriptions(): array { + global $DB; + + $videoid = $this->cm->instance; + + if (!$vimeoactivity = $DB->get_record('vimeoactivity', ['id' => $videoid])) { + throw new \moodle_exception('Unable to find vidoe with id ' . $videoid); + } + + return [ + 'completionprogress' => get_string('completionprogress_ruledesc', + 'mod_vimeoactivity', $vimeoactivity->completionprogress) + ]; + } + + /** + * Returns an array of all completion rules, in the order they should be displayed to users. + * + * @return array + */ + public function get_sort_order(): array { + return [ + 'completionview', + 'completionprogress' + ]; + } +} diff --git a/vimeoactivity/index.php b/classes/event/course_module_instance_list_viewed.php similarity index 55% rename from vimeoactivity/index.php rename to classes/event/course_module_instance_list_viewed.php index 1326d67..3e2edf1 100644 --- a/vimeoactivity/index.php +++ b/classes/event/course_module_instance_list_viewed.php @@ -15,14 +15,21 @@ // along with Moodle. If not, see . /** - * This file contains the required routines for this activity module. + * Record event of viewing instance list. * * @package mod_vimeoactivity - * @author Vignesh + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_vimeoactivity\event; - * @license http://www.gnu.org/copyleft/gpl.html +/** Class for inserting instance view record + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || exit(0); +class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed { -// Nothing to be done here! -exit(0); \ No newline at end of file +} diff --git a/classes/event/course_module_viewed.php b/classes/event/course_module_viewed.php new file mode 100644 index 0000000..bd73c0f --- /dev/null +++ b/classes/event/course_module_viewed.php @@ -0,0 +1,50 @@ +. + +namespace mod_vimeoactivity\event; + +/** + * The course_module_viewed event class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @category event + */ +class course_module_viewed extends \core\event\course_module_viewed { + /** + * Init method. + */ + protected function init() { + $this->data['crud'] = 'r'; + $this->data['edulevel'] = self::LEVEL_PARTICIPATING; + $this->data['objecttable'] = 'vimeoactivity'; + } + /** + * This is used when restoring course logs where it is required that we + * map the objectid to it's new value in the new course. + * Does nothing in the base class except display a debugging message warning + * the user that the event does not contain the required functionality to + * map this information. For events that do not store an objectid this won't + * be called, so no debugging message will be displayed. + * + * @return array + */ + public static function get_objectid_mapping() { + return array('db' => 'vimeoactivity', 'restore' => 'vimeoactivity'); + } +} diff --git a/classes/external/progress.php b/classes/external/progress.php new file mode 100644 index 0000000..15a53d2 --- /dev/null +++ b/classes/external/progress.php @@ -0,0 +1,99 @@ +. + +namespace mod_vimeoactivity\external; + +use completion_info; +use external_api; +use external_function_parameters; +use external_single_structure; +use external_value; +use mod_vimeoactivity\util\watchprog; + +defined('MOODLE_INTERNAL') || die(); + +global $USER, $config; +/** + * Completion external api class. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class progress extends external_api { + /** + * Complete parameters + * + * @return external_function_parameters + */ + public static function track_parameters() { + return new external_function_parameters([ + 'cmid' => new external_value(PARAM_INT, 'The course module id'), + 'progress' => new external_value(PARAM_INT, 'The progress'), + ]); + } + + /** + * Complete method + * + * @param int $cmid + * @param int $watchprog + * @return array + * + * @throws \coding_exception + * @throws \invalid_parameter_exception + * @throws \moodle_exception + */ + public static function track($cmid, $watchprog) { + global $DB, $USER, $CFG; + + // We always must pass webservice params through validate_parameters. + self::validate_parameters(self::track_parameters(), ['cmid' => $cmid, 'progress' => $watchprog]); + + list ($course, $cm) = get_course_and_cm_from_cmid($cmid, 'video'); + + $context = \context_course::instance($course->id); + + if (!is_enrolled($context)) { + return [ + 'status' => 'notenrolled' + ]; + } + + $progutil = new watchprog(); + $progutil->addprogress($cm->instance, $watchprog); + $completion = new completion_info($course); + $completion->update_state($cm, COMPLETION_COMPLETE); + + return [ + 'status' => 'ok' + ]; + } + + /** + * Complete return fields + * + * @return external_single_structure + */ + public static function track_returns() { + return new external_single_structure( + array( + 'status' => new external_value(PARAM_TEXT, 'Operation status') + ) + ); + } +} diff --git a/classes/util/watchprog.php b/classes/util/watchprog.php new file mode 100644 index 0000000..ad9912a --- /dev/null +++ b/classes/util/watchprog.php @@ -0,0 +1,180 @@ +. + +namespace mod_vimeoactivity\util; + +/** + * watchprogress class. + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class watchprog { + /** + * Adding progress in database + * + * @param int $videoid + * @param int $watchprog + * + * @return int + */ + public function addprogress($videoid, $watchprog) { + global $DB, $USER; + + $data = new \stdClass(); + $data->video = $videoid; + $data->user = $USER->id; + $data->progress = $watchprog; + $data->timecreated = time(); + + $id = $DB->insert_record('vimeoactivity_progress', $data); + + return $id; + } + /** + * [vimeoactivity_fetch_progress] + * + * @param integer $userid + * @param integer $videoid + * @return object|null + */ + public function vimeoactivity_fetch_progress($userid, $videoid) { + // Importing all the required global + // objects into this function scope. + global $DB; + + // Normalizing the supplied arguments and making + // sure they are within the required parameters. + $userid = max(0, (integer)$userid); + $videoid = max(0, (integer)$videoid); + $result = null; + + // Verifying if the supplied identifiers are valid + // (greater than zero) and, if not, there is no need + // to even touch the database and returning a null + // value as this function result. + if ($userid < 1 || $videoid < 1) { + return($result); + } + + // Compiling the required command to + // load this object from the database. + $sql = "SELECT id,". + "user,". + "video,". + "progress,". + "timecreated,". + "timemodified ". + "FROM {vimeoactivity_progress} ". + "WHERE user=? ". + "AND video=? ". + "LIMIT 1"; + + // Executing the required command to + // load this object from the database. + + if ($record = $DB->get_record_sql($sql, [$userid, $videoid])) { + // Normalizing the loaded object + // attributes and making sure they + // are within the required parameters. + $result = new \stdClass; + $result->id = max(0, (integer)$record->id); + $result->user = max(0, (integer)$record->user); + $result->video = max(0, (integer)$record->video); + $result->progress = max(0, (integer)$record->progress); + $result->timecreated = max(0, (integer)$record->timecreated); + $result->timemodified = max(0, (integer)$record->timemodified); + } + + // Returning the object loaded + // from the database, if any, + // as this function result. + return($result); + } + + /** + * [vimeoactivity_insert_progress] + * + * @param integer $userid + * @param integer $videoid + * @param integer $value + * @return boolean + */ + public function vimeoactivity_save_progress($userid, $videoid, $value) { + // Importing all the required global + // objects into this function scope. + global $DB; + + // Normalizing the supplied arguments and making + // sure they are within the required parameters. + $userid = max(0, (integer)$userid); + $videoid = max(0, (integer)$videoid); + $value = max(0, (integer)$value); + $created = time(); + + // Verifying if the supplied identifiers are valid + // (greater than zero) and, if not, there is no need + // to even touch the database and returning a false + // boolean value as this function result. + if ($userid < 1 || $videoid < 1) { + return(false); + } + + // Compiling the required command + // to persist the supplied object + // progress within the database. + if ($object = vimeoactivity_fetch_progress($userid, $videoid)) { + // Verifying if the supplied progress value is higher than + // what we have stored within the database, if true, store + // it, otherwise return false because it would make no sense + // to unsee the video, and it would mess up completion rules + // that depends on it. + if ($value > $object->progress) { + // Compiling the required command + // to update the supplied object + // within the database. + $values = ['id' => $object->id, + 'progress' => $value, + 'timemodified' => $created]; + + // Executing the required command + // to update the supplied object + // within the database. + return((boolean)$DB->update_record_raw('vimeoactivity_progress', $values)); + } + } else { + // Compiling the required command + // to update the supplied object + // within the database. + $values = ['user' => $userid, + 'video' => $videoid, + 'progress' => $value, + 'timecreated' => $created]; + + // Executing the required command + // to update the supplied object + // within the database. + return((boolean)$DB->insert_record_raw('vimeoactivity_progress', $values)); + } + + // Because we were unable to execute this operation + // successfully, returning a false boolean value as + // this function result. + return(false); + } + +} diff --git a/vimeoactivity/db/access.php b/db/access.php similarity index 91% rename from vimeoactivity/db/access.php rename to db/access.php index 17ce932..5b42706 100644 --- a/vimeoactivity/db/access.php +++ b/db/access.php @@ -19,8 +19,8 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); @@ -44,4 +44,4 @@ ), 'clonepermissionsfrom' => 'moodle/course:manageactivities' ), -); \ No newline at end of file +); diff --git a/vimeoactivity/db/install.php b/db/install.php similarity index 89% rename from vimeoactivity/db/install.php rename to db/install.php index b68c9cd..db58788 100644 --- a/vimeoactivity/db/install.php +++ b/db/install.php @@ -19,10 +19,9 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); /** * This function is responsible for executing the @@ -42,4 +41,4 @@ function xmldb_vimeoactivity_install() { */ function xmldb_vimeoactivity_install_recovery() { return(true); -} \ No newline at end of file +} diff --git a/vimeoactivity/db/install.xml b/db/install.xml similarity index 94% rename from vimeoactivity/db/install.xml rename to db/install.xml index 91eab85..f9aba32 100644 --- a/vimeoactivity/db/install.xml +++ b/db/install.xml @@ -7,9 +7,9 @@ - - - + + + @@ -17,7 +17,7 @@ - + diff --git a/db/services.php b/db/services.php new file mode 100644 index 0000000..9023da3 --- /dev/null +++ b/db/services.php @@ -0,0 +1,37 @@ +. + +/** + * Vimeo services definition + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +$functions = [ + 'mod_vimeoactivity_trackprogress' => [ + 'classname' => 'mod_vimeoactivity\external\progress', + 'classpath' => 'mod/vimeoactivity/classes/external/progress.php', + 'methodname' => 'track', + 'description' => 'Saves the tracked video progress', + 'type' => 'write', + 'ajax' => true + ] +]; diff --git a/vimeoactivity/db/uninstall.php b/db/uninstall.php similarity index 87% rename from vimeoactivity/db/uninstall.php rename to db/uninstall.php index f1d9c1d..ba87395 100644 --- a/vimeoactivity/db/uninstall.php +++ b/db/uninstall.php @@ -19,10 +19,9 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); /** * This function is responsible for executing the @@ -32,4 +31,4 @@ */ function xmldb_vimeoactivity_uninstall() { return(true); -} \ No newline at end of file +} diff --git a/vimeoactivity/db/upgrade.php b/db/upgrade.php similarity index 88% rename from vimeoactivity/db/upgrade.php rename to db/upgrade.php index af194e7..44e0fdb 100644 --- a/vimeoactivity/db/upgrade.php +++ b/db/upgrade.php @@ -19,10 +19,9 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); /** * This function is responsible for executing the @@ -37,4 +36,4 @@ function xmldb_vimeoactivity_upgrade($oldversion) { } else { return(true); } -} \ No newline at end of file +} diff --git a/index.php b/index.php new file mode 100644 index 0000000..8e4739a --- /dev/null +++ b/index.php @@ -0,0 +1,92 @@ +. + +/** + * This file contains the required routines for this activity module. + * + * @package mod_vimeoactivity + * @author Mohammad Farouk + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +require(__DIR__.'/../../config.php'); + +require_once(__DIR__.'/lib.php'); + +$id = required_param('id', PARAM_INT); +require_course_login($course, true); +$course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST); +require_course_login($course); + +$coursecontext = context_course::instance($course->id); + +$event = \mod_vimeoactivity\event\course_module_instance_list_viewed::create(array( + 'context' => $coursecontext +)); +$event->add_record_snapshot('course', $course); +$event->trigger(); + +$PAGE->set_url('/mod/vimeoactivity/index.php', array('id' => $id)); +$PAGE->set_title(format_string($course->fullname)); +$PAGE->set_heading(format_string($course->fullname)); +$PAGE->set_context($coursecontext); + +echo $OUTPUT->header(); + +$modulenameplural = get_string('modulenameplural', 'mod_vimeoactivity'); +echo $OUTPUT->heading($modulenameplural); + +$videos = get_all_instances_in_course('vimeoactivity', $course); + +if (empty($videos)) { + notice(get_string('no$vimeoactivityinstances', 'mod_vimeoactivity'), + new moodle_url('/course/view.php', array('id' => $course->id))); +} + +$table = new html_table(); +$table->attributes['class'] = 'generaltable mod_index'; + +if ($course->format == 'weeks') { + $table->head = array(get_string('week'), get_string('name')); + $table->align = array('center', 'left'); +} else if ($course->format == 'topics') { + $table->head = array(get_string('topic'), get_string('name')); + $table->align = array('center', 'left', 'left', 'left'); +} else if ($course->format == 'tiles') { + $table->head = array('Tile', get_string('name')); + $table->align = array('center', 'left', 'left', 'left'); +} else { + $table->head = array(get_string('name')); + $table->align = array('left', 'left', 'left'); +} + +foreach ($videos as $video) { + $link = (!$video->visible) ? html_writer::link( + new moodle_url('/mod/vimeoactivity/view.php', array('id' => $video->coursemodule)), + format_string($video->name, true), + array('class' => 'dimmed')) : html_writer::link( + new moodle_url('/mod/vimeoactivity/view.php', array('id' => $video->coursemodule)), + format_string($video->name, true)); + + if ($course->format == 'weeks' || $course->format == 'topics' || $course->format == 'tiles') { + $table->data[] = array($video->section, $link); + } else { + $table->data[] = array($link); + } +} + +echo html_writer::table($table); +echo $OUTPUT->footer(); diff --git a/vimeoactivity/lang/en/vimeoactivity.php b/lang/en/vimeoactivity.php similarity index 92% rename from vimeoactivity/lang/en/vimeoactivity.php rename to lang/en/vimeoactivity.php index f5416b7..83f4f65 100644 --- a/vimeoactivity/lang/en/vimeoactivity.php +++ b/lang/en/vimeoactivity.php @@ -19,8 +19,8 @@ * * @package mod_vimeoactivity * @author Vignesh - * @copyright BlackBean Technologies Ltda - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || exit(0); @@ -34,7 +34,9 @@ $string['modulenameplural'] = 'Vimeo Activity'; $string['moduleadministration'] = 'Vimeo Activity - Administration'; $string['vimeo:addinstance'] = 'Add instance'; -$string['vimeo'] = 'Vimeo Activity'; +$string['vimeoactivity:addinstance'] = 'add instance'; +$string['vimeoactivity:view'] = 'view'; +$string['vimeoactivity'] = 'Vimeo Activity'; $string['mod/vimeoactivity'] = 'Vimeo Activity'; $string['mod_vimeoactivity'] = 'Vimeo Activity'; $string['label_name'] = 'Name'; diff --git a/vimeoactivity/lib.php b/lib.php similarity index 92% rename from vimeoactivity/lib.php rename to lib.php index dc62582..463dd47 100644 --- a/vimeoactivity/lib.php +++ b/lib.php @@ -19,10 +19,9 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); /** * This function returns what @@ -41,6 +40,8 @@ function vimeoactivity_supports($feature) { return true; case FEATURE_COMPLETION_TRACKS_VIEWS: return true; + case FEATURE_BACKUP_MOODLE2: + return true; default: return false; } @@ -71,8 +72,10 @@ function vimeoactivity_get_coursemodule_info(stdclass $coursemodule) { if ($video->popupopen) { $video->popupwidth = ($video->popupwidth > 0) ? $video->popupwidth : 640; $video->popupheight = ($video->popupheight > 0) ? $video->popupheight : 360; - $info->onclick = "window.open('".$CFG->wwwroot."/mod/vimeoactivity/view.php?id=".$coursemodule->id."&popup=1','_blank',". - "'top=' + (window.top.outerHeight / 2 + window.top.screenY - ( ".$video->popupheight." / 2)) + ',". + $info->onclick = "window.open('".$CFG->wwwroot."/mod/vimeoactivity/view.php?id=". + $coursemodule->id."&popup=1','_blank',". + "'top=' + (window.top.outerHeight / 2 + window.top.screenY - ( ". + $video->popupheight." / 2)) + ',". "left=' + (window.top.outerWidth / 2 + window.top.screenX - ( ".$video->popupwidth." / 2)) + ',". "width=".$video->popupwidth.",height=".$video->popupheight.",toolbar=no,location=no,menubar=no,". "copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes'); return false;"; @@ -92,7 +95,7 @@ function vimeoactivity_get_coursemodule_info(stdclass $coursemodule) { // Because we were unable to execute // this operation successfully, returning // a null value as this function result. - return(null); + return new cached_cm_info(); } /** @@ -193,7 +196,7 @@ function vimeoactivity_delete_instance($id) { // Trying to delete the requested object // from the database and, if successful, // returning a true boolean as result. - if (vimeoactivity_delete_video($video)) { + if (vimeoactivity_delete_video($video->id)) { // Rebuilding this course cache. rebuild_course_cache($video->course, true); @@ -209,28 +212,6 @@ function vimeoactivity_delete_instance($id) { return(false); } -/** - * This standard function will check all instances of this - * module and make sure there are up-to-date events created - * for each of them. If courseid equals to zero, then every - * Vimeo event in the site is checked, else only Vimeo events - * belonging to the course specified are checked. This is only - * required if the module is generating calendar events. - * - * @param integer $courseid - * @return boolean - */ -function vimeoactivity_refresh_events($courseid) { - // Because we don't have any related - // events returning a true boolean - // value as this function result. - if ($courseid > 0) { - return(true); - } else { - return(true); - } -} - /** * Obtains the automatic completion state * for this video based on any conditions @@ -324,7 +305,7 @@ function vimeoactivity_print_recent_activity($course, $viewfullnames, $timestart * * This callback function is supposed to populate the passed array with * custom activity records. These records are then rendered into HTML via - * {@link vimeoactivity_print_recent_mod_activity()}. + * {vimeoactivity_print_recent_mod_activity()}. * * Returns void, it adds items into $activities and increases $index. * @@ -342,12 +323,12 @@ function vimeoactivity_get_recent_mod_activity(&$activities, &$index, $timestart /** * Prints single activity item prepared by - * {@link vimeoactivity_get_recent_mod_activity()} + * {vimeoactivity_get_recent_mod_activity()} * * @param stdclass $activity activity record with added 'cmid' property * @param integer $courseid the id of the course we produce the report for * @param boolean $detail print detailed report - * @param array $modnames as returned by {@link get_module_types_names()} + * @param array $modnames as returned by {get_module_types_names()} * @param boolean $viewfullnames disautoplay users' full names */ function vimeoactivity_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) { @@ -457,4 +438,4 @@ function vimeoactivity_grade_item_delete(stdclass $video) { // grades, returning a false boolean // value as this function result. return(false); -} \ No newline at end of file +} diff --git a/vimeoactivity/locallib.php b/locallib.php similarity index 97% rename from vimeoactivity/locallib.php rename to locallib.php index 87e11da..b448a05 100644 --- a/vimeoactivity/locallib.php +++ b/locallib.php @@ -19,10 +19,9 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); /** * [vimeoactivity_fetch_video] @@ -203,7 +202,7 @@ function vimeoactivity_update_video(stdclass $video) { // Executing the required command // to persist the supplied object // within the database. - if ($result = $DB->update_record_raw('vimeoactivity', $values)) { + if ($DB->update_record_raw('vimeoactivity', $values)) { // Because we were able to execute this operation // completely and successfully, returning a true // boolean value as this function result. @@ -298,7 +297,9 @@ function vimeoactivity_render_video(stdclass $video, $styles = true, $scripts = } if ($video->color <> '') { - $output .= '
'; + $output .= '
'; $output .= ' '; $output .= '
'."\n"; } else { @@ -337,8 +338,7 @@ function vimeoactivity_render_video(stdclass $video, $styles = true, $scripts = } else { $output .= ' loop:false,'."\n"; } - - $output .= ' title:false,'."\n"; + $output .= ' title:true,'."\n"; $output .= ' byline:false};'."\n"; $output .= 'var vimeo_'.$video->id.'_player = new Vimeo.Player("mod-vimeoactivity-'.$video->id.'", options);'."\n"; $output .= 'var vimeo_'.$video->id.'_progress = 0;'."\n"; @@ -357,7 +357,6 @@ function vimeoactivity_render_video(stdclass $video, $styles = true, $scripts = $output .= '}'."\n"; $output .= '});'."\n"; $output .= ''."\n"; - // Returning the compiled Vimeo // video as this method's result. return($output); @@ -555,7 +554,7 @@ function vimeoactivity_fetch_progress($userid, $videoid) { // (greater than zero) and, if not, there is no need // to even touch the database and returning a null // value as this function result. - if ($userid < 1 or $videoid < 1) { + if ($userid < 1 || $videoid < 1) { return($result); } @@ -617,7 +616,7 @@ function vimeoactivity_save_progress($userid, $videoid, $value) { // (greater than zero) and, if not, there is no need // to even touch the database and returning a false // boolean value as this function result. - if ($userid < 1 or $videoid < 1) { + if ($userid < 1 || $videoid < 1) { return(false); } @@ -685,7 +684,7 @@ function vimeoactivity_delete_progress($userid, $videoid) { // (greater than zero) and, if not, there is no need // to even touch the database and returning a false // boolean value as this function result. - if ($userid < 1 or $videoid < 1) { + if ($userid < 1 || $videoid < 1) { return(false); } @@ -693,4 +692,4 @@ function vimeoactivity_delete_progress($userid, $videoid) { // database and returning a boolean value // as this function result. return((boolean)$DB->delete_records('vimeoactivity_progress', ['user' => $userid, 'video' => $videoid])); -} \ No newline at end of file +} diff --git a/vimeoactivity/mod_form.php b/mod_form.php similarity index 86% rename from vimeoactivity/mod_form.php rename to mod_form.php index 2eeec12..74f4b17 100644 --- a/vimeoactivity/mod_form.php +++ b/mod_form.php @@ -19,8 +19,8 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); @@ -33,11 +33,9 @@ /** * This class is responsible for defining and validating this plug-in add and edit forms. * - * @license http://www.gnu.org/copyleft/gpl.html */ -class mod_vimeoactivity_mod_form extends moodleform_mod -{ +class mod_vimeoactivity_mod_form extends moodleform_mod { /** * This method is responsible for * registering this form inputs. @@ -121,10 +119,10 @@ public function add_completion_rules() { 80 => '80%', 90 => '90%', 100 => '100%']), - $this->_form->createElement('checkbox', 'completionenable', ' ', get_string('label_enable', 'mod_vimeoactivity')), + $this->_form->createElement('checkbox', 'completionenable', ' ', get_string('label_enable', 'mod_vimeoactivity')) ]; $this->_form->setType('completionprogress', PARAM_INT); - $this->_form->addGroup($group, 'completionprogress', get_string('label_completion', 'mod_vimeoactivity'), [''], false); + $this->_form->addGroup($group, 'completionprogress', get_string('label_completion', 'mod_vimeoactivity'), null, false); $this->_form->addHelpButton('completionprogress', 'label_completion', 'mod_vimeoactivity'); $this->_form->disabledIf('completionprogress', 'completionenable', 'notchecked'); @@ -142,11 +140,30 @@ public function add_completion_rules() { public function completion_rule_enabled($data) { $data['completionenable'] = intval($data['completionenable']); $data['completionprogress'] = intval($data['completionprogress']); - return($data['completionenable'] == 1 and - $data['completionprogress'] >= 0 and + return($data['completionenable'] == 1 && + $data['completionprogress'] >= 0 && $data['completionprogress'] <= 100); } - + /** + * Allows module to modify the data returned by form get_data(). + * This method is also called in the bulk activity completion form. + * + * Only available on moodleform_mod. + * + * @param stdClass $data the form data to be modified. + */ + /** public function data_postprocessing($data) { + * parent::data_postprocessing($data); + * if (!empty($data->completionunlocked)) { + * // Turn off completion settings if the checkboxes aren't ticked. + * $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC; + * + * if (!$autocompletion || empty($data->completionprogress)) { + * $data->completionprogress = null; + * } + * } + * } + */ /** * This function is responsible for validating * the supplied Vimeo video data and returning @@ -185,4 +202,4 @@ public function validation($data, $files) { // array as this function result. return($errors); } -} \ No newline at end of file +} diff --git a/vimeoactivity/ping.php b/ping.php similarity index 94% rename from vimeoactivity/ping.php rename to ping.php index 9b3f149..7f09dd1 100644 --- a/vimeoactivity/ping.php +++ b/ping.php @@ -19,8 +19,8 @@ * * @package mod_vimeoactivity * @author Vignesh - - * @license http://www.gnu.org/copyleft/gpl.html + * @copyright 2023 Mohammad Farouk + * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('AJAX_SCRIPT', true); @@ -56,7 +56,7 @@ // Deciding if the loaded video must be // marked as a completed task, or not. - if ($video->completionenable == true and + if ($video->completionenable == true && $video->completionprogress <= $value) { $module = get_coursemodule_from_instance('vimeoactivity', $videoid, 0, false, MUST_EXIST); $course = $DB->get_record('course', ['id' => $module->course], '*', MUST_EXIST); diff --git a/vimeoactivity/pix/icon.png b/pix/icon.png similarity index 100% rename from vimeoactivity/pix/icon.png rename to pix/icon.png diff --git a/vimeoactivity/pix/icon.svg b/pix/icon.svg similarity index 100% rename from vimeoactivity/pix/icon.svg rename to pix/icon.svg diff --git a/script.js b/script.js new file mode 100644 index 0000000..4996ac1 --- /dev/null +++ b/script.js @@ -0,0 +1,2644 @@ +/*! @vimeo/player v2.18.0 | (c) 2022 Vimeo | MIT License | https://github.com/vimeo/player.js */ +(function (global, factory) { + typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : + typeof define === 'function' && define.amd ? define(factory) : + (global = typeof globalThis !== 'undefined' ? globalThis : global || self, (global.Vimeo = global.Vimeo || {}, global.Vimeo.Player = factory())); + }(this, (function () { 'use strict'; + + function _classCallCheck(instance, Constructor) { + if (!(instance instanceof Constructor)) { + throw new TypeError("Cannot call a class as a function"); + } + } + + function _defineProperties(target, props) { + for (var i = 0; i < props.length; i++) { + var descriptor = props[i]; + descriptor.enumerable = descriptor.enumerable || false; + descriptor.configurable = true; + if ("value" in descriptor) descriptor.writable = true; + Object.defineProperty(target, descriptor.key, descriptor); + } + } + + function _createClass(Constructor, protoProps, staticProps) { + if (protoProps) _defineProperties(Constructor.prototype, protoProps); + if (staticProps) _defineProperties(Constructor, staticProps); + return Constructor; + } + + /** + * @module lib/functions + */ + + /** + * Check to see this is a node environment. + * @type {Boolean} + */ + + /* global global */ + var isNode = typeof global !== 'undefined' && {}.toString.call(global) === '[object global]'; + /** + * Get the name of the method for a given getter or setter. + * + * @param {string} prop The name of the property. + * @param {string} type Either “get” or “set”. + * @return {string} + */ + + function getMethodName(prop, type) { + if (prop.indexOf(type.toLowerCase()) === 0) { + return prop; + } + + return "".concat(type.toLowerCase()).concat(prop.substr(0, 1).toUpperCase()).concat(prop.substr(1)); + } + /** + * Check to see if the object is a DOM Element. + * + * @param {*} element The object to check. + * @return {boolean} + */ + + function isDomElement(element) { + return Boolean(element && element.nodeType === 1 && 'nodeName' in element && element.ownerDocument && element.ownerDocument.defaultView); + } + /** + * Check to see whether the value is a number. + * + * @see http://dl.dropboxusercontent.com/u/35146/js/tests/isNumber.html + * @param {*} value The value to check. + * @param {boolean} integer Check if the value is an integer. + * @return {boolean} + */ + + function isInteger(value) { + // eslint-disable-next-line eqeqeq + return !isNaN(parseFloat(value)) && isFinite(value) && Math.floor(value) == value; + } + /** + * Check to see if the URL is a Vimeo url. + * + * @param {string} url The url string. + * @return {boolean} + */ + + function isVimeoUrl(url) { + return /^(https?:)?\/\/((player|www)\.)?vimeo\.com(?=$|\/)/.test(url); + } + /** + * Check to see if the URL is for a Vimeo embed. + * + * @param {string} url The url string. + * @return {boolean} + */ + + function isVimeoEmbed(url) { + var expr = /^https:\/\/player\.vimeo\.com\/video\/\d+/; + return expr.test(url); + } + /** + * Get the Vimeo URL from an element. + * The element must have either a data-vimeo-id or data-vimeo-url attribute. + * + * @param {object} oEmbedParameters The oEmbed parameters. + * @return {string} + */ + + function getVimeoUrl() { + var oEmbedParameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}; + var id = oEmbedParameters.id; + var url = oEmbedParameters.url; + var idOrUrl = id || url; + + if (!idOrUrl) { + throw new Error('An id or url must be passed, either in an options object or as a data-vimeo-id or data-vimeo-url attribute.'); + } + + if (isInteger(idOrUrl)) { + return "https://vimeo.com/".concat(idOrUrl); + } + + if (isVimeoUrl(idOrUrl)) { + return idOrUrl.replace('http:', 'https:'); + } + + if (id) { + throw new TypeError("\u201C".concat(id, "\u201D is not a valid video id.")); + } + + throw new TypeError("\u201C".concat(idOrUrl, "\u201D is not a vimeo.com url.")); + } + + var arrayIndexOfSupport = typeof Array.prototype.indexOf !== 'undefined'; + var postMessageSupport = typeof window !== 'undefined' && typeof window.postMessage !== 'undefined'; + + if (!isNode && (!arrayIndexOfSupport || !postMessageSupport)) { + throw new Error('Sorry, the Vimeo Player API is not available in this browser.'); + } + + var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {}; + + function createCommonjsModule(fn, module) { + return module = { exports: {} }, fn(module, module.exports), module.exports; + } + + /*! + * weakmap-polyfill v2.0.4 - ECMAScript6 WeakMap polyfill + * https://github.com/polygonplanet/weakmap-polyfill + * Copyright (c) 2015-2021 polygonplanet + * @license MIT + */ + (function (self) { + + if (self.WeakMap) { + return; + } + + var hasOwnProperty = Object.prototype.hasOwnProperty; + + var hasDefine = Object.defineProperty && function () { + try { + // Avoid IE8's broken Object.defineProperty + return Object.defineProperty({}, 'x', { + value: 1 + }).x === 1; + } catch (e) {} + }(); + + var defineProperty = function (object, name, value) { + if (hasDefine) { + Object.defineProperty(object, name, { + configurable: true, + writable: true, + value: value + }); + } else { + object[name] = value; + } + }; + + self.WeakMap = function () { + // ECMA-262 23.3 WeakMap Objects + function WeakMap() { + if (this === void 0) { + throw new TypeError("Constructor WeakMap requires 'new'"); + } + + defineProperty(this, '_id', genId('_WeakMap')); // ECMA-262 23.3.1.1 WeakMap([iterable]) + + if (arguments.length > 0) { + // Currently, WeakMap `iterable` argument is not supported + throw new TypeError('WeakMap iterable is not supported'); + } + } // ECMA-262 23.3.3.2 WeakMap.prototype.delete(key) + + + defineProperty(WeakMap.prototype, 'delete', function (key) { + checkInstance(this, 'delete'); + + if (!isObject(key)) { + return false; + } + + var entry = key[this._id]; + + if (entry && entry[0] === key) { + delete key[this._id]; + return true; + } + + return false; + }); // ECMA-262 23.3.3.3 WeakMap.prototype.get(key) + + defineProperty(WeakMap.prototype, 'get', function (key) { + checkInstance(this, 'get'); + + if (!isObject(key)) { + return void 0; + } + + var entry = key[this._id]; + + if (entry && entry[0] === key) { + return entry[1]; + } + + return void 0; + }); // ECMA-262 23.3.3.4 WeakMap.prototype.has(key) + + defineProperty(WeakMap.prototype, 'has', function (key) { + checkInstance(this, 'has'); + + if (!isObject(key)) { + return false; + } + + var entry = key[this._id]; + + if (entry && entry[0] === key) { + return true; + } + + return false; + }); // ECMA-262 23.3.3.5 WeakMap.prototype.set(key, value) + + defineProperty(WeakMap.prototype, 'set', function (key, value) { + checkInstance(this, 'set'); + + if (!isObject(key)) { + throw new TypeError('Invalid value used as weak map key'); + } + + var entry = key[this._id]; + + if (entry && entry[0] === key) { + entry[1] = value; + return this; + } + + defineProperty(key, this._id, [key, value]); + return this; + }); + + function checkInstance(x, methodName) { + if (!isObject(x) || !hasOwnProperty.call(x, '_id')) { + throw new TypeError(methodName + ' method called on incompatible receiver ' + typeof x); + } + } + + function genId(prefix) { + return prefix + '_' + rand() + '.' + rand(); + } + + function rand() { + return Math.random().toString().substring(2); + } + + defineProperty(WeakMap, '_polyfill', true); + return WeakMap; + }(); + + function isObject(x) { + return Object(x) === x; + } + })(typeof globalThis !== 'undefined' ? globalThis : typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof commonjsGlobal !== 'undefined' ? commonjsGlobal : commonjsGlobal); + + var npo_src = createCommonjsModule(function (module) { + /*! Native Promise Only + v0.8.1 (c) Kyle Simpson + MIT License: http://getify.mit-license.org + */ + (function UMD(name, context, definition) { + // special form of UMD for polyfilling across evironments + context[name] = context[name] || definition(); + + if ( module.exports) { + module.exports = context[name]; + } + })("Promise", typeof commonjsGlobal != "undefined" ? commonjsGlobal : commonjsGlobal, function DEF() { + + var builtInProp, + cycle, + scheduling_queue, + ToString = Object.prototype.toString, + timer = typeof setImmediate != "undefined" ? function timer(fn) { + return setImmediate(fn); + } : setTimeout; // dammit, IE8. + + try { + Object.defineProperty({}, "x", {}); + + builtInProp = function builtInProp(obj, name, val, config) { + return Object.defineProperty(obj, name, { + value: val, + writable: true, + configurable: config !== false + }); + }; + } catch (err) { + builtInProp = function builtInProp(obj, name, val) { + obj[name] = val; + return obj; + }; + } // Note: using a queue instead of array for efficiency + + + scheduling_queue = function Queue() { + var first, last, item; + + function Item(fn, self) { + this.fn = fn; + this.self = self; + this.next = void 0; + } + + return { + add: function add(fn, self) { + item = new Item(fn, self); + + if (last) { + last.next = item; + } else { + first = item; + } + + last = item; + item = void 0; + }, + drain: function drain() { + var f = first; + first = last = cycle = void 0; + + while (f) { + f.fn.call(f.self); + f = f.next; + } + } + }; + }(); + + function schedule(fn, self) { + scheduling_queue.add(fn, self); + + if (!cycle) { + cycle = timer(scheduling_queue.drain); + } + } // promise duck typing + + + function isThenable(o) { + var _then, + o_type = typeof o; + + if (o != null && (o_type == "object" || o_type == "function")) { + _then = o.then; + } + + return typeof _then == "function" ? _then : false; + } + + function notify() { + for (var i = 0; i < this.chain.length; i++) { + notifyIsolated(this, this.state === 1 ? this.chain[i].success : this.chain[i].failure, this.chain[i]); + } + + this.chain.length = 0; + } // NOTE: This is a separate function to isolate + // the `try..catch` so that other code can be + // optimized better + + + function notifyIsolated(self, cb, chain) { + var ret, _then; + + try { + if (cb === false) { + chain.reject(self.msg); + } else { + if (cb === true) { + ret = self.msg; + } else { + ret = cb.call(void 0, self.msg); + } + + if (ret === chain.promise) { + chain.reject(TypeError("Promise-chain cycle")); + } else if (_then = isThenable(ret)) { + _then.call(ret, chain.resolve, chain.reject); + } else { + chain.resolve(ret); + } + } + } catch (err) { + chain.reject(err); + } + } + + function resolve(msg) { + var _then, + self = this; // already triggered? + + + if (self.triggered) { + return; + } + + self.triggered = true; // unwrap + + if (self.def) { + self = self.def; + } + + try { + if (_then = isThenable(msg)) { + schedule(function () { + var def_wrapper = new MakeDefWrapper(self); + + try { + _then.call(msg, function $resolve$() { + resolve.apply(def_wrapper, arguments); + }, function $reject$() { + reject.apply(def_wrapper, arguments); + }); + } catch (err) { + reject.call(def_wrapper, err); + } + }); + } else { + self.msg = msg; + self.state = 1; + + if (self.chain.length > 0) { + schedule(notify, self); + } + } + } catch (err) { + reject.call(new MakeDefWrapper(self), err); + } + } + + function reject(msg) { + var self = this; // already triggered? + + if (self.triggered) { + return; + } + + self.triggered = true; // unwrap + + if (self.def) { + self = self.def; + } + + self.msg = msg; + self.state = 2; + + if (self.chain.length > 0) { + schedule(notify, self); + } + } + + function iteratePromises(Constructor, arr, resolver, rejecter) { + for (var idx = 0; idx < arr.length; idx++) { + (function IIFE(idx) { + Constructor.resolve(arr[idx]).then(function $resolver$(msg) { + resolver(idx, msg); + }, rejecter); + })(idx); + } + } + + function MakeDefWrapper(self) { + this.def = self; + this.triggered = false; + } + + function MakeDef(self) { + this.promise = self; + this.state = 0; + this.triggered = false; + this.chain = []; + this.msg = void 0; + } + + function Promise(executor) { + if (typeof executor != "function") { + throw TypeError("Not a function"); + } + + if (this.__NPO__ !== 0) { + throw TypeError("Not a promise"); + } // instance shadowing the inherited "brand" + // to signal an already "initialized" promise + + + this.__NPO__ = 1; + var def = new MakeDef(this); + + this["then"] = function then(success, failure) { + var o = { + success: typeof success == "function" ? success : true, + failure: typeof failure == "function" ? failure : false + }; // Note: `then(..)` itself can be borrowed to be used against + // a different promise constructor for making the chained promise, + // by substituting a different `this` binding. + + o.promise = new this.constructor(function extractChain(resolve, reject) { + if (typeof resolve != "function" || typeof reject != "function") { + throw TypeError("Not a function"); + } + + o.resolve = resolve; + o.reject = reject; + }); + def.chain.push(o); + + if (def.state !== 0) { + schedule(notify, def); + } + + return o.promise; + }; + + this["catch"] = function $catch$(failure) { + return this.then(void 0, failure); + }; + + try { + executor.call(void 0, function publicResolve(msg) { + resolve.call(def, msg); + }, function publicReject(msg) { + reject.call(def, msg); + }); + } catch (err) { + reject.call(def, err); + } + } + + var PromisePrototype = builtInProp({}, "constructor", Promise, + /*configurable=*/ + false); // Note: Android 4 cannot use `Object.defineProperty(..)` here + + Promise.prototype = PromisePrototype; // built-in "brand" to signal an "uninitialized" promise + + builtInProp(PromisePrototype, "__NPO__", 0, + /*configurable=*/ + false); + builtInProp(Promise, "resolve", function Promise$resolve(msg) { + var Constructor = this; // spec mandated checks + // note: best "isPromise" check that's practical for now + + if (msg && typeof msg == "object" && msg.__NPO__ === 1) { + return msg; + } + + return new Constructor(function executor(resolve, reject) { + if (typeof resolve != "function" || typeof reject != "function") { + throw TypeError("Not a function"); + } + + resolve(msg); + }); + }); + builtInProp(Promise, "reject", function Promise$reject(msg) { + return new this(function executor(resolve, reject) { + if (typeof resolve != "function" || typeof reject != "function") { + throw TypeError("Not a function"); + } + + reject(msg); + }); + }); + builtInProp(Promise, "all", function Promise$all(arr) { + var Constructor = this; // spec mandated checks + + if (ToString.call(arr) != "[object Array]") { + return Constructor.reject(TypeError("Not an array")); + } + + if (arr.length === 0) { + return Constructor.resolve([]); + } + + return new Constructor(function executor(resolve, reject) { + if (typeof resolve != "function" || typeof reject != "function") { + throw TypeError("Not a function"); + } + + var len = arr.length, + msgs = Array(len), + count = 0; + iteratePromises(Constructor, arr, function resolver(idx, msg) { + msgs[idx] = msg; + + if (++count === len) { + resolve(msgs); + } + }, reject); + }); + }); + builtInProp(Promise, "race", function Promise$race(arr) { + var Constructor = this; // spec mandated checks + + if (ToString.call(arr) != "[object Array]") { + return Constructor.reject(TypeError("Not an array")); + } + + return new Constructor(function executor(resolve, reject) { + if (typeof resolve != "function" || typeof reject != "function") { + throw TypeError("Not a function"); + } + + iteratePromises(Constructor, arr, function resolver(idx, msg) { + resolve(msg); + }, reject); + }); + }); + return Promise; + }); + }); + + /** + * @module lib/callbacks + */ + var callbackMap = new WeakMap(); + /** + * Store a callback for a method or event for a player. + * + * @param {Player} player The player object. + * @param {string} name The method or event name. + * @param {(function(this:Player, *): void|{resolve: function, reject: function})} callback + * The callback to call or an object with resolve and reject functions for a promise. + * @return {void} + */ + + function storeCallback(player, name, callback) { + var playerCallbacks = callbackMap.get(player.element) || {}; + + if (!(name in playerCallbacks)) { + playerCallbacks[name] = []; + } + + playerCallbacks[name].push(callback); + callbackMap.set(player.element, playerCallbacks); + } + /** + * Get the callbacks for a player and event or method. + * + * @param {Player} player The player object. + * @param {string} name The method or event name + * @return {function[]} + */ + + function getCallbacks(player, name) { + var playerCallbacks = callbackMap.get(player.element) || {}; + return playerCallbacks[name] || []; + } + /** + * Remove a stored callback for a method or event for a player. + * + * @param {Player} player The player object. + * @param {string} name The method or event name + * @param {function} [callback] The specific callback to remove. + * @return {boolean} Was this the last callback? + */ + + function removeCallback(player, name, callback) { + var playerCallbacks = callbackMap.get(player.element) || {}; + + if (!playerCallbacks[name]) { + return true; + } // If no callback is passed, remove all callbacks for the event + + + if (!callback) { + playerCallbacks[name] = []; + callbackMap.set(player.element, playerCallbacks); + return true; + } + + var index = playerCallbacks[name].indexOf(callback); + + if (index !== -1) { + playerCallbacks[name].splice(index, 1); + } + + callbackMap.set(player.element, playerCallbacks); + return playerCallbacks[name] && playerCallbacks[name].length === 0; + } + /** + * Return the first stored callback for a player and event or method. + * + * @param {Player} player The player object. + * @param {string} name The method or event name. + * @return {function} The callback, or false if there were none + */ + + function shiftCallbacks(player, name) { + var playerCallbacks = getCallbacks(player, name); + + if (playerCallbacks.length < 1) { + return false; + } + + var callback = playerCallbacks.shift(); + removeCallback(player, name, callback); + return callback; + } + /** + * Move callbacks associated with an element to another element. + * + * @param {HTMLElement} oldElement The old element. + * @param {HTMLElement} newElement The new element. + * @return {void} + */ + + function swapCallbacks(oldElement, newElement) { + var playerCallbacks = callbackMap.get(oldElement); + callbackMap.set(newElement, playerCallbacks); + callbackMap.delete(oldElement); + } + + /** + * @module lib/postmessage + */ + /** + * Parse a message received from postMessage. + * + * @param {*} data The data received from postMessage. + * @return {object} + */ + + function parseMessageData(data) { + if (typeof data === 'string') { + try { + data = JSON.parse(data); + } catch (error) { + // If the message cannot be parsed, throw the error as a warning + console.warn(error); + return {}; + } + } + + return data; + } + /** + * Post a message to the specified target. + * + * @param {Player} player The player object to use. + * @param {string} method The API method to call. + * @param {object} params The parameters to send to the player. + * @return {void} + */ + + function postMessage(player, method, params) { + if (!player.element.contentWindow || !player.element.contentWindow.postMessage) { + return; + } + + var message = { + method: method + }; + + if (params !== undefined) { + message.value = params; + } // IE 8 and 9 do not support passing messages, so stringify them + + + var ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\d+).*$/, '$1')); + + if (ieVersion >= 8 && ieVersion < 10) { + message = JSON.stringify(message); + } + + player.element.contentWindow.postMessage(message, player.origin); + } + /** + * Parse the data received from a message event. + * + * @param {Player} player The player that received the message. + * @param {(Object|string)} data The message data. Strings will be parsed into JSON. + * @return {void} + */ + + function processData(player, data) { + data = parseMessageData(data); + var callbacks = []; + var param; + + if (data.event) { + if (data.event === 'error') { + var promises = getCallbacks(player, data.data.method); + promises.forEach(function (promise) { + var error = new Error(data.data.message); + error.name = data.data.name; + promise.reject(error); + removeCallback(player, data.data.method, promise); + }); + } + + callbacks = getCallbacks(player, "event:".concat(data.event)); + param = data.data; + } else if (data.method) { + var callback = shiftCallbacks(player, data.method); + + if (callback) { + callbacks.push(callback); + param = data.value; + } + } + + callbacks.forEach(function (callback) { + try { + if (typeof callback === 'function') { + callback.call(player, param); + return; + } + + callback.resolve(param); + } catch (e) {// empty + } + }); + } + + /** + * @module lib/embed + */ + var oEmbedParameters = ['autopause', 'autoplay', 'background', 'byline', 'color', 'controls', 'dnt', 'height', 'id', 'interactive_params', 'keyboard', 'loop', 'maxheight', 'maxwidth', 'muted', 'playsinline', 'portrait', 'responsive', 'speed', 'texttrack', 'title', 'transparent', 'url', 'width']; + /** + * Get the 'data-vimeo'-prefixed attributes from an element as an object. + * + * @param {HTMLElement} element The element. + * @param {Object} [defaults={}] The default values to use. + * @return {Object} + */ + + function getOEmbedParameters(element) { + var defaults = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + return oEmbedParameters.reduce(function (params, param) { + var value = element.getAttribute("data-vimeo-".concat(param)); + + if (value || value === '') { + params[param] = value === '' ? 1 : value; + } + + return params; + }, defaults); + } + /** + * Create an embed from oEmbed data inside an element. + * + * @param {object} data The oEmbed data. + * @param {HTMLElement} element The element to put the iframe in. + * @return {HTMLIFrameElement} The iframe embed. + */ + + function createEmbed(_ref, element) { + var html = _ref.html; + + if (!element) { + throw new TypeError('An element must be provided'); + } + + if (element.getAttribute('data-vimeo-initialized') !== null) { + return element.querySelector('iframe'); + } + + var div = document.createElement('div'); + div.innerHTML = html; + element.appendChild(div.firstChild); + element.setAttribute('data-vimeo-initialized', 'true'); + return element.querySelector('iframe'); + } + /** + * Make an oEmbed call for the specified URL. + * + * @param {string} videoUrl The vimeo.com url for the video. + * @param {Object} [params] Parameters to pass to oEmbed. + * @param {HTMLElement} element The element. + * @return {Promise} + */ + + function getOEmbedData(videoUrl) { + var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + var element = arguments.length > 2 ? arguments[2] : undefined; + return new Promise(function (resolve, reject) { + if (!isVimeoUrl(videoUrl)) { + throw new TypeError("\u201C".concat(videoUrl, "\u201D is not a vimeo.com url.")); + } + + var url = "https://vimeo.com/api/oembed.json?url=".concat(encodeURIComponent(videoUrl)); + + for (var param in params) { + if (params.hasOwnProperty(param)) { + url += "&".concat(param, "=").concat(encodeURIComponent(params[param])); + } + } + + var xhr = 'XDomainRequest' in window ? new XDomainRequest() : new XMLHttpRequest(); + xhr.open('GET', url, true); + + xhr.onload = function () { + if (xhr.status === 404) { + reject(new Error("\u201C".concat(videoUrl, "\u201D was not found."))); + return; + } + + if (xhr.status === 403) { + reject(new Error("\u201C".concat(videoUrl, "\u201D is not embeddable."))); + return; + } + + try { + var json = JSON.parse(xhr.responseText); // Check api response for 403 on oembed + + if (json.domain_status_code === 403) { + // We still want to create the embed to give users visual feedback + createEmbed(json, element); + reject(new Error("\u201C".concat(videoUrl, "\u201D is not embeddable."))); + return; + } + + resolve(json); + } catch (error) { + reject(error); + } + }; + + xhr.onerror = function () { + var status = xhr.status ? " (".concat(xhr.status, ")") : ''; + reject(new Error("There was an error fetching the embed code from Vimeo".concat(status, "."))); + }; + + xhr.send(); + }); + } + /** + * Initialize all embeds within a specific element + * + * @param {HTMLElement} [parent=document] The parent element. + * @return {void} + */ + + function initializeEmbeds() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + var elements = [].slice.call(parent.querySelectorAll('[data-vimeo-id], [data-vimeo-url]')); + + var handleError = function handleError(error) { + if ('console' in window && console.error) { + console.error("There was an error creating an embed: ".concat(error)); + } + }; + + elements.forEach(function (element) { + try { + // Skip any that have data-vimeo-defer + if (element.getAttribute('data-vimeo-defer') !== null) { + return; + } + + var params = getOEmbedParameters(element); + var url = getVimeoUrl(params); + getOEmbedData(url, params, element).then(function (data) { + return createEmbed(data, element); + }).catch(handleError); + } catch (error) { + handleError(error); + } + }); + } + /** + * Resize embeds when messaged by the player. + * + * @param {HTMLElement} [parent=document] The parent element. + * @return {void} + */ + + function resizeEmbeds() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + + // Prevent execution if users include the player.js script multiple times. + if (window.VimeoPlayerResizeEmbeds_) { + return; + } + + window.VimeoPlayerResizeEmbeds_ = true; + + var onMessage = function onMessage(event) { + if (!isVimeoUrl(event.origin)) { + return; + } // 'spacechange' is fired only on embeds with cards + + + if (!event.data || event.data.event !== 'spacechange') { + return; + } + + var iframes = parent.querySelectorAll('iframe'); + + for (var i = 0; i < iframes.length; i++) { + if (iframes[i].contentWindow !== event.source) { + continue; + } // Change padding-bottom of the enclosing div to accommodate + // card carousel without distorting aspect ratio + + + var space = iframes[i].parentElement; + space.style.paddingBottom = "".concat(event.data.data[0].bottom, "px"); + break; + } + }; + + window.addEventListener('message', onMessage); + } + /** + * Add chapters to existing metadata for Google SEO + * + * @param {HTMLElement} [parent=document] The parent element. + * @return {void} + */ + + function initAppendVideoMetadata() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + + // Prevent execution if users include the player.js script multiple times. + if (window.VimeoSeoMetadataAppended) { + return; + } + + window.VimeoSeoMetadataAppended = true; + + var onMessage = function onMessage(event) { + if (!isVimeoUrl(event.origin)) { + return; + } + + var data = parseMessageData(event.data); + + if (!data || data.event !== 'ready') { + return; + } + + var iframes = parent.querySelectorAll('iframe'); + + for (var i = 0; i < iframes.length; i++) { + var iframe = iframes[i]; // Initiate appendVideoMetadata if iframe is a Vimeo embed + + var isValidMessageSource = iframe.contentWindow === event.source; + + if (isVimeoEmbed(iframe.src) && isValidMessageSource) { + var player = new Player(iframe); + player.callMethod('appendVideoMetadata', window.location.href); + } + } + }; + + window.addEventListener('message', onMessage); + } + /** + * Seek to time indicated by vimeo_t query parameter if present in URL + * + * @param {HTMLElement} [parent=document] The parent element. + * @return {void} + */ + + function checkUrlTimeParam() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + + // Prevent execution if users include the player.js script multiple times. + if (window.VimeoCheckedUrlTimeParam) { + return; + } + + window.VimeoCheckedUrlTimeParam = true; + + var handleError = function handleError(error) { + if ('console' in window && console.error) { + console.error("There was an error getting video Id: ".concat(error)); + } + }; + + var onMessage = function onMessage(event) { + if (!isVimeoUrl(event.origin)) { + return; + } + + var data = parseMessageData(event.data); + + if (!data || data.event !== 'ready') { + return; + } + + var iframes = parent.querySelectorAll('iframe'); + + for (var i = 0; i < iframes.length; i++) { + var iframe = iframes[i]; + var isValidMessageSource = iframe.contentWindow === event.source; + + if (isVimeoEmbed(iframe.src) && isValidMessageSource) { + (function () { + var player = new Player(iframe); + player.getVideoId().then(function (videoId) { + var matches = new RegExp("[?&]vimeo_t_".concat(videoId, "=([^&#]*)")).exec(window.location.href); + + if (matches && matches[1]) { + var sec = decodeURI(matches[1]); + player.setCurrentTime(sec); + } + + return; + }).catch(handleError); + })(); + } + } + }; + + window.addEventListener('message', onMessage); + } + + /* MIT License + + Copyright (c) Sindre Sorhus (sindresorhus.com) + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + Terms */ + function initializeScreenfull() { + var fn = function () { + var val; + var fnMap = [['requestFullscreen', 'exitFullscreen', 'fullscreenElement', 'fullscreenEnabled', 'fullscreenchange', 'fullscreenerror'], // New WebKit + ['webkitRequestFullscreen', 'webkitExitFullscreen', 'webkitFullscreenElement', 'webkitFullscreenEnabled', 'webkitfullscreenchange', 'webkitfullscreenerror'], // Old WebKit + ['webkitRequestFullScreen', 'webkitCancelFullScreen', 'webkitCurrentFullScreenElement', 'webkitCancelFullScreen', 'webkitfullscreenchange', 'webkitfullscreenerror'], ['mozRequestFullScreen', 'mozCancelFullScreen', 'mozFullScreenElement', 'mozFullScreenEnabled', 'mozfullscreenchange', 'mozfullscreenerror'], ['msRequestFullscreen', 'msExitFullscreen', 'msFullscreenElement', 'msFullscreenEnabled', 'MSFullscreenChange', 'MSFullscreenError']]; + var i = 0; + var l = fnMap.length; + var ret = {}; + + for (; i < l; i++) { + val = fnMap[i]; + + if (val && val[1] in document) { + for (i = 0; i < val.length; i++) { + ret[fnMap[0][i]] = val[i]; + } + + return ret; + } + } + + return false; + }(); + + var eventNameMap = { + fullscreenchange: fn.fullscreenchange, + fullscreenerror: fn.fullscreenerror + }; + var screenfull = { + request: function request(element) { + return new Promise(function (resolve, reject) { + var onFullScreenEntered = function onFullScreenEntered() { + screenfull.off('fullscreenchange', onFullScreenEntered); + resolve(); + }; + + screenfull.on('fullscreenchange', onFullScreenEntered); + element = element || document.documentElement; + var returnPromise = element[fn.requestFullscreen](); + + if (returnPromise instanceof Promise) { + returnPromise.then(onFullScreenEntered).catch(reject); + } + }); + }, + exit: function exit() { + return new Promise(function (resolve, reject) { + if (!screenfull.isFullscreen) { + resolve(); + return; + } + + var onFullScreenExit = function onFullScreenExit() { + screenfull.off('fullscreenchange', onFullScreenExit); + resolve(); + }; + + screenfull.on('fullscreenchange', onFullScreenExit); + var returnPromise = document[fn.exitFullscreen](); + + if (returnPromise instanceof Promise) { + returnPromise.then(onFullScreenExit).catch(reject); + } + }); + }, + on: function on(event, callback) { + var eventName = eventNameMap[event]; + + if (eventName) { + document.addEventListener(eventName, callback); + } + }, + off: function off(event, callback) { + var eventName = eventNameMap[event]; + + if (eventName) { + document.removeEventListener(eventName, callback); + } + } + }; + Object.defineProperties(screenfull, { + isFullscreen: { + get: function get() { + return Boolean(document[fn.fullscreenElement]); + } + }, + element: { + enumerable: true, + get: function get() { + return document[fn.fullscreenElement]; + } + }, + isEnabled: { + enumerable: true, + get: function get() { + // Coerce to boolean in case of old WebKit + return Boolean(document[fn.fullscreenEnabled]); + } + } + }); + return screenfull; + } + + var playerMap = new WeakMap(); + var readyMap = new WeakMap(); + var screenfull = {}; + + var Player = /*#__PURE__*/function () { + /** + * Create a Player. + * + * @param {(HTMLIFrameElement|HTMLElement|string|jQuery)} element A reference to the Vimeo + * player iframe, and id, or a jQuery object. + * @param {object} [options] oEmbed parameters to use when creating an embed in the element. + * @return {Player} + */ + function Player(element) { + var _this = this; + + var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + _classCallCheck(this, Player); + + /* global jQuery */ + if (window.jQuery && element instanceof jQuery) { + if (element.length > 1 && window.console && console.warn) { + console.warn('A jQuery object with multiple elements was passed, using the first element.'); + } + + element = element[0]; + } // Find an element by ID + + + if (typeof document !== 'undefined' && typeof element === 'string') { + element = document.getElementById(element); + } // Not an element! + + + if (!isDomElement(element)) { + throw new TypeError('You must pass either a valid element or a valid id.'); + } // Already initialized an embed in this div, so grab the iframe + + + if (element.nodeName !== 'IFRAME') { + var iframe = element.querySelector('iframe'); + + if (iframe) { + element = iframe; + } + } // iframe url is not a Vimeo url + + + if (element.nodeName === 'IFRAME' && !isVimeoUrl(element.getAttribute('src') || '')) { + throw new Error('The player element passed isn’t a Vimeo embed.'); + } // If there is already a player object in the map, return that + + + if (playerMap.has(element)) { + return playerMap.get(element); + } + + this._window = element.ownerDocument.defaultView; + this.element = element; + this.origin = '*'; + var readyPromise = new npo_src(function (resolve, reject) { + _this._onMessage = function (event) { + if (!isVimeoUrl(event.origin) || _this.element.contentWindow !== event.source) { + return; + } + + if (_this.origin === '*') { + _this.origin = event.origin; + } + + var data = parseMessageData(event.data); + var isError = data && data.event === 'error'; + var isReadyError = isError && data.data && data.data.method === 'ready'; + + if (isReadyError) { + var error = new Error(data.data.message); + error.name = data.data.name; + reject(error); + return; + } + + var isReadyEvent = data && data.event === 'ready'; + var isPingResponse = data && data.method === 'ping'; + + if (isReadyEvent || isPingResponse) { + _this.element.setAttribute('data-ready', 'true'); + + resolve(); + return; + } + + processData(_this, data); + }; + + _this._window.addEventListener('message', _this._onMessage); + + if (_this.element.nodeName !== 'IFRAME') { + var params = getOEmbedParameters(element, options); + var url = getVimeoUrl(params); + getOEmbedData(url, params, element).then(function (data) { + var iframe = createEmbed(data, element); // Overwrite element with the new iframe, + // but store reference to the original element + + _this.element = iframe; + _this._originalElement = element; + swapCallbacks(element, iframe); + playerMap.set(_this.element, _this); + return data; + }).catch(reject); + } + }); // Store a copy of this Player in the map + + readyMap.set(this, readyPromise); + playerMap.set(this.element, this); // Send a ping to the iframe so the ready promise will be resolved if + // the player is already ready. + + if (this.element.nodeName === 'IFRAME') { + postMessage(this, 'ping'); + } + + if (screenfull.isEnabled) { + var exitFullscreen = function exitFullscreen() { + return screenfull.exit(); + }; + + this.fullscreenchangeHandler = function () { + if (screenfull.isFullscreen) { + storeCallback(_this, 'event:exitFullscreen', exitFullscreen); + } else { + removeCallback(_this, 'event:exitFullscreen', exitFullscreen); + } // eslint-disable-next-line + + + _this.ready().then(function () { + postMessage(_this, 'fullscreenchange', screenfull.isFullscreen); + }); + }; + + screenfull.on('fullscreenchange', this.fullscreenchangeHandler); + } + + return this; + } + /** + * Get a promise for a method. + * + * @param {string} name The API method to call. + * @param {Object} [args={}] Arguments to send via postMessage. + * @return {Promise} + */ + + + _createClass(Player, [{ + key: "callMethod", + value: function callMethod(name) { + var _this2 = this; + + var args = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + return new npo_src(function (resolve, reject) { + // We are storing the resolve/reject handlers to call later, so we + // can’t return here. + // eslint-disable-next-line promise/always-return + return _this2.ready().then(function () { + storeCallback(_this2, name, { + resolve: resolve, + reject: reject + }); + postMessage(_this2, name, args); + }).catch(reject); + }); + } + /** + * Get a promise for the value of a player property. + * + * @param {string} name The property name + * @return {Promise} + */ + + }, { + key: "get", + value: function get(name) { + var _this3 = this; + + return new npo_src(function (resolve, reject) { + name = getMethodName(name, 'get'); // We are storing the resolve/reject handlers to call later, so we + // can’t return here. + // eslint-disable-next-line promise/always-return + + return _this3.ready().then(function () { + storeCallback(_this3, name, { + resolve: resolve, + reject: reject + }); + postMessage(_this3, name); + }).catch(reject); + }); + } + /** + * Get a promise for setting the value of a player property. + * + * @param {string} name The API method to call. + * @param {mixed} value The value to set. + * @return {Promise} + */ + + }, { + key: "set", + value: function set(name, value) { + var _this4 = this; + + return new npo_src(function (resolve, reject) { + name = getMethodName(name, 'set'); + + if (value === undefined || value === null) { + throw new TypeError('There must be a value to set.'); + } // We are storing the resolve/reject handlers to call later, so we + // can’t return here. + // eslint-disable-next-line promise/always-return + + + return _this4.ready().then(function () { + storeCallback(_this4, name, { + resolve: resolve, + reject: reject + }); + postMessage(_this4, name, value); + }).catch(reject); + }); + } + /** + * Add an event listener for the specified event. Will call the + * callback with a single parameter, `data`, that contains the data for + * that event. + * + * @param {string} eventName The name of the event. + * @param {function(*)} callback The function to call when the event fires. + * @return {void} + */ + + }, { + key: "on", + value: function on(eventName, callback) { + if (!eventName) { + throw new TypeError('You must pass an event name.'); + } + + if (!callback) { + throw new TypeError('You must pass a callback function.'); + } + + if (typeof callback !== 'function') { + throw new TypeError('The callback must be a function.'); + } + + var callbacks = getCallbacks(this, "event:".concat(eventName)); + + if (callbacks.length === 0) { + this.callMethod('addEventListener', eventName).catch(function () {// Ignore the error. There will be an error event fired that + // will trigger the error callback if they are listening. + }); + } + + storeCallback(this, "event:".concat(eventName), callback); + } + /** + * Remove an event listener for the specified event. Will remove all + * listeners for that event if a `callback` isn’t passed, or only that + * specific callback if it is passed. + * + * @param {string} eventName The name of the event. + * @param {function} [callback] The specific callback to remove. + * @return {void} + */ + + }, { + key: "off", + value: function off(eventName, callback) { + if (!eventName) { + throw new TypeError('You must pass an event name.'); + } + + if (callback && typeof callback !== 'function') { + throw new TypeError('The callback must be a function.'); + } + + var lastCallback = removeCallback(this, "event:".concat(eventName), callback); // If there are no callbacks left, remove the listener + + if (lastCallback) { + this.callMethod('removeEventListener', eventName).catch(function (e) {// Ignore the error. There will be an error event fired that + // will trigger the error callback if they are listening. + }); + } + } + /** + * A promise to load a new video. + * + * @promise LoadVideoPromise + * @fulfill {number} The video with this id or url successfully loaded. + * @reject {TypeError} The id was not a number. + */ + + /** + * Load a new video into this embed. The promise will be resolved if + * the video is successfully loaded, or it will be rejected if it could + * not be loaded. + * + * @param {number|string|object} options The id of the video, the url of the video, or an object with embed options. + * @return {LoadVideoPromise} + */ + + }, { + key: "loadVideo", + value: function loadVideo(options) { + return this.callMethod('loadVideo', options); + } + /** + * A promise to perform an action when the Player is ready. + * + * @todo document errors + * @promise LoadVideoPromise + * @fulfill {void} + */ + + /** + * Trigger a function when the player iframe has initialized. You do not + * need to wait for `ready` to trigger to begin adding event listeners + * or calling other methods. + * + * @return {ReadyPromise} + */ + + }, { + key: "ready", + value: function ready() { + var readyPromise = readyMap.get(this) || new npo_src(function (resolve, reject) { + reject(new Error('Unknown player. Probably unloaded.')); + }); + return npo_src.resolve(readyPromise); + } + /** + * A promise to add a cue point to the player. + * + * @promise AddCuePointPromise + * @fulfill {string} The id of the cue point to use for removeCuePoint. + * @reject {RangeError} the time was less than 0 or greater than the + * video’s duration. + * @reject {UnsupportedError} Cue points are not supported with the current + * player or browser. + */ + + /** + * Add a cue point to the player. + * + * @param {number} time The time for the cue point. + * @param {object} [data] Arbitrary data to be returned with the cue point. + * @return {AddCuePointPromise} + */ + + }, { + key: "addCuePoint", + value: function addCuePoint(time) { + var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + return this.callMethod('addCuePoint', { + time: time, + data: data + }); + } + /** + * A promise to remove a cue point from the player. + * + * @promise AddCuePointPromise + * @fulfill {string} The id of the cue point that was removed. + * @reject {InvalidCuePoint} The cue point with the specified id was not + * found. + * @reject {UnsupportedError} Cue points are not supported with the current + * player or browser. + */ + + /** + * Remove a cue point from the video. + * + * @param {string} id The id of the cue point to remove. + * @return {RemoveCuePointPromise} + */ + + }, { + key: "removeCuePoint", + value: function removeCuePoint(id) { + return this.callMethod('removeCuePoint', id); + } + /** + * A representation of a text track on a video. + * + * @typedef {Object} VimeoTextTrack + * @property {string} language The ISO language code. + * @property {string} kind The kind of track it is (captions or subtitles). + * @property {string} label The human‐readable label for the track. + */ + + /** + * A promise to enable a text track. + * + * @promise EnableTextTrackPromise + * @fulfill {VimeoTextTrack} The text track that was enabled. + * @reject {InvalidTrackLanguageError} No track was available with the + * specified language. + * @reject {InvalidTrackError} No track was available with the specified + * language and kind. + */ + + /** + * Enable the text track with the specified language, and optionally the + * specified kind (captions or subtitles). + * + * When set via the API, the track language will not change the viewer’s + * stored preference. + * + * @param {string} language The two‐letter language code. + * @param {string} [kind] The kind of track to enable (captions or subtitles). + * @return {EnableTextTrackPromise} + */ + + }, { + key: "enableTextTrack", + value: function enableTextTrack(language, kind) { + if (!language) { + throw new TypeError('You must pass a language.'); + } + + return this.callMethod('enableTextTrack', { + language: language, + kind: kind + }); + } + /** + * A promise to disable the active text track. + * + * @promise DisableTextTrackPromise + * @fulfill {void} The track was disabled. + */ + + /** + * Disable the currently-active text track. + * + * @return {DisableTextTrackPromise} + */ + + }, { + key: "disableTextTrack", + value: function disableTextTrack() { + return this.callMethod('disableTextTrack'); + } + /** + * A promise to pause the video. + * + * @promise PausePromise + * @fulfill {void} The video was paused. + */ + + /** + * Pause the video if it’s playing. + * + * @return {PausePromise} + */ + + }, { + key: "pause", + value: function pause() { + return this.callMethod('pause'); + } + /** + * A promise to play the video. + * + * @promise PlayPromise + * @fulfill {void} The video was played. + */ + + /** + * Play the video if it’s paused. **Note:** on iOS and some other + * mobile devices, you cannot programmatically trigger play. Once the + * viewer has tapped on the play button in the player, however, you + * will be able to use this function. + * + * @return {PlayPromise} + */ + + }, { + key: "play", + value: function play() { + return this.callMethod('play'); + } + /** + * Request that the player enters fullscreen. + * @return {Promise} + */ + + }, { + key: "requestFullscreen", + value: function requestFullscreen() { + if (screenfull.isEnabled) { + return screenfull.request(this.element); + } + + return this.callMethod('requestFullscreen'); + } + /** + * Request that the player exits fullscreen. + * @return {Promise} + */ + + }, { + key: "exitFullscreen", + value: function exitFullscreen() { + if (screenfull.isEnabled) { + return screenfull.exit(); + } + + return this.callMethod('exitFullscreen'); + } + /** + * Returns true if the player is currently fullscreen. + * @return {Promise} + */ + + }, { + key: "getFullscreen", + value: function getFullscreen() { + if (screenfull.isEnabled) { + return npo_src.resolve(screenfull.isFullscreen); + } + + return this.get('fullscreen'); + } + /** + * Request that the player enters picture-in-picture. + * @return {Promise} + */ + + }, { + key: "requestPictureInPicture", + value: function requestPictureInPicture() { + return this.callMethod('requestPictureInPicture'); + } + /** + * Request that the player exits picture-in-picture. + * @return {Promise} + */ + + }, { + key: "exitPictureInPicture", + value: function exitPictureInPicture() { + return this.callMethod('exitPictureInPicture'); + } + /** + * Returns true if the player is currently picture-in-picture. + * @return {Promise} + */ + + }, { + key: "getPictureInPicture", + value: function getPictureInPicture() { + return this.get('pictureInPicture'); + } + /** + * A promise to unload the video. + * + * @promise UnloadPromise + * @fulfill {void} The video was unloaded. + */ + + /** + * Return the player to its initial state. + * + * @return {UnloadPromise} + */ + + }, { + key: "unload", + value: function unload() { + return this.callMethod('unload'); + } + /** + * Cleanup the player and remove it from the DOM + * + * It won't be usable and a new one should be constructed + * in order to do any operations. + * + * @return {Promise} + */ + + }, { + key: "destroy", + value: function destroy() { + var _this5 = this; + + return new npo_src(function (resolve) { + readyMap.delete(_this5); + playerMap.delete(_this5.element); + + if (_this5._originalElement) { + playerMap.delete(_this5._originalElement); + + _this5._originalElement.removeAttribute('data-vimeo-initialized'); + } + + if (_this5.element && _this5.element.nodeName === 'IFRAME' && _this5.element.parentNode) { + // If we've added an additional wrapper div, remove that from the DOM. + // If not, just remove the iframe element. + if (_this5.element.parentNode.parentNode && _this5._originalElement && _this5._originalElement !== _this5.element.parentNode) { + _this5.element.parentNode.parentNode.removeChild(_this5.element.parentNode); + } else { + _this5.element.parentNode.removeChild(_this5.element); + } + } // If the clip is private there is a case where the element stays the + // div element. Destroy should reset the div and remove the iframe child. + + + if (_this5.element && _this5.element.nodeName === 'DIV' && _this5.element.parentNode) { + _this5.element.removeAttribute('data-vimeo-initialized'); + + var iframe = _this5.element.querySelector('iframe'); + + if (iframe && iframe.parentNode) { + // If we've added an additional wrapper div, remove that from the DOM. + // If not, just remove the iframe element. + if (iframe.parentNode.parentNode && _this5._originalElement && _this5._originalElement !== iframe.parentNode) { + iframe.parentNode.parentNode.removeChild(iframe.parentNode); + } else { + iframe.parentNode.removeChild(iframe); + } + } + } + + _this5._window.removeEventListener('message', _this5._onMessage); + + if (screenfull.isEnabled) { + screenfull.off('fullscreenchange', _this5.fullscreenchangeHandler); + } + + resolve(); + }); + } + /** + * A promise to get the autopause behavior of the video. + * + * @promise GetAutopausePromise + * @fulfill {boolean} Whether autopause is turned on or off. + * @reject {UnsupportedError} Autopause is not supported with the current + * player or browser. + */ + + /** + * Get the autopause behavior for this player. + * + * @return {GetAutopausePromise} + */ + + }, { + key: "getAutopause", + value: function getAutopause() { + return this.get('autopause'); + } + /** + * A promise to set the autopause behavior of the video. + * + * @promise SetAutopausePromise + * @fulfill {boolean} Whether autopause is turned on or off. + * @reject {UnsupportedError} Autopause is not supported with the current + * player or browser. + */ + + /** + * Enable or disable the autopause behavior of this player. + * + * By default, when another video is played in the same browser, this + * player will automatically pause. Unless you have a specific reason + * for doing so, we recommend that you leave autopause set to the + * default (`true`). + * + * @param {boolean} autopause + * @return {SetAutopausePromise} + */ + + }, { + key: "setAutopause", + value: function setAutopause(autopause) { + return this.set('autopause', autopause); + } + /** + * A promise to get the buffered property of the video. + * + * @promise GetBufferedPromise + * @fulfill {Array} Buffered Timeranges converted to an Array. + */ + + /** + * Get the buffered property of the video. + * + * @return {GetBufferedPromise} + */ + + }, { + key: "getBuffered", + value: function getBuffered() { + return this.get('buffered'); + } + /** + * @typedef {Object} CameraProperties + * @prop {number} props.yaw - Number between 0 and 360. + * @prop {number} props.pitch - Number between -90 and 90. + * @prop {number} props.roll - Number between -180 and 180. + * @prop {number} props.fov - The field of view in degrees. + */ + + /** + * A promise to get the camera properties of the player. + * + * @promise GetCameraPromise + * @fulfill {CameraProperties} The camera properties. + */ + + /** + * For 360° videos get the camera properties for this player. + * + * @return {GetCameraPromise} + */ + + }, { + key: "getCameraProps", + value: function getCameraProps() { + return this.get('cameraProps'); + } + /** + * A promise to set the camera properties of the player. + * + * @promise SetCameraPromise + * @fulfill {Object} The camera was successfully set. + * @reject {RangeError} The range was out of bounds. + */ + + /** + * For 360° videos set the camera properties for this player. + * + * @param {CameraProperties} camera The camera properties + * @return {SetCameraPromise} + */ + + }, { + key: "setCameraProps", + value: function setCameraProps(camera) { + return this.set('cameraProps', camera); + } + /** + * A representation of a chapter. + * + * @typedef {Object} VimeoChapter + * @property {number} startTime The start time of the chapter. + * @property {object} title The title of the chapter. + * @property {number} index The place in the order of Chapters. Starts at 1. + */ + + /** + * A promise to get chapters for the video. + * + * @promise GetChaptersPromise + * @fulfill {VimeoChapter[]} The chapters for the video. + */ + + /** + * Get an array of all the chapters for the video. + * + * @return {GetChaptersPromise} + */ + + }, { + key: "getChapters", + value: function getChapters() { + return this.get('chapters'); + } + /** + * A promise to get the currently active chapter. + * + * @promise GetCurrentChaptersPromise + * @fulfill {VimeoChapter|undefined} The current chapter for the video. + */ + + /** + * Get the currently active chapter for the video. + * + * @return {GetCurrentChaptersPromise} + */ + + }, { + key: "getCurrentChapter", + value: function getCurrentChapter() { + return this.get('currentChapter'); + } + /** + * A promise to get the color of the player. + * + * @promise GetColorPromise + * @fulfill {string} The hex color of the player. + */ + + /** + * Get the color for this player. + * + * @return {GetColorPromise} + */ + + }, { + key: "getColor", + value: function getColor() { + return this.get('color'); + } + /** + * A promise to set the color of the player. + * + * @promise SetColorPromise + * @fulfill {string} The color was successfully set. + * @reject {TypeError} The string was not a valid hex or rgb color. + * @reject {ContrastError} The color was set, but the contrast is + * outside of the acceptable range. + * @reject {EmbedSettingsError} The owner of the player has chosen to + * use a specific color. + */ + + /** + * Set the color of this player to a hex or rgb string. Setting the + * color may fail if the owner of the video has set their embed + * preferences to force a specific color. + * + * @param {string} color The hex or rgb color string to set. + * @return {SetColorPromise} + */ + + }, { + key: "setColor", + value: function setColor(color) { + return this.set('color', color); + } + /** + * A representation of a cue point. + * + * @typedef {Object} VimeoCuePoint + * @property {number} time The time of the cue point. + * @property {object} data The data passed when adding the cue point. + * @property {string} id The unique id for use with removeCuePoint. + */ + + /** + * A promise to get the cue points of a video. + * + * @promise GetCuePointsPromise + * @fulfill {VimeoCuePoint[]} The cue points added to the video. + * @reject {UnsupportedError} Cue points are not supported with the current + * player or browser. + */ + + /** + * Get an array of the cue points added to the video. + * + * @return {GetCuePointsPromise} + */ + + }, { + key: "getCuePoints", + value: function getCuePoints() { + return this.get('cuePoints'); + } + /** + * A promise to get the current time of the video. + * + * @promise GetCurrentTimePromise + * @fulfill {number} The current time in seconds. + */ + + /** + * Get the current playback position in seconds. + * + * @return {GetCurrentTimePromise} + */ + + }, { + key: "getCurrentTime", + value: function getCurrentTime() { + return this.get('currentTime'); + } + /** + * A promise to set the current time of the video. + * + * @promise SetCurrentTimePromise + * @fulfill {number} The actual current time that was set. + * @reject {RangeError} the time was less than 0 or greater than the + * video’s duration. + */ + + /** + * Set the current playback position in seconds. If the player was + * paused, it will remain paused. Likewise, if the player was playing, + * it will resume playing once the video has buffered. + * + * You can provide an accurate time and the player will attempt to seek + * to as close to that time as possible. The exact time will be the + * fulfilled value of the promise. + * + * @param {number} currentTime + * @return {SetCurrentTimePromise} + */ + + }, { + key: "setCurrentTime", + value: function setCurrentTime(currentTime) { + return this.set('currentTime', currentTime); + } + /** + * A promise to get the duration of the video. + * + * @promise GetDurationPromise + * @fulfill {number} The duration in seconds. + */ + + /** + * Get the duration of the video in seconds. It will be rounded to the + * nearest second before playback begins, and to the nearest thousandth + * of a second after playback begins. + * + * @return {GetDurationPromise} + */ + + }, { + key: "getDuration", + value: function getDuration() { + return this.get('duration'); + } + /** + * A promise to get the ended state of the video. + * + * @promise GetEndedPromise + * @fulfill {boolean} Whether or not the video has ended. + */ + + /** + * Get the ended state of the video. The video has ended if + * `currentTime === duration`. + * + * @return {GetEndedPromise} + */ + + }, { + key: "getEnded", + value: function getEnded() { + return this.get('ended'); + } + /** + * A promise to get the loop state of the player. + * + * @promise GetLoopPromise + * @fulfill {boolean} Whether or not the player is set to loop. + */ + + /** + * Get the loop state of the player. + * + * @return {GetLoopPromise} + */ + + }, { + key: "getLoop", + value: function getLoop() { + return this.get('loop'); + } + /** + * A promise to set the loop state of the player. + * + * @promise SetLoopPromise + * @fulfill {boolean} The loop state that was set. + */ + + /** + * Set the loop state of the player. When set to `true`, the player + * will start over immediately once playback ends. + * + * @param {boolean} loop + * @return {SetLoopPromise} + */ + + }, { + key: "setLoop", + value: function setLoop(loop) { + return this.set('loop', loop); + } + /** + * A promise to set the muted state of the player. + * + * @promise SetMutedPromise + * @fulfill {boolean} The muted state that was set. + */ + + /** + * Set the muted state of the player. When set to `true`, the player + * volume will be muted. + * + * @param {boolean} muted + * @return {SetMutedPromise} + */ + + }, { + key: "setMuted", + value: function setMuted(muted) { + return this.set('muted', muted); + } + /** + * A promise to get the muted state of the player. + * + * @promise GetMutedPromise + * @fulfill {boolean} Whether or not the player is muted. + */ + + /** + * Get the muted state of the player. + * + * @return {GetMutedPromise} + */ + + }, { + key: "getMuted", + value: function getMuted() { + return this.get('muted'); + } + /** + * A promise to get the paused state of the player. + * + * @promise GetLoopPromise + * @fulfill {boolean} Whether or not the video is paused. + */ + + /** + * Get the paused state of the player. + * + * @return {GetLoopPromise} + */ + + }, { + key: "getPaused", + value: function getPaused() { + return this.get('paused'); + } + /** + * A promise to get the playback rate of the player. + * + * @promise GetPlaybackRatePromise + * @fulfill {number} The playback rate of the player on a scale from 0.5 to 2. + */ + + /** + * Get the playback rate of the player on a scale from `0.5` to `2`. + * + * @return {GetPlaybackRatePromise} + */ + + }, { + key: "getPlaybackRate", + value: function getPlaybackRate() { + return this.get('playbackRate'); + } + /** + * A promise to set the playbackrate of the player. + * + * @promise SetPlaybackRatePromise + * @fulfill {number} The playback rate was set. + * @reject {RangeError} The playback rate was less than 0.5 or greater than 2. + */ + + /** + * Set the playback rate of the player on a scale from `0.5` to `2`. When set + * via the API, the playback rate will not be synchronized to other + * players or stored as the viewer's preference. + * + * @param {number} playbackRate + * @return {SetPlaybackRatePromise} + */ + + }, { + key: "setPlaybackRate", + value: function setPlaybackRate(playbackRate) { + return this.set('playbackRate', playbackRate); + } + /** + * A promise to get the played property of the video. + * + * @promise GetPlayedPromise + * @fulfill {Array} Played Timeranges converted to an Array. + */ + + /** + * Get the played property of the video. + * + * @return {GetPlayedPromise} + */ + + }, { + key: "getPlayed", + value: function getPlayed() { + return this.get('played'); + } + /** + * A promise to get the qualities available of the current video. + * + * @promise GetQualitiesPromise + * @fulfill {Array} The qualities of the video. + */ + + /** + * Get the qualities of the current video. + * + * @return {GetQualitiesPromise} + */ + + }, { + key: "getQualities", + value: function getQualities() { + return this.get('qualities'); + } + /** + * A promise to get the current set quality of the video. + * + * @promise GetQualityPromise + * @fulfill {string} The current set quality. + */ + + /** + * Get the current set quality of the video. + * + * @return {GetQualityPromise} + */ + + }, { + key: "getQuality", + value: function getQuality() { + return this.get('quality'); + } + /** + * A promise to set the video quality. + * + * @promise SetQualityPromise + * @fulfill {number} The quality was set. + * @reject {RangeError} The quality is not available. + */ + + /** + * Set a video quality. + * + * @param {string} quality + * @return {SetQualityPromise} + */ + + }, { + key: "setQuality", + value: function setQuality(quality) { + return this.set('quality', quality); + } + /** + * A promise to get the seekable property of the video. + * + * @promise GetSeekablePromise + * @fulfill {Array} Seekable Timeranges converted to an Array. + */ + + /** + * Get the seekable property of the video. + * + * @return {GetSeekablePromise} + */ + + }, { + key: "getSeekable", + value: function getSeekable() { + return this.get('seekable'); + } + /** + * A promise to get the seeking property of the player. + * + * @promise GetSeekingPromise + * @fulfill {boolean} Whether or not the player is currently seeking. + */ + + /** + * Get if the player is currently seeking. + * + * @return {GetSeekingPromise} + */ + + }, { + key: "getSeeking", + value: function getSeeking() { + return this.get('seeking'); + } + /** + * A promise to get the text tracks of a video. + * + * @promise GetTextTracksPromise + * @fulfill {VimeoTextTrack[]} The text tracks associated with the video. + */ + + /** + * Get an array of the text tracks that exist for the video. + * + * @return {GetTextTracksPromise} + */ + + }, { + key: "getTextTracks", + value: function getTextTracks() { + return this.get('textTracks'); + } + /** + * A promise to get the embed code for the video. + * + * @promise GetVideoEmbedCodePromise + * @fulfill {string} The `