Desktop/native LibVLC 3 player. Controls are serialized; event handlers must not block on the engine thread. FrameReady runs on a decoder thread and is copy-only. More...

Inheritance diagram for Gondwana.Video.VlcVideoPlayer:

Public Member Functions

VlcVideoPlayer (string[]? vlcArgs=null, int initialWidth=1280, int initialHeight=720)

Creates a native desktop player. Native libraries are supplied by the application.

void Open (Uri source)

Opens a video from the specified source URI.

Parameters

source The URI of the video source to open.

void Open (Stream source, bool leaveOpen=false)

Opens a readable stream. Ownership transfers on success unless leaveOpen is true. Keep a borrowed stream alive and unused until the next Open or Dispose. Seek/loop require a seekable stream. Backends without stream support throw without taking ownership.

Parameters

source	The source.
leaveOpen	Whether to leave the supplied stream open after use.

void Play ()

Starts or resumes playback of the video.

void Pause ()

Pauses the video playback.

void Stop ()

Stops the video playback and resets the position.

void Seek (TimeSpan position)

Seeks to the specified position in the video.

Parameters

position The position to seek to in the video timeline.

void SetRate (double rate)

Sets the playback rate of the video.

Parameters

rate	The playback rate multiplier (e.g., 1.0 for normal speed, 2.0 for double speed).

void Dispose ()

Properties
bool	Loop `[get, set]`
	Gets or sets a value indicating whether the video should loop when it reaches the end.
bool	IsPlaying `[get]`
	Gets a value indicating whether the video is currently playing.
VideoMetadata	Metadata `[get]`
	Gets an atomic snapshot of metadata availability and values for the current source.
bool	IsMetadataReady `[get]`
	True only when metadata for the current source is available.
bool	HasAudio `[get]`
	Gets whether the video has an audio track. Consult IsMetadataReady before interpreting false.
TimeSpan	Duration `[get]`
	Gets the total duration of the video.
TimeSpan	Position `[get]`
	Gets the current playback position in the video.
int int height	NaturalSize `[get]`
Exception?	LastError `[get]`
	The most recent native callback or playback failure, if any.

Events
EventHandler?	Started
EventHandler?	Paused
EventHandler?	Stopped
EventHandler?	Ended
EventHandler< VideoStateChangedEventArgs >?	StateChanged
EventHandler< VideoFrameReadyEventArgs >?	FrameReady
Events inherited from Gondwana.Video.IVideoPlayer
EventHandler	Started
	Occurs when the video playback starts.
EventHandler	Paused
	Occurs when the video playback is paused.
EventHandler	Stopped
	Occurs when the video playback is stopped.
EventHandler	Ended
	Occurs when the video playback reaches the end.
EventHandler< VideoStateChangedEventArgs >	StateChanged
	Occurs when the video state changes, including MediaOpening, MediaOpened, MetadataReady, and MetadataFailed. MediaOpening must precede frames for a replacement source, after callbacks for the prior source have stopped. Events may run on background threads.
EventHandler< VideoFrameReadyEventArgs >	FrameReady
	Occurs when a decoded BGRX frame is ready. The pointer is valid only during the callback. Copy it before returning. Do not call engine/render operations or player controls here.

Additional Inherited Members
Public Attributes inherited from Gondwana.Video.IVideoPlayer
int	width
	Gets the natural size (width and height) of the video in pixels.

Detailed Description

Desktop/native LibVLC 3 player. Controls are serialized; event handlers must not block on the engine thread. FrameReady runs on a decoder thread and is copy-only.

Definition at line 8 of file VlcVideoPlayer.cs.

Constructor & Destructor Documentation

◆ VlcVideoPlayer()

Gondwana.Video.VlcVideoPlayer.VlcVideoPlayer	(	string?[]	vlcArgs = null,
		int	initialWidth = 1280,
		int	initialHeight = 720 )

Creates a native desktop player. Native libraries are supplied by the application.

Parameters

vlcArgs	Optional LibVLC arguments.
initialWidth	Legacy compatibility argument, validated but not used to force a decode size.
initialHeight	Legacy compatibility argument; actual dimensions come from format negotiation.

Definition at line 68 of file VlcVideoPlayer.cs.

Member Function Documentation

◆ Dispose()

void Gondwana.Video.VlcVideoPlayer.Dispose ( )

Definition at line 321 of file VlcVideoPlayer.cs.

◆ Open() [1/2]

void Gondwana.Video.VlcVideoPlayer.Open	(	Stream	source,
		bool	leaveOpen = false )

Opens a readable stream. Ownership transfers on success unless leaveOpen is true. Keep a borrowed stream alive and unused until the next Open or Dispose. Seek/loop require a seekable stream. Backends without stream support throw without taking ownership.

Parameters

source	The source.
leaveOpen	Whether to leave the supplied stream open after use.

Public Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VlcVideoPlayer()

Member Function Documentation

◆ Dispose()

◆ Open() [1/2]

◆ Open() [2/2]

◆ Pause()

◆ Play()

◆ Seek()

◆ SetRate()

◆ Stop()

Property Documentation

◆ Duration

◆ HasAudio

◆ IsMetadataReady

◆ IsPlaying

◆ LastError

◆ Loop

◆ Metadata

◆ NaturalSize

◆ Position

Event Documentation

◆ Ended

◆ FrameReady

◆ Paused

◆ Started

◆ StateChanged

◆ Stopped