README

Mediamachine

Go Mediamachine SDK for MediaMachine

Go Reference Go Report Card

Mediamachine APIs provide an easy way to create intelligent video Thumbnails and Summaries, as well as for common video transcode tasks.

You can use this SDK for:

  • Generating a thumbnail from videos
  • Generating a summary from videos
  • Transcode videos into different formats

Installation

go get github.com/stackrock/mediamachinego

Usage

Initialize the MediaMachine SDK with an API obtained from your MediaMachine Account

import "github.com/stackrock/mediamachinego/mediamachine"
mm := mediamachine.MediaMachine{APIKey: apiKey}

MediaMachine works with various video storage sources:

  • URL (File Servers: For output, MediaMachine will POST to that URL)
  • Amazon S3
  • Google GCP
  • Microsoft Azure buckets

The input/output sources can also be different! You can leverage MediaMachine API to also move video assets between different storage locations as part of the processing steps.

Additionally, the API calls also accept success and failure endpoints - MediaMachine asynchronously calls them when the video is processed.

Intelligent Thumbnail creation

MediaMachine SDK can generate beautiful Thumbnails for your videos by scanning the video for good quality frames. Sample code

Intelligent Summary creation

MediaMachine SDK can generate an automatic Summary for your videos in GIF or MP4 format. Sample code

Video Transcoding

MediaMachine SDK can transcode your videos between different formats. Sample code

A Transcode processor can be configured to return different kind of outputs:

  • Supported output containers: MP4, WEBM.
  • Supported output encoders: H265, H264, VP8, VP9.
  • Supported output bitrates: 1000kbps, 2000kbps, 4000kbps.

Contributing

We welcome feedback and PRs and appreciate efforts to help us improve.

Our general guidance is:

  • Check the issues/PR list to see if someone might have already answered your concern
  • If you want to suggest changes, feel free to open an issue first and give details about the errors you might be seeing or suggested improvements
  • If you're opening issues/PRs please try to give as much detailed information as possible so that we can help you right away

Directories

Path Synopsis
Package colors provides a handy reference to names colors for the Watermark color field.
Package colors provides a handy reference to names colors for the Watermark color field.
examples
summary
Example usage of MediaMachine SDK for creating video Summaries.
Example usage of MediaMachine SDK for creating video Summaries.
thumbnail
Example usage of MediaMachine SDK for extracting intelligent Thumbnails.
Example usage of MediaMachine SDK for extracting intelligent Thumbnails.
transcode
Example usage of MediaMachine SDK for video transcoding.
Example usage of MediaMachine SDK for video transcoding.