XML video description

The video format is described in the attributes of the ovs:available_format element. Every combination of video quality and codecs parameters should be described in a separate format element.

The following fields are supported:

• codecs (mandatory attribute) — the codec available for this video format.

• width — Width of the video in pixels.

• height — Height of the video in pixels.

• bitrate — Maximum bitrate in kilobits per second (kbps).

• quality — video quality.

  Supported values:

  • low — Low quality (resolution lower than 360×640, bitrate below 717 kbps)

  • medium — Average quality (resolution between 360×640 and 720×1280, bitrate from 717 kbps to 1 Mbps)

  • HD — HD quality (resolution between 720×1280 and 1080×1920, bitrate of 1-2 Mbps)

  • full HD — Full HD quality (resolution higher than 1080×1920, bitrate above 2 Mbps)

• size — Size of the video file in kilobytes.

Markup example:

<ovs:available_format>
<ovs:format codecs="h.264" width="320" height="240" quality="low" bitrate="250"/>
<ovs:format codecs="h.264" width="854" height="480" quality="medium" bitrate="800"/>
<ovs:format codecs="h.264" width="1280" height="720" quality="HD" bitrate="1800"/>
<ovs:format codecs="h.264" width="1920" height="1080" quality="full HD" bitrate="2800"/>
</ovs:available_format>

You can use the value of the category element to specify the category this video belongs to. The categories recommended by Yandex and their corresponding values are listed below. If the category you're looking for is not in the list, you can make up your own category and set an appropriate value.

Available categories

• auto_moto

• animation

• webinars

• webcams

• home_family_kids

• animals

• health

• games

• interview

• internet

• art

• history

• karaoke

• disasters_and_accidents

• clip

• concert

• short_video

• beauty_and_fashion

• recipe

• music

• cartoons

• science

• news

• education

• parody

• politics

• nature

• software

• broadcast

• travel

• entertainment

• commercial

• gardening

• handmade

• slideshow

• sport

• lifestyle

• dancing

• TV

• tvseries

• tvshow

• gadget

• goods

• trailer

• hobby

• movie

• movie_about_movie

• fragment

You can set multiple categories by separating them with commas or putting them in separate elements. For example, you can signify that a clip is a film trailer or a concert recording.

Markup example:

<ovs:category>movie</ovs:category>
<ovs:category>trailer</ovs:category>

Additional markup is available for some video categories:

Movies (ovs:movie)

Supported characteristics:

• ovs:original_name — Title of the movie in original language.

• ovs:release_date — Release date of the movie. If the exact date is unknown, set January 1 of the year the movie was released.

• ovs:part — Part number for movies with multiple parts (for example, Harry Potter and the Deathly Hollows: Part 1).

Markup example:

<ovs:movie>
  <ovs:original_name>Harry Potter and the Deathly Hollows</ovs:original_name>
  <ovs:release_date>2013-03-04T00:00:00</ovs:release_date>
  <ovs:part>1</ovs:part>
</ovs:movie>

Episode of a series (ovs:tvseries)

Supported characteristics:

• ovs:episode (mandatory field) — Episode number.

• ovs:season — Season number.

• ovs:release_date — Date the series was first broadcast.

• ovs:original_name — Name in the original language.

Markup example:

<ovs:tvseries>
    <ovs:original_name>The Big Bang Theory</ovs:original_name>
      <ovs:release_date>2013-03-04T00:00:00</ovs:release_date>
      <ovs:season>6</ovs:season>
      <ovs:episode>15</ovs:episode>
</ovs:tvseries>

Music video (ovs:music)

Supported characteristics:

• ovs:track_name (mandatory field) — Name of the track.

• ovs:album — Name of the album.

Markup example:

<ovs:music>
      <track_name>A Bar In Amsterdam</track_name>
      <album>Le Pop</album>
</ovs:music>

Episode of a show (ovs:tvshow)

Supported characteristics:

• ovs:episode (mandatory field) — Episode number.

• ovs:season — Season number.

• ovs:release_date — Date the show was first broadcast.

Markup example:

<ovs:tvshow>
    <ovs:original_name>Top Gear</ovs:original_name>
      <ovs:release_date>2013-03-04T00:00:00</ovs:release_date>
      <ovs:season>19</ovs:season>
      <ovs:episode>2</ovs:episode>
</ovs:tvshow>

Broadcast (ovs:broadcast)

Supported characteristics:

• ovs:start_date (mandatory field) — Date and time at start of broadcast.

• ovs:end_date — Date and time at the end of the broadcast. This can be omitted if the broadcast is available at the same address where it was at the end of the broadcast.

Markup example:

<ovs:broadcast>
      <ovs:start_date>2013-04-04T00:00:00</ovs:start_date>
      <ovs:end_date>2013-04-04T00:30:00</ovs:end_date>
</ovs:broadcast>

You can only use one of these categories for additional description of a video (for example, you cannot use the ovs:movie and ovs:tvshow elements simultaneously). Setting additional elements is optional — if there is no detailed data about a video, just set the appropriate value for the ovs:category element.

Supported characteristics:

• embed_url — link to embed a video hosted on a separate site.

  If the link has not been generated, use the embed_html field to embed the player code.

• embed_html — HTML code to embed the player for the videoclip (use this if you can't generate a link for the embed_url field).

• allow_embed — Indicates that the video can be displayed on the Yandex search results page.

  By default, a video can be played directly in the search results. To restrict viewing of the video to your site, set the <ovs:allow_embed>no</ovs:allow_embed> element.

• available_platform — the platform you can play the video on.

  Sample list of supported platforms:

  <ovs:available_platform>Windows</ovs:available_platform>
  <ovs:available_platform>WindowsPhone</ovs:available_platform>

  Full list of possible platforms:

  • Desktop — indicates that the main PC platforms are supported (see list below)

  • Windows

  • Linux

  • OSX

  • Mobile — indicates that the main mobile platforms are supported (listed below).

  • iOS

  • Android

  • WindowsPhone

  • WindowsMobile

  • Symbian

  • Bada

  • BlackBerry

  • MeeGo

Date and time should be entered using the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ss+03:00 format, where:

• YYYY — year

• MM — month

• DD — day

• HH — hour

• mm — minute

• ss — second

• +03:00 — time zone (in this case — Moscow time).

If you want to set just the year (for example, for a movie release date), set it to midnight January 1 of that year, such as 2001-01-01T00:00:00.

Markup example:

<ovs:created_date>2013-07-15T15:00:00</ovs:created_date>
<ovs:upload_date>2013-07-19T02:35:10</ovs:upload_date>

Viewing and rating statistics for the video can be entered in the ovs:stats element using the following properties:

• views_last_day — Number of views in the last day.

• views_last_month — Number of views in the last month.

• views_last_week — Number of views in the last week.

• views_total — Total number of views.

• comments — Number of comments on the video.

• likes — Total number of users who liked the video.

• dislikes — Total number of users who did not like the video.

• rating — Average rating of the video (on a scale from 0 to 10).

Markup example:

<ovs:stats>
      <views_last_day>0</views_last_day>
      <views_last_month>45454</views_last_month>
      <views_last_week>5454</views_last_week>
      <views_total>544787</views_total>
      <comments>5</comments>
      <likes>54</likes>
      <dislikes>1</dislikes>
      <rating>6</rating>
      <rating_count>54444</rating_count>
</ovs:stats>

You can use the allow_countries and disallow_countries elements to enter restrictions regarding where the video can be shown. We recommend using the ovs:allow_countries element if the video is only allowed to be shown in certain countries. Likewise, it is best to use the ovs:disallow_countries element if the video is only restricted in a few countries. Multiple restrictions can be comma-separated or set in separate elements.

Markup example:

<!-- Video display is only allowed in Russia (viewers age 12+) and Turkey (viewers age 18+). -->
<ovs:allow_countries>ru(12+), tr(18+)</ovs:allow_countries>

<!-- Video display is allowed everywhere except Great Britain. The video can be played in Russia
     to audiences ages 12+, and in Turkey to audiences ages 18+. -->
<ovs:disallow_countries>ru(12+), tr(18+)</ovs:disallow_countries>
<ovs:disallow_countries>uk</ovs:disallow_countries>

You can enter information about video price in the price element. Several different prices can be entered. For example, a video service subscription price and a price to download just the one videoclip.

Supported attributes:

• type — Payment type.

  Supported values:

  • rent— Access to the videoclip for a given period of time

  • subscription — Subscription to a series of clips or for a long period of time

  • purchase — Buy video

• duration — Duration (length of paid access), in ISO 8601 format.

• currency — Currency, in ISO 4217 format.

Markup example:

<!-- Price to rent the clip for 36 hours. -->
<ovs:price type="rent" duration="P1DT12H" currency="rur">100</ovs:price>
<!-- Price for a one-month subscription. -->
<ovs:price type="subscription" duration="P1M" currency="rur">1000</ovs:price>
<!-- Price to purchase video. -->
<ovs:price type="purchase" currency="rur">100</ovs:price>