Open source media management and distribution platform

asset/$asset_id/play

Fri, 03/05/2010 - 15:29 — forgacs

Retrieve play and / or download information from a video

This implements a play call request. The main parameter is a unique mediafile id. The returned response is an URI to the streaming video server (plain) or in a desired format (eg metafile or object). It is also possible to request a download URL, which refers to a download server. A special playback option is "still". If there is a still created for an asset, you can obtain the link to this still with this call. For a more practical request of a still use: /asset/{asset_id}/still.

Request URL

/asset/{asset_id}/play [GET]

Request parameters

Parameter

Type

Description

Method

Obligatory/Optional

asset_id

alphanumeric

asset id

URL

mandatory

mediafile_id

alphanumeric

mediafile id

GET

mandatory
(not mandatory when profile_id is used)

original_mediafile_id

alphanumeric

(New since 1.7.0) Usaeble in combination with profile_id. Plays the mediafile which is transcoded with {profile_id} of the {original mediafile_id}.

GET

optional

profile_id

integer

Play the mediafile which is transcode with {profile_id}.

(new since 1.7.0) If {original_mediafile_id} is also given, plays the transcoded file with profile_id= {profile_id} which was transcoded from source file mediafile_id = {original_mediafile_id}

GET

optional

user_id

string

user id of the person that wants to play the video, is used for logging, and authorization.

GET

mandatory(*)

response

string

response type:

  • plain
    (plain URL)

  • metafile
    (metafile format, this depends on the type of video)

  • object
    (html object)

  • download
    (download url)

  • still
    (still)

GET

optional, default=plain

still_id

alphanumeric

If response type = still and still_id is given, then it gives back that still (not the default still)

GET

optional

size

text

If response type = still, then size parameter may filter the response (eg. 150x120)

GET

optional

format

text

If response type = still, then it is possble to filter the response to format (eg. 'jpeg')

GET

optional

range

text

If response type = still, then it is possible to filter the response to range (to the still order value) (eg. '3', or '3,5,6', or '3, 5-8')

GET

optional

group_id

string

group ID of the person who wants to play the video, can be used for authorization.

GET

optional

aut_domain

string

The domain for which the application is made. If specified it is used for authorization. The domain is checked against the acl rules of the media files, if the domain appears in the / acl / domain list, the video is played.

GET

optional

aut_realm

string

If specified it is used for authorization.

GET

optional

start

integer

start time of the video clip in milliseconds. Must be less than 24 hours (86,400,000)

GET

optional

autostart

boolean

Adjust the value of the autostart in object code.

GET

optional (default = true)

duration

integer

Playing length of the video clip in milliseconds. Must be less than 24 hours (86,400,000)

GET

optional

width

integer

The width of the video.

GET

optional, when not used in combination with height, height will be calculated based on ratio.

height

integer

The height of the video.

GET

optional, when not used in combination with width, width will be calculated based on ratio.

(*) although mandatory, user_id is not checked against the user list. The EUA is responsible for proper filling of this field.

Example request URL

/asset/212swfkk7pzWZGjtTRM/play?mediafile_id=TYBaMHCP7bLKG8BdIcbYQ&user_id=entree004

Example output

<items>
  <item id="1">
    <output>http://wms.acceptatie.streaming.kennisnet.nl/vpx-test/ElTiElxvvLXfhYLnrp1B0nsCJEj</output>
    <content_type></content_type>
  </item>
</items>

Response fields

Field

Description

value

URL to the requested content

output

depending on the specified response.

content_type

in response = metafile.