Abrahamic-God / media-scanner

A service used with CasparCG Server software for scanning media located on the server. Queried with query and thumbnail commands through CasparCG Server using AMCP.

CasparCG Media-Scanner

This project facilitates CasparCG Server since version 2.2.0. It abstracts the collection of metadata and generation of thumbnails into a separate process.

Usage

This project is designed to be used via the AMCP protocol in CasparCG server. However, there are some endpoints for additional data which can only be access directly over http.

AMCP Endpoints

These endpoints are exposed by the AMCP protocol in CasparCG Server. This means that they have some AMCP syntax wrappings, which will likely need to be stripped off if using in an external client

• /tls - Lists available template files
• /cls - Lists available media files
• /fls - Lists available font files
• /cinf/<name> - Gets information on specified media file
• /thumbnail/generate - Backwards compatibility, has no effect
• /thumbnail/generate/<name> - Backwards compatibility, has no effect
• /thumbnail - Lists the available thumbnails
• /thumbnail/<name> - Gets the thumbnail for a media file

Changes

A stream of changes can be accessed with the following. Full docs

const PouchDB = require('pouchdb-node')
const db = new PouchDB('http://localhost:8000/db/_media')

// Listen for changes
db.changes({
    since: 'now',
    include_docs: true,
    live: true
}).on('change', function (changes) {
    console.log(changes)
}).on('error', function (err) {
    // handle errors
});

Development

This project uses the latest LTS version NodeJS (8), so you need that installed. Get it from: https://nodejs.org/en/. We also use Leveldown which uses native modules so if you're on Windows you need to install windows build tools:

npm install --global --production windows-build-tools

After this:

• Clone the repository
• Run npm install
• Run npm dev to start the development server

Building

Be aware that because of the native extensions, you can only build for the target you are currently on.

• On Windows
  • npm run build-win32
• On Linux
  • npm run build-linux

The built files will be placed in ./dist, make sure you copy all files into the main CasparCG directory.

Note: Due to an incompatability with a dependency and pkg, a fix up step is performed during build until this is resolved upstream pkg express-pouchdb. This could cause issues when updating the express-pouchdb package.

License

CasparCG Media-Scanner is distributed under the GNU Lesser General Public License LGPLv3 or higher, see LICENSE for details.

More information is available at http://casparcg.com/

Documentation

The most up-to-date documentation is always available at https://github.com/CasparCG/help/wiki