View source for VLCKit

This page provides a brief overview on the [[LibVLC]] binding for Objective-C.

== Introduction ==
VLCKit is an Objective-C wrapper for libvlc's external interface, on '''Mac OS X''' and '''iOS'''.

It includes basic classes for playlists, streaming and transcoding. However, this is only a limited set. Doing simple media players (comparable to QuickTime Player or MPlayer OS X) is as hard as doing a QuickTime-based one; thus, it is really easy. However, you'll lack most of the cool things such as running multiple 
interfaces within one instance (remember that hotkeys is an interface, too). Still, you get da überfeature: playing multiple streams within one instance of VLC side by side.

== Build the framework ==

* Clone git://git.videolan.org/vlc-bindings/VLCKit.git
* open <code>.VLCKit.xcodeproj</code> 
* make sure the VLCKit target is selected 
* build the project

This should automatically build VLC itself.

== Basic usage in your application ==
The code should speak by itself
   // Set up a videoView by hand. You can also do that in the nib file
    videoView = [[VLCVideoView alloc] initWithFrame:[[window contentView] bounds]];
    [[window contentView] addSubview:videoView];
    [videoView setAutoresizingMask: NSViewHeightSizable|NSViewWidthSizable];
   
    // Init the player object
    player = [[VLCMediaPlayer alloc] initWithVideoView:videoView];
  
    [player setMedia:[VLCMedia mediaWithPath:@"/to/my/movie"]];
    [player play];

== Sample code ==
You should be able to find sample code in:
* <code> Examples </code>: This is the folder that contains the VLC.framework basics usage.
* <code> ./vlc/projects/macosx/vlc_app </code>: This is the VLC application that uses the framework intensivly, this is much more advanced.

== What applications use VLCKit? ==
* [http://imagneto.sourceforge.net/ iMagneto]
* [[Lunettes]] by the VideoLAN team
* [[iOS|VLC for iOS]] by the VideoLAN team

Feel free to add your application above in alphabetical order.

== Related ==
* [[OSXCompile|Compiling VLC on MacOS X]]

==External Links==

* [http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC/Introduction/introObjectiveC.html Introduction to The Objective-C 2.0 Programming Language]
* [http://developer.apple.com/documentation/developertools/Conceptual/IB_UserGuide/Introduction/Introduction.html Interface Builder]

[[Category:LibVLC]]
[[Category:Mac OS X]]