Videos

Videos are at the core of the Zype experience. You can upload videos or import videos from a third party source and use Zype to deliver your video content to any device or geographic location desired.

Learn about Dynamic Player Technology (DPT)
Monitoring your views
Related playlists
Uploading videos to the Zype Platform
Importing videos to your Video Library from a third party source
Adding a collection of videos from Vimeo
Adding single videos from a Vimeo link
Adding videos from a YouTube Channel to the Zype Platform
Adding YouTube videos from a URL
Adding your Crunchyroll videos to Zype
Bulk importing of third party video sources (Advanced)
Uploading videos to Zype using our Ruby Gem
Walkthrough of the Zype API with a sample Rails app
Embedding a player on your site
Search filters on the Zype Platform
Choosing thumbnails for your videos
Deleting a video
Upload formats
Managing video segments
Discovery URLs
Subtitles

Learn about Dynamic Player Technology (DPT)

Zype’s DPT allows you to create player rules based on geography and device. For example, you could declare that end users will receive the Hulu Player if he or she is accessing your video via desktop in the United States or the Zype Player if he or she is accessing your video via desktop in Australia.

What you need to start

You will need to have a video collection on the Zype Platform from the video sources that you want to create player rules for.

1. Make sure you have imported your videos into your video catalogue on the Zype Platform.

video imports

What you need to do in the Zype Platform

1. Visit the Player Rule Page and click on New Player Rule

player rules

2. Complete the Player Rules form. You will need to know the countries and devices you want for your rule. Based on countries and devices, you will be given player options that can be served to the end user.

player rule form

Using the API

You can query the Zype API to only show videos that dynamically conform to your DPT rules given an end user’s device and geolocation. Set dpt to equal true in your GET request.

 GET https://api.zype.com/videos?dpt=true

Using the Player API

1. Once you have set up your video catalog in the Zype Platform and you have created your player rules, you are ready to use the Zype Player API!

2. You can find your player key and API key using the Zype Platform

site keys

3a. To make the API call to get the appropriate player

GET http://api.zype.com/videos/{video_id}/player/?api_key={api_key}&player_key={player_key}

3b. To use the Zype Ruby Gem to get the appropriate player

@zype_cli = Zype::Client.new
@video = @zype_cli.videos.find(params[:video_id])
@player = @video.player(player_key: params[:player_key])

Check our previous post on how to set up your Rails app with the Zype Gem!


Monitoring your views

In a previous post, we covered how to use Zype’s Dynamic Player Technology (DPT). In this post, we’ll be covering how to use the DPT logs to see what requests are being made for your video content. For example, let’s say you’ve uploaded a batch of new videos and after the first 30 days, you’d like to get an idea of who’s viewing your content and what times of the day are most popular for viewing.

Where can I find my logs?

After you’ve uploaded some video content to the Zype platform, log in through the admin portal and navigate to the logs section under the settings dropdown menu. In this post, we’ll cover the request logs, so feel free to click on that link once you see the logs menu.

dpt logs navigation

What type of information can I see in my request logs?

The request logs screen shows you lots of information about the requests made to view your videos. Here are the most pertinent pieces of information:

Data Description
Video The video that was requested
IP Address The IP address of the requester
Country The country the request was made from
Device The device the request was made from
Player The player that served the video
Provider The provider of the content
Revenue Model The revenue model of the viewer
Status The status of the request
Created The date and time the request was created

dpt logs

How can I search the request logs data?

The request logs screen gives you a snapshot of the most recent requests by default.

Sorting the request logs is easy: use the four dropdown menus to select your search parameters and then click on the search button.

searching logs

Check our previous post on how to set up your Rails app with the Zype Gem!


Let’s say you’ve already got some video content on your Zype destination site, but now you’d like to recommend additional content based on what your users are watching. The solution we’ve implemented is called related videos. In this post, we’ll be covering how to create a playlist of related videos that are recommended to a viewer based on what the video they’re watching. Here’s an example of the finished product:

related playlist

The related videos section is automatically created for each video on your site, but if you’d like to be more specific about which videos are displayed there, follow along as we set up a playlist of related videos.

Setting up the playlist can be done from the admin portal. Navigate to the playlist section on the sidebar and and click “New Playlist”. Follow through the menu and create a playlist (make sure it’s active!).

playlist navigation

How can I choose which videos are shown in the playlist?

This is an easy one. Use the “Add Videos” button to select which videos will appear under the related videos section.

add videos navigation

How can I choose which videos display the playlist?

Choosing the videos that will have your playlist displayed is done through the playlist edit screen. You can get there quickly by clicking on the name of your playlist here:

edit your playlist

Use our multiselector to search for the videos you want and click on them to move them into selected videos. Click “Save Changes” when you’re done.

choose related videos

Let’s confirm

You should take a second and make sure everything is going according to plan. Go to your site and view a video that you added to selected videos in the previous step. Below the video, under the section “Related Videos”, you should see the playlist you just created and the first few videos you added. You can also update any of your current playlists to act as a playlist of related videos by following these same steps.

Check our previous post on how to set up your Rails app with the Zype Gem!


Uploading videos to the Zype Platform from the web

The easiest way to add a video to your video library is to upload a video to the Zype Platform.

We support many popular media formats such as: 3GP, AAC, AVI, FLV, MP4 and MPEG-2. We do not currently support Apple ProRes, ARRI and RED.

Step 1:

Go to Import & Upload, and click the “Upload from My Web Browser” button.

Upload Videos

Step 2:

By default, we automatically add the video to your library and we activate the video. If you would like to change this, toggle Add Video or Activate Video off. Then, select the file that you want to upload.

upload video

Step 3:

When the file is finished uploading, you will be redirected to the video’s page where you can add additional metadata. Once your video is finished transcoding, you will be able to play your video and select your video thumbnail.

add video metadata


Importing videos from a third party source

We’ve made it easier to import your videos from third party sources like YouTube, Vimeo, or Hulu to your video library! Now, the default option is to automatically add all video imports to your video library as new videos.

Step 1: Add your video source and make sure that add videos is turned on

add video source

Step 2: Navigate to your Video Library, you should see new videos from your video source that are active! Note, videos will be added to your video library as they become available

video library

Advanced importing

If you do not want to automatically import all of the videos from a video source to your video library or if you want to merge your video imports to videos preexisting in your library, you can turn add video ‘off’ when you create a video source and use the “Advanced Video Importing” option.

add video source not-auto

Then, navigate to the video imports screen and click on the add button for the videos that you want to add to your video library or the merge button if you want to merge your video imports to preexisting videos in your video library.

advanced video importing


Adding videos from a Vimeo Channel, Group or User

We’re happy to provide you with a simple and powerful tool for importing your Vimeo videos to the Zype Platform. Below are the steps for grabbing your videos, no matter where they exist in Vimeo.

Step 1:

Go to Video Sources and click on the Vimeo icon.

click vimeo

Step 2:

Enter a name for your Vimeo video source (something to help you remember it!).

Step 3:

You’ll need to copy and paste a link to your Vimeo videos from a Group, Channel or User. Here are some quick example links:

https://vimeo.com/channels/staffpicks

https://vimeo.com/user36554072/videos

https://vimeo.com/groups/animation

First, go to Vimeo and copy the link:

copy your link

Then paste the link into the Vimeo Source form:

paste your link

Then click the ‘Save Changes’ button.

Step 4:

If everything went according to plan, you can see your new video imports by clicking on the green ‘Video Imports’ button.

video imports button


Adding Vimeo video from a URL

Check out the Video Imports Screen and click on the “Add Video Import” button to get started.

navigate to form

The next step is to copy a URL from Vimeo that shows the video you want to add.

copy url

Paste the URL into the field on this page and click “Add Video Import”.

paste url

Then click the ‘Save Changes’ button.

save changes

If everything went according to plan, you should see the video imports screen again, with a new import from the link you provided. If you’re interested in grabbing a bunch of videos from Vimeo, you may want to follow our guides under Adding Videos.


Adding videos from a YouTube Channel to the Zype Platform

We simplified the process of searching for and importing a YouTube Channel into the Zype Platform. Before, you had to manually go to YouTube and find your Channel ID. This was a cumbersome process. Now you can search for a YouTube Channel from the Zype Platform and we will get the Channel ID for you.

Step 1:

Go to Video Sources and click on the YouTube icon.

click youtube

Step 2:

Enter a name for your YouTube video source (something to help you remember it!) and click the Search YouTube Channels button

search youtube channels

Step 3:

Enter the channel name that you are searching for and click Search. You will be given a list of YouTube Channels that match your search criteria. Click the Select Channel button for the YouTube Channel that you want to add.

click select channel

Step 4:

This will prepopulate the Channel ID for you. All you need to do is click Save Changes and the Zype Platform will start to import all of the videos from the channel that you selected!

click submit

Step 5:

Your imported videos are in your import videos page. You can add videos to your catalog from there.

import videos


Adding YouTube video from a URL

We’re happy to announce that the Zype Platform now grants you the power to import videos from YouTube simply by copying an pasting a YouTube link into the platform.

Check out the Video Imports Screen and click on the “Add a YouTube Video Import” button to get started.

navigate to form

The next step is to copy a URL from YouTube that shows the video you want to add.

copy url

Paste the URL into the field on this page and click “Add Video Import”.

paste url

If everything went according to plan, you should see the video imports screen again, with a new import from the link you provided. If you’re interested in grabbing a bunch of videos from YouTube, you may want to follow our guides under Adding Videos.


Adding your Crunchyroll videos to Zype

We know you have a lot of video content and we know that you want it all to be available to your viewers through the Zype Platform. That’s why we’re proud to announce that you can now use Crunchyroll as a video source for videos on the Zype Platform!

As part of the announcement, we want to walk you through the setup involved and get you up to speed. If you’ve added videos to the Zype Platform using video sources in the past, the will look very familiar.

First, let’s login to the Zype Platform and go to Video Sources. Now click on the Crunchyroll icon.

click crunchyroll

Adding your affiliate code

Enter a name for your Crunchyroll video source (something you’ll remember!) and your Crunchyroll Affiliate code (this is provided to you by Crunchyroll when you become an affiliate.)

add name and affiliate code

Importing your videos

Now sit back while we go get all of your Crunchyroll videos and add them to the Zype Platform as video imports. Once we’ve imported all of your videos you will find them under the Video Imports tab. The last step is to create new videos from the imports or add the video imports to videos you already have on the Zype Platform.

video imports

Confirm

You can confirm that your videos were added by clicking on the videos tab and searching for the ones you’ve just added.

videos


Bulk importing of third party video sources (Advanced)

To bulk add video imports to your video library, check the videos that you want to add and click the button “Add to Library.” This will automatically add new videos to your video library. If you would like to merge videos into preexisting videos in your video library, you will need to click the merge chain for each video.

add to library

To bulk remove video imports from your video library, check the videos that you want to remove and click the button “Remove from Library.” Note, this does not delete the video, it only removes the chosen video import data source from your video.

remove from library


Uploading videos to Zype using our Ruby Gem

We’re rolling out a bunch of new ways to add video content to the Zype Platform, like Youtube Channel Import and Crunchyroll Video Import. In this post we’ll show you how to use the Zype Command Line Interface (or CLI) to upload videos that you have stored on a harddrive.

Downloading and installing the Zype CLI

First, you’ll need to download and set up the Zype CLI. You can find the tool on gitHub.

You’ll need to clone down the repo, then run the following commands:

$ gem build zype.gemspec
$ gem install ./zype-1.0.0.gem

You can confirm that your installation succeeded by entering

$ zype

which will display a list of available commands for the Zype CLI. Remember this command in case you have questions about what the Zype CLI can do!

CLI Interface

Logging in through the Zype CLI

Let’s make sure that you can login and that your Zype CLI is linked to your instance of the Zype Platform.

Enter the command below:

$ zype account:login

You’ll be prompted to enter your Zype API Key. You can find this by logging in to the Zype Platform and clicking on API within the settings menu at the top of the screen. Grab your API key and enter it into the terminal to continue. You should use your admin api key.

Uploading your videos

You’ll need to know which directory contains the videos you want to upload. Once you know where they live, you can run the upload command.

If all of the files live in a single directory, run the following command, replacing the example directory (“/myDir/videos”) with your own.

$ zype video:upload --directory="/myDir/videos"

If you have multiple subdirectories that contain videos, you can pass in a wildcard character (*) at the end of the parent directory to grab all of the videos within each subdirectory. Like this:

$ zype video:upload --directory="/myDir/videos/*"

Now sit back while we upload all of your videos and add them to the Zype Platform as video imports. Once we’ve imported all of your videos you will find them under the Video Imports tab. The last step is to create new videos from the imports or add the video imports to videos you already have on the Zype Platform.

video imports

Confirm

You can confirm that your videos were added by clicking on the videos tab and searching for the ones you’ve just added.

videos


Walkthrough of the Zype API with a sample Rails app

We want to make the Zype Platform accessible to as many types of developers as possible. To do this, we have provided API documentation and are happy to talk with you about creating a turnkey app.

As a developer, I always like to learn by example, so we have created a template Rails app to show you what you can do with the Zype Platform using our Ruby Gem and also provide you with a starter template if you want to build off of it for your own web app.

We intentionally kept the styling simple and used Bootstrap if you would like to use this example as a foundation to your Rails app. Feel free to clone the repo here. You will need your Zype API and player keys from the Zype Platform. The README has directions to how you can find your keys.

The Zype Rails sample app has the following pages and features.

Home Page

The homepage includes all of your playlists, a link in the header to view all videos, and a search box to search for a specific video. The playlists can be configured in the Zype Platform and can be fetched via the Ruby Gem.

homepage

Playlist Page

You can click on any playlist to view all the videos that belong to that playlist. You can sort the videos based on release date, name, or popularity. Also note that there are Zype videos and YouTube videos in the same player. The Zype Platform and Zype API allows you to seamlessly combine the two.

playlist page

Browse all Videos

The browse all videos uses the Ruby Gem to query the Zype API to get all the videos. When you hover over a video, you will see the description. Feel free to read the Video API Documentation to see what other information gets returned when you query for the videos.

browse videos

Video Page

When you click on a video’s thumbnail, you get directed to the video’s page. The video’s page contains the title, description, and video player. The Zype API will deliver the appropriate player based on where the video source comes from and what Player Rules you set.

video page

Have questions about implementing our sample Rails app or want to see examples of other features or in other languages? Feel free to comment below!


Embedding a player on your site

The Zype Platform allows you to manage all of your video content in one place and then deliver your video content across any platform or device. In this tutorial, I will map out how to embed a video uploaded to the Zype Platform on any web page.

Step 1

Navigate to your video’s page and click on the Embed Code tab.

Go to Embed Code

Step 2

Copy the embed code.

Copy Embed Code

Step 3

You will need to place the div with the id ‘zype_player’ where you want your player to be located on your page.

Currently, you can pass in autoplay, player_key, and subscription_id params. The player_key is required and can be found in Settings > API. Autoplay and subscription_id are optional.

<div id='zype_player'></div>
<script id='zype_player_js' src='https://api.zype.com/embed/{video_id}.js?autoplay={boolean}&player_key={player_key}&subscription_id={subscription_id}' type='text/javascript'></script>

Search filters on the Zype Platform

If you’ve been busy adding video content to the Zype Platform and creating playlists, you might be at the point where you’ve got a few pages of each. To help you better manage your content, we’ve added a set of filters to the videos and playlists pages:

video filtering

playlist filtering

The filter buttons let you select as many parameters for your search as you’d like. Each button has a dropdown you can use to select a value to search by. The default search options are the categories you’ve created for your site and “Active” (whether or not the video is marked as active). You can create and manage your categories here.

Once you’ve selected all of the filters you want to use, click the search button to see the results.

You can search by entering a search term, using the filters or both!

If the filter buttons are grayed out, that’s because you don’t have any videos or playlists yet.

Check out our previous blog post on defining categories and playlists, if you have questions about getting started.


Choosing thumbnails for your videos

When you upload a video to the Zype Platform, Zype will create thumbnails for your video. You can also upload your own custom image that will be displayed as a video’s thumbnail. To change your the thumbnail for your video, follow the steps below. Note, this is only to change your thumbnail from a video uploaded directly to the Zype Platform. It does not apply to thumbnails from an external data source like YouTube or Vimeo.

Step 1:

thumbnail 1

From your video library, click on the video that you want to change the thumbnail for and click on the “Thumbnails” tab.

Step 2:

Select a thumbnail from our auto-generated selection

thumbnail 2

OR choose to upload one from your harddrive.

thumbnail 3

The thumbnail will automatically be updated!

Step 3:

thumbnail 4

You can click the ‘remove’ button to remove custom thumbnails from a video. Once you’ve clicked remove, upload another image or choose from the auto-generated images we provide. Make sure to save your changes when done!


Deleting a video

To delete a video, navigate to your Video Library and click on the trash can for the video that you want to remove.

remove video

Note, when you delete a video, the video is removed from all playlists, the video import and/or upload is released, and video favorites/ratings are removed.


Upload formats

Zype supports uploading in the following popular media formats:

We do not currently support the following:


Managing video segments

Video segments help you highlight specific time blocks in a video. This is additional metadata for your video that is exposed via the Zype API. Each segment can have a start time, an end time, and a description.

To manage a video’s segments, navigate to the video’s details page and click on the “Segments” tab. Then, click on the “New Segment” button. You will be prompted to enter the time in HH:MM:SS format.

manage segments


Discovery URLs

You can set a discovery URL for each of your videos. The discovery URL is the URL where a viewer can access the video in their web browser. This is particularly useful for services that aggregate where viewers can access your content like GoWatchIt.

To set the discovery url for a video, navigate to the video’s detail page and in the “Details” tab scroll down to the “Discovery URL” field. You should enter the URL of the video on your website.

video detail

You can access the discovery url in two different ways with the Zype Platform. First, you can use our video API to get your discovery URL. Moreover, the discovery url is used in your RSS feeds powered by Zype. To get your RSS feed, first click on Publishing in the left hand menu on the Zype Platform.

publishing page

Then, click on “MRSS feeds.” You can choose the type of feed for importing into your website or syndicating to partners. The discovery url is located in the attribute in Zype’s RSS feeds.

rss feeds


Subtitles

You can set soft subtitles on a per video basis. Soft subtitles are text files that live outside of the video file, but can be toggled on or off in the video player. Zype currently accepts .srt and .vtt subtitle files for web play and .srt files for Roku play. Check the image below to see what subtitles will look like in your Zype Player!

subtitle example

To upload a subtitle, first navigate to the video that you want to add subtitles to and click on the “Subtitles” tab.

subtitle tab

Next, click the “New Subtitle” button. This will pop up a new form field to enter your subtitle data.

subtitle add

Then, select the language and upload the .srt or .vtt file for your subtitles. You can choose to have the subtitles active or not. Only active subtitles will be available on the video player.

subtitle upload

Click “Save Changes” to complete uploading your subtitles onto the Zype Platform! Your players will now have the options to display subtitles for the languages that you have uploaded.

There are a lot of ways to create soft subtitles to upload to Zype. At Zype, we use Aegisub to create our SRT and VTT subtitle files. This is a free software that allows you to enter captions alongside the video playing. Then, it converts your captions to SRT or VTT files for you to upload onto the Zype Platform.