Iciclecreek.Avalonia.Controls.Media 1.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package Iciclecreek.Avalonia.Controls.Media --version 1.0.3                
NuGet\Install-Package Iciclecreek.Avalonia.Controls.Media -Version 1.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Iciclecreek.Avalonia.Controls.Media" Version="1.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Iciclecreek.Avalonia.Controls.Media --version 1.0.3                
#r "nuget: Iciclecreek.Avalonia.Controls.Media, 1.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Iciclecreek.Avalonia.Controls.Media as a Cake Addin
#addin nuget:?package=Iciclecreek.Avalonia.Controls.Media&version=1.0.3

// Install Iciclecreek.Avalonia.Controls.Media as a Cake Tool
#tool nuget:?package=Iciclecreek.Avalonia.Controls.Media&version=1.0.3                

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 appropriate implement CanXXX() so that they are enabled/disabled as appropriate.

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

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

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Iciclecreek.Avalonia.Controls.Media:

Package Downloads
Iciclecreek.AdaptiveCards.Rendering.Avalonia

AdaptiveCard renderer for AvaloniauUI

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.5 305 12/6/2023
1.0.4 164 11/16/2023
1.0.3 127 11/15/2023
1.0.2 127 11/15/2023
1.0.1 128 11/15/2023
1.0.0 118 11/14/2023