Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
garkimasera committed Dec 2, 2021
1 parent aa2069c commit bdaba49
Showing 1 changed file with 3 additions and 47 deletions.
50 changes: 3 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,5 @@
# vlc-rs [![Build Status](https://travis-ci.org/garkimasera/vlc-rs.svg?branch=master)](https://travis-ci.org/garkimasera/vlc-rs)
# vlc-rs
Rust bindings for libVLC media framework.

## Status
Many missing functions and wrappers.

## Use
Please add the following dependencies to your Cargo.toml.

```Toml
[dependencies]
vlc-rs = "0.3"
```

Or:

```Toml
[dependencies.vlc-rs]
git = "https://github.com/garkimasera/vlc-rs.git"
```

## Example
Play for 10 seconds from a media file.
```Rust
extern crate vlc;
use vlc::{Instance, Media, MediaPlayer};
use std::thread;

fn main() {
// Create an instance
let instance = Instance::new().unwrap();
// Create a media from a file
let md = Media::new_path(&instance, "path_to_a_media_file.ogg").unwrap();
// Create a media player
let mdp = MediaPlayer::new(&instance).unwrap();
mdp.set_media(&md);

// Start playing
mdp.play().unwrap();

// Wait for 10 seconds
thread::sleep(::std::time::Duration::from_secs(10));
}
```

Other examples are in the examples directory.

## License
MIT (Examples are licensed under CC0)
**This project has moved:**
https://code.videolan.org/videolan/vlc-rs

0 comments on commit bdaba49

Please sign in to comment.