You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

4606 lines
214 KiB

<?xml version="1.0"?>
<doc>
<assembly>
<name>LibVLCSharp</name>
</assembly>
<members>
<member name="F:LibVLCSharp.Shared.Constants.LibrariesRepositoryFolderName">
<summary>
The name of the folder that contains the per-architecture folders
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Core">
<summary>
The Core class handles libvlc loading intricacies on various platforms as well as
the libvlc/libvlcsharp version match check.
</summary>
<summary>
The Core class handles libvlc loading intricacies on various platforms as well as
the libvlc/libvlcsharp version match check.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Core.Native.XInitThreads">
<summary>
Initializes the X threading system
</summary>
<remarks>Linux X11 only</remarks>
<returns>non-zero on success, zero on failure</returns>
</member>
<member name="M:LibVLCSharp.Shared.Core.EnsureVersionsMatch">
<summary>
Checks whether the major version of LibVLC and LibVLCSharp match <para/>
Throws a VLCException if the major versions mismatch
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Core.Initialize(System.String)">
<summary>
Load the native libvlc library (if necessary, depending on platform)
<para/> Ensure that you installed the VideoLAN.LibVLC.[YourPlatform] package in your target project
<para/> This will throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the native libvlc libraries cannot be found or loaded.
<para/> It may also throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the LibVLC and LibVLCSharp major versions do not match.
See https://code.videolan.org/videolan/LibVLCSharp/-/blob/master/docs/versioning.md for more info about the versioning strategy.
</summary>
<param name="libvlcDirectoryPath">The path to the directory that contains libvlc and libvlccore
No need to specify unless running netstandard 1.1, or using custom location for libvlc
<para/> This parameter is NOT supported on Linux, use LD_LIBRARY_PATH instead.
</param>
</member>
<member name="M:LibVLCSharp.Shared.Core.DisableMessageErrorBox">
<summary>
Disable error dialogs in case of dll loading failures on older Windows versions.
<para/>
This is mostly to fix Windows XP support (https://code.videolan.org/videolan/LibVLCSharp/issues/173),
though it may happen under other conditions (broken plugins/wrong ABI).
<para/>
As libvlc may load additional plugins later in the lifecycle of the application,
we should not unset this on exiting <see cref="M:LibVLCSharp.Shared.Core.Initialize(System.String)"/>
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Dialog">
<summary>
Dialogs can be raised by libvlc for network actions and logins.
You may only call once PostLogin or PostAction or Dismiss after which this instance will be invalid.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Dialog.PostLogin(System.String,System.String,System.Boolean)">
<summary>
Post a login answer.
After this call, the instance won't be valid anymore
</summary>
<param name="username">valid non-empty string</param>
<param name="password">valid string</param>
<param name="store">if true stores the credentials</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.Dialog.PostAction(System.Int32)">
<summary>
Post a question answer.
After this call, this instance won't be valid anymore
QuestionCb
</summary>
<param name="actionIndex">1 for action1, 2 for action2</param>
<returns>return true on success, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.Dialog.Dismiss">
<summary>
Dismiss a dialog.
After this call, this instance won't be valid anymore
</summary>
<returns>true if properly dismissed, false otherwise</returns>
</member>
<member name="T:LibVLCSharp.Shared.DialogQuestionType">
<summary>
Describes the question type by libvlc
</summary>
</member>
<member name="F:LibVLCSharp.Shared.DialogQuestionType.Normal">
<summary>
Normal question
</summary>
</member>
<member name="F:LibVLCSharp.Shared.DialogQuestionType.Warning">
<summary>
Warning question
</summary>
</member>
<member name="F:LibVLCSharp.Shared.DialogQuestionType.Critical">
<summary>
Critical question
</summary>
</member>
<member name="T:LibVLCSharp.Shared.DisplayError">
<summary>
Called when an error message needs to be displayed.
</summary>
<param name="title">title of the dialog </param>
<param name="text">text of the dialog </param>
</member>
<member name="T:LibVLCSharp.Shared.DisplayLogin">
<summary>
Called when a login dialog needs to be displayed.
You can interact with this dialog by calling PostLogin() to post an answer or Dismiss() to cancel this dialog.
</summary>
<param name="dialog">id used to interact with the dialog </param>
<param name="title">title of the dialog </param>
<param name="text">text of the dialog </param>
<param name="defaultUsername">user name that should be set on the user form</param>
<param name="askStore">if true, ask the user if he wants to save the credentials</param>
<param name="token">Use token to cancel operation</param>
</member>
<member name="T:LibVLCSharp.Shared.DisplayQuestion">
<summary>
Called when a question dialog needs to be displayed.
You can interact with this dialog by calling PostAction() to post an answer or Dismiss() to cancel this dialog.
</summary>
<param name="dialog">id used to interact with the dialog</param>
<param name="title">title of the dialog</param>
<param name="text">text of the dialog</param>
<param name="type">question type (or severity) of the dialog</param>
<param name="cancelText">text of the cancel button</param>
<param name="firstActionText">text of the first button, if NULL, don't display this button</param>
<param name="secondActionText">text of the second button, if NULL, don't display this button</param>
<param name="token">Use token to cancel operation</param>
</member>
<member name="T:LibVLCSharp.Shared.DisplayProgress">
<summary>
Called when a progress dialog needs to be displayed.
If cancellable cancelText is not NULL, you can cancel this dialog by calling libvlc_dialog_dismiss()
</summary>
<param name="dialog">id used to interact with the dialog</param>
<param name="title">title of the dialog</param>
<param name="text">text of the dialog</param>
<param name="indeterminate">true if the progress dialog is indeterminate</param>
<param name="position">initial position of the progress bar (between 0.0 and 1.0)</param>
<param name="cancelText">text of the cancel button, if NULL the dialog is not cancellable</param>
<param name="token">Use token to cancel operation</param>
</member>
<member name="T:LibVLCSharp.Shared.UpdateProgress">
<summary>
Called when a progress dialog needs to be updated.
</summary>
<param name="dialog">id of the dialog</param>
<param name="position">position of the progress bar (between 0.0 and 1.0)</param>
<param name="text">new text of the progress dialog </param>
</member>
<member name="T:LibVLCSharp.Shared.Equalizer">
<summary>
Equalizer settings can be applied to a media player using this type
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.#ctor">
<summary>
Create a new default equalizer, with all frequency values zeroed.
The new equalizer can subsequently be applied to a media player by invoking
libvlc_media_player_set_equalizer().
version LibVLC 2.2.0 or later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.#ctor(System.UInt32)">
<summary>
Create a new equalizer, with initial frequency values copied from an existing preset.
The new equalizer can subsequently be applied to a media player by invoking
libvlc_media_player_set_equalizer().
version LibVLC 2.2.0 or later
</summary>
<param name="index">index of the preset, counting from zero</param>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.SetPreamp(System.Single)">
<summary>
Set a new pre-amplification value for an equalizer.
The new equalizer settings are subsequently applied to a media player by invoking
MediaPlayer::setEqualizer().
The supplied amplification value will be clamped to the -20.0 to +20.0 range.
</summary>
<param name="preamp">preamp value (-20.0 to 20.0 Hz)</param>
LibVLC 2.2.0 or later
<returns>true on success, false otherwise</returns>
</member>
<member name="P:LibVLCSharp.Shared.Equalizer.Preamp">
<summary>
Get the current pre-amplification value from an equalizer.
return preamp value (Hz)
LibVLC 2.2.0 or later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.SetAmp(System.Single,System.UInt32)">
<summary>
Set a new amplification value for a particular equalizer frequency band.
The new equalizer settings are subsequently applied to a media player by invoking MediaPlayer::setEqualizer().
The supplied amplification value will be clamped to the -20.0 to +20.0 range.
LibVLC 2.2.0 or later
</summary>
<param name="amp">amplification value (-20.0 to 20.0 Hz)</param>
<param name="band">index, counting from zero, of the frequency band to set</param>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.Amp(System.UInt32)">
<summary>
Get the amplification value for a particular equalizer frequency band.
LibVLC 2.2.0 or later
</summary>
<param name="band">index, counting from zero, of the frequency band to get</param>
<returns>amplification value (Hz); NaN if there is no such frequency band</returns>
</member>
<member name="P:LibVLCSharp.Shared.Equalizer.PresetCount">
<summary>
Get the number of equalizer presets.
LibVLC 2.2.0 or later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.PresetName(System.UInt32)">
<summary>
Get the name of a particular equalizer preset.
This name can be used, for example, to prepare a preset label or menu in a user interface.
</summary>
<param name="index">index of the preset, counting from zero</param>
<returns>preset name, or empty string if there is no such preset</returns>
</member>
<member name="P:LibVLCSharp.Shared.Equalizer.BandCount">
<summary>
Get the number of distinct frequency bands for an equalizer.
return number of frequency bands
LibVLC 2.2.0 or later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Equalizer.BandFrequency(System.UInt32)">
<summary>
Get a particular equalizer band frequency.
This value can be used, for example, to create a label for an equalizer band control in a user interface.
LibVLC 2.2.0 or later
</summary>
<param name="index">index index of the band, counting from zero</param>
<returns>equalizer band frequency (Hz), or -1 if there is no such band</returns>
</member>
<member name="T:LibVLCSharp.Shared.EventManager.EventTypeManager">
<summary>
The class that manages one type of event
</summary>
</member>
<member name="M:LibVLCSharp.Shared.EventManager.Attach(LibVLCSharp.Shared.EventType,System.Action{System.IntPtr})">
<summary>
Increments the reference count to the event handler method.
</summary>
<param name="eventType">The event type</param>
<param name="eventHandler">The event handler for this event type</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerChangedEventArgs">
<summary>
The MediaPlayerChanged event indicates when a new MediaPlayer has been set up with the VideoView
and is ready to use for a first time playback.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayerChangedEventArgs.#ctor(LibVLCSharp.Shared.MediaPlayer,LibVLCSharp.Shared.MediaPlayer)">
<summary>
MediaPlayerChangedEventArgs constructor, used internally by LibVLCSharp
</summary>
<param name="oldMediaPlayer">The previous mediaplayer (if any)</param>
<param name="newMediaPlayer">The new mediaplayer (if any)</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayerChangedEventArgs.OldMediaPlayer">
<summary>
The previous mediaplayer (if any)
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayerChangedEventArgs.NewMediaPlayer">
<summary>
The new mediaplayer (if any)
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerChangingEventArgs">
<summary>
Internal event used by LibVLCSharp.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayerChangingEventArgs.#ctor(LibVLCSharp.Shared.MediaPlayer,LibVLCSharp.Shared.MediaPlayer)">
<summary>
MediaPlayerChangingEventArgs constructor, used internally by LibVLCSharp
</summary>
<param name="oldMediaPlayer">The previous mediaplayer (if any)</param>
<param name="newMediaPlayer">The new mediaplayer (if any)</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayerChangingEventArgs.OldMediaPlayer">
<summary>
The previous mediaplayer (if any)
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayerChangingEventArgs.NewMediaPlayer">
<summary>
The new mediaplayer (if any)
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.Structures.AudioOutputDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">AudioOutputDescriptionStructure from interop</param>
<returns>public AudioOutputDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.Structures.AudioOutputDeviceStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">AudioOutputDeviceStructure from interop</param>
<returns>public AudioOutputDevice to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.Structures.ModuleDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">ModuleDescriptionStructure from interop</param>
<returns>public ModuleDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.Structures.TrackDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">TrackDescriptionStructure from interop</param>
<returns>public TrackDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.Structures.ChapterDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">ChapterDescriptionStructure from interop</param>
<returns>public ChapterDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.MediaSlaveStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">MediaSlaveStructure from interop</param>
<returns>public MediaSlave to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.MediaTrackStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">TrackDescriptionStructure from interop</param>
<returns>public TrackDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.SubtitleTrackStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">SubtitleTrackStructure from interop</param>
<returns>public SubtitleTrack to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.MediaDiscovererDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">MediaDiscovererDescriptionStructure from interop</param>
<returns>public MediaDiscovererDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.Build(LibVLCSharp.Shared.RendererDescriptionStructure)">
<summary>
Helper method that creates a user friendly type from the internal interop structure.
</summary>
<param name="s">RendererDescriptionStructure from interop</param>
<returns>public RendererDescription to be consumed by the user</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.ToUtf8(System.String)">
<summary>
Helper method that marshals a UTF16 managed string to a UTF8 native string ptr
</summary>
<param name="str">the managed string to marshal to native</param>
<returns>a ptr to the UTF8 string that needs to be freed after use</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalExtensions.FromUtf8(System.IntPtr,System.Boolean)">
<summary>
Helper method that mashals a UTF8 native string ptr to a UTF16 managed string.
Optionally frees the native string ptr
</summary>
<param name="nativeString">the native string to marshal to managed</param>
<param name="libvlcFree">frees the native pointer of the libvlc string (use only for char*)</param>
<returns>a managed UTF16 string</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.CreateWithOptions(System.String[],System.Func{System.Int32,System.IntPtr[],System.IntPtr})">
<summary>
Helper for libvlc_new
</summary>
<param name="options">libvlc options, an UTF16 string array turned to UTF8 string pointer array</param>
<param name="create">the create function call</param>
<returns>the result of the create function</returns>
<exception cref="T:LibVLCSharp.Shared.VLCException">Thrown when libvlc could not be created</exception>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Retrieve``2(System.Func{System.IntPtr},System.Func{System.IntPtr,``0},System.Func{``0,``1},System.Func{``0,System.IntPtr},System.Action{System.IntPtr})">
<summary>
Generic marshalling function to retrieve structs from a libvlc linked list
</summary>
<typeparam name="T">Internal struct type</typeparam>
<typeparam name="TU">publicly facing struct type</typeparam>
<param name="getRef">Native libvlc call: retrieve collection start pointer from parent reference</param>
<param name="retrieve">Retrieve the internal struct by marshalling the native pointer</param>
<param name="create">Create a publicly facing struct from the internal struct values</param>
<param name="next">Access next element in the list</param>
<param name="releaseRef">Native libvlc call: release resources allocated with the getRef call</param>
<returns>An array of publicly facing struct types</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Retrieve``2(System.IntPtr,LibVLCSharp.Shared.Helpers.MarshalUtils.ArrayOut,System.Func{System.IntPtr,``0},System.Func{``0,``1},System.Action{System.IntPtr,System.UInt32})">
<summary>
Generic marshalling function to retrieve structs from libvlc by reading from unmanaged memory with offsets
This supports uint libvlc signatures.
</summary>
<typeparam name="T">Internal struct type</typeparam>
<typeparam name="TU">publicly facing struct type</typeparam>
<param name="nativeRef">native reference of the parent</param>
<param name="getRef">Native libvlc call: retrieve collection start pointer from parent reference</param>
<param name="retrieve">Retrieve the internal struct by marshalling the native pointer</param>
<param name="create">Create a publicly facing struct from the internal struct values</param>
<param name="releaseRef">Native libvlc call: release the array allocated with the getRef call with the given element count</param>
<returns>An array of publicly facing struct types</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Retrieve``2(System.IntPtr,LibVLCSharp.Shared.Helpers.MarshalUtils.ArrayLongOut,System.Func{System.IntPtr,``0},System.Func{``0,``1},System.Action{System.IntPtr,System.UIntPtr})">
<summary>
Generic marshalling function to retrieve structs from libvlc by reading from unmanaged memory with offsets
</summary>
<typeparam name="T">Internal struct type</typeparam>
<typeparam name="TU">publicly facing struct type</typeparam>
<param name="nativeRef">native reference of the parent</param>
<param name="getRef">Native libvlc call: retrieve collection start pointer from parent reference</param>
<param name="retrieve">Retrieve the internal struct by marshalling the native pointer</param>
<param name="create">Create a publicly facing struct from the internal struct values</param>
<param name="releaseRef">Native libvlc call: release the array allocated with the getRef call with the given element count</param>
<returns>An array of publicly facing struct types</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Retrieve``3(System.IntPtr,``2,LibVLCSharp.Shared.Helpers.MarshalUtils.CategoryArrayOut{``2},System.Func{System.IntPtr,``0},System.Func{``0,``1},System.Action{System.IntPtr,System.UIntPtr})">
<summary>
Generic marshalling function to retrieve structs from libvlc by reading from unmanaged memory with offsets
This supports an additional enum configuration parameter.
</summary>
<typeparam name="T">Internal struct type</typeparam>
<typeparam name="TU">publicly facing struct type</typeparam>
<typeparam name="TE">Additional enum confugation type</typeparam>
<param name="nativeRef">native reference of the parent</param>
<param name="extraParam">Additional enum confugation type</param>
<param name="getRef">Native libvlc call: retrieve collection start pointer from parent reference</param>
<param name="retrieve">Retrieve the internal struct by marshalling the native pointer</param>
<param name="create">Create a publicly facing struct from the internal struct values</param>
<param name="releaseRef">Native libvlc call: release the array allocated with the getRef call with the given element count</param>
<returns>An array of publicly facing struct types</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.ToUtf8(System.String[])">
<summary>
Turns an array of UTF16 C# strings to an array of pointer to UTF8 strings
</summary>
<param name="args"></param>
<returns>Array of pointer you need to release when you're done with Marshal.FreeHGlobal</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.PtrToStructure``1(System.IntPtr)">
<summary>
Marshal a pointer to a struct
Helper with netstandard1.1 and net40 support
</summary>
<typeparam name="T"></typeparam>
<param name="ptr"></param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Open(System.String,System.IntPtr@)">
<summary>
Crossplatform dlopen
</summary>
<returns>true if successful</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.Close(System.IntPtr)">
<summary>
Crossplatform fclose
</summary>
<param name="fileHandle"></param>
<returns>true if successful</returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.LibVLCFree(System.IntPtr@)">
<summary>
Frees an heap allocation returned by a LibVLC function.
If you know you're using the same underlying C run-time as the LibVLC
implementation, then you can call ANSI C free() directly instead.
</summary>
<param name="ptr">the pointer</param>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.PerformInteropAndFree``1(System.Func{``0},System.IntPtr[])">
<summary>
Performs the native call, frees the ptrs and returns the result
</summary>
<typeparam name="T"></typeparam>
<param name="interopCall"></param>
<param name="ptrs"></param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.PerformInteropAndFree(System.Action,System.IntPtr[])">
<summary>
Performs the native call and frees the ptrs
</summary>
<param name="interopCall"></param>
<param name="ptrs"></param>
</member>
<member name="M:LibVLCSharp.Shared.Helpers.MarshalUtils.GetInstance``1(System.IntPtr)">
<summary>
Gets the instance represented by the given handle.
This must be a GCHandle.
</summary>
<typeparam name="T">The type of instance to retrieve</typeparam>
<param name="handle">The handle given back by libvlc</param>
<returns>null if it is not a valid handle, the instance otherwise</returns>
</member>
<member name="T:LibVLCSharp.Shared.PlatformHelper">
<summary>
Small helper for determining the current platform
</summary>
</member>
<member name="P:LibVLCSharp.Shared.PlatformHelper.IsWindows">
<summary>
Returns true if running on Windows, false otherwise
</summary>
</member>
<member name="P:LibVLCSharp.Shared.PlatformHelper.IsLinux">
<summary>
Returns true if running on Linux, false otherwise
</summary>
</member>
<member name="P:LibVLCSharp.Shared.PlatformHelper.IsLinuxDesktop">
<summary>
Returns true if running on Linux desktop, false otherwise
</summary>
</member>
<member name="P:LibVLCSharp.Shared.PlatformHelper.IsMac">
<summary>
Returns true if running on macOS, false otherwise
</summary>
</member>
<member name="P:LibVLCSharp.Shared.PlatformHelper.IsX64BitProcess">
<summary>
Returns true if running in 64bit process, false otherwise
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Internal">
<summary>
This base class is used for the main libvlc types
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Internal.NativeReference">
<summary>
The pointer to the native code representation of this object
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Internal.Release">
<summary>
Release native resources by calling this C function
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Internal.IsDisposed">
<summary>
Indicates whether this object has already been disposed
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Internal.#ctor(System.Func{System.IntPtr},System.Action{System.IntPtr})">
<summary>
Base constructor for most libvlc objects. Will perform native calls.
</summary>
<param name="create">A create function that will return a pointer to the instance in native code</param>
<param name="release">A release Action that takes the native pointer to that C# instance's native code representation
and performs the release call in native code. It will be called once when the C# instance gets disposed.</param>
</member>
<member name="M:LibVLCSharp.Shared.Internal.Dispose">
<summary>
Dispose of this instance
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Internal.Dispose(System.Boolean)">
<summary>
Dispose of this instance
</summary>
<param name="disposing">true if called from a method</param>
</member>
<member name="T:LibVLCSharp.Shared.IVideoControl">
<summary>
Interface for video control
</summary>
</member>
<member name="E:LibVLCSharp.Shared.IVideoControl.SizeChanged">
<summary>
Occurs when the size of the control changes
</summary>
</member>
<member name="P:LibVLCSharp.Shared.IVideoControl.Width">
<summary>
Gets the width of the video view
</summary>
</member>
<member name="P:LibVLCSharp.Shared.IVideoControl.Height">
<summary>
Gets the height of the video view
</summary>
</member>
<member name="T:LibVLCSharp.Shared.IVideoView">
<summary>
VideoView Interface
</summary>
</member>
<member name="P:LibVLCSharp.Shared.IVideoView.MediaPlayer">
<summary>
MediaPlayer object connected to the view
</summary>
</member>
<member name="T:LibVLCSharp.Shared.LibVLC">
<summary>
Main LibVLC API object representing a libvlc instance in native code.
Note: You may create multiple mediaplayers from a single LibVLC instance
</summary>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.Equals(LibVLCSharp.Shared.LibVLC)">
<summary>
Determines whether two object instances are equal.
</summary>
<param name="other">other libvlc instance to compare with</param>
<returns>true if same instance, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.Equals(System.Object)">
<summary>
Determines whether two object instances are equal.
</summary>
<param name="obj">other libvlc instance to compare with</param>
<returns>true if same instance, false otherwise</returns>
</member>
<member name="F:LibVLCSharp.Shared.LibVLC._log">
<summary>
The real log event handlers.
</summary>
</member>
<member name="F:LibVLCSharp.Shared.LibVLC._gcHandle">
<summary>
The GCHandle to be passed to callbacks as userData
</summary>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.GetHashCode">
<summary>
Returns the hashcode for this libvlc instance
</summary>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.#ctor(System.String[])">
<summary>
Create and initialize a libvlc instance.
This functions accept a list of &quot;command line&quot; arguments similar to the
main(). These arguments affect the LibVLC instance default configuration.
LibVLC may create threads. Therefore, any thread-unsafe process
initialization must be performed before calling libvlc_new(). In particular
and where applicable:
<para>- setlocale() and textdomain(),</para>
<para>- setenv(), unsetenv() and putenv(),</para>
<para>- with the X11 display system, XInitThreads()</para>
(see also libvlc_media_player_set_xwindow()) and
<para>- on Microsoft Windows, SetErrorMode().</para>
<para>- sigprocmask() shall never be invoked; pthread_sigmask() can be used.</para>
On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the
signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
Also while LibVLC is active, the wait() function shall not be called, and
any call to waitpid() shall use a strictly positive value for the first
parameter (i.e. the PID). Failure to follow those rules may lead to a
deadlock or a busy loop.
Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
even if it is not, in principles, necessary, e.g.:
On Microsoft Windows Vista/2008, the process error mode
SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.
On later versions, that is optional and unnecessary.
Also on Microsoft Windows (Vista and any later version), setting the default
DLL directories to SYSTEM32 exclusively is strongly recommended for
security reasons:
Arguments are meant to be passed from the command line to LibVLC, just like
VLC media player does. The list of valid arguments depends on the LibVLC
version, the operating system and platform, and set of available LibVLC
plugins. Invalid or unsupported arguments will cause the function to fail
(i.e. return NULL). Also, some arguments may alter the behaviour or
otherwise interfere with other LibVLC functions.
There is absolutely no warranty or promise of forward, backward and
cross-platform compatibility with regards to libvlc_new() arguments.
We recommend that you do not use them, other than when debugging.
<para/> This will throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the native libvlc libraries cannot be found or loaded.
<para/> It may also throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the LibVLC and LibVLCSharp major versions do not match.
See https://code.videolan.org/videolan/LibVLCSharp/-/blob/master/docs/versioning.md for more info about the versioning strategy.
<example>
<code>
// example <br/>
using var libvlc = new LibVLC("--verbose=2");
<br/> // or <br/>
using var libvlc = new LibVLC("--verbose", "2");
</code>
</example>
</summary>
<param name="options">list of arguments, in the form "--option=value"</param>
<returns>the libvlc instance or NULL in case of error</returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.#ctor(System.Boolean,System.String[])">
<summary>
Create and initialize a libvlc instance.
This functions accept a list of &quot;command line&quot; arguments similar to the
main(). These arguments affect the LibVLC instance default configuration.
LibVLC may create threads. Therefore, any thread-unsafe process
initialization must be performed before calling libvlc_new(). In particular
and where applicable:
<para>- setlocale() and textdomain(),</para>
<para>- setenv(), unsetenv() and putenv(),</para>
<para>- with the X11 display system, XInitThreads()</para>
(see also libvlc_media_player_set_xwindow()) and
<para>- on Microsoft Windows, SetErrorMode().</para>
<para>- sigprocmask() shall never be invoked; pthread_sigmask() can be used.</para>
On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the
signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
Also while LibVLC is active, the wait() function shall not be called, and
any call to waitpid() shall use a strictly positive value for the first
parameter (i.e. the PID). Failure to follow those rules may lead to a
deadlock or a busy loop.
Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
even if it is not, in principles, necessary, e.g.:
On Microsoft Windows Vista/2008, the process error mode
SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.
On later versions, that is optional and unnecessary.
Also on Microsoft Windows (Vista and any later version), setting the default
DLL directories to SYSTEM32 exclusively is strongly recommended for
security reasons:
Arguments are meant to be passed from the command line to LibVLC, just like
VLC media player does. The list of valid arguments depends on the LibVLC
version, the operating system and platform, and set of available LibVLC
plugins. Invalid or unsupported arguments will cause the function to fail
(i.e. return NULL). Also, some arguments may alter the behaviour or
otherwise interfere with other LibVLC functions.
There is absolutely no warranty or promise of forward, backward and
cross-platform compatibility with regards to libvlc_new() arguments.
We recommend that you do not use them, other than when debugging.
<para/> This will throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the native libvlc libraries cannot be found or loaded.
<para/> It may also throw a <see cref="T:LibVLCSharp.Shared.VLCException"/> if the LibVLC and LibVLCSharp major versions do not match.
See https://code.videolan.org/videolan/LibVLCSharp/-/blob/master/docs/versioning.md for more info about the versioning strategy.
</summary>
<param name="enableDebugLogs">enable verbose debug logs</param>
<param name="options">list of arguments (should be NULL)</param>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.PatchOptions(System.String[],System.Boolean)">
<summary>
Make dirty hacks to include necessary defaults on some platforms.
</summary>
<param name="options">The options given by the user</param>
<param name="enableDebugLogs">enable debug logs</param>
<returns>The patched options</returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.Dispose(System.Boolean)">
<summary>
Dispose of this libvlc instance
</summary>
<param name="disposing"></param>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.op_Equality(LibVLCSharp.Shared.LibVLC,LibVLCSharp.Shared.LibVLC)">
<summary>
Determines whether 2 instances of libvlc are equals
</summary>
<param name="libvlc1">1st instance of libvlc</param>
<param name="libvlc2">2nd instance of libvlc</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.op_Inequality(LibVLCSharp.Shared.LibVLC,LibVLCSharp.Shared.LibVLC)">
<summary>
Determines whether 2 instances of libvlc are different
</summary>
<param name="libvlc1">1st instance of libvlc</param>
<param name="libvlc2">2nd instance of libvlc</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.AddInterface(System.String)">
<summary>
Try to start a user interface for the libvlc instance.
</summary>
<param name="name">interface name, or null for default</param>
<returns>True if successful, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.SetExitHandler(LibVLCSharp.Shared.ExitCallback)">
<summary>
<para>Registers a callback for the LibVLC exit event. This is mostly useful if</para>
<para>the VLC playlist and/or at least one interface are started with</para>
<para>libvlc_playlist_play() or libvlc_add_intf() respectively.</para>
<para>Typically, this function will wake up your application main loop (from</para>
<para>another thread).</para>
</summary>
<param name="cb">
<para>callback to invoke when LibVLC wants to exit,</para>
<para>or NULL to disable the exit handler (as by default)</para>
</param>
<remarks>
<para>This function should be called before the playlist or interface are</para>
<para>started. Otherwise, there is a small race condition: the exit event could</para>
<para>be raised before the handler is registered.</para>
<para>This function and libvlc_wait() cannot be used at the same time.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.SetUserAgent(System.String,System.String)">
<summary>
<para>Sets the application name. LibVLC passes this as the user agent string</para>
<para>when a protocol requires it.</para>
</summary>
<param name="name">human-readable application name, e.g. &quot;FooBar player 1.2.3&quot;</param>
<param name="http">HTTP User Agent, e.g. &quot;FooBar/1.2.3 Python/2.6.0&quot;</param>
<remarks>LibVLC 1.1.1 or later</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.SetAppId(System.String,System.String,System.String)">
<summary>
<para>Sets some meta-information about the application.</para>
<para>See also libvlc_set_user_agent().</para>
</summary>
<param name="id">Java-style application identifier, e.g. &quot;com.acme.foobar&quot;</param>
<param name="version">application version numbers, e.g. &quot;1.2.3&quot;</param>
<param name="icon">application icon name, e.g. &quot;foobar&quot;</param>
<remarks>LibVLC 2.1.0 or later.</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.CloseLogFile">
<summary>
Close log file handle
</summary>
<returns>true if no file to close or close operation successful, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.SetLogFile(System.String)">
<summary>Sets up logging to a file.
Watch out: Overwrite contents if file exists!
Potentially throws a VLCException if FILE * cannot be obtained
</summary>
<para>FILE pointer opened for writing</para>
<para>(the FILE pointer must remain valid until libvlc_log_unset())</para>
<param name="filename">open/create file with Write access. If existing, resets content.</param>
<remarks>LibVLC 2.1.0 or later</remarks>
</member>
<member name="E:LibVLCSharp.Shared.LibVLC.Log">
<summary>
The event that is triggered when a log is emitted from libVLC.
Listening to this event will discard the default logger in libvlc.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.AudioFilters">
<summary>Returns a list of audio filters that are available.</summary>
<returns>
<para>a list of module descriptions. It should be freed with libvlc_module_description_list_release().</para>
<para>In case of an error, NULL is returned.</para>
</returns>
<remarks>
<para>libvlc_module_description_t</para>
<para>libvlc_module_description_list_release</para>
</remarks>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.VideoFilters">
<summary>Returns a list of video filters that are available.</summary>
<returns>
<para>a list of module descriptions. It should be freed with libvlc_module_description_list_release().</para>
<para>In case of an error, NULL is returned.</para>
</returns>
<remarks>
<para>libvlc_module_description_t</para>
<para>libvlc_module_description_list_release</para>
</remarks>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.AudioOutputs">
<summary>Gets the list of available audio output modules.</summary>
<returns>list of available audio outputs. It must be freed with</returns>
<remarks>
<para>libvlc_audio_output_list_release</para>
<para>libvlc_audio_output_t .</para>
<para>In case of error, NULL is returned.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.AudioOutputDevices(System.String)">
<summary>Gets a list of audio output devices for a given audio output module,</summary>
<param name="audioOutputName">
<para>audio output name</para>
<para>(as returned by libvlc_audio_output_list_get())</para>
</param>
<returns>
<para>A NULL-terminated linked list of potential audio output devices.</para>
<para>It must be freed with libvlc_audio_output_device_list_release()</para>
</returns>
<remarks>
<para>libvlc_audio_output_device_set().</para>
<para>Not all audio outputs support this. In particular, an empty (NULL)</para>
<para>list of devices doesnotimply that the specified audio output does</para>
<para>not work.</para>
<para>The list might not be exhaustive.</para>
<para>Some audio output devices in the list might not actually work in</para>
<para>some circumstances. By default, it is recommended to not specify any</para>
<para>explicit audio device.</para>
<para>LibVLC 2.1.0 or later.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.MediaDiscoverers(LibVLCSharp.Shared.MediaDiscovererCategory)">
<summary>Get media discoverer services by category</summary>
<param name="discovererCategory">category of services to fetch</param>
<returns>the number of media discoverer services (0 on error)</returns>
<remarks>LibVLC 3.0.0 and later.</remarks>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.SetDialogHandlers(LibVLCSharp.Shared.DisplayError,LibVLCSharp.Shared.DisplayLogin,LibVLCSharp.Shared.DisplayQuestion,LibVLCSharp.Shared.DisplayProgress,LibVLCSharp.Shared.UpdateProgress)">
<summary>
Register callbacks in order to handle VLC dialogs.
LibVLC 3.0.0 and later.
</summary>
<param name="error">Called when an error message needs to be displayed.</param>
<param name="login">Called when a login dialog needs to be displayed.
You can interact with this dialog by calling Dialog.PostLogin() to post an answer or Dialog.Dismiss() to cancel this dialog.</param>
<param name="question">Called when a question dialog needs to be displayed.
You can interact with this dialog by calling Dialog.PostLogin() to post an answer or Dialog.Dismiss() to cancel this dialog.</param>
<param name="displayProgress">Called when a progress dialog needs to be displayed.</param>
<param name="updateProgress">Called when a progress dialog needs to be updated.</param>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.UnsetDialogHandlers">
<summary>
Unset dialog callbacks if previously set
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.DialogHandlersSet">
<summary>
True if dialog handlers are set
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.RendererList">
<summary>
List of available renderers used to create RendererDiscoverer objects
Note: LibVLC 3.0.0 and later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.GetLogContext(System.IntPtr,System.String@,System.String@,System.Nullable{System.UInt32}@)">
<summary>
Gets log message debug infos.
This function retrieves self-debug information about a log message:
- the name of the VLC module emitting the message,
- the name of the source code module (i.e.file) and
- the line number within the source code module.
The returned module name and file name will be NULL if unknown.
The returned line number will similarly be zero if unknown.
</summary>
<param name="logContext">The log message context (as passed to the <see cref="T:LibVLCSharp.Shared.LibVLC.InternalLogCallback"/>)</param>
<param name="module">The module name storage.</param>
<param name="file">The source code file name storage.</param>
<param name="line">The source code file line number storage.</param>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.Retain">
<summary>Increments the native reference counter for this libvlc instance</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.Version">
<summary>The version of the LibVLC engine currently used by LibVLCSharp</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.Changeset">
<summary>The changeset of the LibVLC engine currently used by LibVLCSharp</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.LastLibVLCError">
<summary>
A human-readable error message for the last LibVLC error in the calling
thread. The resulting string is valid until another error occurs (at least
until the next LibVLC call).
<para/> Null if no error.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.LibVLC.ClearLibVLCError">
<summary>
Clears the LibVLC error status for the current thread. This is optional.
By default, the error status is automatically overridden when a new error
occurs, and destroyed when the thread exits.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LibVLC.LibVLCCompiler">
<summary>
Retrieve the libvlc compiler version.
Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
</summary>
</member>
<member name="T:LibVLCSharp.Shared.LibVLC.InternalExitCallback">
<summary>
Registers a callback for the LibVLC exit event.
This is mostly useful if the VLC playlist and/or at least one interface are started with libvlc_playlist_play()
or AddInterface() respectively. Typically, this function will wake up your application main loop (from another thread).
</summary>
</member>
<member name="T:LibVLCSharp.Shared.LogLevel">
<summary>Logging messages level.</summary>
<remarks>Future LibVLC versions may define new levels.</remarks>
</member>
<member name="F:LibVLCSharp.Shared.LogLevel.Debug">
<summary>Debug message</summary>
</member>
<member name="F:LibVLCSharp.Shared.LogLevel.Notice">
<summary>Important informational message</summary>
</member>
<member name="F:LibVLCSharp.Shared.LogLevel.Warning">
<summary>Warning (potential error) message</summary>
</member>
<member name="F:LibVLCSharp.Shared.LogLevel.Error">
<summary>Error message</summary>
</member>
<member name="T:LibVLCSharp.Shared.ExitCallback">
<summary>
Registers a callback for the LibVLC exit event.
This is mostly useful if the VLC playlist and/or at least one interface are started with libvlc_playlist_play()
or AddInterface() respectively. Typically, this function will wake up your application main loop (from another thread).
</summary>
</member>
<member name="T:LibVLCSharp.Shared.EventType">
<summary>LibVLCEvent types</summary>
</member>
<member name="F:LibVLCSharp.Shared.EventType.MediaDiscovererStarted">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_start()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.MediaDiscovererStopped">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.RendererDiscovererItemAdded">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.RendererDiscovererItemDeleted">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaAdded">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaRemoved">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaChanged">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStarted">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStopped">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusInit">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusOpening">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusPlaying">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusPause">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusEnd">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.EventType.VlmMediaInstanceStatusError">
<remarks>
<para>Useless event, it will be triggered only when calling</para>
<para>libvlc_media_discoverer_stop()</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.LibVLCEvent">
<summary>Renderer item</summary>
<remarks>
<para>This struct is passed by a</para>
<para>or deleted.</para>
<para>An item is valid until the</para>
<para>is called with the same pointer.</para>
<para>libvlc_renderer_discoverer_event_manager()</para>
</remarks>
<summary>A LibVLC event</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaMetaChangedEventArgs">
<summary>
Media metadata changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaMetaChangedEventArgs.MetadataType">
<summary>
Type of the metadata that changed
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaParsedChangedEventArgs">
<summary>
Media parsed status changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParsedChangedEventArgs.ParsedStatus">
<summary>
The new parsed status
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaSubItemAddedEventArgs">
<summary>
Media sub item added
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSubItemAddedEventArgs.SubItem">
<summary>
The newly added media subitem
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaDurationChangedEventArgs">
<summary>
The duration of the media changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaDurationChangedEventArgs.Duration">
<summary>
The new media duration
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaFreedEventArgs">
<summary>
The media has been freed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaFreedEventArgs.Media">
<summary>
Freed media
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaStateChangedEventArgs">
<summary>
The state of the media changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStateChangedEventArgs.State">
<summary>
New media state
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaSubItemTreeAddedEventArgs">
<summary>
A media sub item tree has been added
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSubItemTreeAddedEventArgs.SubItem">
<summary>
New media sub item tree
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerMediaChangedEventArgs">
<summary>
The mediaplayer's media changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerMediaChangedEventArgs.Media">
<summary>
New mediaplayer's media
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerBufferingEventArgs">
<summary>
The mediaplayer buffering information
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerBufferingEventArgs.Cache">
<summary>
Caching information
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerTimeChangedEventArgs">
<summary>
The mediaplayer's time changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerTimeChangedEventArgs.Time">
<summary>
Mediaplayer's current time
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerPositionChangedEventArgs">
<summary>
The mediaplayer's position changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerPositionChangedEventArgs.Position">
<summary>
Mediaplayer's current position
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerSeekableChangedEventArgs">
<summary>
The mediaplayer's seekable status changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerSeekableChangedEventArgs.Seekable">
<summary>
The new seekable capability
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerPausableChangedEventArgs">
<summary>
The mediaplayer's pausable status changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerPausableChangedEventArgs.Pausable">
<summary>
The new pausable capability
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerTitleChangedEventArgs">
<summary>
The mediaplayer's title changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerTitleChangedEventArgs.Title">
<summary>
The new title
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerChapterChangedEventArgs">
<summary>
The mediaplayer's chapter changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerChapterChangedEventArgs.Chapter">
<summary>
The new chapter
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerSnapshotTakenEventArgs">
<summary>
The mediaplayer had a snapshot taken
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerSnapshotTakenEventArgs.Filename">
<summary>
Filename of the newly taken snapshot
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerLengthChangedEventArgs">
<summary>
The mediaplayer's length changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerLengthChangedEventArgs.Length">
<summary>
The new mediaplayer length
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerVoutEventArgs">
<summary>
The mediaplayer's video output changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerVoutEventArgs.Count">
<summary>
Number of available video outputs
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerScrambledChangedEventArgs">
<summary>
The mediaplayer scrambled status changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerScrambledChangedEventArgs.Scrambled">
<summary>
The scrambled status
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerESAddedEventArgs">
<summary>
The mediaplayer has a new Elementary Stream (ES)
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESAddedEventArgs.Id">
<summary>
The Id of the new Elementary Stream (ES)
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESAddedEventArgs.Type">
<summary>
The type of the new Elementary Stream (ES)
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerESDeletedEventArgs">
<summary>
An Elementary Stream (ES) was deleted
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESDeletedEventArgs.Id">
<summary>
The Id of the deleted Elementary Stream (ES)
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESDeletedEventArgs.Type">
<summary>
The type of the deleted Elementary Stream (ES)
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerESSelectedEventArgs">
<summary>
An Elementary Stream (ES) was selected
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESSelectedEventArgs.Id">
<summary>
The Id of the selected Elementary Stream (ES)
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerESSelectedEventArgs.Type">
<summary>
The type of the seleted Elementary Stream (ES)
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerAudioDeviceEventArgs">
<summary>
The mediaplayer's audio device changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerAudioDeviceEventArgs.AudioDevice">
<summary>
String describing the audio device
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerVolumeChangedEventArgs">
<summary>
The mediaplayer's volume changed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerVolumeChangedEventArgs.Volume">
<summary>
The new volume
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaListBaseEventArgs">
<summary>
Base class for MediaList events
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaListBaseEventArgs.Media">
<summary>
Current node
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaListBaseEventArgs.Index">
<summary>
Current index
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaListBaseEventArgs.#ctor(LibVLCSharp.Shared.Media,System.Int32)">
<summary>
Default constructor
</summary>
<param name="media">Current node</param>
<param name="index">Current index</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaListItemAddedEventArgs">
<summary>
An item has been added to the MediaList
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaListWillAddItemEventArgs">
<summary>
An item is about to be added to the MediaList
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaListItemDeletedEventArgs">
<summary>
An item has been deleted from the MediaList
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaListWillDeleteItemEventArgs">
<summary>
An item is about to be deleted from the MediaList
</summary>
</member>
<member name="T:LibVLCSharp.Shared.RendererDiscovererItemAddedEventArgs">
<summary>
A new RendererItem has been found
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererDiscovererItemAddedEventArgs.RendererItem">
<summary>
The newly found RendererItem
</summary>
</member>
<member name="T:LibVLCSharp.Shared.RendererDiscovererItemDeletedEventArgs">
<summary>
A RendererItem has been deleted
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererDiscovererItemDeletedEventArgs.RendererItem">
<summary>
The deleted RendererItem
</summary>
</member>
<member name="T:LibVLCSharp.Shared.LogEventArgs">
<summary>
The LibVLC Log Event Arg
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.Level">
<summary>
The severity of the log message.
By default, you will only get error messages, but you can get all messages by specifying "-vv" in the options.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.Message">
<summary>
The log message
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.Module">
<summary>
The name of the module that emitted the message
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.SourceFile">
<summary>
The source file that emitted the message.
This may be <see langword="null"/> if that info is not available, i.e. always if you are using a release version of VLC.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.SourceLine">
<summary>
The line in the <see cref="P:LibVLCSharp.Shared.LogEventArgs.SourceFile"/> at which the message was emitted.
This may be <see langword="null"/> if that info is not available, i.e. always if you are using a release version of VLC.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.LogEventArgs.FormattedLog">
<summary>
Helper property with already formatted log message
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Media">
<summary>
Media is an abstract representation of a playable media. It can be a network stream or a local video/audio file.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Media.#ctor(LibVLCSharp.Shared.LibVLC,System.String,LibVLCSharp.Shared.FromType,System.String[])">
<summary>
Media Constructs a libvlc Media instance
</summary>
<param name="libVLC">A libvlc instance</param>
<param name="mrl">A path, location, or node name, depending on the 3rd parameter</param>
<param name="type">The type of the 2nd argument.</param>
<param name="options">the libvlc options, in the form of ":your-option"</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.#ctor(LibVLCSharp.Shared.LibVLC,System.Uri,System.String[])">
<summary>
Media Constructs a libvlc Media instance
</summary>
<param name="libVLC">A libvlc instance</param>
<param name="uri">The absolute URI of the resource.</param>
<param name="options">the libvlc options, in the form of ":your-option"</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.#ctor(LibVLCSharp.Shared.LibVLC,System.Int32,System.String[])">
<summary>
Create a media for an already open file descriptor.
The file descriptor shall be open for reading(or reading and writing).
Regular file descriptors, pipe read descriptors and character device
descriptors(including TTYs) are supported on all platforms.
Block device descriptors are supported where available.
Directory descriptors are supported on systems that provide fdopendir().
Sockets are supported on all platforms where they are file descriptors,
i.e.all except Windows.
\note This library will <b>not</b> automatically close the file descriptor
under any circumstance.Nevertheless, a file descriptor can usually only be
rendered once in a media player.To render it a second time, the file
descriptor should probably be rewound to the beginning with lseek().
</summary>
<param name="libVLC">A libvlc instance</param>
<param name="fd">open file descriptor</param>
<param name="options">the libvlc options, in the form of ":your-option"</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.#ctor(LibVLCSharp.Shared.MediaList)">
<summary>
Create a media from a media list
</summary>
<param name="mediaList">media list to create media from</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.#ctor(LibVLCSharp.Shared.LibVLC,LibVLCSharp.Shared.MediaInput,System.String[])">
<summary>
Create a media from a MediaInput
requires libvlc 3.0 or higher
</summary>
<param name="libVLC">the libvlc instance</param>
<param name="input">the media to be used by libvlc. LibVLCSharp will NOT dispose or close it.
Use <see cref="T:LibVLCSharp.Shared.StreamMediaInput"/> or implement your own.</param>
<param name="options">the libvlc options, in the form of ":your-option"</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.AddOption(System.String)">
<summary>Add an option to the media.
<example>
<code>
// example <br/>
media.AddOption(":no-audio");
</code>
</example></summary>
<param name="option">the media option, in the form of ":your-option"</param>
<remarks>
<para>This option will be used to determine how the media_player will</para>
<para>read the media. This allows to use VLC's advanced</para>
<para>reading/streaming options on a per-media basis.</para>
<para>The options are listed in 'vlc --long-help' from the command line,</para>
<para>e.g. &quot;-sout-all&quot;. Keep in mind that available options and their semantics</para>
<para>vary across LibVLC versions and builds.</para>
<para>Not all options affects libvlc_media_t objects:</para>
<para>Specifically, due to architectural issues most audio and video options,</para>
<para>such as text renderer options, have no effects on an individual media.</para>
<para>These options must be set through libvlc_new() instead.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.AddOption(LibVLCSharp.Shared.MediaConfiguration)">
<summary>
Convenience method for crossplatform media configuration
</summary>
<param name="mediaConfiguration">mediaConfiguration translate to strings parsed by the vlc engine, some are platform specific</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.AddOptionFlag(System.String,System.UInt32)">
<summary>Add an option to the media with configurable flags.</summary>
<param name="option">the media option</param>
<param name="flags">the flags for this option</param>
<remarks>
<para>This option will be used to determine how the media_player will</para>
<para>read the media. This allows to use VLC's advanced</para>
<para>reading/streaming options on a per-media basis.</para>
<para>The options are detailed in vlc --long-help, for instance</para>
<para>&quot;--sout-all&quot;. Note that all options are not usable on medias:</para>
<para>specifically, due to architectural issues, video-related options</para>
<para>such as text renderer options cannot be set on a single media. They</para>
<para>must be set on the whole libvlc instance instead.</para>
</remarks>
</member>
<member name="P:LibVLCSharp.Shared.Media.Mrl">
<summary>Get the media resource locator (mrl) from a media descriptor object</summary>
</member>
<member name="M:LibVLCSharp.Shared.Media.Duplicate">
<summary>Duplicate a media descriptor object.</summary>
</member>
<member name="M:LibVLCSharp.Shared.Media.Meta(LibVLCSharp.Shared.MetadataType)">
<summary>Read the meta of the media.</summary>
<param name="metadataType">the meta to read</param>
<returns>the media's meta</returns>
<remarks>
If the media has not yet been parsed this will return NULL.
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.SetMeta(LibVLCSharp.Shared.MetadataType,System.String)">
<summary>
<para>Set the meta of the media (this function will not save the meta, call</para>
<para>libvlc_media_save_meta in order to save the meta)</para>
</summary>
<param name="metadataType">the <see cref="T:LibVLCSharp.Shared.MetadataType"/> to write</param>
<param name="metaValue">the media's meta</param>
</member>
<member name="M:LibVLCSharp.Shared.Media.SaveMeta">
<summary>Save the meta previously set</summary>
<returns>true if the write operation was successful</returns>
</member>
<member name="P:LibVLCSharp.Shared.Media.State">
<summary>
Get current <see cref="T:LibVLCSharp.Shared.VLCState"/> of media descriptor object.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Media.Statistics">
<summary>Get the current statistics about the media
structure that contain the statistics about the media
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Media.EventManager">
<summary>
<para>Get event manager from media descriptor object.</para>
<para>NOTE: this function doesn't increment reference counting.</para>
</summary>
<returns>event manager object</returns>
</member>
<member name="P:LibVLCSharp.Shared.Media.Duration">
<summary>Get duration (in ms) of media descriptor object item.</summary>
<returns>duration of media item or -1 on error</returns>
</member>
<member name="M:LibVLCSharp.Shared.Media.Parse(LibVLCSharp.Shared.MediaParseOptions,System.Int32,System.Threading.CancellationToken)">
<summary>
Parse the media asynchronously with options.
It uses a flag to specify parse options (see <see cref="T:LibVLCSharp.Shared.MediaParseOptions"/>). All these flags can be combined. By default, the media is parsed only if it's a local file.
<para/> Note: Parsing can be aborted with ParseStop().
</summary>
<param name="options">Parse options flags. They can be combined</param>
<param name="timeout">maximum time allowed to preparse the media.
<para/>If -1, the default "preparse-timeout" option will be used as a timeout.
<para/>If 0, it will wait indefinitely. If > 0, the timeout will be used (in milliseconds).
</param>
<param name="cancellationToken">token to cancel the operation</param>
<returns>the parse status of the media</returns>
</member>
<member name="P:LibVLCSharp.Shared.Media.IsParsed">
<summary>Return true is the media descriptor object is parsed</summary>
<returns>true if media object has been parsed otherwise it returns false</returns>
</member>
<member name="P:LibVLCSharp.Shared.Media.ParsedStatus">
<summary>Get Parsed status for media descriptor object.</summary>
<returns>a value of the libvlc_media_parsed_status_t enum</returns>
<remarks>
<para>libvlc_MediaParsedChanged</para>
<para>libvlc_media_parsed_status_t</para>
<para>LibVLC 3.0.0 or later</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.ParseStop">
<summary>Stop the parsing of the media</summary>
<remarks>
<para>When the media parsing is stopped, the libvlc_MediaParsedChanged event will</para>
<para>be sent with the libvlc_media_parsed_status_timeout status.</para>
<para>libvlc_media_parse_with_options</para>
<para>LibVLC 3.0.0 or later</para>
</remarks>
</member>
<member name="P:LibVLCSharp.Shared.Media.Tracks">
<summary>Get media descriptor's elementary streams description
<para>address to store an allocated array of Elementary Streams</para>
<para>descriptions (must be freed with libvlc_media_tracks_release</para>
<para>by the caller) [OUT]</para>
<returns>the number of Elementary Streams (zero on error)</returns>
<remarks>
<para>Note, you need to call libvlc_media_parse() or play the media at least once</para>
<para>before calling this function.</para>
<para>Not doing this will result in an empty array.</para>
<para>LibVLC 2.1.0 and later.</para>
</remarks>
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Media.SubItems">
<summary>
<para>Get subitems of media descriptor object. This will increment</para>
<para>the reference count of supplied media descriptor object. Use</para>
<para>libvlc_media_list_release() to decrement the reference counting.</para>
</summary>
<returns>list of media descriptor subitems or NULL</returns>
</member>
<member name="P:LibVLCSharp.Shared.Media.Type">
<summary>
The type of the media
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Media.AddSlave(LibVLCSharp.Shared.MediaSlaveType,System.UInt32,System.String)">
<summary>Add a slave to the current media.</summary>
<param name="type">subtitle or audio</param>
<param name="priority">from 0 (low priority) to 4 (high priority)</param>
<param name="uri">Uri of the slave (should contain a valid scheme).</param>
<returns>true on success, false on error.</returns>
<remarks>
<para>A slave is an external input source that may contains an additional subtitle</para>
<para>track (like a .srt) or an additional audio track (like a .ac3).</para>
<para>This function must be called before the media is parsed (via</para>
<para>libvlc_media_parse_with_options()) or before the media is played (via</para>
<para>libvlc_media_player_play())</para>
<para>LibVLC 3.0.0 and later.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.AddSlave(LibVLCSharp.Shared.MediaSlaveType,System.UInt32,System.Uri)">
<summary>Add a slave to the current media.</summary>
<param name="type">subtitle or audio</param>
<param name="priority">from 0 (low priority) to 4 (high priority)</param>
<param name="uri">Uri of the slave (should contain a valid scheme).</param>
<returns>true on success, false on error.</returns>
<remarks>
<para>A slave is an external input source that may contains an additional subtitle</para>
<para>track (like a .srt) or an additional audio track (like a .ac3).</para>
<para>This function must be called before the media is parsed (via</para>
<para>libvlc_media_parse_with_options()) or before the media is played (via</para>
<para>libvlc_media_player_play())</para>
<para>LibVLC 3.0.0 and later.</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.ClearSlaves">
<summary>
<para>Clear all slaves previously added by libvlc_media_slaves_add() or</para>
<para>internally.</para>
</summary>
<remarks>LibVLC 3.0.0 and later.</remarks>
</member>
<member name="P:LibVLCSharp.Shared.Media.Slaves">
<summary>Get a media descriptor's slave list</summary>
<para>address to store an allocated array of slaves (must be</para>
<para>freed with libvlc_media_slaves_release()) [OUT]</para>
<returns>the number of slaves (zero on error)</returns>
<remarks>
<para>The list will contain slaves parsed by VLC or previously added by</para>
<para>libvlc_media_slaves_add(). The typical use case of this function is to save</para>
<para>a list of slave in a database for a later use.</para>
<para>LibVLC 3.0.0 and later.</para>
<para>libvlc_media_slaves_add</para>
</remarks>
</member>
<member name="M:LibVLCSharp.Shared.Media.CodecDescription(LibVLCSharp.Shared.TrackType,System.UInt32)">
<summary>Get a media's codec description</summary>
<param name="type">The type of the track</param>
<param name="codec">the codec or fourcc</param>
<returns>the codec description</returns>
</member>
<member name="M:LibVLCSharp.Shared.Media.Equals(System.Object)">
<summary>
Equality override for this media instance
</summary>
<param name="obj">the media to compare this one with</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.Media.GetHashCode">
<summary>
Custom hascode implemenation for this Media instance
</summary>
<returns>the hashcode for this Media instance</returns>
</member>
<member name="M:LibVLCSharp.Shared.Media.Retain">
<summary>Increments the native reference counter for the media</summary>
</member>
<member name="T:LibVLCSharp.Shared.Media.InternalOpenMedia">
<summary>
<para>It consists of a media location and various optional meta data.</para>
<para>@{</para>
<para></para>
<para>LibVLC media item/descriptor external API</para>
</summary>
<summary>Callback prototype to open a custom bitstream input media.</summary>
<param name="opaque">private pointer as passed to libvlc_media_new_callbacks()</param>
<param name="data">storage space for a private data pointer [OUT]</param>
<param name="size">byte length of the bitstream or UINT64_MAX if unknown [OUT]</param>
<returns>
<para>0 on success, non-zero on error. In case of failure, the other</para>
<para>callbacks will not be invoked and any value stored in *datap and *sizep is</para>
<para>discarded.</para>
</returns>
<remarks>
<para>The same media item can be opened multiple times. Each time, this callback</para>
<para>is invoked. It should allocate and initialize any instance-specific</para>
<para>resources, then store them in *datap. The instance resources can be freed</para>
<para>in the</para>
<para>For convenience, *datap is initially NULL and *sizep is initially 0.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.Media.InternalReadMedia">
<summary>Callback prototype to read data from a custom bitstream input media.</summary>
<param name="opaque">private pointer as set by the</param>
<param name="buf">start address of the buffer to read data into</param>
<param name="len">bytes length of the buffer</param>
<returns>
<para>strictly positive number of bytes read, 0 on end-of-stream,</para>
<para>or -1 on non-recoverable error</para>
</returns>
<remarks>
<para>callback</para>
<para>If no data is immediately available, then the callback should sleep.</para>
<para>The application is responsible for avoiding deadlock situations.</para>
<para>In particular, the callback should return an error if playback is stopped;</para>
<para>if it does not return, then libvlc_media_player_stop() will never return.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.Media.InternalSeekMedia">
<summary>Callback prototype to seek a custom bitstream input media.</summary>
<param name="opaque">private pointer as set by the</param>
<param name="offset">absolute byte offset to seek to</param>
<returns>0 on success, -1 on error.</returns>
<remarks>callback</remarks>
</member>
<member name="T:LibVLCSharp.Shared.Media.InternalCloseMedia">
<summary>Callback prototype to close a custom bitstream input media.</summary>
<param name="opaque">private pointer as set by the</param>
<remarks>callback</remarks>
</member>
<member name="E:LibVLCSharp.Shared.Media.MetaChanged">
<summary>
The meta information changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.ParsedChanged">
<summary>
The parsing status changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.SubItemAdded">
<summary>
A sub item was added to this media's MediaList
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.DurationChanged">
<summary>
The duration of the media changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.MediaFreed">
<summary>
The media was freed on the native side
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.StateChanged">
<summary>
The media state changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.Media.SubItemTreeAdded">
<summary>
A sub item tree was added to this media
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VLCState">
<summary>Note the order of libvlc_state_t enum must match exactly the order of</summary>
<remarks>
<para>mediacontrol_PlayerStatus,</para>
<para>input_state_e enums,</para>
<para>and VideoLAN.LibVLCSharp.State (at bindings/cil/src/media.cs).</para>
<para>Expected states by web plugins are:</para>
<para>IDLE/CLOSE=0, OPENING=1, PLAYING=3, PAUSED=4,</para>
<para>STOPPING=5, ENDED=6, ERROR=7</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.NothingSpecial">
<summary>
Nothing special happening
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Opening">
<summary>
Opening media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Buffering">
<summary>
Buffering media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Playing">
<summary>
Playing media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Paused">
<summary>
Paused media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Stopped">
<summary>
Stopped media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Ended">
<summary>
Ended media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VLCState.Error">
<summary>
Error media
</summary>
</member>
<member name="T:LibVLCSharp.Shared.TrackType">
<summary>
Media track type such as Audio, Video or Text
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TrackType.Unknown">
<summary>
Unknown track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TrackType.Audio">
<summary>
Audio track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TrackType.Video">
<summary>
Video track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TrackType.Text">
<summary>
Text track
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoOrientation">
<summary>
Video orientation
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.TopLeft">
<summary>Normal. Top line represents top, left column left.</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.TopRight">
<summary>Flipped horizontally</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.BottomLeft">
<summary>Flipped vertically</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.BottomRight">
<summary>Rotated 180 degrees</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.LeftTop">
<summary>Transposed</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.LeftBottom">
<summary>Rotated 90 degrees clockwise (or 270 anti-clockwise)</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.RightTop">
<summary>Rotated 90 degrees anti-clockwise</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoOrientation.RightBottom">
<summary>Anti-transposed</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoProjection">
<summary>
Video projection
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoProjection.Rectangular">
<summary>
Rectangular
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoProjection.Equirectangular">
<summary>360 spherical</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoProjection.CubemapLayoutStandard">
<summary>
Cubemap layout standard
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaSlaveType">
<summary>Type of a media slave: subtitle or audio.</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSlaveType.Subtitle">
<summary>
Subtitle
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSlaveType.Audio">
<summary>
Audio
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MetadataType">
<summary>
Meta data types
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Title">
<summary>
Title metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Artist">
<summary>
Artist metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Genre">
<summary>
Genre metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Copyright">
<summary>
Copyright metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Album">
<summary>
Album metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.TrackNumber">
<summary>
Track number metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Description">
<summary>
Description metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Rating">
<summary>
Rating metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Date">
<summary>
Date metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Setting">
<summary>
Setting metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.URL">
<summary>
URL metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Language">
<summary>
Language metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.NowPlaying">
<summary>
Now playing metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Publisher">
<summary>
Publisher metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.EncodedBy">
<summary>
Encoded by metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.ArtworkURL">
<summary>
Artwork URL metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.TrackID">
<summary>
Track ID metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.TrackTotal">
<summary>
Total track metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Director">
<summary>
Director metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Season">
<summary>
Season metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Episode">
<summary>
Episode metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.ShowName">
<summary>
Show name metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.Actors">
<summary>
Actors metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.AlbumArtist">
<summary>
Album artist metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.DiscNumber">
<summary>
Disc number metadata
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MetadataType.DiscTotal">
<summary>
Disc total metadata
</summary>
</member>
<member name="T:LibVLCSharp.Shared.FromType">
<summary>
The FromType enum is used to drive the media creation.
A media is usually created using a string, which can represent one of 3 things: FromPath, FromLocation, AsNode.
</summary>
</member>
<member name="F:LibVLCSharp.Shared.FromType.FromPath">
<summary>
Create a media for a certain file path.
</summary>
</member>
<member name="F:LibVLCSharp.Shared.FromType.FromLocation">
<summary>
Create a media with a certain given media resource location,
for instance a valid URL.
note To refer to a local file with this function,
the file://... URI syntax <b>must</b> be used (see IETF RFC3986).
We recommend using FromPath instead when dealing with
local files.
</summary>
</member>
<member name="F:LibVLCSharp.Shared.FromType.AsNode">
<summary>
Create a media as an empty node with a given name.
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaParseOptions">
<summary>
Parse flags used by libvlc_media_parse_with_options()
</summary>
<remarks>libvlc_media_parse_with_options</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaParseOptions.ParseLocal">
<summary>Parse media if it's a local file</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParseOptions.ParseNetwork">
<summary>Parse media even if it's a network file</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParseOptions.FetchLocal">
<summary>Fetch meta and covert art using local resources</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParseOptions.FetchNetwork">
<summary>Fetch meta and covert art using network resources</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParseOptions.DoInteract">
<summary>
Interact with the user (via libvlc_dialog_cbs) when preparsing this item
(and not its sub items). Set this flag in order to receive a callback
when the input is asking for credentials.
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaParsedStatus">
<summary>
Parse status used sent by libvlc_media_parse_with_options() or returned by
libvlc_media_get_parsed_status()
</summary>
<remarks>
libvlc_media_parse_with_options
libvlc_media_get_parsed_status
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaParsedStatus.Skipped">
<summary>
Parsing was skipped
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParsedStatus.Failed">
<summary>
Parsing failed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParsedStatus.Timeout">
<summary>
Parsing timed out
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaParsedStatus.Done">
<summary>
Parsing completed successfully
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaType">
<summary>Media type</summary>
<remarks>libvlc_media_get_type</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.Unknown">
<summary>
Unknown media type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.File">
<summary>
File type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.Directory">
<summary>
Directory type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.Disc">
<summary>
Disc type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.Stream">
<summary>
Stream type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaType.Playlist">
<summary>
Playlist type
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaConfiguration">
<summary>
Configuration helper designed to be used for advanced libvlc configuration
<para/> More info at https://wiki.videolan.org/VLC_command-line_help/
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaConfiguration.EnableHardwareDecoding">
<summary>
Enable/disable hardware decoding (crossplatform).
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaConfiguration.FileCaching">
<summary>
Caching value for local files, in milliseconds [0 .. 60000ms]
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaConfiguration.NetworkCaching">
<summary>
Caching value for network resources, in milliseconds [0 .. 60000ms]
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaConfiguration.Build">
<summary>
Builds the current MediaConfiguration for consumption by libvlc (or storage)
</summary>
<returns>Configured libvlc options as strings</returns>
</member>
<member name="T:LibVLCSharp.Shared.MediaDiscoverer">
<summary>
MediaDiscoverer should be used to find media on NAS and any SMB/UPnP-enabled device on your local network.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaDiscoverer.#ctor(LibVLCSharp.Shared.LibVLC,System.String)">
<summary>
Media discoverer constructor
</summary>
<param name="libVLC">libvlc instance this will be attached to</param>
<param name="name">name from one of LibVLC.MediaDiscoverers</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaDiscoverer.Start">
<summary>
Start media discovery.
To stop it, call MediaDiscover::stop() or destroy the object directly.
</summary>
<returns>false in case of error, true otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaDiscoverer.Stop">
<summary>
Stop media discovery.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscoverer.LocalizedName">
<summary>
Get media service discover object its localized name.
under v3 only
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscoverer.EventManager">
<summary>
Get event manager from media service discover object.
under v3 only
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscoverer.IsRunning">
<summary>
Query if media service discover object is running.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscoverer.MediaList">
<summary>
The MediaList attached to this MediaDiscoverer
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaDiscoverer.Started">
<summary>
Media discovery has been started for this media discoverer
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaDiscoverer.Stopped">
<summary>
Media discovery has been stopped for this media discoverer
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaDiscoverer.Dispose(System.Boolean)">
<summary>
Dispose of this media discoverer
</summary>
<param name="disposing">true if called from a method</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaDiscovererCategory">
<summary>Category of a media discoverer</summary>
<remarks>libvlc_media_discoverer_list_get()</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaDiscovererCategory.Devices">
<summary>devices, like portable music player</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaDiscovererCategory.Lan">
<summary>LAN/WAN services, like Upnp, SMB, or SAP</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaDiscovererCategory.Podcasts">
<summary>Podcasts</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaDiscovererCategory.Localdirs">
<summary>Local directories, like Video, Music or Pictures directories</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaInput">
<summary>
An abstract class that lets libvlc read a media from callbacks.
Override this to provide your own reading mechanism, or you can use the <see cref="T:LibVLCSharp.Shared.StreamMediaInput"/> class
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaInput.GcHandle">
<summary>
The GCHandle to be passed to callbacks as userData
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.#ctor">
<summary>
The constructor
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaInput.CanSeek">
<summary>
A value indicating whether this Media input can be seeked in.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Open(System.UInt64@)">
<summary>
LibVLC calls this method when it wants to open the media
</summary>
<param name="size">This value must be filled with the length of the media (or ulong.MaxValue if unknown)</param>
<returns><c>true</c> if the stream opened successfully</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Read(System.IntPtr,System.UInt32)">
<summary>
LibVLC calls this method when it wants to read the media
</summary>
<param name="buf">The buffer where read data must be written</param>
<param name="len">The buffer length</param>
<returns>strictly positive number of bytes read, 0 on end-of-stream, or -1 on non-recoverable error</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Seek(System.UInt64)">
<summary>
LibVLC calls this method when it wants to seek to a specific position in the media
</summary>
<param name="offset">The offset, in bytes, since the beginning of the stream</param>
<returns><c>true</c> if the seek succeeded, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Close">
<summary>
LibVLC calls this method when it wants to close the media.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Dispose(System.Boolean)">
<summary>
Override this to dispose things in your child class
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaInput.Dispose">
<summary>
Disposes of this instance
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaList">
<summary>
The MediaList holds a list of Media types
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.#ctor(LibVLCSharp.Shared.Media)">
<summary>
Get subitems of media descriptor object.
</summary>
<param name="media"></param>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.#ctor(LibVLCSharp.Shared.MediaDiscoverer)">
<summary>
Get media service discover media list.
</summary>
<param name="mediaDiscoverer"></param>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.#ctor(LibVLCSharp.Shared.LibVLC)">
<summary>
Create an empty media list.
</summary>
<param name="libVLC"></param>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.SetMedia(LibVLCSharp.Shared.Media)">
<summary>
Associate media instance with this media list instance. If another
media instance was present it will be released.
</summary>
<param name="media">media instance to add</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.AddMedia(LibVLCSharp.Shared.Media)">
<summary>
Add media instance to media list
</summary>
<param name="media">a media instance</param>
<returns>true on success, false if the media list is read-only</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.InsertMedia(LibVLCSharp.Shared.Media,System.Int32)">
<summary>
Insert media instance in media list on a position.
</summary>
<param name="media">a media instance</param>
<param name="position">position in the array where to insert</param>
<returns>true on success, false if the media list is read-only</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.RemoveIndex(System.Int32)">
<summary>
Remove media instance from media list on a position.
</summary>
<param name="positionIndex">position in the array where to remove the iteam</param>
<returns>true on success, false if the media list is read-only or the item was not found</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaList.Count">
<summary>
Get count on media list items.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaList.Item(System.Int32)">
<summary>
Gets the element at the specified index
</summary>
<param name="position">position in array where to insert</param>
<returns>media instance at position, or null if not found.
In case of success, Media.Retain() is called to increase the refcount on the media. </returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.IndexOf(LibVLCSharp.Shared.Media)">
<summary>
Find index position of List media instance in media list. Warning: the
function will return the first matched position.
</summary>
<param name="media">media instance</param>
<returns>position of media instance or -1 if media not found</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaList.IsReadonly">
<summary>
This indicates if this media list is read-only from a user point of view.
True if readonly, false otherwise
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.Lock">
<summary>
Get lock on media list items
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.Unlock">
<summary>
Release lock on media list items The MediaList lock should be held upon entering this function.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaList.EventManager">
<summary>
Get libvlc_event_manager from this media list instance. The
p_event_manager is immutable, so you don't have to hold the lock
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.Retain">
<summary>Increments the native reference counter for this medialist instance</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaList.ItemAdded">
<summary>
An item has been added to the MediaList
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaList.WillAddItem">
<summary>
An item is about to be added to the MediaList
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaList.ItemDeleted">
<summary>
An item has been deleted from the MediaList
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaList.WillDeleteItem">
<summary>
An item is about to be deleted from the MediaList
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaList.EndReached">
<summary>
The media list reached its end
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaList.GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection of media
</summary>
<returns>an enumerator over a media collection</returns>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer">
<summary>
The MediaPlayer type is used to control playback, set renderers, provide events and much more
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayer._gcHandle">
<summary>
The GCHandle to be passed to callbacks as userData
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.#ctor(LibVLCSharp.Shared.LibVLC)">
<summary>Create an empty Media Player object</summary>
<param name="libVLC">
<para>the libvlc instance in which the Media Player</para>
<para>should be created.</para>
</param>
<returns>a new media player object, or NULL on error.</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.#ctor(LibVLCSharp.Shared.Media)">
<summary>Create a Media Player object from a Media</summary>
<param name="media">
<para>the media. Afterwards the p_md can be safely</para>
<para>destroyed.</para>
</param>
<returns>a new media player object, or NULL on error.</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Media">
<summary>
Get the media used by the media_player.
Set the media that will be used by the media_player.
If any, previous md will be released.
Note: It is safe to release the Media on the C# side after it's been set on the MediaPlayer successfully
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.IsPlaying">
<summary>
return true if the media player is playing, false otherwise
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Play">
<summary>
Start playback with Media that is set
If playback was already started, this method has no effect
</summary>
<returns>true if successful</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Play(LibVLCSharp.Shared.Media)">
<summary>
Set media and start playback
</summary>
<param name="media"></param>
<returns>true if successful</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetPause(System.Boolean)">
<summary>
Pause or resume (no effect if there is no media).
version LibVLC 1.1.1 or later
</summary>
<param name="pause">play/resume if true, pause if false</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Pause">
<summary>
Toggle pause (no effect if there is no media)
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Stop">
<summary>
Stop the playback (no effect if there is no media)
warning:
This is synchronous, and will block until all VLC threads have been joined.
Calling this from a VLC callback is a bound to cause a deadlock.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.NsObject">
<summary>
Get the NSView handler previously set
return the NSView handler or 0 if none where set
<para></para>
<para></para>
Set the NSView handler where the media player should render its video output.
Use the vout called "macosx".
<para></para>
The drawable is an NSObject that follow the
VLCOpenGLVideoViewEmbedding protocol: VLCOpenGLVideoViewEmbedding NSObject
Or it can be an NSView object.
If you want to use it along with Qt4 see the QMacCocoaViewContainer.
Then the following code should work: { NSView *video = [[NSView
alloc] init]; QMacCocoaViewContainer *container = new
QMacCocoaViewContainer(video, parent);
libvlc_media_player_set_nsobject(mp, video); [video release]; }
You can find a live example in VLCVideoView in VLCKit.framework.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.XWindow">
<summary>
Set an X Window System drawable where the media player should render its video output.
The call takes effect when the playback starts. If it is already started, it might need to be stopped before changes apply.
If LibVLC was built without X11 output support, then this function has no effects.
By default, LibVLC will capture input events on the video rendering area.
Use libvlc_video_set_mouse_input() and libvlc_video_set_key_input() to disable that and deliver events to the parent window / to the application instead.
By design, the X11 protocol delivers input events to only one recipient.
<para></para>
Warning:
The application must call the XInitThreads() function from Xlib before libvlc_new(), and before any call to XOpenDisplay() directly
or via any other library.Failure to call XInitThreads() will seriously impede LibVLC performance.
Calling XOpenDisplay() before XInitThreads() will eventually crash the process. That is a limitation of Xlib.
uint: X11 window ID
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Hwnd">
<summary>
Set a Win32/Win64 API window handle (HWND) where the media player
should render its video output. If LibVLC was built without
Win32/Win64 API output support, then this has no effects.
<para></para>
Get the Windows API window handle (HWND) previously set
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Length">
<summary>
The movie length (in ms), or -1 if there is no media.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Time">
<summary>
Set the movie time (in ms). This has no effect if no media is being
played. Not all formats and protocols support this.
<para></para>
Get the movie time (in ms), or -1 if there is no media.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Position">
<summary>
Set movie position as percentage between 0.0 and 1.0. This has no
effect if playback is not enabled. This might not work depending on
the underlying input format and protocol.
<para></para>
Get movie position as percentage between 0.0 and 1.0.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SeekTo(System.TimeSpan)">
<summary>
Set the movie time. This has no effect if no media is being
played. Not all formats and protocols support this.
</summary>
<param name="time">the movie time to seek to</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Chapter">
<summary>
Set movie chapter (if applicable).
<para></para>
Get the movie chapter number currently playing, or -1 if there is no media.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.ChapterCount">
<summary>
Get the number of chapters in movie, or -1.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.WillPlay">
<summary>
True if the player is able to play
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.ChapterCountForTitle(System.Int32)">
<summary>
Get the number of chapters in title, or -1
</summary>
<param name="title"></param>
<returns></returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Title">
<summary>
Set movie title number to play
<para></para>
Get movie title number currently playing, or -1
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.TitleCount">
<summary>
The title number count, or -1
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.PreviousChapter">
<summary>
Set previous chapter (if applicable)
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.NextChapter">
<summary>
Set next chapter (if applicable)
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Rate">
<summary>
Get the requested movie play rate.
warning
<para></para>
Depending on the underlying media, the requested rate may be
different from the real playback rate.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetRate(System.Single)">
<summary>
Set movie play rate
</summary>
<param name="rate">movie play rate to set</param>
<returns>
return -1 if an error was detected, 0 otherwise (but even then, it
might not actually work depending on the underlying media protocol)
</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.State">
<summary>
Get the current state of the media player (playing, paused, ...)
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Fps">
<summary>
Get the frames per second (fps) for this playing movie, or 0 if unspecified
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.VoutCount">
<summary>
Get the number of video outputs
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.IsSeekable">
<summary>
True if the media player can seek
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.CanPause">
<summary>
True if the media player can pause
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.ProgramScambled">
<summary>
True if the current program is scrambled
<para></para>
LibVLC 2.2.0 or later
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.NextFrame">
<summary>
Display the next frame (if supported)
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Navigate(System.UInt32)">
<summary>
Navigate through DVD Menu
</summary>
<param name="navigate">the Navigation mode</param>
LibVLC 2.0.0 or later
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVideoTitleDisplay(LibVLCSharp.Shared.Position,System.UInt32)">
<summary>
Set if, and how, the video title will be shown when media is played.
</summary>
<param name="position">position at which to display the title, or libvlc_position_disable to prevent the title from being displayed</param>
<param name="timeout">title display timeout in milliseconds (ignored if libvlc_position_disable)</param>
LibVLC 2.1.0 or later
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.ToggleFullscreen">
<summary>
Toggle fullscreen status on non-embedded video outputs.
<para></para>
warning: The same limitations applies to this function as to MediaPlayer::setFullscreen()
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Fullscreen">
<summary>
Enable or disable fullscreen.
Warning, TL;DR version : Unless you know what you're doing, don't use this.
Put your VideoView inside a fullscreen control instead, refer to your platform documentation.
<para></para>
Warning, long version :
With most window managers, only a top-level windows can be in full-screen mode.
Hence, this function will not operate properly if libvlc_media_player_set_xwindow() was used to embed the video in a non-top-level window.
In that case, the embedding window must be reparented to the root window before fullscreen mode is enabled.
You will want to reparent it back to its normal parent when disabling fullscreen.
<para></para>
return the fullscreen status (boolean)
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.ToggleTeletext">
<summary>
Toggle teletext transparent status on video output.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetEqualizer(LibVLCSharp.Shared.Equalizer)">
<summary>
Apply new equalizer settings to a media player.
The equalizer is first created by invoking libvlc_audio_equalizer_new() or libvlc_audio_equalizer_new_from_preset().
It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not.
Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any.
If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played.
Equalizer settings will automatically be applied to subsequently played media.
To disable the equalizer for a media player invoke this method passing NULL for the p_equalizer parameter.
The media player does not keep a reference to the supplied equalizer so it is safe for an application to release the equalizer reference
any time after this method returns.
</summary>
<param name="equalizer">opaque equalizer handle, or NULL to disable the equalizer for this media player</param>
LibVLC 2.2.0 or later
<returns>true on success, false otherwise.</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.UnsetEqualizer">
<summary>
unsetEqualizer disable equalizer for this media player
</summary>
<returns>true on success, false otherwise.</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioCallbacks(LibVLCSharp.Shared.MediaPlayer.LibVLCAudioPlayCb,LibVLCSharp.Shared.MediaPlayer.LibVLCAudioPauseCb,LibVLCSharp.Shared.MediaPlayer.LibVLCAudioResumeCb,LibVLCSharp.Shared.MediaPlayer.LibVLCAudioFlushCb,LibVLCSharp.Shared.MediaPlayer.LibVLCAudioDrainCb)">
<summary>
Sets callbacks and private data for decoded audio.
Use libvlc_audio_set_format() or libvlc_audio_set_format_callbacks() to configure the decoded audio format.
Note: The audio callbacks override any other audio output mechanism. If the callbacks are set, LibVLC will not output audio in any way.
</summary>
<param name="playCb">callback to play audio samples (must not be NULL) </param>
<param name="pauseCb">callback to pause playback (or NULL to ignore) </param>
<param name="resumeCb">callback to resume playback (or NULL to ignore) </param>
<param name="flushCb">callback to flush audio buffers (or NULL to ignore) </param>
<param name="drainCb">callback to drain audio buffers (or NULL to ignore) </param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVolumeCallback(LibVLCSharp.Shared.MediaPlayer.LibVLCVolumeCb)">
<summary>
Set callbacks and private data for decoded audio.
This only works in combination with libvlc_audio_set_callbacks().
Use libvlc_audio_set_format() or libvlc_audio_set_format_callbacks() to configure the decoded audio format.
</summary>
<param name="volumeCb">callback to apply audio volume, or NULL to apply volume in software</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioFormatCallback(LibVLCSharp.Shared.MediaPlayer.LibVLCAudioSetupCb,LibVLCSharp.Shared.MediaPlayer.LibVLCAudioCleanupCb)">
<summary>
Sets decoded audio format via callbacks.
This only works in combination with libvlc_audio_set_callbacks().
</summary>
<param name="setupCb">callback to select the audio format (cannot be NULL)</param>
<param name="cleanupCb">callback to release any allocated resources (or NULL)</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioFormat(System.String,System.UInt32,System.UInt32)">
<summary>
Sets a fixed decoded audio format.
This only works in combination with libvlc_audio_set_callbacks(), and is mutually exclusive with libvlc_audio_set_format_callbacks().
</summary>
<param name="format">a four-characters string identifying the sample format (e.g. "S16N" or "FL32")</param>
<param name="rate">sample rate (expressed in Hz)</param>
<param name="channels">channels count</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioOutput(System.String)">
<summary>
Selects an audio output module.
Note:
Any change will take effect only after playback is stopped and restarted. Audio output cannot be changed while playing.
</summary>
<param name="name">name of audio output, use psz_name of</param>
<returns>true if function succeeded, false on error</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.OutputDevice">
<summary>
Get the current audio output device identifier.
This complements <see cref="M:LibVLCSharp.Shared.MediaPlayer.SetOutputDevice(System.String,System.String)"/>
warning The initial value for the current audio output device identifier
may not be set or may be some unknown value.A LibVLC application should
compare this value against the known device identifiers (e.g.those that
were previously retrieved by a call to <see cref="P:LibVLCSharp.Shared.MediaPlayer.AudioOutputDeviceEnum"/> or
<see cref="M:LibVLCSharp.Shared.LibVLC.AudioOutputDevices(System.String)"/>) to find the current audio output device.
It is possible that the selected audio output device changes(an external
change) without a call to <see cref="M:LibVLCSharp.Shared.MediaPlayer.SetOutputDevice(System.String,System.String)"/>.That may make this
method unsuitable to use if a LibVLC application is attempting to track
dynamic audio device changes as they happen.
</summary>
<returns>the current audio output device identifier, or NULL if no device is selected or in case of error.</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetOutputDevice(System.String,System.String)">
<summary>
Configures an explicit audio output device.
If the module paramater is NULL, audio output will be moved to the device
specified by the device identifier string immediately.This is the
recommended usage.
A list of adequate potential device strings can be obtained with
<see cref="P:LibVLCSharp.Shared.MediaPlayer.AudioOutputDeviceEnum"/>
However passing NULL is supported in LibVLC version 2.2.0 and later only;
in earlier versions, this function would have no effects when the module
parameter was NULL.
If the module parameter is not NULL, the device parameter of the
corresponding audio output, if it exists, will be set to the specified
string.
A list of adequate potential device strings can be obtained with
<see cref="M:LibVLCSharp.Shared.LibVLC.AudioOutputDevices(System.String)"/>
</summary>
<param name="deviceId">device identifier string</param>
<param name="module">If NULL, current audio output module. if non-NULL, name of audio output module</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AudioOutputDeviceEnum">
<summary>
Gets a list of potential audio output devices
<para/> Not all audio outputs support enumerating devices. The audio output may be functional even if the list is empty (NULL).
The list may not be exhaustive. Some audio output devices in the list might not actually work in some circumstances.
<para/> By default, it is recommended to not specify any explicit audio device.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.ToggleMute">
<summary>
Toggle mute status.
Warning
Toggling mute atomically is not always possible: On some platforms, other processes can mute the VLC audio playback
stream asynchronously.
Thus, there is a small race condition where toggling will not work.
See also the limitations of libvlc_audio_set_mute().
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Mute">
<summary>
Get current mute status.
Set mute status.
Warning
This function does not always work.
If there are no active audio playback stream, the mute status might not be available.
If digital pass-through (S/PDIF, HDMI...) is in use, muting may be unapplicable.
Also some audio output plugins do not support muting at all.
Note
To force silent playback, disable all audio tracks. This is more efficient and reliable than mute.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Volume">
<summary>
Get/Set the volume in percents (0 = mute, 100 = 0dB)
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AudioTrackCount">
<summary>
Get the number of available audio tracks (int), or -1 if unavailable
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AudioTrackDescription">
<summary>
Retrive the audio track description
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AudioTrack">
<summary>
Get current audio track ID or -1 if no active input.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioTrack(System.Int32)">
<summary>
Set current audio track.
</summary>
<param name="trackIndex">the track ID (i_id field from track description)</param>
<returns>true on success, false on error</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Channel">
<summary>
Get current audio channel.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetChannel(LibVLCSharp.Shared.AudioOutputChannel)">
<summary>
Set current audio channel.
</summary>
<param name="channel">the audio channel</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Equals(System.Object)">
<summary>
Equals override based on the native instance reference
</summary>
<param name="obj">the mediaplayer instance to compare this to</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.GetHashCode">
<summary>
Custom hascode implemenation for this MediaPlayer instance
</summary>
<returns>the hashcode for this MediaPlayer instance</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AudioDelay">
<summary>
Get current audio delay (microseconds).
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAudioDelay(System.Int64)">
<summary>
Set current audio delay. The audio delay will be reset to zero each
time the media changes.
</summary>
<param name="delay">the audio delay (microseconds)</param>
<returns>true on success, false on error </returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVideoCallbacks(LibVLCSharp.Shared.MediaPlayer.LibVLCVideoLockCb,LibVLCSharp.Shared.MediaPlayer.LibVLCVideoUnlockCb,LibVLCSharp.Shared.MediaPlayer.LibVLCVideoDisplayCb)">
<summary>
Set callbacks and private data to render decoded video to a custom area in memory.
Use libvlc_video_set_format() or libvlc_video_set_format_callbacks() to configure the decoded format.
Warning
Rendering video into custom memory buffers is considerably less efficient than rendering in a custom window as normal.
For optimal perfomances, VLC media player renders into a custom window, and does not use this function and associated callbacks.
It is highly recommended that other LibVLC-based application do likewise.
To embed video in a window, use libvlc_media_player_set_xid() or equivalent depending on the operating system.
If window embedding does not fit the application use case, then a custom LibVLC video output display plugin is required to maintain optimal video rendering performances.
The following limitations affect performance:
Hardware video decoding acceleration will either be disabled completely, or require(relatively slow) copy from video/DSP memory to main memory.
Sub-pictures(subtitles, on-screen display, etc.) must be blent into the main picture by the CPU instead of the GPU.
Depending on the video format, pixel format conversion, picture scaling, cropping and/or picture re-orientation,
must be performed by the CPU instead of the GPU.
Memory copying is required between LibVLC reference picture buffers and application buffers (between lock and unlock callbacks).
</summary>
<param name="lockCb">callback to lock video memory (must not be NULL)</param>
<param name="unlockCb">callback to unlock video memory (or NULL if not needed)</param>
<param name="displayCb">callback to display video (or NULL if not needed)</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVideoFormat(System.String,System.UInt32,System.UInt32,System.UInt32)">
<summary>
Set decoded video chroma and dimensions. This only works in
combination with MediaPlayer::setCallbacks() , and is mutually exclusive
with MediaPlayer::setFormatCallbacks()
</summary>
<param name="chroma">a four-characters string identifying the chroma (e.g."RV32" or "YUYV")</param>
<param name="width">pixel width</param>
<param name="height">pixel height</param>
<param name="pitch">line pitch (in bytes)</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVideoFormatCallbacks(LibVLCSharp.Shared.MediaPlayer.LibVLCVideoFormatCb,LibVLCSharp.Shared.MediaPlayer.LibVLCVideoCleanupCb)">
<summary>
Set decoded video chroma and dimensions.
This only works in combination with libvlc_video_set_callbacks().
</summary>
<param name="formatCb">callback to select the video format (cannot be NULL)</param>
<param name="cleanupCb">callback to release any allocated resources (or NULL)</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.EnableKeyInput">
<summary>
Enable or disable key press events handling, according to the LibVLC hotkeys configuration.
By default and for historical reasons, keyboard events are handled by the LibVLC video widget.
Note
On X11, there can be only one subscriber for key press and mouse click events per window.
If your application has subscribed to those events for the X window ID of the video widget,
then LibVLC will not be able to handle key presses and mouse clicks in any case.
Warning
This function is only implemented for X11 and Win32 at the moment.
true to handle key press events, false to ignore them.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.EnableMouseInput">
<summary>
Enable or disable mouse click events handling.
By default, those events are handled. This is needed for DVD menus to work, as well as a few video filters such as "puzzle".
Warning
This function is only implemented for X11 and Win32 at the moment.
true to handle mouse click events, false to ignore them.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Size(System.UInt32,System.UInt32@,System.UInt32@)">
<summary>
Get the pixel dimensions of a video.
</summary>
<param name="num">number of the video (starting from, and most commonly 0)</param>
<param name="px">pointer to get the pixel width [OUT]</param>
<param name="py">pointer to get the pixel height [OUT]</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Cursor(System.UInt32,System.Int32@,System.Int32@)">
<summary>
Get the mouse pointer coordinates over a video.
Coordinates are expressed in terms of the decoded video resolution, not in terms of pixels on the screen/viewport
(to get the latter, you can query your windowing system directly).
Either of the coordinates may be negative or larger than the corresponding dimension of the video,
if the cursor is outside the rendering area.
Warning
The coordinates may be out-of-date if the pointer is not located on the video rendering area.
LibVLC does not track the pointer if it is outside of the video widget.
Note
LibVLC does not support multiple pointers(it does of course support multiple input devices sharing the same pointer) at the moment.
</summary>
<param name="num">number of the video (starting from, and most commonly 0)</param>
<param name="px">pointer to get the abscissa [OUT]</param>
<param name="py">pointer to get the ordinate [OUT]</param>
<returns>true on success, false on failure</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Scale">
<summary>
Get/Set the current video scaling factor. See also MediaPlayer::setScale() .
That is the ratio of the number of
pixels on screen to the number of pixels in the original decoded video
in each dimension.Zero is a special value; it will adjust the video
to the output window/drawable(in windowed mode) or the entire screen.
Note that not all video outputs support scaling.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.AspectRatio">
<summary>
Get/set current video aspect ratio.
Set to null to reset to default
Invalid aspect ratios are ignored.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Spu">
<summary>
The current video subtitle track
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetSpu(System.Int32)">
<summary>
Set Spu (subtitle)
</summary>
<param name="spu">Video subtitle track to select (id from track description)</param>
<returns>true on success, false otherwise</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.SpuCount">
<summary>
Get the number of available video subtitles.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.SpuDescription">
<summary>
Retrieve SpuDescription in a TrackDescription struct
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.SpuDelay">
<summary>
Get the current subtitle delay.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetSpuDelay(System.Int64)">
<summary>
Set the subtitle delay.
This affects the timing of when the subtitle will be displayed.
Positive values result in subtitles being displayed later, while negative values will result in subtitles being displayed earlier.
The subtitle delay will be reset to zero each time the media changes.
</summary>
<param name="delay">time (in microseconds) the display of subtitles should be delayed</param>
<returns>true if successful, false otherwise</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.TitleDescription">
<summary>
Get the description of available titles.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.FullChapterDescriptions(System.Int32)">
<summary>
Get the full description of available chapters.
</summary>
<param name="titleIndex">Index of the title to query for chapters (uses current title if set to -1)</param>
<returns>Array of chapter descriptions.</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.ChapterDescription(System.Int32)">
<summary>
Get the description of available chapters for specific title.
</summary>
<param name="titleIndex">selected title</param>
<returns>chapter descriptions</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.CropGeometry">
<summary>
Get/Set current crop filter geometry.
Empty string to unset
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Teletext">
<summary>
Get current teletext page requested.
Set new teletext page to retrieve.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.VideoTrackCount">
<summary>
Get number of available video tracks.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.VideoTrackDescription">
<summary>
Get the description of available video tracks.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.VideoTrack">
<summary>
Get current video track ID (int) or -1 if no active input.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetVideoTrack(System.Int32)">
<summary>
Set video track.
</summary>
<param name="trackIndex">the track ID (i_id field from track description)</param>
<returns>true on sucess, false out of range</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.TakeSnapshot(System.UInt32,System.String,System.UInt32,System.UInt32)">
<summary>
Take a snapshot of the current video window.
If i_width AND i_height is 0, original size is used. If i_width XOR
i_height is 0, original aspect-ratio is preserved.
</summary>
<param name="num">number of video output (typically 0 for the first/only one)</param>
<param name="filePath">the path where to save the screenshot to</param>
<param name="width">the snapshot's width</param>
<param name="height">the snapshot's height</param>
<returns>true on success</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetDeinterlace(System.String)">
<summary>
Enable or disable deinterlace filter
</summary>
<param name="deinterlaceMode">type of deinterlace filter, null to disable</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.MarqueeInt(LibVLCSharp.Shared.VideoMarqueeOption)">
<summary>
Get an integer marquee option value
</summary>
<param name="option">marq option to get</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.MarqueeString(LibVLCSharp.Shared.VideoMarqueeOption)">
<summary>
Get a string marquee option value
</summary>
<param name="option">marq option to get</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetMarqueeInt(LibVLCSharp.Shared.VideoMarqueeOption,System.Int32)">
<summary>
Enable, disable or set an integer marquee option
Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
or disabling (arg 0) the marq filter.
</summary>
<param name="option">marq option to set</param>
<param name="value">marq option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetMarqueeString(LibVLCSharp.Shared.VideoMarqueeOption,System.String)">
<summary>
Enable, disable or set an string marquee option
</summary>
<param name="option">marq option to set</param>
<param name="marqueeValue">marq option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.LogoInt(LibVLCSharp.Shared.VideoLogoOption)">
<summary>
Get integer logo option.
</summary>
<param name="option">logo option to get, values of libvlc_video_logo_option_t</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetLogoInt(LibVLCSharp.Shared.VideoLogoOption,System.Int32)">
<summary>
Set logo option as integer. Options that take a different type value
are ignored. Passing libvlc_logo_enable as option value has the side
effect of starting (arg !0) or stopping (arg 0) the logo filter.
</summary>
<param name="option">logo option to set, values of libvlc_video_logo_option_t</param>
<param name="value">logo option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetLogoString(LibVLCSharp.Shared.VideoLogoOption,System.String)">
<summary>
Set logo option as string. Options that take a different type value are ignored.
</summary>
<param name="option">logo option to set, values of libvlc_video_logo_option_t</param>
<param name="logoValue">logo option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.AdjustInt(LibVLCSharp.Shared.VideoAdjustOption)">
<summary>
Get integer adjust option.
</summary>
<param name="option">adjust option to get, values of libvlc_video_adjust_option_t</param>
<returns></returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAdjustInt(LibVLCSharp.Shared.VideoAdjustOption,System.Int32)">
<summary>
Set adjust option as integer. Options that take a different type value
are ignored. Passing libvlc_adjust_enable as option value has the side
effect of starting (arg !0) or stopping (arg 0) the adjust filter.
</summary>
<param name="option">adust option to set, values of libvlc_video_adjust_option_t</param>
<param name="value">adjust option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.AdjustFloat(LibVLCSharp.Shared.VideoAdjustOption)">
<summary>
Get adjust option float value
</summary>
<param name="option">The option for which to get the value</param>
<returns>the float value for a given option</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetAdjustFloat(LibVLCSharp.Shared.VideoAdjustOption,System.Single)">
<summary>
Set adjust option as float. Options that take a different type value are ignored.
</summary>
<param name="option">adust option to set, values of <see cref="T:LibVLCSharp.Shared.VideoAdjustOption"/></param>
<param name="value">adjust option value</param>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.AddSlave(LibVLCSharp.Shared.MediaSlaveType,System.String,System.Boolean)">
<summary>
Add a slave to the current media player.
note If the player is playing, the slave will be added directly. This call
will also update the slave list of the attached VLC::Media.
</summary>
<param name="type">subtitle or audio</param>
<param name="uri">Uri of the slave (should contain a valid scheme).</param>
<param name="select">True if this slave should be selected when it's loaded</param>
<returns></returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Viewpoint">
<summary>
Current 360 viewpoint of this mediaplayer.
<para/>Update with <see cref="M:LibVLCSharp.Shared.MediaPlayer.UpdateViewpoint(System.Single,System.Single,System.Single,System.Single,System.Boolean)"/>
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.UpdateViewpoint(System.Single,System.Single,System.Single,System.Single,System.Boolean)">
<summary>
Update the video viewpoint information.
The values are set asynchronously, it will be used by the next frame displayed.
It is safe to call this function before the media player is started.
LibVLC 3.0.0 and later
</summary>
<param name="yaw">view point yaw in degrees ]-180;180]</param>
<param name="pitch">view point pitch in degrees ]-90;90]</param>
<param name="roll">view point roll in degrees ]-180;180]</param>
<param name="fov">field of view in degrees ]0;180[ (default 80.)</param>
<param name="absolute">if true replace the old viewpoint with the new one. If false, increase/decrease it.</param>
<returns>true if successful, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetRenderer(LibVLCSharp.Shared.RendererItem)">
<summary>
Set a renderer to the media player.
</summary>
<param name="rendererItem">discovered renderer item or null to fallback on local rendering</param>
<returns>true on success, false otherwise</returns>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.Role">
<summary>Gets the media role.
<para/> version LibVLC 3.0.0 and later.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.SetRole(LibVLCSharp.Shared.MediaPlayerRole)">
<summary>Sets the media role.
<para/> version LibVLC 3.0.0 and later.
</summary>
<returns>true on success, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Retain">
<summary>Increments the native reference counter for this mediaplayer instance</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.EnableHardwareDecoding">
<summary>
Enable/disable hardware decoding in a crossplatform way.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.FileCaching">
<summary>
Caching value for local files, in milliseconds [0 .. 60000ms]
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.NetworkCaching">
<summary>
Caching value for network resources, in milliseconds [0 .. 60000ms]
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVideoLockCb">
<summary>
<para>A LibVLC media player plays one media (usually in a custom drawable).</para>
<para>@{</para>
<para></para>
<para>LibVLC simple media player external API</para>
</summary>
<summary>Opaque equalizer handle.</summary>
<remarks>Equalizer settings can be applied to a media player.</remarks>
<summary>Callback prototype to allocate and lock a picture buffer.</summary>
<param name="opaque">private pointer as passed to libvlc_video_set_callbacks() [IN]</param>
<param name="planes">
<para>start address of the pixel planes (LibVLC allocates the array</para>
<para>of void pointers, this callback must initialize the array) [OUT]</para>
</param>
<returns>
<para>a private pointer for the display and unlock callbacks to identify</para>
<para>the picture buffers</para>
</returns>
<remarks>
<para>Whenever a new video frame needs to be decoded, the lock callback is</para>
<para>invoked. Depending on the video chroma, one or three pixel planes of</para>
<para>adequate dimensions must be returned via the second parameter. Those</para>
<para>planes must be aligned on 32-bytes boundaries.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVideoUnlockCb">
<summary>Callback prototype to unlock a picture buffer.</summary>
<param name="opaque">private pointer as passed to libvlc_video_set_callbacks() [IN]</param>
<param name="picture">private pointer returned from the</param>
<param name="planes">pixel planes as defined by the</param>
<remarks>
<para>When the video frame decoding is complete, the unlock callback is invoked.</para>
<para>This callback might not be needed at all. It is only an indication that the</para>
<para>application can now read the pixel values if it needs to.</para>
<para>A picture buffer is unlocked after the picture is decoded,</para>
<para>but before the picture is displayed.</para>
<para>callback [IN]</para>
<para>callback (this parameter is only for convenience) [IN]</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVideoDisplayCb">
<summary>Callback prototype to display a picture.</summary>
<param name="opaque">private pointer as passed to libvlc_video_set_callbacks() [IN]</param>
<param name="picture">private pointer returned from the</param>
<remarks>
<para>When the video frame needs to be shown, as determined by the media playback</para>
<para>clock, the display callback is invoked.</para>
<para>callback [IN]</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVideoFormatCb">
<summary>
<para>Callback prototype to configure picture buffers format.</para>
<para>This callback gets the format of the video as output by the video decoder</para>
<para>and the chain of video filters (if any). It can opt to change any parameter</para>
<para>as it needs. In that case, LibVLC will attempt to convert the video format</para>
<para>(rescaling and chroma conversion) but these operations can be CPU intensive.</para>
</summary>
<param name="opaque">
<para>pointer to the private pointer passed to</para>
<para>libvlc_video_set_callbacks() [IN/OUT]</para>
</param>
<param name="chroma">pointer to the 4 bytes video format identifier [IN/OUT]</param>
<param name="width">pointer to the pixel width [IN/OUT]</param>
<param name="height">pointer to the pixel height [IN/OUT]</param>
<param name="pitches">
<para>table of scanline pitches in bytes for each pixel plane</para>
<para>(the table is allocated by LibVLC) [OUT]</para>
</param>
<param name="lines">table of scanlines count for each plane [OUT]</param>
<returns>the number of picture buffers allocated, 0 indicates failure</returns>
<remarks>
<para>For each pixels plane, the scanline pitch must be bigger than or equal to</para>
<para>the number of bytes per pixel multiplied by the pixel width.</para>
<para>Similarly, the number of scanlines must be bigger than of equal to</para>
<para>the pixel height.</para>
<para>Furthermore, we recommend that pitches and lines be multiple of 32</para>
<para>to not break assumptions that might be held by optimized code</para>
<para>in the video decoders, video filters and/or video converters.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVideoCleanupCb">
<summary>Callback prototype to configure picture buffers format.</summary>
<param name="opaque">
<para>private pointer as passed to libvlc_video_set_callbacks()</para>
<para>(and possibly modified by</para>
</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioSetupCb">
<summary>Callback prototype to setup the audio playback.</summary>
<param name="opaque">
<para>pointer to the data pointer passed to</para>
<para>libvlc_audio_set_callbacks() [IN/OUT]</para>
</param>
<param name="format">4 bytes sample format [IN/OUT]</param>
<param name="rate">sample rate [IN/OUT]</param>
<param name="channels">channels count [IN/OUT]</param>
<returns>0 on success, anything else to skip audio playback</returns>
<remarks>This is called when the media player needs to create a new audio output.</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioCleanupCb">
<summary>Callback prototype for audio playback cleanup.</summary>
<param name="opaque">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<remarks>This is called when the media player no longer needs an audio output.</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioPlayCb">
<summary>Callback prototype for audio playback.</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<param name="samples">pointer to a table of audio samples to play back [IN]</param>
<param name="count">number of audio samples to play back</param>
<param name="pts">expected play time stamp (see libvlc_delay())</param>
<remarks>
<para>The LibVLC media player decodes and post-processes the audio signal</para>
<para>asynchronously (in an internal thread). Whenever audio samples are ready</para>
<para>to be queued to the output, this callback is invoked.</para>
<para>The number of samples provided per invocation may depend on the file format,</para>
<para>the audio coding algorithm, the decoder plug-in, the post-processing</para>
<para>filters and timing. Application must not assume a certain number of samples.</para>
<para>The exact format of audio samples is determined by libvlc_audio_set_format()</para>
<para>or libvlc_audio_set_format_callbacks() as is the channels layout.</para>
<para>Note that the number of samples is per channel. For instance, if the audio</para>
<para>track sampling rate is 48000&#160;Hz, then 1200&#160;samples represent 25&#160;milliseconds</para>
<para>of audio signal - regardless of the number of audio channels.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioPauseCb">
<summary>Callback prototype for audio pause.</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<param name="pts">time stamp of the pause request (should be elapsed already)</param>
<remarks>
<para>LibVLC invokes this callback to pause audio playback.</para>
<para>The pause callback is never called if the audio is already paused.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioResumeCb">
<summary>Callback prototype for audio resumption.</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<param name="pts">time stamp of the resumption request (should be elapsed already)</param>
<remarks>
<para>LibVLC invokes this callback to resume audio playback after it was</para>
<para>previously paused.</para>
<para>The resume callback is never called if the audio is not paused.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioFlushCb">
<summary>Callback prototype for audio buffer flush.
<para>LibVLC invokes this callback if it needs to discard all pending buffers and</para>
<para>stop playback as soon as possible. This typically occurs when the media is stopped.</para>
</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<param name="pts">current presentation timestamp</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCAudioDrainCb">
<summary>Callback prototype for audio buffer drain.</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<remarks>
<para>LibVLC may invoke this callback when the decoded audio track is ending.</para>
<para>There will be no further decoded samples for the track, but playback should</para>
<para>nevertheless continue until all already pending buffers are rendered.</para>
</remarks>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayer.LibVLCVolumeCb">
<summary>Callback prototype for audio volume change.</summary>
<param name="data">data pointer as passed to libvlc_audio_set_callbacks() [IN]</param>
<param name="volume">software volume (1. = nominal, 0. = mute)</param>
<param name="mute">muted flag</param>
</member>
<member name="P:LibVLCSharp.Shared.MediaPlayer.EventManager">
<summary>
Get the Event Manager from which the media player send event.
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.MediaChanged">
<summary>
The media of this mediaplayer changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.NothingSpecial">
<summary>
Nothing special to report
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Opening">
<summary>
The mediaplayer is opening a media
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Buffering">
<summary>
The mediaplayer is buffering
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Playing">
<summary>
The mediaplayer started playing a media
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Paused">
<summary>
The mediaplayer paused playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Stopped">
<summary>
The mediaplayer stopped playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Forward">
<summary>
The mediaplayer went forward in the playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Backward">
<summary>
The mediaplayer went backward in the playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.EndReached">
<summary>
The mediaplayer reached the end of the playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.EncounteredError">
<summary>
The mediaplayer encountered an error during playback
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.TimeChanged">
<summary>
The mediaplayer's playback time changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.PositionChanged">
<summary>
The mediaplayer's position changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.SeekableChanged">
<summary>
The mediaplayer's seek capability changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.PausableChanged">
<summary>
The mediaplayer's pause capability changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.TitleChanged">
<summary>
The title of the mediaplayer changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.ChapterChanged">
<summary>
The mediaplayer changed the chapter of a media
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.SnapshotTaken">
<summary>
The mediaplayer took a snapshot
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.LengthChanged">
<summary>
The length of a playback changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Vout">
<summary>
The Video Output count of the MediaPlayer changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.ScrambledChanged">
<summary>
The mediaplayer scrambled status changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.ESAdded">
<summary>
The mediaplayer has a new Elementary Stream (ES)
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.ESDeleted">
<summary>
The mediaplayer has one less Elementary Stream (ES)
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.ESSelected">
<summary>
An Elementary Stream (ES) was selected
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.AudioDevice">
<summary>
The mediaplayer's audio device changed
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Corked">
<summary>
The mediaplayer is corked
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Uncorked">
<summary>
The mediaplayer is uncorked
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Muted">
<summary>
The mediaplayer is muted
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.Unmuted">
<summary>
The mediaplayer is unmuted
</summary>
</member>
<member name="E:LibVLCSharp.Shared.MediaPlayer.VolumeChanged">
<summary>
The mediaplayer's volume changed
</summary>
</member>
<member name="M:LibVLCSharp.Shared.MediaPlayer.Dispose(System.Boolean)">
<summary>
Dispose override
Effectively stops playback and disposes a media if any
</summary>
<param name="disposing">release any unmanaged resources</param>
</member>
<member name="T:LibVLCSharp.Shared.Title">
<summary>Description for titles</summary>
</member>
<member name="F:LibVLCSharp.Shared.Title.Menu">
<summary>
Menu title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Title.Interactive">
<summary>
Interactive title
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoMarqueeOption">
<summary>Marq options definition</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Enable">
<summary>
Enable marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Text">
<summary>
Text marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Color">
<summary>
Color marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Opacity">
<summary>
Opacity marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Position">
<summary>
Position marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Refresh">
<summary>
Refresh marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Size">
<summary>
Size marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Timeout">
<summary>
Timeout marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.X">
<summary>
X marquee
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoMarqueeOption.Y">
<summary>
Y marquee
</summary>
</member>
<member name="T:LibVLCSharp.Shared.NavigationMode">
<summary>Navigation mode</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Activate">
<summary>
Activate
</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Up">
<summary>
Navigation up
</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Down">
<summary>
Navigation down
</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Left">
<summary>
Navigation left
</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Right">
<summary>
Navigation right
</summary>
</member>
<member name="F:LibVLCSharp.Shared.NavigationMode.Popup">
<summary>
Navigation popup
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Position">
<summary>Enumeration of values used to set position (e.g. of video title).</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Disable">
<summary>
Disable
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Center">
<summary>
Center video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Left">
<summary>
Left video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Right">
<summary>
Right video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Top">
<summary>
Top video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.TopLeft">
<summary>
TopLeft video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.TopRight">
<summary>
TopRight video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.Bottom">
<summary>
Bottom video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.BottomLeft">
<summary>
BottomLeft video title
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Position.BottomRight">
<summary>
BottomRight video title
</summary>
</member>
<member name="T:LibVLCSharp.Shared.TeletextKey">
<summary>
<para>Enumeration of teletext keys than can be passed via</para>
<para>libvlc_video_set_teletext()</para>
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TeletextKey.Red">
<summary>
Red
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TeletextKey.Green">
<summary>
Green
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TeletextKey.Yellow">
<summary>
Yellow
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TeletextKey.Blue">
<summary>
Blue
</summary>
</member>
<member name="F:LibVLCSharp.Shared.TeletextKey.Index">
<summary>
Index
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoLogoOption">
<summary>
option values for libvlc_video_{get,set}_logo_{int,string}
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Enable">
<summary>
Enable
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.File">
<summary>
string argument, &quot;file,d,t;file,d,t;...&quot;
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.X">
<summary>
X
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Y">
<summary>
Y
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Delay">
<summary>
Delay
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Repeat">
<summary>
Repeat
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Opacity">
<summary>
Opacity
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoLogoOption.Position">
<summary>
Position
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoAdjustOption">
<summary>
option values for libvlc_video_{get,set}_adjust_{int,float,bool}
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Enable">
<summary>
Enable
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Contrast">
<summary>
Contrast
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Brightness">
<summary>
Brightness
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Hue">
<summary>
Hue
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Saturation">
<summary>
Saturation
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoAdjustOption.Gamma">
<summary>
Gamma
</summary>
</member>
<member name="T:LibVLCSharp.Shared.AudioOutputChannel">
<summary>
Audio channels
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.Error">
<summary>
Error
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.Stereo">
<summary>
Stereo mode
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.RStereo">
<summary>
RStereo mode
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.Left">
<summary>
Left mode
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.Right">
<summary>
Right mode
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioOutputChannel.Dolbys">
<summary>
Dolbys mode
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaPlayerRole">
<summary>Media player roles.</summary>
<remarks>
<para>LibVLC 3.0.0 and later.</para>
<para>See</para>
</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.None">
<summary>Don't use a media player role</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Music">
<summary>Music (or radio) playback</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Video">
<summary>Video playback</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Communication">
<summary>Speech, real-time communication</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Game">
<summary>Video game</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.LiblvcRoleNotification">
<summary>User interaction feedback</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Animation">
<summary>Embedded animation (e.g. in web page)</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Production">
<summary>Audio editing/production</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Accessibility">
<summary>Accessibility</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaPlayerRole.Test">
<summary>Testing</summary>
</member>
<member name="T:LibVLCSharp.Shared.RendererDiscoverer">
<summary>
The renderer discoverer can be used to find and use a Chromecast or other distant renderers.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.RendererDiscoverer.#ctor(LibVLCSharp.Shared.LibVLC,System.String)">
<summary>
Create a new renderer discoverer with a LibVLC and protocol name depending on host platform
</summary>
<param name="libVLC">libvlc instance this will be connected to</param>
<param name="name">
The service discovery protocol name depending on platform. Use <see cref="P:LibVLCSharp.Shared.LibVLC.RendererList"/> to find the one for your platform,
or let libvlcsharp find it for you
</param>
</member>
<member name="M:LibVLCSharp.Shared.RendererDiscoverer.Start">
<summary>
Start the renderer discovery
</summary>
<returns>true if start successful</returns>
</member>
<member name="M:LibVLCSharp.Shared.RendererDiscoverer.Stop">
<summary>
Stop the renderer discovery
</summary>
</member>
<member name="E:LibVLCSharp.Shared.RendererDiscoverer.ItemAdded">
<summary>
Raised when a renderer item has been found
</summary>
</member>
<member name="E:LibVLCSharp.Shared.RendererDiscoverer.ItemDeleted">
<summary>
Raised when a renderer item has disappeared
</summary>
</member>
<member name="T:LibVLCSharp.Shared.RendererItem">
<summary>
A renderer item represents a device that libvlc can use to render media.
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererItem.Name">
<summary>
Name of the renderer item
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererItem.Type">
<summary>
Type of the renderer item
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererItem.IconUri">
<summary>
IconUri of the renderer item
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererItem.CanRenderVideo">
<summary>
true if the renderer item can render video
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererItem.CanRenderAudio">
<summary>
true if the renderer item can render audio
</summary>
</member>
<member name="T:LibVLCSharp.Shared.StreamMediaInput">
<summary>
A <see cref="T:LibVLCSharp.Shared.MediaInput"/> implementation that reads from a .NET stream
</summary>
</member>
<member name="M:LibVLCSharp.Shared.StreamMediaInput.#ctor(System.IO.Stream)">
<summary>
Initializes a new instance of <see cref="T:LibVLCSharp.Shared.StreamMediaInput"/>, which reads from the given .NET stream.
</summary>
<remarks>You are still responsible to dispose the stream you give as input.</remarks>
<param name="stream">The stream to be read from.</param>
</member>
<member name="M:LibVLCSharp.Shared.StreamMediaInput.Open(System.UInt64@)">
<summary>
LibVLC calls this method when it wants to open the media
</summary>
<param name="size">This value must be filled with the length of the media (or ulong.MaxValue if unknown)</param>
<returns><c>true</c> if the stream opened successfully</returns>
</member>
<member name="M:LibVLCSharp.Shared.StreamMediaInput.Read(System.IntPtr,System.UInt32)">
<summary>
LibVLC calls this method when it wants to read the media
</summary>
<param name="buf">The buffer where read data must be written</param>
<param name="len">The buffer length</param>
<returns>strictly positive number of bytes read, 0 on end-of-stream, or -1 on non-recoverable error</returns>
</member>
<member name="M:LibVLCSharp.Shared.StreamMediaInput.Seek(System.UInt64)">
<summary>
LibVLC calls this method when it wants to seek to a specific position in the media
</summary>
<param name="offset">The offset, in bytes, since the beginning of the stream</param>
<returns><c>true</c> if the seek succeeded, false otherwise</returns>
</member>
<member name="M:LibVLCSharp.Shared.StreamMediaInput.Close">
<summary>
LibVLC calls this method when it wants to close the media.
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Structures.AudioOutputDescription">
<summary>
Description for audio output.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Structures.AudioOutputDescription.#ctor(System.String,System.String)">
<summary>
AudioOutputDescription default constructor
</summary>
<param name="name">Audio output name</param>
<param name="description">Audio output description</param>
</member>
<member name="F:LibVLCSharp.Shared.Structures.AudioOutputDescription.Name">
<summary>
Audio output name
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Structures.AudioOutputDescription.Description">
<summary>
Audio output description
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Structures.AudioOutputDevice">
<summary>
Description for audio output device
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Structures.AudioOutputDevice.#ctor(System.String,System.String)">
<summary>
AudioOutputDevice default constructor
</summary>
<param name="deviceIdentifier">Device identifier string</param>
<param name="description">User-friendly device description</param>
</member>
<member name="F:LibVLCSharp.Shared.Structures.AudioOutputDevice.DeviceIdentifier">
<summary>
Device identifier string.
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Structures.AudioOutputDevice.Description">
<summary>
User-friendly device description.
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Structures.ChapterDescription">
<summary>
<para>Description for chapters.</para>
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Structures.ChapterDescription.TimeOffset">
<summary>
Time-offset of the chapter in milliseconds
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Structures.ChapterDescription.Duration">
<summary>
Duration of the chapter in milliseconds
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Structures.ChapterDescription.Name">
<summary>
Chapter name
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Structures.ChapterDescription.#ctor(System.Int64,System.Int64,System.String)">
<summary>
TrackDescription constructor
</summary>
<param name="timeOffset">Chapter time-offset</param>
<param name="duration">Chapter duration</param>
<param name="name">Chapter name</param>
</member>
<member name="T:LibVLCSharp.Shared.Structures.ModuleDescription">
<summary>
Description of a module.
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Structures.ModuleDescription.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Default constructor for ModuleDescription
</summary>
<param name="name">Module name</param>
<param name="shortName">Module short name</param>
<param name="longName">Module long name</param>
<param name="help">Module help</param>
</member>
<member name="F:LibVLCSharp.Shared.Structures.ModuleDescription.Name">
<summary>
Module name
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Structures.ModuleDescription.ShortName">
<summary>
Module short name
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Structures.ModuleDescription.LongName">
<summary>
Module long name
</summary>
</member>
<member name="F:LibVLCSharp.Shared.Structures.ModuleDescription.Help">
<summary>
Module help
</summary>
</member>
<member name="T:LibVLCSharp.Shared.Structures.TrackDescription">
<summary>
<para>Description for video, audio tracks and subtitles. It contains</para>
<para>id, name (description string)</para>
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Structures.TrackDescription.Id">
<summary>
Track description Id
</summary>
</member>
<member name="P:LibVLCSharp.Shared.Structures.TrackDescription.Name">
<summary>
Track description
</summary>
</member>
<member name="M:LibVLCSharp.Shared.Structures.TrackDescription.#ctor(System.Int32,System.String)">
<summary>
TrackDescription constructor
</summary>
<param name="id">Track description Id</param>
<param name="name">Track description</param>
</member>
<member name="T:LibVLCSharp.Shared.MediaDiscovererDescription">
<summary>
Description of a media discoverer
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscovererDescription.Name">
<summary>
Media discoverer description name
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscovererDescription.LongName">
<summary>
Media discoverer description long name
</summary>
</member>
<member name="P:LibVLCSharp.Shared.MediaDiscovererDescription.Category">
<summary>
Media discoverer category
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaSlave">
<summary>A slave of a libvlc_media_t</summary>
<remarks>libvlc_media_slaves_get</remarks>
</member>
<member name="F:LibVLCSharp.Shared.MediaSlave.Uri">
<summary>
Media slave URI
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSlave.Type">
<summary>
Media slave type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaSlave.Priority">
<summary>
Media slave priority
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaStats">
<summary>
Statistics of a Media
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.ReadBytes">
<summary>
The number of bytes read
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.InputBitrate">
<summary>
The input bitrate
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DemuxReadBytes">
<summary>
The number of bytes read by the demux
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DemuxBitrate">
<summary>
The demux bitrate
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DemuxCorrupted">
<summary>
The number of frame discarded
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DemuxDiscontinuity">
<summary>
The number of frame dropped
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DecodedVideo">
<summary>
The number of decoded video blocks
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DecodedAudio">
<summary>
The number of decoded audio blocks
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.DisplayedPictures">
<summary>
The number of frames displayed
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.LostPictures">
<summary>
The number of frames lost
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.PlayedAudioBuffers">
<summary>
The number of buffers played
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.LostAudioBuffers">
<summary>
The number of buffers lost
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.SentPackets">
<summary>
The number of packets sent
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.SentBytes">
<summary>
The number of bytes sent
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaStats.SendBitrate">
<summary>
The bitrate used to send
</summary>
</member>
<member name="T:LibVLCSharp.Shared.AudioTrack">
<summary>
Audio track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioTrack.Channels">
<summary>
Audio track channels
</summary>
</member>
<member name="F:LibVLCSharp.Shared.AudioTrack.Rate">
<summary>
Audio track rate
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoTrack">
<summary>
Video track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.Height">
<summary>
Video height
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.Width">
<summary>
Video Width
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.SarNum">
<summary>
Video SarNum
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.SarDen">
<summary>
Video SarDen
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.FrameRateNum">
<summary>
Video frame rate num
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.FrameRateDen">
<summary>
Video frame rate den
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.Orientation">
<summary>
Video orientation
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.Projection">
<summary>
Video projection
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoTrack.Pose">
<summary>
Video viewpoint
</summary>
</member>
<member name="T:LibVLCSharp.Shared.SubtitleTrack">
<summary>
Subtitle track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.SubtitleTrack.Encoding">
<summary>
Subtitle encoding
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaTrack">
<summary>
Media track information
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Codec">
<summary>
Media track codec
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.OriginalFourcc">
<summary>
Media track original fourcc
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Id">
<summary>
Media track id
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.TrackType">
<summary>
Media track type
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Profile">
<summary>
Media track profile
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Level">
<summary>
Media track level
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Data">
<summary>
Media track data
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Bitrate">
<summary>
Media track bitrate
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Language">
<summary>
Media track language
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrack.Description">
<summary>
Media track description
</summary>
</member>
<member name="T:LibVLCSharp.Shared.MediaTrackData">
<summary>
Media track data struct, containing info about audio, video and subtitles track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrackData.Audio">
<summary>
Audio track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrackData.Video">
<summary>
Video track
</summary>
</member>
<member name="F:LibVLCSharp.Shared.MediaTrackData.Subtitle">
<summary>
Subtitle track
</summary>
</member>
<member name="T:LibVLCSharp.Shared.RendererDescription">
<summary>
Renderer description
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererDescription.Name">
<summary>
Renderer Name
</summary>
</member>
<member name="P:LibVLCSharp.Shared.RendererDescription.LongName">
<summary>
Renderer long name
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VideoViewpoint">
<summary>Viewpoint for video outputs</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoViewpoint.Yaw">
<summary>
view point yaw in degrees ]-180;180]
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoViewpoint.Pitch">
<summary>
view point pitch in degrees ]-90;90]
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoViewpoint.Roll">
<summary>
view point roll in degrees ]-180;180]
</summary>
</member>
<member name="F:LibVLCSharp.Shared.VideoViewpoint.Fov">
<summary>
field of view in degrees ]0;180[ (default 80.)
</summary>
</member>
<member name="T:LibVLCSharp.Shared.VLCException">
<summary>
This exception is thrown when a problem with VLC occured
</summary>
</member>
<member name="M:LibVLCSharp.Shared.VLCException.#ctor(System.String)">
<summary>
VLC Exception constructor
</summary>
<param name="message"></param>
</member>
<member name="M:LibVLCSharp.Shared.VLCException.#ctor(System.String,System.Exception)">
<summary>
Creates a <see cref="T:LibVLCSharp.Shared.VLCException" /> with a message and an inner exeption
</summary>
</member>
</members>
</doc>