Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/adrg/libvlc-go

Go bindings for libVLC and high-level media player interface
https://github.com/adrg/libvlc-go

audio bindings go golang golang-library libvlc libvlc-go media media-player player screen-capture screen-recorder sound video video-player vlc vlc-libvlc vlc-media-player vlc-player

Last synced: 23 days ago
JSON representation

Go bindings for libVLC and high-level media player interface

Lists

README 

        


  


    libvlc-go logo

  





Go bindings for libVLC and high-level media player interface.





    

        Build status

    

    

        pkg.go.dev documentation

    

    

        MIT license

    

    

        Awesome Go

    

    

        Buy me a coffee

    

    


    

        Go report card

    

    

        GitHub contributors

    

    

        Discord channel

    

    

        GitHub open issues

    

    

        GitHub closed issues

    




The package can be useful for adding multimedia capabilities to applications

through the provided player interfaces. It relies on Go modules in order to

mirror each supported major version of [libVLC](https://www.videolan.org/vlc/libvlc.html).



Documentation for v3, which implements bindings for libVLC 3.X, can be found on [pkg.go.dev](https://pkg.go.dev/github.com/adrg/libvlc-go/v3).  

Documentation for v2, which implements bindings for libVLC 2.X, can be found on [pkg.go.dev](https://pkg.go.dev/github.com/adrg/libvlc-go/v2).





    

      libvlc-go media player

    

    

      libvlc-go screen recorder

    

    

      libvlc-go equalizer

    

    

      libvlc-go media discovery

    




Example applications:



* [GUI media player](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_player)

* [GUI screen recorder](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_screen_recorder)

* [GUI equalizer](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_equalizer)

* [GUI media discovery](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_media_discovery)



## Prerequisites



The libVLC development files are required. Instructions for installing the

VLC SDK on multiple operating systems can be found on the wiki pages of this project.



- [Install on Linux](https://github.com/adrg/libvlc-go/wiki/Install-on-Linux)

- [Install on Windows](https://github.com/adrg/libvlc-go/wiki/Install-on-Windows)

- [Install on macOS](https://github.com/adrg/libvlc-go/wiki/Install-on-macOS)



## Installation



In order to support multiple versions of libVLC, the package contains a Go

module for each major version of the API. Choose an installation option

depending on the version of libVLC you want to use.



**libVLC v3.X**



```bash

go get github.com/adrg/libvlc-go/v3

```



**libVLC v2.X**



```bash

go get github.com/adrg/libvlc-go/v2



# Build for libVLC < v2.2.0

go build -tags legacy

```



All versions above also work for projects which are not using Go modules.

However, consider switching to modules.



## Examples



* [GTK 3 media player](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_player) (using [gotk3](https://github.com/gotk3/gotk3))

* [GTK 3 screen recorder](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_screen_recorder) (using [gotk3](https://github.com/gotk3/gotk3))

* [GTK 3 media discovery](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_media_discovery) (using [gotk3](https://github.com/gotk3/gotk3))

* [GTK 3 equalizer](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk3_equalizer) (using [gotk3](https://github.com/gotk3/gotk3))

* [GTK 2 media player](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk2_player) (using [go-gtk](https://github.com/mattn/go-gtk))

* [GTK 2 screen recorder](https://github.com/adrg/libvlc-go-examples/tree/master/v3/gtk2_screen_recorder) (using [go-gtk](https://github.com/mattn/go-gtk))

* [Basic player usage](https://github.com/adrg/libvlc-go-examples/blob/master/v3/player/player.go)

* [Basic list player usage](https://github.com/adrg/libvlc-go-examples/tree/master/v3/list_player/list_player.go)

* [Handling events](https://github.com/adrg/libvlc-go-examples/tree/master/v3/event_handling/event_handling.go)

* [Retrieve media tracks](https://github.com/adrg/libvlc-go-examples/blob/master/v3/media_tracks/media_tracks.go)

* [Retrieve media information](https://github.com/adrg/libvlc-go-examples/blob/master/v3/media_information/media_information.go)

* [Display screen as player media](https://github.com/adrg/libvlc-go-examples/blob/master/v3/display_screen_media/display_screen_media.go)

* [Stream media to Chromecast](https://github.com/adrg/libvlc-go-examples/blob/master/v3/chromecast_streaming/chromecast_streaming.go)

* [Player equalizer usage](https://github.com/adrg/libvlc-go-examples/blob/master/v3/equalizer/equalizer.go)



Examples for all supported API versions can be found at https://github.com/adrg/libvlc-go-examples.



## Usage



```go

package main



import (

    "log"



    vlc "github.com/adrg/libvlc-go/v3"

)



func main() {

    // Initialize libVLC. Additional command line arguments can be passed in

    // to libVLC by specifying them in the Init function.

    if err := vlc.Init("--no-video", "--quiet"); err != nil {

        log.Fatal(err)

    }

    defer vlc.Release()



    // Create a new player.

    player, err := vlc.NewPlayer()

    if err != nil {

        log.Fatal(err)

    }

    defer func() {

        player.Stop()

        player.Release()

    }()



    // Add a media file from path or from URL.

    // Set player media from path:

    // media, err := player.LoadMediaFromPath("localpath/test.mp4")

    // Set player media from URL:

    media, err := player.LoadMediaFromURL("http://stream-uk1.radioparadise.com/mp3-32")

    if err != nil {

        log.Fatal(err)

    }

    defer media.Release()



    // Retrieve player event manager.

    manager, err := player.EventManager()

    if err != nil {

        log.Fatal(err)

    }



    // Register the media end reached event with the event manager.

    quit := make(chan struct{})

    eventCallback := func(event vlc.Event, userData interface{}) {

        close(quit)

    }



    eventID, err := manager.Attach(vlc.MediaPlayerEndReached, eventCallback, nil)

    if err != nil {

        log.Fatal(err)

    }

    defer manager.Detach(eventID)



    // Start playing the media.

    err = player.Play()

    if err != nil {

        log.Fatal(err)

    }



    <-quit

}

```



## In action



A list of projects using libvlc-go, in alphabetical order. If you want to

showcase your project in this section, please create a pull request with it.



- [Alio](https://github.com/fenimore/alio) - Command-line music player with Emacs style key bindings.

- [Tripbot](https://github.com/adanalife/tripbot) - An ongoing 24/7 slow-TV art project.



## Stargazers over time



[![Stargazers over time](https://starchart.cc/adrg/libvlc-go.svg)](https://starchart.cc/adrg/libvlc-go)



## Contributing



Contributions in the form of pull requests, issues or just general feedback,

are always welcome.  

See [CONTRIBUTING.MD](CONTRIBUTING.md).



**Contributors**:

[adrg](https://github.com/adrg),

[fenimore](https://github.com/fenimore),

[tarrsalah](https://github.com/tarrsalah),

[danielpellon](https://github.com/danielpellon),

[patknight](https://github.com/patknight),

[sndnvaps](https://github.com/sndnvaps).



## Discord server



libvlc-go is part of the libVLC Discord Community [server](https://discord.gg/3h3K3JF). Feel free to come say hello!



## References



For more information see the

[libVLC](https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html) documentation.



## License



Copyright (c) 2018 Adrian-George Bostan.



This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).

See [LICENSE](LICENSE) for more details.