{"id":17146038,"url":"https://github.com/emersion/node-fluent-vlc","last_synced_at":"2026-03-08T12:38:17.636Z","repository":{"id":24638872,"uuid":"28048200","full_name":"emersion/node-fluent-vlc","owner":"emersion","description":"A fluent API to VLC (https://www.videolan.org/vlc/)","archived":false,"fork":false,"pushed_at":"2014-12-15T19:32:45.000Z","size":160,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-03T07:14:06.765Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emersion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-15T17:38:01.000Z","updated_at":"2021-10-06T04:05:16.000Z","dependencies_parsed_at":"2022-09-05T08:21:43.485Z","dependency_job_id":null,"html_url":"https://github.com/emersion/node-fluent-vlc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emersion%2Fnode-fluent-vlc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emersion%2Fnode-fluent-vlc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emersion%2Fnode-fluent-vlc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emersion%2Fnode-fluent-vlc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emersion","download_url":"https://codeload.github.com/emersion/node-fluent-vlc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233045482,"owners_count":18616522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T21:07:39.593Z","updated_at":"2026-03-08T12:38:17.599Z","avatar_url":"https://github.com/emersion.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fluent VLC-API for Node.js\n\nInspired from [`fluent-ffmpeg`](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg).\n\n## Installation\n\nVia npm:\n```\n$ npm install fluent-vlc\n```\n\n## Usage\n\n### Prerequisites\n\nYou will need VLC to be installed on your system.\n\nIf the `VLC_PATH` environment variable is set, it will be used as the full path to the `vlc` executable. Otherwise, it will attempt to call `vlc` directly (so it should be in your `PATH`).\n\n### Creating a VLC command\n\nThe fluent-vlc module returns a constructor that you can use to instanciate VLC commands.\n\n```js\nvar vlc = require('fluent-vlc');\nvar command = vlc();\n```\n\nYou may pass an input URL or readable stream, a configuration object, or both to the constructor.\n```js\nvar command = vlc('file:///path/to/file.avi');\nvar command = vlc(fs.createReadStream('/path/to/file.avi'));\n```\n\n### Specifying outputs\n\n#### output(target): set the output\n\nSets the output of the command. The target argument may be an output filename, a URL or a writable stream (but at most one output stream may be used with a single command).\n\n#### format(format): set output format\n\n```js\nvlc('file:///path/to/file.avi').format('flv');\n```\n\n#### audioCodec(format, [options]): set output audio codec\n\n```js\nvlc('file:///path/to/file.avi').audioCodec('vorb');\n```\n\n#### videoCodec(format, [options]): set output video codec\n\n```js\nvlc('file:///path/to/file.avi').videoCodec('theo');\n```\n\n### Misc\n\n#### addOption(option...): add a custom VLC option\n\n```js\nvlc('file:///path/to/file.avi').format('ogg').videoCodec('theo').audioCodec('vorb').addOption('--sout-theora-quality=5', '--sout-vorbis-quality=1');\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femersion%2Fnode-fluent-vlc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femersion%2Fnode-fluent-vlc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femersion%2Fnode-fluent-vlc/lists"}