mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-15 16:06:41 +03:00
Joey Parrish
c8e80cb58d
- Update tutorial link in README - Fix python version in README - Move jsdoc conf to docs/ folder - Add API docs main page - Change style of inline code blocks - Don't repeat tutorial title in jsdoc template - (makes it easier to read tutorials on github as MD) - Add tutorials for: - Welcome to Shaka - Basic Usage - Debugging - Configuration - Networking and Buffering Configuration - DRM Configuration - License Server Authentication - Plugins - Tutorials still to come: - License Headers and Track Restrictions - Special Considerations for Live - v2 Upgrade Guide Change-Id: I16401c216cf4023d9097750ac7f6090c68bf3c9b
2.3 KiB
2.3 KiB
Basic Usage
Basic usage of Shaka Player is very easy:
- Start with {@tutorial welcome} and compile the library.
- Create a simple HTML page with a video element.
- In your application's JavaScript:
- Install polyfills.
- Check for browser support.
- Create a Player object to wrap the video element.
- Listen for errors.
- Load a manifest.
NOTE: For simplicity, we will use alert() for errors in this tutorial.
In a real application, you would want a more appropriate mechanism to display
errors to your users.
<!DOCTYPE html>
<html>
<head>
<!-- Shaka Player compiled library: -->
<script src="dist/shaka-player.compiled.js"></script>
<!-- Your application source: -->
<script src="myapp.js"></script>
</head>
<body>
<video id="video"
width="640"
poster="//shaka-player-demo.appspot.com/assets/poster.jpg"
controls autoplay></video>
</body>
</html>
// myapp.js
var manifestUri = '//storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd';
function initApp() {
// Install built-in polyfills to patch browser incompatibilities.
shaka.polyfill.installAll();
// Check to see if the browser supports the basic APIs Shaka needs.
shaka.Player.support().then(function(support) {
if (support.supported) {
// Everything looks good!
initPlayer();
} else {
// This browser does not have the minimum set of APIs we need.
alert('Browser not supported!');
}
});
}
function initPlayer() {
// Create a Player instance.
var video = document.getElementById('video');
var player = new shaka.Player(video);
// Attach player to the window to make it easy to access in the JS console.
window.player = player;
// Listen for error events.
player.addEventListener('error', onErrorEvent);
// Try to load a manifest.
player.load(manifestUri).then(function() {
// The video has now been loaded!
}).catch(onError);
}
function onErrorEvent(event) {
// Extract the shaka.util.Error object from the event.
onError(event.detail);
}
function onError(error) {
// Log the error.
console.error(error);
alert('Error code ' + error.code);
}
document.addEventListener('DOMContentLoaded', initApp);
That's it!
Continue the Tutorials
Next, check out {@tutorial debugging}.