# ffmpeg-probe

> Wrapper around ffprobe for getting info about media files.

Latest version **1.0.6** (published 2019-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install ffmpeg-probe
pnpm add ffmpeg-probe
yarn add ffmpeg-probe
bun add ffmpeg-probe
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-04-02 |
| First published | 2018-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Travis Fischer |
| Maintainers | fisch0920 |
| Keywords | ffmpeg, ffprobe, fluent-ffmpeg |

## Links

- npm: https://www.npmjs.com/package/ffmpeg-probe
- Repository: https://github.com/transitive-bullshit/ffmpeg-probe
- npm.io page: https://npm.io/package/ffmpeg-probe

## Dependencies (1)

- [execa](https://npm.io/package/execa.md) ^0.10.0

## Recent versions

- 1.0.6 (latest) — 2019-04-02
- 1.0.5 — 2018-07-06
- 1.0.4 — 2018-04-24
- 1.0.3 — 2018-04-17
- 1.0.2 — 2018-04-03
- 1.0.1 — 2018-03-28
- 1.0.0 — 2018-03-28
- 0.1.0 — 2018-03-28

## README

# ffmpeg-probe

> Wrapper around [ffprobe](https://www.ffmpeg.org/ffprobe.html) for getting info about media files such as width, height, and duration.

[![NPM](https://img.shields.io/npm/v/ffmpeg-probe.svg)](https://www.npmjs.com/package/ffmpeg-probe) [![Build Status](https://travis-ci.com/transitive-bullshit/ffmpeg-probe.svg?branch=master)](https://travis-ci.com/transitive-bullshit/ffmpeg-probe) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save ffmpeg-probe
# or
yarn add ffmpeg-probe
```

## Usage

```js
const ffmpeg = require('fluent-ffmpeg')
const probe = require('ffmpeg-probe')

const info = await probe('input.mp4')

// info = {
//   width: 640,
//   height: 360,
//   duration: 4000,
//   fps: 25,
//   streams: [ ... ],
//   format: { ... }
// }
```

## API

### probe(input)

Returns a `Promise` for the [probe](https://www.ffmpeg.org/ffprobe.html) information augmented with the first stream's `width`, `height`, and `duration` in milliseconds.

#### input

Type: `String`

Path or URL to a media file.

## Related

- [fluent-ffmpeg](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg)
- [awesome-ffmpeg](https://github.com/transitive-bullshit/awesome-ffmpeg) - A curated list of awesome ffmpeg resources with a focus on JavaScript.

## License

MIT © [Travis Fischer](https://github.com/transitive-bullshit)

---
_Source: https://npm.io/package/ffmpeg-probe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._