Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 2.73 KB

README.md

File metadata and controls

94 lines (70 loc) · 2.73 KB
Raw

amara-php

PHP snippets and scripts for interacting with Amara

These are unsupported samples for your own implementations.

All code except SrtParser is licensed as GPL 3.0 https://www.gnu.org/licenses/gpl-3.0.en.html

SrtParser is licensed as LGPL 2+ by Julien 'delphiki' Villetorte

API

Provides an object to perform some of the most common interactions with Amara's API

Example usage

require_once 'API.php';
$API = new AmaraPHP\API\API(
        'https://www.amara.org/api/',
        'username',
        'apikey'
  );
$videoInfo = $API->getVideoInfo(array(
            'video_id' => $video_id
            ));
$title = basename(str_replace('.mp4', '', $videoInfo->all_urls[0]));
$captions = $API->getSubtitle(array(
        'format' => 'srt',
        'video_id' => $video_id,
        'language_code' => $language
    ));

Team Stats

Collects data about a team and the languages.

Example usage

Make sure there's a tmp folder where the script is placed and that teamstats.php is set as executable (chmod +x teamstats.php)

Run from the Linux commandline:

./teamstats.php -t teamslug -p projectslug -stats vlc -apikey 123abcetc -u username

The stats flag indicates what stats to collect.

  • v for video info
  • l for language info, including state (complete/incomplete)
  • r for runtime stats
  • p for proxy stats. This may try to fetch the duration using ffmpeg if possible and it's missing from the API.
  • c for completion stats. This will list how many videos in each language are completed

You can specify multiple teamsluts and projectslugs separating them with commas (no spaces). Project is optional.

After the script finishes running a number of CSV files will be created in a timestamped folder inside tmp.

Known issues

Currently it doesn't use the API component.

ShotLog

Exports two sets of parsed subtitles into a side-by-side shot log document

Requires delphiki/subrip-file-parser (a modified copy is included in Formats/SrtParser)

Example usage

Where parse_subrip is a method to turn a string containing a SRT's content into a subrip-file-parser object

$shotLog = new AmaraPHP\Formats\ShotLog();
$videoInfo = $API->getVideoInfo(array(
    'video_id' => $video_id
));
$title = basename(str_replace('.mp4', '', $videoInfo->all_urls[0]));
$captionsTrack = $API->getSubtitle(array(
        'format' => 'srt',
        'video_id' => $video_id,
        'language_code' => $language
    ));
$captions = parse_subrip($captionsTrack);
$descriptionsTrack = $API->getSubtitle(array(
        'format' => 'srt',
        'video_id' => $video_id,
        'language_code' => 'meta-audio'
    ));
$descriptions = parse_subrip($descriptionsTrack);
$shotLog->save($captions->getSubs(), $descriptions->getSubs(), $tmpDir, $title);