@the-/video-converter
==========

<!---
This file is generated by @the-/templates. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/the-labo/the
[bd_npm_url]: http://www.npmjs.org/package/@the-/video-converter
[bd_npm_shield_url]: http://img.shields.io/npm/v/@the-/video-converter.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Video file converter

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>




<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->

<a name="section-doc-readme-01-installation-md"></a>

Installation
-----

```bash
$ npm install @the-/video-converter --save
```


<!-- Section from "doc/readme/01.Installation.md.hbs" End -->

<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->

<a name="section-doc-readme-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { TheVideoConverter } = require('@the-/video-converter')

async function tryExample() {
  const converter = new TheVideoConverter()
  await converter.convertIntoMP4('src01.wav', 'dest01.mp4')
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/readme/02.Usage.md.hbs" End -->


<!-- Sections Start -->

<a name="api"></a>

## API Guide


- module:@the-/video-converter
  - [.create(args)](./doc/api/api.md#module_@the-/video-converter.create)
  - [.default()](./doc/api/api.md#module_@the-/video-converter.default)
  - [.filenameFor(config)](./doc/api/api.md#module_@the-/video-converter.filenameFor)
  - [.helpers](./doc/api/api.md#module_@the-/video-converter.helpers)
  - [.isVideoSrc(src)](./doc/api/api.md#module_@the-/video-converter.isVideoSrc)
  - [.mixins](./doc/api/api.md#module_@the-/video-converter.mixins)
  - [.TheVideoConverter](./doc/api/api.md#module_@the-/video-converter.TheVideoConverter)
- module:@the-/video-converter.mixins
  - [.mp4Mix()](./doc/api/api.md#module_@the-/video-converter.mixins.mp4Mix)
- module:@the-/video-converter.mixins.mp4Mix
  - [~MP4Mixed](./doc/api/api.md#module_@the-/video-converter.mixins.mp4Mix~MP4Mixed)
- MP4Mixed
  - [#convertIntoMP4(src,dest,options)](./doc/api/api.md#MP4Mixed#convertIntoMP4)
- TheVideoConverter
  - [#convert(src,dest,options)](./doc/api/api.md#TheVideoConverter#convert)
  - [#inspect(filename,options)](./doc/api/api.md#TheVideoConverter#inspect)
  - [#isVideoSrc(src)](./doc/api/api.md#TheVideoConverter#isVideoSrc)
  - [#process(src,options)](./doc/api/api.md#TheVideoConverter#process)

See [API Guide](./doc/api/api.md) for more detail


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][the_labo_url]

[the_labo_url]: https://github.com/the-labo

<!-- Links End -->