Skip to content

ol-videorecorder-control

A simple toggle control The control can be created with an interaction to control its activation.

Demo

Setup

Plugin usage

This component is part of the MapControls plugin. If not installed globally, you need to import and use the plugin in your main.ts or use the explicit component import (see section below).

Import and use the MapControls plugin
ts
import { createApp } from "vue";
import App from "./App.vue";

import { 
  Map,
  Layers,
  Sources,
  MapControls
} from 'vue3-openlayers';

const app = createApp(App);
// ...
app.use(MapControls); 
// ...

Explicit import

If you don't want to install a plugin, you can import the component explicitly. It's available as a child of the named export MapControls.

NOTE

The following documentation refers to the plugin usage. Please make sure to adopt the component names, when you decided to use explicit component imports (e. g. <ol-map> becomes <Map.OlMap> etc.).

Usage

Plugin UsageExplicit Import
<ol-videorecorder-control><MapControls.OlVideoRecorderControl>
vue
<template>
  <ol-map style="height: 400px" :controls="[]">
    <ol-view :center="center" :zoom="zoom" :projection="projection" />

    <ol-tile-layer>
      <ol-source-osm />
    </ol-tile-layer>
    <ol-videorecorder-control @stop="videoStopped" />
  </ol-map>
</template>

<script setup>
import { ref } from "vue";
const center = ref([40, 40]);
const projection = ref("EPSG:4326");
const zoom = ref(8);

const videoStopped = (event) => {
  console.log(event);
};
</script>

Properties

Props from OpenLayers

Properties are passed-trough from ol-ext directly. Their types and default values can be checked-out in the official docs. Only some properties deviate caused by reserved keywords from Vue / HTML. This deviating props are described in the section below.

Deviating Properties

downloadName

If this property is set, the file will be downloaded immediately after stopping the recording and saved as the given downloadName. If not defined, you need to handle the stop event fired on component level. By default this property is set to mapVideo.mp4.

Events

You have access to all Events from the underlying control. Check out the official docs to see the available events tht will be fired.

html
<ol-videorecorder-control @error="handleEvent" />

Methods

You have access to all Methods from the underlying control. Check out the official docs to see the available methods.

To access the source, you can use a ref() as shown below:

vue
<template>
  <!-- ... -->
  <ol-videorecorder-control ref="vRef" @error="handleEvent" />
  <!-- ... -->
</template>

<script setup lang="ts">
import { ref, onMounted } from "vue";
import type VideoRecorder from "ol-ext/control/VideoRecorder";

const vRef = ref<{ control: VideoRecorder }>(null);

onMounted(() => {
  const recorder: VideoRecorder = vRef.value?.control;
  // call your method on `recorder`
});
</script>