Skip to content

Commit

Permalink
adding nugetdoc.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mariodivece committed Apr 19, 2019
1 parent 34e6e45 commit 929711b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
9 changes: 9 additions & 0 deletions Support/nugetdoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Here is a quick guide on how to get started.
1. Open Visual Studio (v2019 recommended), and create a new WPF Application. Target Framework must be 4.6.1 or above.
2. Install the NuGet Package from your Package Manager Console: `PM> Install-Package FFME.Windows`
3. You need FFmpeg **shared** binaries (64 or 32 bit, depending on your app's target architecture). Build your own or download a compatible build from [Zeranoe FFmpeg Builds site](https://ffmpeg.zeranoe.com/builds/).
4. Your FFmpeg build should have a `bin` folder with 3 exe files and some dll files. Copy all those files to a folder such as `c:\ffmpeg`
5. Within you application's startup code (`Main` method), set `Unosquare.FFME.Library.FFmpegDirectory = @"c:\ffmpeg";`.
6. Use the FFME `MediaElement` control as any other WPF control.
For example: In your `MainForm.xaml`, add the namespace: `xmlns:ffme="clr-namespace:Unosquare.FFME;assembly=ffme.win"` and then add the FFME control your window's XAML: `<ffme:MediaElement x:Name="Media" Background="Gray" LoadedBehavior="Play" UnloadedBehavior="Manual" />`
7. To play files or streams, simply set the `Source` property: `Media.Source = new Uri(@"c:\your-file-here");`. Since `Source` is a dependency property, it needs to be set from the GUI thread.
2 changes: 1 addition & 1 deletion Unosquare.FFME.Windows/Unosquare.FFME.Windows.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<PropertyGroup>
<!-- Assembly Properties -->
<TargetFrameworks>net472</TargetFrameworks>
<TargetFrameworks>net472;net461;netcoreapp3.0</TargetFrameworks>
<RootNamespace>Unosquare.FFME</RootNamespace>
<LangVersion>latest</LangVersion>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
Expand Down
1 change: 1 addition & 0 deletions Unosquare.FFME.sln
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Support", "Support", "{8BF2
Support\ffme.png = Support\ffme.png
Support\ffmeplay.png = Support\ffmeplay.png
LICENSE = LICENSE
Support\nugetdoc.md = Support\nugetdoc.md
README.md = README.md
Support\readme.txt = Support\readme.txt
toc.yml = toc.yml
Expand Down

0 comments on commit 929711b

Please sign in to comment.