API Overview

Complete reference documentation for IAppPlayer's APIs, including all parameters, methods, events, and configuration options.

Player Configuration

Learn about createPlayer method and all configuration parameters.

  • createPlayer method signature
  • All parameter documentation
  • Configuration objects
  • Default values
View Documentation

Controller Methods

All methods available on IAppPlayerController for playback control.

  • Playback control methods
  • Fullscreen management
  • Subtitle and track control
  • Advanced features
View Methods

Event System

Complete list of player events and their parameters.

  • Lifecycle events
  • Playback events
  • UI events
  • Error handling
View Events

Data Sources

Data source configuration for various video formats and protocols.

  • Video format support
  • DRM configuration
  • Cache strategies
  • Network configuration
View Configuration

Getting Started with the API

The most common workflow:

  1. Create a player using IAppPlayerConfig.createPlayer()
  2. Get the controller from PlayerResult.activeController
  3. Listen to events through the eventListener callback
  4. Control playback using controller methods
  5. Release resources with dispose()
dart 
// Basic API usage example
final result = await IAppPlayerConfig.createPlayer(
  url: 'https://example.com/video.mp4',
  eventListener: (event) {
    // Handle player events
  },
);

final controller = result.activeController;
controller?.play();

Quick Reference

Need more information? Navigate to the specific sections above or check out: