Developer Resources - Bambuser Embed API:s
HTML player embed
Revision 1.08 - updated 2012.11.06
Iframe based embed which automatically displays your content in a Flash player or in one of the supported mobile friendly formats.
This is the default way to embed Bambuser on a third party site and also the easiest way to display broadcasts on a mobile website or within a mobile application.
Embed a specific broadcast
To target a single broadcast, use the following HTML:
Replace <VID> with the actual id of the broadcast you want to embed.
A few ways to obtain a vid:
- vid is included in responses from the metadata feed API
- vid can be derived from the following url schema:
Shorter form url: http://bambuser.com/v/[vid]
Longer form url: http://bambuser.com/channel/[username]/broadcast/[vid] - vid is included in auto-generated embed codes on the site.
Example:
Embed a channel
To target a channel, use the following HTML:
Replace <USERNAME> with an actual Bambuser username.
This embed approach will display the latest content from the selected user,
ie either the current live broadcast or the latest archived broadcast if no ongoing broadcast is found.
The value must be url encoded i.e.
| ' ' (space) | » | + |
| Å | » | %C3%A5 |
Example:
The channel embed for user Månster
Optional parameters
autoplay: You can set the autoplay parameter to hint what kind of playback behavior you prefer. Autoplay is not suitable or even possible at all on some mobile platforms, in which case use of autoplay=1 will be ignored.
autoplay=1: always attempt to play automaticallyautoplay=0: do not autoplay
Default behavior: Attempt to play live broadcasts automatically. Do not autoplay archived broadcasts.
Example:
chat: You can set the chat parameter to hint if the chat should be included in the embed or not. If the broadcast owner has disabled the chat entirely the chat parameter will not have any effect. Currently the chat requires flash and will not work on platforms without it.
chat=1: chat is addedchat=0: chat is disabled
Default behavior: Chat is added to the player.
Example:
mute: You can set the mute parameter to hint if audio should be turned on or off during playback. Mute is not suitable or even possible at all on some mobile platforms, in which case use of the mute option will be ignored.
mute=1: audio is turned offmute=0: audio is turned on
Default behavior: Audio is turned on.
Example:
Player theme
Some aspects of the player, like the color scheme, is controlled by the owner of each broadcast via Dashboard.
See also: Help - "Customize your player"
Player dimensions
The player's width and height can be chosen freely as long as the player is large enough to fit its visual elements and it's aspect ratio makes sense. Width below 220px is not recommended.
Compact mode: When the player's aspect ratio is close to the broadcast's aspect ratio, functionality like chat and broadcast archive is layered on top of the video.
Note: Non-flash presentation might not have the extra functionality implemented to the same degree as the Flash version do.
Expanded mode: When the player has a significant amount of extra space below the video, extra functionality is automatically placed there instead.
See also: Help - "How do I embed my broadcasts on other sites?"
Example:
The channel embed for user Bambuser, with enough height to trigger expanded mode.
