The embedded media annotation specifies an image, video, or other rich content that should be displayed with this post. It uses the JSON oEmbed specification. We support the standard photo, video, and rich oEmbed types, and an additional html5video type specified below.
We highly recommend providing the embeddable_url attribute so other clients can request different oEmbed details for this object from the original oEmbed provider (if there is one).
{
"type": "net.app.core.oembed",
"value": {
"version": "1.0",
"type": "photo",
"width": 240,
"height": 160,
"title": "ZB8T0193",
"url": "http://farm4.static.flickr.com/3123/2341623661_7c99f48bbf_m.jpg",
"author_name": "Bees",
"author_url": "http://www.flickr.com/photos/bees/",
"provider_name": "Flickr",
"provider_url": "http://www.flickr.com/",
"embeddable_url": "http://www.flickr.com/photos/bees/2341623661/"
}
}{
"type": "net.app.core.oembed",
"value": {
"version": "1.0",
"type": "video",
"provider_name": "YouTube",
"provider_url": "http://youtube.com/",
"width": 425,
"height": 344,
"title": "Amazing Nintendo Facts",
"author_name": "ZackScott",
"author_url": "http://www.youtube.com/user/ZackScott",
"html":
"<object width=\"425\" height=\"344\">
<param name=\"movie\" value=\"http://www.youtube.com/v/M3r2XDceM6A&fs=1\"></param>
<param name=\"allowFullScreen\" value=\"true\"></param>
<param name=\"allowscriptaccess\" value=\"always\"></param>
<embed src=\"http://www.youtube.com/v/M3r2XDceM6A&fs=1\"
type=\"application/x-shockwave-flash\" width=\"425\" height=\"344\"
allowscriptaccess=\"always\" allowfullscreen=\"true\"></embed>
</object>",
"embeddable_url": "http://youtube.com/watch?v=M3r2XDceM6A"
}
}{
"type": "net.app.core.oembed",
"value": {
"version": "1.0",
"type": "html5video",
"provider_name": "Video.js",
"provider_url": "http://www.videojs.com",
"width": 970,
"height": 404,
"title": "Disney Nature's Oceans",
"author_name": "Disney",
"author_url": "http://nature.disney.com/oceans",
"sources": [
{"type": "video/mp4", "url": "http://vjs.zencdn.net/v/oceans.mp4"},
{"type": "video/webm", "url": "http://vjs.zencdn.net/v/oceans.webm"}
]
"poster_url": "http://www.videojs.com/img/poster.jpg",
}
}{
"type": "net.app.core.oembed",
"value": {
"provider_url": "http://soundcloud.com",
"description": "Listen to Merenti - La Karambaa by M\u00e9renti | Create, record and share the sounds you create anywhere to friends, family and the world with SoundCloud, the world's largest community of sound creators.",
"title": "Merenti - La Karambaa by M\u00e9renti",
"html": "<iframe width=\"500\" height=\"166\" scrolling=\"no\" frameborder=\"no\" src=\"http://w.soundcloud.com/player/?url=http%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F6733249&show_artwork=true&maxwidth=900\"></iframe>",
"author_name": "M\u00e9renti",
"height": 166,
"width": 500,
"thumbnail_url": "http://i1.sndcdn.com/artworks-000003051440-mm2z46-t500x500.jpg?d95e793",
"thumbnail_width": 500,
"version": "1.0",
"provider_name": "SoundCloud",
"type": "rich",
"thumbnail_height": 500,
"author_url": "http://soundcloud.com/mrenti"
"embeddable_url": "http://soundcloud.com/mrenti/merenti-la-karambaa"
}
}To correspond with the oEmbed spec, this annotation accepts keys that are not specified below.
| Field | Required? | Type | Description |
|---|---|---|---|
type |
Required | string | photo, video, html5video, or rich corresponding to the oEmbed type. |
version |
Required | string | Must be 1.0. |
width |
Required | integer | The width in pixels needed to display the embeddable content. |
height |
Required | integer | The height in pixels needed to display the embeddable content. |
url |
Required if type="photo" |
string | The source URL for the image. |
html |
Required if type="video" or type="rich" |
string | The HTML to display the rich or video content. It should have no margins or padding. App.net does no validation of this field. Please program defensively. You may wish to load this in an off-domain iframe to avoid XSS vulnerabilities. |
sources |
Required if type="html5video" |
list | A list of up to 5 {type, url} entries to use in the source tags. type should be a string that can be dropped into the type attribute of a source tag (e.g. video/mp4 or video/webm; codecs="vp8.0, vorbis"). |
embeddable_url |
Optional (but recommended) | string | A URL that can be given to an oEmbed provider to recreate the oEmbed data contained in this annotation. This is useful so other clients can get updated information or retrieve a different sized embedding through an oEmbed endpoint. |
title |
Optional | string | A title for this embedded content. |
author_name |
Optional | string | The author of this embedded content. |
author_url |
Optional | string | The URL for the author of this embedded content. |
provider_name |
Optional | string | The service that provides this embedded content. |
provider_url |
Optional | string | The URL for the service that provides this embedded content. |
cache_age |
Optional | integer | How long (in seconds) should clients cache the embedded content. |
poster_url |
Optional | string | A URL to a poster image for an html5video. |
thumbnail_url |
Optional | string | A URL to an image that represents this resource. If this parameter is specified, thumbnail_height and thumbnail_width must also be present. |
thumbnail_height |
Optional | string | The height of the thumbnail image. If this parameter is specified, thumbnail_url and thumbnail_width must also be present. |
thumbnail_width |
Optional | string | The height of the thumbnail image. If this parameter is specified, thumbnail_height and thumbnail_url must also be present. |
url, poster_url, thumbnail_url, embeddable_url, and all url fields in sources are processed for App.net URI templates by default. You can turn this behavior off by passing "process_template": false as an extra attribute.
- Mark Thurman (@mthurman, mthurman@app.net)