npm package: @plutotcool/vue-freecaster
Description: Freecaster video player integration for vue
Author: Julien Dargelos
Latest version: 3.1.0

# vue-freecaster

Freecaster video player integration for vue.

- [Demo](https://plutotcool.github.io/vue-freecaster/playground)
- [Documentation](https://plutotcool.github.io/vue-freecaster)
- [Freecaster documentation](https://docs.freecaster.com/player/index.html)

## Installation

```shell
pnpm install @plutotcool/vue-freecaster
```

## Usage

### Plugin

The plugin loads the required freecaster scripts and globally
registers the `FreecasterPlayer` component in your vue app.

```typescript
import Vue from 'vue';
import { FreecasterPlugin } from '@plutotcool/vue-freecaster'

Vue.use(FreecasterPlugin)
```

- [Plugin options](https://plutotcool.github.io/vue-freecaster/interfaces/Plugin.FreecasterPluginOptions.html)

### Player composable

The `usePlayer` composable provide a reactive freecaster player instance
attached to an element ref.

```vue
<script setup lang="ts">
  import { usePlayer } from '@plutotcool/vue-freecaster'

  const { element, attributes, player } = usePlayer({
    options: {
      videoId: '...'
    }
  })
</script>

<template>
  <div ref="element" v-bind="attributes"/>
</template>
```

- [Composable parameters](https://plutotcool.github.io/vue-freecaster/interfaces/usePlayer.UsePlayerParameters.html)
- [Player options](https://plutotcool.github.io/vue-freecaster/interfaces/Player.PlayerOptions.html)
- [Player instance](https://plutotcool.github.io/vue-freecaster/interfaces/Player.Player.html)

### Player component

The `FreecasterPlayer` component is a wrapper around the `usePlayer` composable.
It also provides models for the player state.

```vue
<script setup lang="ts">
  import { FreecasterPlayer, type Player } from '@plutotcool/vue-freecaster'

  const player = shallowRef<Player>()
  const muted = ref(false)
  const paused = ref(false)
  const volume = ref(1)
  const currentTime = ref(0)
  const readyState = ref(0)
  const fullscreen = ref(false)
  const subtitles = ref<TextTrack[]>([])
  const currentSubtitles = ref<TextTrack>()
</script>

<template>
  <FreecasterPlayer
    video-id="..."
    v-model="player"
    v-model:muted="muted"
    v-model:paused="paused"
    v-model:volume="volume"
    v-model:current-time="currentTime"
    v-model:ready-state="readyState"
    v-model:fullscreen="fullscreen"
    v-model:subtitles="subtitles"
    v-model:current-subtitles="currentSubtitles"
  />
</template>
```

- [Component props](https://plutotcool.github.io/vue-freecaster/interfaces/_FreecasterPlayer__.FreecasterPlayerProps.html)
- [Component events](https://plutotcool.github.io/vue-freecaster/types/_FreecasterPlayer__.FreecasterPlayerEmits.html)

### Custom elements

Out of the box, the freecaster player does not work well inside web components,
there are especially two issues to overcome:

> Automatic player initialization relies on the behavior of
> `document.getElementsByClassName('freecaster-player')` which doesn't select
> elements through shadow doms.

> [!TIP]
> vue-freecaster handles initialization by explicitly calling the global
> `window.fcload` method on the player element.

<br>

> The player stylesheets are included using top-level `<link>` elements in the
> `<head>`, thus css rules don't cascade into shadow doms.

> [!TIP]
> vue-freecaster provides a `<FreecasterStyle/>` component that can be added to
> the closest shadow root that contains your players (eg: your root `<App/>`
> component). It will look for freecaster stylesheets in the `<head>`, and
> import them inside the shadow dom:
>
> ```vue
> <script setup lang="ts">
>   import { FreecasterStyle } from '@plutotcool/vue-freecaster'
> </script>
>
> <template>
>   <FreecasterStyle/>
>   <!-- Rest of your app -->
> </template>
> ```