Developer API Documentation
Published on Dec 10, 2025
Welcome to PlayM3U8 API Documentation. This guide provides complete API reference, parameter details and code examples.
π Quick Start
Include Resources
<!-- CSS --> <link href="https://web.sdk.qcloud.com/player/tcplayer/release/v5.1.0/tcplayer.min.css" rel="stylesheet"> <!-- JS --> <script src="https://web.sdk.qcloud.com/player/tcplayer/release/v5.1.0/tcplayer.v5.1.0.min.js"></script>
Create Player Container
<video id="player" preload="auto" playsinline webkit-playsinline></video>
π Basic Usage
Simple Playback Example
const player = TCPlayer('player', {
sources: [{
src: 'https://example.com/video.m3u8'
}]
});βοΈ Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
| sources | Array | Yes | Video source array |
| autoplay | Boolean | No | Auto play, default false |
| controls | Boolean | No | Show controls, default true |
| poster | String | No | Poster image URL |
π§ Methods Reference
play() - Play video
player.play();
pause() - Pause video
player.pause();
src(url) - Set video source
player.src('https://example.com/video.m3u8');
dispose() - Destroy player
player.dispose();
π‘ Event Listeners
// Play started
player.on('play', function() {
console.log('Playing');
});
// Paused
player.on('pause', function() {
console.log('Paused');
});
// Error handling
player.on('error', function(error) {
console.error('Error:', error);
});β οΈ Important Notes
- β’ M3U8 URL must support CORS
- β’ Mobile Safari requires user interaction to play
- β’ Some browsers block autoplay