Web Access URLs

Usage Profiles Are Required to use Web Access URLs

Usage Profiles allow you to define specific formats into which ingested content will be transcoded. These formats can be stored within yospaceCDS or in a third-party CDN file vault. Regardless of their location, yospaceCDS keeps track of where they are and provides an Web Access syntax for retrieving the media. The design of the Web Access URL syntax differs from the mobile access syntax in that it is primarily concerned with offering a means of requesting a format that will have been created on the ingest of content against a Usage Profile with custom formats defined.

A specific format can be requested, which is analogous to requesting the exact binary file within yospaceCDS or remotely hosted, however a 'best match' mode is also offered which offers the format that best fits the requirement given the defined constraints. This allow client systems, such as embedded players to specify what their ideal match would be without knowing the encoding policy in the back-end. This separation allows for retrospective changes to the encoding profiles of content to automatically propogate to players using this request method. In other words, the business logic of what to deliver where, can be centrally managed.

Web Access Syntax

http://cds1.yospace.com/access/d/u/0/1/web/{specification}/{mid}?f={fid}

Where:

• {specification} is a comma-separated list of constraints to which yospaceCDS will use to make the best format match.

  Due to the way this list is parsed, it must end with a comma or the final element will not be recognised. See the examples below.

  • Rendition
    • ren - A specific rendition ID. This overrides all other specifications. If a rendition exists with this ID then it is selected. If such a rendition does not exist and other specification parameters are supplied in the specification string, then an alternative rendition is chosen based on these specifications. If the rendition does not exist and no other specifications are supplied then no content is delivered.
  • Type
    • type - video or audio, absence assumes video.
  • Size (mins and maxs)
    • Absence of these constraints will result in yospaceCDS finding the largest rendition matching available given other parameters.
    • maxs - maximum size, can be specified in XxY, or Xx or xY to determine horizontal and/or vertical constraints. Selected video will not exceed any specified dimension.
    • mins - minimum size, can be specified as maxs. Selected video will not be smaller than any specified dimension.
  • Encoding Rate (minq and maxq)
    • Absence of these constraints will result in yospaceCDS finding the highest quality given other parameters.
    • maxq - maximum quality. Specify an integer indicating bits per second. Selected video will not exceed the specified value.
    • minq - minimum quality. Specify an integer indicating bits per second. Selected video will exceed the specified value.
  • Frame Rate (minr and maxr)
    • maxr - maximum frame rate. Selected video will not exceed the specified value.
    • minr - minimum frame rate. Selected video will exceed the specified value.
  • Container (fmt)
    • Absence of these constraints results in yospaceCDS making a determination based on the requesting User Agent.
    • fmt - values to match all support container formats, including audio formats. Example valuesflv, mp4, mp3
  • Audio Channels
    • ac - mono, stereo. Absence assumes stereo.
  • Video mode (reserved for future use)
    • vm - standard, 3d. Absence assumes standard.
• {mid} is the content ID of the video.
• {fid} is the ID of the Output Feed to which the access should be attributed. It is optional, however it allows you to attribute the download to an Output Feed for reporting purposes.

Examples

The following examples select variants based on Media Item ID 17493337 under feed ID 100013012999.

http://cds1.yospace.com/access/d/u/0/1/web/maxs=640x,/17493337?f=100013012999

Selects a video no wider than 640 pixels wide.

http://cds1.yospace.com/access/d/u/0/1/web/maxq=512000,mins=384x216,/17493337?f=100013012999

Selects a video no smaller than 384 x 216 pixels with a bit rate no greater than 512kbps.

http://cds1.yospace.com/access/d/u/0/1/web/type=audio,minq=128000,/17493337?f=100013012999

Selects a audio file with a bitrate no less than 128kbps.