libvlc.VLCPlayer

libvlc.VLCPlayer

##Class Declaration

 Global Class VLCPlayer
 Inherits VLCInstance

##Remarks This class wraps the Media Player API. All playback is ultimately performed by a VLCPlayer instance, which can be accessed by calling the TruePlayer method on the appropriate class (e.g. VLCMediaPlayer.TruePlayer, ListPlayer.TruePlayer)

There is no GUI shown unless you attempt to play a video. Call EmbedWithin to embed the video output in any window or control. Playing a video without embedding the player will display the output in a new window.

Media playback occurs asynchronously on a separate (OS-level) thread.

###Basic use Create a new instance, then use the Media method to specify the media file or URL to be played. Media accepts a FolderItem or String containing a fully-qualified URL.

  Dim player As New VLCPlayer
  player.Media = GetOpenFolderItem(MediaFileTypes.All)
  player.Play
  Do Until player.CurrentState = libvlc.PlayerState.ENDED
    If player.CurrentState = libvlc.PlayerState.ERROR Then Exit Do
    If App.CurrentThread = Nil Then
      App.DoEvents
    Else
      App.SleepCurrentThread(200)
    End If
  Loop Until player.CurrentState = libvlc.PlayerState.STOPPING

##Event Definitions

• ChangedState
• VLCLog

##Methods

• AddInterface
• Constructor
• EmbeddedWithin
• EmbedWithin
• GetCursorXY
• GetVideoDimensions
• Handle
• Media
• MetaData
• Operator_Compare
• Pause
• Play
• Resume
• SetAudioOutput
• SetSubtitleFile
• Stop
• SubtitleCount
• SubtitleIndex
• Subtitles
• TakeSnapshot
• ToggleFullScreen
• ToggleTeletext

##Properties

• AspectRatio As String
• CanPause As Boolean
• CanPlay As Boolean
• CanSeek As Boolean
• CaptureKeyboard As Boolean
• CaptureMouse As Boolean
• CurrentState As libvlc.PlayerState
• Equalizer As libvlc.Equalizer
• Fullscreen As Boolean
• HasAudio As Boolean
• HasVideo As Boolean
• IsPlaying As Boolean
• LengthMS As Int64
• Muted As Boolean
• Position As Single
• Scale As Single
• Speed As Single
• TimeMS As Int64
• Volume As Integer

##Shared Methods

• AudioFilters
• AudioOutputs
• Load
• VideoFilters

##See also

• VLCMediaPlayer