> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Parameter reference

> Complete reference for the FastPix Flutter Player SDK classes, parameters, and configuration options.

Complete reference for the FastPix Flutter Player SDK classes, parameters, and configuration options.

## FastPixPlayerController

Main controller class for playback management.

| Function                                | Description                                                |
| --------------------------------------- | ---------------------------------------------------------- |
| `initialize(dataSource, configuration)` | Initialize the player with a data source and configuration |
| `play()`                                | Start playback                                             |
| `pause()`                               | Pause playback                                             |
| `seekTo(position)`                      | Seek to a specific position                                |
| `setVolume(volume)`                     | Set volume (0.0 to 1.0)                                    |
| `updateDataSource(dataSource)`          | Update the current data source                             |
| `dispose()`                             | Clean up resources                                         |
| `currentState`                          | Get current player state                                   |
| `isPlaying`                             | Returns `true` if playing                                  |
| `isPaused`                              | Returns `true` if paused                                   |
| `isFinished`                            | Returns `true` if playback is finished                     |
| `getCurrentPosition()`                  | Get current playback position                              |
| `getTotalDuration()`                    | Get total video duration                                   |

## FastPixPlayerDataSource

Class to configure the streaming source.

| Parameter        | Type                 | Required | Description                                               |
| ---------------- | -------------------- | -------- | --------------------------------------------------------- |
| `playbackId`     | String               | Yes      | Unique identifier for your stream                         |
| `format`         | Enum                 | Yes      | Stream format (for example, `FastPixStreamingFormat.hls`) |
| `title`          | String               | No       | Optional title for the stream                             |
| `description`    | String               | No       | Optional description                                      |
| `customDomain`   | String               | No       | Custom streaming domain                                   |
| `token`          | String               | No       | Token for secured playback                                |
| `streamType`     | Boolean              | No       | `true` if live stream                                     |
| `headers`        | Map\<String, String> | No       | Custom HTTP headers                                       |
| `cacheEnabled`   | Boolean              | No       | Enable or disable caching                                 |
| `loop`           | Boolean              | No       | Enable or disable looping                                 |
| `qualityControl` | Object               | No       | Attach a `FastPixPlayerQualityControl` object             |

## FastPixPlayerConfiguration

Player behavior customization.

| Property                | Description             |
| ----------------------- | ----------------------- |
| `controlsConfiguration` | Configure UI controls   |
| `autoPlayConfiguration` | Autoplay behavior       |
| `qualityConfiguration`  | Quality selection logic |

## FastPixPlayerQualityControl

Advanced quality control.

| Property         | Description                                      |
| ---------------- | ------------------------------------------------ |
| `resolution`     | Target resolution (`auto`, `p360`, `p480`, etc.) |
| `minResolution`  | Minimum resolution                               |
| `maxResolution`  | Maximum resolution                               |
| `renditionOrder` | Rendition order (`default_`, `asc`, `desc`)      |

## Widgets

| Widget               | Description                                          |
| -------------------- | ---------------------------------------------------- |
| `FastPixPlayer`      | Core video player widget with full playback controls |
| `FastPixPlayerState` | Represents player state                              |

## Player states

| State         | Description                  |
| ------------- | ---------------------------- |
| `initialized` | Player created but not ready |
| `ready`       | Ready to play                |
| `playing`     | Actively playing             |
| `paused`      | Paused state                 |
| `buffering`   | Waiting for data             |
| `finished`    | Playback completed           |
| `error`       | Error encountered            |

## Display options (FastPixAspectRatio)

| Value       | Description        |
| ----------- | ------------------ |
| `fit`       | Fit to screen      |
| `ratio16x9` | Standard 16:9      |
| `ratio4x3`  | Classic 4:3        |
| `ratio1x1`  | Square 1:1         |
| `stretch`   | Fill entire screen |

## Autoplay settings

| Option     | Behavior               |
| ---------- | ---------------------- |
| `enabled`  | Always autoplay        |
| `disabled` | No autoplay            |
| `wifiOnly` | Autoplay only on Wi-Fi |

## Supported resolutions (FastPixResolution)

| Value   | Resolution |
| ------- | ---------- |
| `auto`  | Automatic  |
| `p360`  | 360p       |
| `p480`  | 480p       |
| `p720`  | 720p       |
| `p1080` | 1080p      |
| `p1440` | 1440p      |
| `p2160` | 2160p (4K) |