developing a custom video solution with the 3play media api
TRANSCRIPT
1
Developing a Custom Video Solution
with 3Play Media’s API
Mo Zhu
Software Engineer
3Play Media
CJ Johnson
VP of Product
3Play Media
Tole Khesin
VP of Marketing
3Play Media
Bryan Ollendyke
Instructional
Technologist
Penn State University
Agenda
‣ API overview
– What is an API?
– How does 3Play Media’s API work?
– What can I do with the 3Play Media API?
‣ Video search demo with code examples
‣ Penn State University’s captioning workflow demo
‣ Q&A
2
API Introduction by
Mo Zhu
3Play Media
3
What is an API?
‣ “Application Programing Interface”
‣ Graphical User Interface (human to computer) vs.
Application Programming Interface (computer to
computer)
4
‣ APIs allow two computers to
interact with each other by passing
data and commands
What’s So Great About APIs?
‣ Design workflows that suit your business needs
‣ Automate repetitive manual tasks (esp. at scale)
‣ These reduce:
– Cost
– Labor hours
– Organizational and workflow complexity
5
7
Under the Hood
How Does 3Play Media’s API Work?
‣ RESTful architecture
– Create, read, update, and destroy
(CRUD) information stored in the app
– For example, Facebook
8
‣ Not all CRUD is accessible via the API
‣ Not all functionality from the 3Play Media account
system can be accessed via the API
What can I do with 3Play Media’s
API?
‣ Manage caption/translation/alignment jobs
– View media resource information
– Request captioning, translation, or alignment
– Download finished captions and transcripts
‣ Add interactive transcripts to your video
9
SubtitlesCaptions Transcripts Alignment Interactive
Transcripts
How to Use the 3Play Media API
‣ Getting started:
– Create an API collection
– Retrieve the API key of the relevant collection
– HTTP requests
‣ 3Play Media terminology:
– Account
– Project
– Collection
10
How to Use the 3Play Media API
‣ Media resources are grouped in “collections”
‣ Specify folders in project that belong to a collection
‣ API key and API secret key for each collection
11
How to Use the 3Play Media API
‣ API key is a random string of characters that
identifies you to the system (like a password)
‣ Some calls only require the API key. Others require
the API key and the API secret key
12
HTTP Requests (CRUD)
Create – POST
Read – GET
Update – PATCH
Destroy – DELETE
13
View Files
‣ View all files in the collection:
– GET http://api.3playmedia.com/files
– Include apikey parameter
– http://api.3playmedia.com/files?apikey=abc123
‣ View a single file:
– GET http://api.3playmedia.com/files/:id
– Include apikey parameter
– http://api.3playmedia.com/files/123?apikey=abc123
14
Querying Files
‣ To search the title and the transcript text:
– GET http://api.3playmedia.com/files/search
– Required parameters:
• apikey
• q (this is the search term)
– http://api.3playmedia.com/files/search?apikey=abc12
3&q=olympics
15
Request Captioning
‣ Submit a POST request to
– http://api.3playmedia.com/files
‣ Required parameters:
– apikey
– api_secret_key
– file or link
• If uploading a full file, use file parameter
• If providing an http link to the video, use link parameter
16
Downloading Captions
‣ GET
http://static.3playmedia.com/files/(:file_id or :video_id)/captions.(:format)
‣ Required parameters: apikey
‣ Common formats:
srt, dfxp, smi, stl, qt, qtxml, cptxml, adbe
17
Other Functionality
‣ Translations and transcripts
‣ Auto callback
– 3Play API tells your system when files are done
‣ Automated Transcript Alignment
– Convert a transcript into time-stamped captions
‣ Import existing captions and translations
18
Review
‣ What is an API and how does it work?
‣ Benefits of an API
‣ Features of 3Play Media’s API
‣ Examples different use cases
19
Demo by
Bryan Ollendyke
Penn State University
20
Q&A
21
Mo Zhu
3Play Media
Bryan Ollendyke
Penn State University
@btopro
CJ Johnson
3Play Media
Resources
3Play Media API Documentationhttp://support.3playmedia.com/forums/20792257-API-
Management-and-Documentation/
ELMSLN (Penn State University)http://www.elmsln.org/