Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fsobolev committed Sep 1, 2023
1 parent 3e38572 commit 5e9b510
Show file tree
Hide file tree
Showing 7 changed files with 123 additions and 15 deletions.
39 changes: 39 additions & 0 deletions Docfx/_site/api/Nickvision.MPVSharp.Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,45 @@ <h3 id="Nickvision_MPVSharp_Client_CyclePause" data-uid="Nickvision.MPVSharp.Cli



<a id="Nickvision_MPVSharp_Client_DelProperty_" data-uid="Nickvision.MPVSharp.Client.DelProperty*"></a>

<h3 id="Nickvision_MPVSharp_Client_DelProperty_System_String_" data-uid="Nickvision.MPVSharp.Client.DelProperty(System.String)">
DelProperty(string)

</h3>

<div class="markdown level1 summary"><p>Delete property</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void DelProperty(string name)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Property name</p>
</dd>
</dl>









<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="Nickvision.MPVSharp.ClientException.html">ClientException</a></dt>
<dd><p>Thrown if can't delete property</p>
</dd>
</dl>



<a id="Nickvision_MPVSharp_Client_Dispose_" data-uid="Nickvision.MPVSharp.Client.Dispose*"></a>

<h3 id="Nickvision_MPVSharp_Client_Dispose" data-uid="Nickvision.MPVSharp.Client.Dispose">
Expand Down
39 changes: 39 additions & 0 deletions Docfx/_site/api/Nickvision.MPVSharp.Internal.MPVClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,45 @@ <h4 class="section">Returns</h4>



<a id="Nickvision_MPVSharp_Internal_MPVClient_DelProperty_" data-uid="Nickvision.MPVSharp.Internal.MPVClient.DelProperty*"></a>

<h3 id="Nickvision_MPVSharp_Internal_MPVClient_DelProperty_System_String_" data-uid="Nickvision.MPVSharp.Internal.MPVClient.DelProperty(System.String)">
DelProperty(string)

</h3>

<div class="markdown level1 summary"><p>Delete property</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MPVError DelProperty(string name)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Property name</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Nickvision.MPVSharp.Internal.MPVError.html">MPVError</a></dt>
<dd><p>Error code</p>
</dd>
</dl>











<a id="Nickvision_MPVSharp_Internal_MPVClient_Destroy_" data-uid="Nickvision.MPVSharp.Internal.MPVClient.Destroy*"></a>

<h3 id="Nickvision_MPVSharp_Internal_MPVClient_Destroy" data-uid="Nickvision.MPVSharp.Internal.MPVClient.Destroy">
Expand Down
3 changes: 1 addition & 2 deletions Docfx/_site/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@



<meta name="docfx:docurl" content="https://github.com/NickvisionApps/MPVSharp/blob/windows/Docfx/api/index.md/#L1">

</head>

<script type="module">
Expand Down Expand Up @@ -82,7 +82,6 @@ <h1 id="mpvsharp-api">MPVSharp API</h1>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/NickvisionApps/MPVSharp/blob/windows/Docfx/api/index.md/#L1" class="edit-link">Edit this page</a>
</div>

<div class="next-article d-print-none border-top" id="nextArticle"></div>
Expand Down
13 changes: 6 additions & 7 deletions Docfx/_site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@



<meta name="docfx:docurl" content="https://github.com/NickvisionApps/MPVSharp/blob/windows/Docfx/index.md/#L1">

</head>

<script type="module">
Expand Down Expand Up @@ -78,7 +78,7 @@ <h1 id="nickvisionmpvsharp">Nickvision.MPVSharp</h1>
<p>MPVSharp provides C# bindings for <a href="https://mpv.io/manual/master/#embedding-into-other-programs-libmpv">libmpv</a>, a library for embedding amazing <a href="https://mpv.io/">MPV</a> player into another apps.</p>
<h1 id="installation">Installation</h1>
<p><strong><a href="https://www.nuget.org/packages/Nickvision.MPVSharp/">MPVSharp</a></strong> - main package, requires <code>libmpv</code> to be installed on the user system or provided together with your application (works on Windows and Linux).</p>
<p><strong><a href="https://www.nuget.org/packages/Nickvision.MPVSharp.Bundled/">MPVSharp.Bundled</a></strong> - has <code>libmpv</code> built-in (Windows only).</p>
<p><strong><a href="https://www.nuget.org/packages/Nickvision.MPVSharp.Bundled/">MPVSharp.Bundled</a></strong> - has <code>libmpv</code> built-in (Windows 64-bit only, the build is from <a href="https://github.com/shinchiro/mpv-winbuild-cmake">this repo</a>).</p>
<h1 id="how-to-use">How to use</h1>
<p>There are 2 namespaces:</p>
<ul>
Expand All @@ -88,11 +88,11 @@ <h1 id="how-to-use">How to use</h1>
<p>Look at the <a href="#examples">examples</a> to get the basic idea how to use MPVSharp.</p>
<p>There are comments in the code, but they are mostly an adaptation of some parts of comments from libmpv, which is very well documented:</p>
<ul>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/client.h">client.h</a></li>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/render.h">render.h</a></li>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/render_gl.h">renger_gl.h</a></li>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/client.h">client.h</a></li>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/render.h">render.h</a></li>
<li><a href="https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/render_gl.h">renger_gl.h</a></li>
</ul>
<p>Refer to MPV documentation to find the list of <a href="https://mpv.io/manual/master/#options">options</a>, <a href="https://mpv.io/manual/master/#list-of-input-commands">commands</a> and <a href="https://mpv.io/manual/master/#properties">properties</a>.</p>
<p>Refer to MPV documentation to find the list of <a href="https://mpv.io/manual/stable/#options">options</a>, <a href="https://mpv.io/manual/stable/#list-of-input-commands">commands</a> and <a href="https://mpv.io/manual/stable/#properties">properties</a>.</p>
<h1 id="examples">Examples</h1>
<p><img src="https://raw.githubusercontent.com/NickvisionApps/MPVSharp/main/Examples/GirCore/Screenshot.png" alt="GirCore Example"></p>
<p><sub>GirCore example playing <a href="https://www.youtube.com/watch?v=UXqq0ZvbOnk">Charge</a> - Blender open movie, licensed under CC BY 4.0</sub></p>
Expand All @@ -113,7 +113,6 @@ <h1 id="code-of-conduct">Code of Conduct</h1>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/NickvisionApps/MPVSharp/blob/windows/Docfx/index.md/#L1" class="edit-link">Edit this page</a>
</div>

<div class="next-article d-print-none border-top" id="nextArticle"></div>
Expand Down
2 changes: 1 addition & 1 deletion Docfx/_site/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"homepages": [],
"source_base_path": "/mnt/c/Devel/MPVSharp/Docfx",
"source_base_path": "C:/Devel/MPVSharp/Docfx",
"xrefmap": "xrefmap.yml",
"files": [
{
Expand Down
32 changes: 32 additions & 0 deletions Docfx/_site/xrefmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,22 @@ references:
isSpec: "True"
fullName: Nickvision.MPVSharp.Client.CyclePause
nameWithType: Client.CyclePause
- uid: Nickvision.MPVSharp.Client.DelProperty(System.String)
name: DelProperty(string)
href: api/Nickvision.MPVSharp.Client.html#Nickvision_MPVSharp_Client_DelProperty_System_String_
commentId: M:Nickvision.MPVSharp.Client.DelProperty(System.String)
name.vb: DelProperty(String)
fullName: Nickvision.MPVSharp.Client.DelProperty(string)
fullName.vb: Nickvision.MPVSharp.Client.DelProperty(String)
nameWithType: Client.DelProperty(string)
nameWithType.vb: Client.DelProperty(String)
- uid: Nickvision.MPVSharp.Client.DelProperty*
name: DelProperty
href: api/Nickvision.MPVSharp.Client.html#Nickvision_MPVSharp_Client_DelProperty_
commentId: Overload:Nickvision.MPVSharp.Client.DelProperty
isSpec: "True"
fullName: Nickvision.MPVSharp.Client.DelProperty
nameWithType: Client.DelProperty
- uid: Nickvision.MPVSharp.Client.Destroyed
name: Destroyed
href: api/Nickvision.MPVSharp.Client.html#Nickvision_MPVSharp_Client_Destroyed
Expand Down Expand Up @@ -1207,6 +1223,22 @@ references:
isSpec: "True"
fullName: Nickvision.MPVSharp.Internal.MPVClient.CommandString
nameWithType: MPVClient.CommandString
- uid: Nickvision.MPVSharp.Internal.MPVClient.DelProperty(System.String)
name: DelProperty(string)
href: api/Nickvision.MPVSharp.Internal.MPVClient.html#Nickvision_MPVSharp_Internal_MPVClient_DelProperty_System_String_
commentId: M:Nickvision.MPVSharp.Internal.MPVClient.DelProperty(System.String)
name.vb: DelProperty(String)
fullName: Nickvision.MPVSharp.Internal.MPVClient.DelProperty(string)
fullName.vb: Nickvision.MPVSharp.Internal.MPVClient.DelProperty(String)
nameWithType: MPVClient.DelProperty(string)
nameWithType.vb: MPVClient.DelProperty(String)
- uid: Nickvision.MPVSharp.Internal.MPVClient.DelProperty*
name: DelProperty
href: api/Nickvision.MPVSharp.Internal.MPVClient.html#Nickvision_MPVSharp_Internal_MPVClient_DelProperty_
commentId: Overload:Nickvision.MPVSharp.Internal.MPVClient.DelProperty
isSpec: "True"
fullName: Nickvision.MPVSharp.Internal.MPVClient.DelProperty
nameWithType: MPVClient.DelProperty
- uid: Nickvision.MPVSharp.Internal.MPVClient.Destroy
name: Destroy()
href: api/Nickvision.MPVSharp.Internal.MPVClient.html#Nickvision_MPVSharp_Internal_MPVClient_Destroy
Expand Down
10 changes: 5 additions & 5 deletions Docfx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MPVSharp provides C# bindings for [libmpv](https://mpv.io/manual/master/#embeddi
# Installation
**[MPVSharp](https://www.nuget.org/packages/Nickvision.MPVSharp/)** - main package, requires `libmpv` to be installed on the user system or provided together with your application (works on Windows and Linux).

**[MPVSharp.Bundled](https://www.nuget.org/packages/Nickvision.MPVSharp.Bundled/)** - has `libmpv` built-in (Windows only).
**[MPVSharp.Bundled](https://www.nuget.org/packages/Nickvision.MPVSharp.Bundled/)** - has `libmpv` built-in (Windows 64-bit only, the build is from [this repo](https://github.com/shinchiro/mpv-winbuild-cmake)).

# How to use

Expand All @@ -18,11 +18,11 @@ There are 2 namespaces:
Look at the [examples](#examples) to get the basic idea how to use MPVSharp.

There are comments in the code, but they are mostly an adaptation of some parts of comments from libmpv, which is very well documented:
* [client.h](https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/client.h)
* [render.h](https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/render.h)
* [renger_gl.h](https://github.com/mpv-player/mpv/blob/release/0.35/libmpv/render_gl.h)
* [client.h](https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/client.h)
* [render.h](https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/render.h)
* [renger_gl.h](https://github.com/mpv-player/mpv/blob/release/0.36/libmpv/render_gl.h)

Refer to MPV documentation to find the list of [options](https://mpv.io/manual/master/#options), [commands](https://mpv.io/manual/master/#list-of-input-commands) and [properties](https://mpv.io/manual/master/#properties).
Refer to MPV documentation to find the list of [options](https://mpv.io/manual/stable/#options), [commands](https://mpv.io/manual/stable/#list-of-input-commands) and [properties](https://mpv.io/manual/stable/#properties).

# Examples

Expand Down

0 comments on commit 5e9b510

Please sign in to comment.