Skip to main content
Total Downloads
2.6K
2,617
Published
Dec 6, 2023
2y ago

Get Started

dotnet add package Iciclecreek.Avalonia.Controls.Media --version 1.0.5
ProductVersions
.NET
net6.0

README

Icon

Iciclecreek.Avalonia.Controls.Media

This control library adds support for LibVLC MediaPlayer for Avalonia Desktop applications.

  • MediaPlayerViewModel - A view model class which wraps MediaPlayer so that it's easy to bind UI controls to Commands and state.
  • VideoView element - a element which playing videos and exposes MediaPlayerViewModel for controlling the video playback.
  • MediaPlayerControls element - a off-the-shelf implementation of a UI to control playback of the video
    • Play/Stop/Pause
    • Mute
    • Rate
    • etc.

Installation

  • Install the control nuget package into to your shared Avalonia project
    • Iciclcreek.Avalonia.Controls.Media
  • Install the video playback nuget packages into your Desktop project
    • VideoLan.LibVLC.Mac
    • VideoLAN.LibVLC.Windows

Add a namespace for the library to your .axaml files:

xmlns:media="using:Iciclecreek.Avalonia.Controls.Media"

Samples

Overlay Controls Sample

<media:VideoView Source={Binding Url}>
   <media:MediaPlayerControls/>
</media:VideoView>

MediaPlayerControls-overlay.gif MediaPlayerControls-overlay.gif

External Controls Sample

In this case a MediaPlayerControls element is external to the video player window (aka, not overlayed), but data bound to the MediaPlayerViewModel for the VideoView.

<media:VideoView Name="Player" Source={Binding Url} />

<media:MediaPlayerControls DataContext={Binding #Player.MediaPlayerViewModel}"/>

Custom binding sample

Here is an example which shows how you can create your own command bindings using the MediaPlayerViewModel

<media:VideoView Name="Player" Source={Binding Url} >
    <StackPanel Orientation="Horizontal" Background="Lavender">
        <Button Command="{Binding Play}">Play</Button>
        <Slider Value="{Binding Time}" Maximum="{Binding Length}" Width="200"/>
        <Button Command="{Binding Stop}">Stop</Button>
    </StackPanel>
</media:VideoView>

MediaPlayerViewModel class

The main class driving this is a view model which is set up to support Commands and Property notification to make it easy to data bind UI to the state of the MediaPlayer in the VideoView control. All of the Commands implement CanXXX() so that they are enabled/disabled automatically when bound as a Command.

Command Parameters Description
Play - Play video
Stop - Stop Video - Play starts video over
Pause - Pause video - Play resumes
Mute - Mutes video
Unmute - Unmutes video
TogglePlayPause - Toggles Play/Pause for video
ToggleMute - Toggles Mute state
SetRate float Changes rate of playback (for example "1.75" => 1.75x faster than noraml)
Download Open video external

The MediaPlayerViewModel also exposes the state of the MediaPlayer so you can bind your UI to the properties and it will update in real time to changes (aka appropriate property notification).

Property Type Description
IsMuted bool Mute state
IsCloseCaptioned bool Closed Caption state
Volume int volume for the video playback
IsSeekable bool Seekable state
Time int Current playback position in ms. Changing this changes playback position, so Slider control bound to this controls playback position of the video.
Length int Length of the video in ms.
Rate float Playback speed.

VideoView element

This library contains a fork of the unofficial VideoView with overlay support. The changes are

  • Adds a MediaPlayerViewModel property
  • Sets DataContext for child overlay content to MediaPlayerViewModel
  • Fixes overlay bugs on linux
  • Fixes positioning bugs for overlay
  • Cleaned up (removed static this pointers)

MediaPlayerControls Element

This is a prebuilt element which looks like this:

image-20231114101518141

Supported Platforms

  • Avalonia.Desktop
    • Windows
    • Linux
    • MacOS

It has not been tested at all with Android/iOS

Downloads by Version

Similar & Alternative Packages

Hand-picked matching NuGet libraries based on tags & ecosystem

Depended On By

Find packages that declare this package as a dependency. NuGet does not provide a reverse-dependency endpoint, so candidates are checked on demand.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

Compatibility metadata lists 1 target framework; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.