Introduction

The new Bypass Encoding feature of Playwire allows selected customers to upload already­ encoded videos to Playwire and have them posted immediately, skipping the encoding process that is normally performed automatically on all videos. This is a valuable option if you already have .mp4 versions of your videos in useful sizes, allowing you to avoid spending money on encoding.

To use Bypass Encoding, first make sure of the following:

  • Your account has been enabled for Bypass Encoding. This is a setting that your contact at Playwire can turn on for you if it is not already activated.
  • You have versions of your videos that are in the .mp4 format.
  • Those video files must be accessible via a URL (e.g., “http://myserver.com/path/to/my/video.mp4”).

Bypass Encoding is performed using the Playwire API. If you have not used the API before, you may first wish to review its functions at http://apidoc.phoenix.playwire.com. You will also need to locate your API Token, which can be found in your Account Settings.

This guide assumes you will be interacting directly with the Playwire API. If you are a PHP user, you may wish to use our PHP interface to the API, which is linked to from http://apidoc.phoenix.playwire.com. All examples cited here use ‘curl’, so they can be executed from the command line of most Linux or Mac computers, but you may use functions particular to your programming language.

1

Create a Video

When uploading a video using bypass encoding, you first create the video within Playwire’s systems, then you associate one or more video files with the video, as well as an optional poster image. To create the video itself, you use the POST /videos.json method. Indicate that the ‘video[bypass_encoding]’ attribute is true, and give your video a ‘video[name]’ and a ‘video[category_id]’ at a minimum. For example:
curl ­H "Intergi­Access­Token:  {your token}"
data "video[bypass_encoding]=true&video[name]=CURLTEST&video[category_id]= 10" http://phoenix.playwire.com/api/videos.json

You should get a response back from the API that describes your new video. Copy the value of the ‘id’ field; you will need it for the next step.

2

Associate One or More Video Files with the Video

Now you will associate your first video file with the video. For this, you will use the POST /videos/{video_id}/versions.json method. You need to provide a ‘version[source_url]’ set to the URL of the video file, and you need to provide a ‘version[resolution]’; valid values include ‘sd’, ‘hd’, and ‘mobile’. Every video should have at least an ‘sd’ video file associated with it. For example, this associates a video file with a video and describes it as a SD video:
curl ­H "Intergi­Access­Token: {your token}" 
d "version[source_url]=http://distribution.bbb3d.renderfarming.net/video/mp4/bbb_sunflower_1080p_60fps_normal.mp4&version[resolution]=sd"
http://phoenix.playwire.com/api/videos/{your video id}/versions.json

You can associate more than one video file with a video; you can have .mp4, .ogg, and .webm formats, and also HD, SD, and mobile resolutions. In theory, this means you can have as many as nine different video file versions for a video: three each of .mp4, .ogg, and .webm. However, the only necessary one to start video playback is the SD .mp4 video file.

3

Associate a Poster Image with the Video

Last, you have the option of providing a poster image for your video. This image shows within the video player before the video starts playing, providing a preview for users. Adding a poster is similar to adding a video file; you will use the POST /videos/{video_id}/posters.json method, and you will need to provide a ‘poster[poster_url]’ set to the URL of the poster. Posters should be in the .png, .jpg, or .gif format. For example:
curl ­H "Intergi­Access­Token:  {your token}" 
d "poster[poster_url]=http://cdn.mos.musicradar.com/images/Guitarist/36 2/fender­american­vintage56­strat­630­80.jpg"
http://phoenix.playwire.com/api/videos/ {your video id} /posters.json

Your video is now available for use.

Please note that there are many more attributes you can set for your videos through the API. For example, you probably wish to give each of your videos a description. You can learn more about these optional parameters at http://apidoc.phoenix.playwire.com.

  • Was this Support Article Helpful ?
  • yes   no