Platforms to show: All Mac Windows Linux Cross-Platform

VLC

Classes for the libVLC, the library behind the VLC Media Player application.

• Classes
  • class VLCAudioOutputDeviceMBS
    • method Constructor
    • method Destructor
    • property Description as String
    • property Device as String
    • property NextOutput as VLCAudioOutputDeviceMBS
  • class VLCAudioOutputMBS
    • method Constructor
    • method Destructor
    • property Description as String
    • property Name as String
    • property NextOutput as VLCAudioOutputMBS
  • class VLCEqualizerMBS
    • shared method BandFrequency(index as Integer) as Double
    • method Constructor(index as Integer, vlc as VLCInstanceMBS = nil)
    • method Constructor(vlc as VLCInstanceMBS = nil)
    • method Destructor
    • shared method PresetName(index as Integer) as string
    • shared property BandCount as Integer
    • property Handle as Integer
    • property Preamp as Single
    • shared property PresetCount as Integer
    • property VLC as VLCInstanceMBS
    • property Map(Index as Integer) as Single
  • class VLCEventManagerMBS
    • method Constructor(Media as VLCMediaMBS)
    • method Constructor(MediaDiscoverer as VLCMediaDiscovererMBS)
    • method Constructor(MediaList as VLCMediaListMBS)
    • method Constructor(MediaListPlayer as VLCMediaListPlayerMBS)
    • method Constructor(MediaPlayer as VLCMediaPlayerMBS)
    • method Destructor
    • method Listen
    • property Handle as Integer
    • property Parent as Variant
    • property VLC as VLCInstanceMBS
    • event Log(Message as String, level as Integer, Name as String, Header as String, ModuleName as String, FileName as String, Line as Integer)
    • event MediaDiscovererEnded
    • event MediaDiscovererStarted
    • event MediaDurationChanged(newDuration as Int64)
    • event MediaFreed(media as VLCMediaMBS)
    • event MediaListItemAdded(item as VLCMediaMBS, index as Integer)
    • event MediaListItemDeleted(item as VLCMediaMBS, index as Integer)
    • event MediaListPlayerNextItemSet(item as VLCMediaMBS)
    • event MediaListPlayerPlayed
    • event MediaListPlayerStopped
    • event MediaListWillAddItem(item as VLCMediaMBS, index as Integer)
    • event MediaListWillDeleteItem(item as VLCMediaMBS, index as Integer)
    • event MediaMetaChanged(metatype as Integer)
    • event MediaParsedChanged(newStatus as Integer)
    • event MediaPlayerBackward
    • event MediaPlayerBuffering
    • event MediaPlayerEncounteredError
    • event MediaPlayerEndReached
    • event MediaPlayerForward
    • event MediaPlayerLengthChanged(NewLength as Int64)
    • event MediaPlayerMediaChanged(item as VLCMediaMBS)
    • event MediaPlayerNothingSpecial
    • event MediaPlayerOpening
    • event MediaPlayerPausableChanged(pausable as boolean)
    • event MediaPlayerPaused
    • event MediaPlayerPlaying
    • event MediaPlayerPositionChanged(newPosition as Double)
    • event MediaPlayerScrambledChanged(newScrambled as Integer)
    • event MediaPlayerSeekableChanged(seekable as boolean)
    • event MediaPlayerSnapshotTaken(filename as string)
    • event MediaPlayerStopped
    • event MediaPlayerTimeChanged(newTime as Int64)
    • event MediaPlayerTitleChanged(newTitle as Integer)
    • event MediaPlayerVout(newCount as Integer)
    • event MediaStateChanged(newState as Integer)
    • event MediaSubItemAdded(media as VLCMediaMBS)
    • event MediaSubItemTreeAdded(media as VLCMediaMBS)
    • event VlmMediaAdded(MediaName as string, InstanceName as string)
    • event VlmMediaChanged(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStarted(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusEnd(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusError(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusInit(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusOpening(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusPause(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStatusPlaying(MediaName as string, InstanceName as string)
    • event VlmMediaInstanceStopped(MediaName as string, InstanceName as string)
    • event VlmMediaRemoved(MediaName as string, InstanceName as string)
  • class VLCExitHandlerMBS
    • event ExitEvent
  • class VLCInstanceMBS
    • method AddUserInterface(name as string) as boolean
    • method AudioOutputDevices(ModuleName as string) as VLCAudioOutputDeviceMBS
    • shared method ClearError
    • method ClearLog
    • shared method Clock as Int64
    • method Constructor(args() as string)
    • method Destructor
    • shared method ErrorMessage as string
    • method GetAudioFilterList as VLCModuleDescriptionMBS
    • method GetAudioOutputDeviceCount(AudioOutputName as string) as Integer
    • method GetAudioOutputDeviceID(AudioOutputName as string, index as Integer) as string
    • method GetAudioOutputDeviceLongName(AudioOutputName as string, index as Integer) as string
    • method GetAudioOutputList as VLCAudioOutputMBS
    • shared method GetChangeset as string
    • shared method GetCompiler as string
    • shared method getenv(name as string) as string
    • shared method GetLoadError as string
    • shared method GetVersion as string
    • method GetVideoFilterList as VLCModuleDescriptionMBS
    • shared method LoadLibrary(path as folderitem) as boolean
    • shared method LoadLibrary(path as string) as boolean
    • method SetAppID(ID as string, Version as string, Icon as String)
    • shared method setlocale(category as Integer, locale as string) as string
    • method SetLogEvent
    • method SetLogFile(File as FolderItem)
    • method SetUserAgent(AppName as string, httpUserAgent as string)
    • method WaitUserInterface
    • property Handle as Integer
    • property ExitHandler as VLCExitHandlerMBS
  • class VLCMediaDiscovererMBS
    • method Constructor(vlc as VLCInstanceMBS, name as string)
    • method Destructor
    • method IsRunning as boolean
    • method LocalizedName as string
    • method MediaList as VLCMediaListMBS
    • property Handle as Integer
    • property VLC as VLCInstanceMBS
  • class VLCMediaLibraryMBS
    • method Constructor(vlc as VLCInstanceMBS)
    • method Destructor
    • method Load as boolean
    • method MediaList as VLCMediaListMBS
    • property Handle as Integer
    • property VLC as VLCInstanceMBS
  • class VLCMediaListMBS
    • method AddMedia(item as VLCMediaMBS) as boolean
    • method Constructor(vlc as VLCInstanceMBS)
    • method Count as Integer
    • method Destructor
    • method GetMedia as VLCMediaMBS
    • method IndexOfItem(item as VLCMediaMBS) as Integer
    • method InsertMedia(item as VLCMediaMBS, index as Integer) as boolean
    • method isReadOnly as boolean
    • method ItemAtIndex(index as Integer) as VLCMediaMBS
    • method Lock
    • method Remove(index as Integer) as boolean
    • method SetMedia(item as VLCMediaMBS)
    • method Unlock
    • property Handle as Integer
    • property VLC as VLCInstanceMBS
  • class VLCMediaListPlayerMBS
    • method Constructor(vlc as VLCInstanceMBS)
    • method Destructor
    • method IsPlaying as boolean
    • method MoveNext as boolean
    • method MovePrevious as Boolean
    • method Pause
    • method Play
    • method PlayItem(item as VLCMediaMBS) as Boolean
    • method PlayItemAtIndex(index as Integer) as Boolean
    • method SetMediaList(list as VLCMediaListMBS)
    • method SetMediaPlayer(player as VLCMediaPlayerMBS)
    • method SetPlaybackMode(mode as Integer)
    • method State as Integer
    • method Stop
    • property Handle as Integer
    • property List as VLCMediaListMBS
    • property Player as VLCMediaPlayerMBS
    • property VLC as VLCInstanceMBS
  • class VLCMediaMBS
    • method AddOption(options as string)
    • method AddOptionFlag(options as string, flags as UInt32)
    • method Clone as VLCMediaMBS
    • method Constructor(original as VLCMediaMBS)
    • method Constructor(vlc as VLCInstanceMBS, URL as string)
    • method Destructor
    • method Duration as Int64
    • method IsParsed as Boolean
    • shared method MediaWithData(vlc as VLCInstanceMBS, data as memoryblock) as VLCMediaMBS
    • shared method MediaWithData(vlc as VLCInstanceMBS, data as string) as VLCMediaMBS
    • shared method MediaWithFile(vlc as VLCInstanceMBS, file as folderitem) as VLCMediaMBS
    • shared method MediaWithFileDescriptor(vlc as VLCInstanceMBS, fd as Integer) as VLCMediaMBS
    • shared method MediaWithPath(vlc as VLCInstanceMBS, Path as string) as VLCMediaMBS
    • shared method MediaWithURL(vlc as VLCInstanceMBS, URL as string) as VLCMediaMBS
    • method Meta(type as Integer) as string
    • method MRL as string
    • shared method NewAsNode(vlc as VLCInstanceMBS, name as string) as VLCMediaMBS
    • method Parse
    • method ParseAsync
    • method SaveMeta as Boolean
    • method SetMeta(meta as Integer, value as string)
    • method State as Integer
    • method Stats as VLCMediaStatsMBS
    • method SubItems as VLCMediaListMBS
    • method TrackInfos as VLCMediaTrackInfoMBS()
    • method Tracks as VLCMediaTrackMBS()
    • property Handle as Integer
    • property Tag as Integer
    • property VLC as VLCInstanceMBS
  • class VLCMediaPlayerMBS
    • method Constructor(media as VLCMediaMBS)
    • method Constructor(VLCInstance as VLCInstanceMBS)
    • method CopyCGImage as Variant
    • method CopyMemory as memoryblock
    • method CopyPicture as Picture
    • method CopyToMemory(dest as Ptr, offset as Integer, RowBytes as Integer) as boolean
    • method Destructor
    • method GetChapterCountForTitle(title as Integer) as Integer
    • method GetChapterDescription(index as Integer) as VLCTrackDescriptionMBS
    • method GetMemory as Ptr
    • method Navigate(Navigate as Integer)
    • method NextChapter
    • method NextFrame
    • method Pause
    • method Pause(pause as boolean)
    • method Play as Boolean
    • method PreviousChapter
    • method SetAudioOutput(AudioOutputName as string) as boolean
    • method SetAudioOutputDevice(AudioOutputName as string, deviceID as string)
    • method SetEqualizer(Equalizer as VLCEqualizerMBS = nil)
    • method SetSubtitleFile(filename as string) as boolean
    • method SetVideoTitleDisplay(position as Integer, timeout as Integer)
    • method Stop
    • method ToggleFullScreen
    • method ToggleMute
    • method ToggleTeletext
    • method VideoGetCursor(num as Integer, byref px as Integer, byref py as Integer) as Boolean
    • method VideoGetSize(num as Integer, byref px as UInt32, byref py as UInt32) as Boolean
    • method VideoSetCallback(width as integer, height as integer, CGContextHandle as integer = 0)
    • method VideoSetDeinterlace(Mode as string)
    • method VideoSetFormat(chroma as string, width as UInt32, height as UInt32, pitch as UInt32)
    • method VideoSetKeyInput(on as boolean)
    • method VideoSetLogoString(option as Integer, logo as String)
    • method VideoSetMouseInput(on as boolean)
    • method VideoTakeSnapshot(num as Integer, path as string, width as Integer, height as Integer) as boolean
    • property AGL as UInt32
    • property AspectRatio as string
    • property AudioChannel as Integer
    • property AudioDelay as Int64
    • property AudioOutputDevices as VLCAudioOutputDeviceMBS
    • property AudioOutputDeviceType as Integer
    • property AudioTrack as Integer
    • property AudioTrackCount as Integer
    • property CanPause as boolean
    • property Chapter as Integer
    • property ChapterCount as Integer
    • property CropGeometry as string
    • property FPS as Double
    • property FullScreen as boolean
    • property GetAudioTrackDescription as VLCTrackDescriptionMBS
    • property GetSPUDescription as VLCTrackDescriptionMBS
    • property GetVideoTitleDescription as VLCTrackDescriptionMBS
    • property Handle as Integer
    • property HasNewFrame as Boolean
    • property HasVOut as Integer
    • property Height as Integer
    • property HWND as Integer
    • property IsPlaying as boolean
    • property IsSeekable as boolean
    • property Length as Int64
    • property Media as VLCMediaMBS
    • property Mute as boolean
    • property NSObject as Ptr
    • property Position as Double
    • property ProgramScrambled as boolean
    • property Rate as Double
    • property Scale as Double
    • property SPU as Integer
    • property SPUCount as Integer
    • property SPUDelay as Int64
    • property State as Integer
    • property Tag as Variant
    • property Time as Int64
    • property Title as Integer
    • property TitleCount as Integer
    • property VideoTeleText as Integer
    • property VideoTrack as Integer
    • property VideoTrackCount as Integer
    • property VideoTrackDescription as VLCTrackDescriptionMBS
    • property VLC as VLCInstanceMBS
    • property Volume as Integer
    • property Width as Integer
    • property WillPlay as boolean
    • property XWindow as UInt32
    • property VideoAdjust(option as Integer) as Integer
    • property VideoAdjustFloat(option as Integer) as single
    • property VideoLogo(option as Integer) as Integer
    • property VideoMarquee(option as Integer) as Integer
    • property VideoMarqueeString(option as Integer) as String
  • class VLCMediaStatsMBS
    • property DecodedAudio as Integer
    • property DecodedVideo as Integer
    • property DemuxBitrate as Single
    • property DemuxCorrupted as Integer
    • property DemuxDiscontinuity as Integer
    • property DemuxRead_bytes as Integer
    • property DisplayedPictures as Integer
    • property InputBitrate as Single
    • property LostAbuffers as Integer
    • property LostPictures as Integer
    • property PlayedAbuffers as Integer
    • property ReadBytes as Integer
    • property SendBitrate as Single
    • property SentBytes as Integer
    • property SentPackets as Integer
  • class VLCMediaTrackInfoMBS
    • method Constructor
    • method Destructor
    • property Channels as Integer
    • property Codec as Integer
    • property CodecString as String
    • property Height as Integer
    • property ID as Integer
    • property Level as Integer
    • property Profile as Integer
    • property Rate as Integer
    • property Type as Integer
    • property Width as Integer
  • class VLCMediaTrackMBS
    • method Constructor
    • method Destructor
    • property Bitrate as Integer
    • property Channels as Integer
    • property Codec as Integer
    • property CodecString as String
    • property Description as String
    • property Encoding as String
    • property FrameRate as Double
    • property FrameRateDen as Integer
    • property FrameRateNum as Integer
    • property Height as Integer
    • property ID as Integer
    • property Language as String
    • property Level as Integer
    • property OriginalCode as Integer
    • property Profile as Integer
    • property Rate as Integer
    • property Sar as Double
    • property SarDen as Integer
    • property SarNum as Integer
    • property Type as Integer
    • property Width as Integer
  • class VLCMissingFunctionExceptionMBS
  • class VLCModuleDescriptionMBS
    • method Destructor
    • property Help as String
    • property LongName as String
    • property Name as String
    • property NextModule as VLCModuleDescriptionMBS
    • property ShortName as String
  • class VLCNotInitializedExceptionMBS
  • class VLCTrackDescriptionMBS
    • method Destructor
    • property ID as Integer
    • property Name as String
    • property NextTrack as VLCTrackDescriptionMBS

Release notes

• Version 23.4
  • Added audio constants to VLCInstanceMBS class.
• Version 20.3
  • Fixed crash in Tracks function in VLCMediaMBS class.
• Version 19.0
  • Added VLCMediaPlayerMBS.CopyCGImage to return the CGImageMBS object for current image.
  • Changed VLCMediaPlayerMBS.CopyPicture to always return picture.
  • Changed VLCMediaPlayerMBS.VideoSetCallback to always prepare for CGImage creation on MacOS and CGContext is now optional.
  • Updated VLCInstanceMBS to initialize properly.
• Version 18.0
  • Fixed bug in VLCEqualizerMBS.Map setter.

The items on this page are in the following plugins: MBS VLC Plugin.