PHPackages mesilov/kinescope-php-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. mesilov/kinescope-php-sdk ActiveLibrary[API Development](/categories/api) mesilov/kinescope-php-sdk ========================= Unofficial PHP SDK for Kinescope API - video management platform 0.5.0(1mo ago)11971[4 issues](https://github.com/mesilov/kinescope-php-sdk/issues)[1 PRs](https://github.com/mesilov/kinescope-php-sdk/pulls)MITPHPPHP >=8.4 Since Feb 6Pushed 1mo agoCompare [ Source](https://github.com/mesilov/kinescope-php-sdk)[ Packagist](https://packagist.org/packages/mesilov/kinescope-php-sdk)[ RSS](/packages/mesilov-kinescope-php-sdk/feed)WikiDiscussions main Synced today READMEChangelog (4)Dependencies (47)Versions (17)Used By (0) Kinescope PHP SDK ================= [](#kinescope-php-sdk) Unofficial PHP SDK for [Kinescope](https://kinescope.io) API — a video management platform for uploading, transcoding (up to 4K), protection, and delivery of video content. Requirements ------------ [](#requirements) - PHP >= 8.4 - Extensions: `ext-json`, `ext-curl`, `ext-mbstring` - A PSR-18 HTTP client for API requests (e.g., Guzzle or Symfony HTTP Client) - A PSR-7/PSR-17 implementation for API requests (e.g., `nyholm/psr7`) - Symfony components compatibility: `^5.4|^6.0|^7.0|^8.0` Installation ------------ [](#installation) ``` composer require mesilov/kinescope-php-sdk ``` You also need an HTTP client and PSR-7 implementation for Kinescope API requests. For example, with Guzzle: ``` composer require guzzlehttp/guzzle nyholm/psr7 ``` Quick Start ----------- [](#quick-start) ``` use Kinescope\Core\Credentials; use Kinescope\Services\ServiceFactory; // Create factory with API key $factory = new ServiceFactory(Credentials::fromString('your-api-key')); // Or read from KINESCOPE_API_KEY environment variable $factory = ServiceFactory::fromEnvironment(); // Use services $videos = $factory->videos()->list(); $projects = $factory->projects()->list(); $folders = $factory->folders()->list('project-id'); $playlists = $factory->playlists()->list(); $statistics = $factory->statistics()->forAccount(); ``` Available Services ------------------ [](#available-services) ServiceAccessDescriptionVideos`$factory->videos()`Read/list/search videosProjects`$factory->projects()`Read/list projectsFolders`$factory->folders()`Folder listing and tree navigationPlaylists`$factory->playlists()`Playlist and playlist-entities listingStatistics`$factory->statistics()`Done-video count and total duration aggregationIn-memory Video Search ---------------------- [](#in-memory-video-search) Use `InMemoryVideoSearch` when videos are already loaded and you need to map an external embed URL or lesson title back to a `VideoDTO` / video ID without another API request: ``` use Kinescope\Core\Pagination; use Kinescope\Services\Videos\InMemoryVideoSearch; $videoPage = $factory->videos()->list( pagination: new Pagination(perPage: Pagination::MAX_PER_PAGE), projectId: 'project-id', ); $videos = $videoPage->getData(); $search = new InMemoryVideoSearch(); $video = $search->byEmbedLink( $videos, 'https://kinescope.io/embed/oDko3nwPjHwpzmqUgxJmKB', ); $videoId = $video?->id; $matches = $search->byName($videos, '1.3 Сегментация и ёмкость рынка'); ``` `byEmbedLink()` accepts only the canonical `https://kinescope.io/embed/{slug}` form. URLs with query strings, fragments, trailing slashes, iframe HTML, and non-embed Kinescope links return `null`. `byName()` uses deterministic normalized substring matching: trim, multibyte lowercase, `ё`/`е` equivalence, whitespace collapsing, and one leading lesson-number prefix removal. It is not BM25, fuzzy search, stemming, or ranked full-text search. CLI --- [](#cli) The package ships a standalone Symfony Console entry point: ``` vendor/bin/kinescope list ``` Credentials are resolved from `KINESCOPE_API_KEY` or `--api-key` / `-k`. Read-only commands use singular resources and explicit actions: ``` # List projects or show one project vendor/bin/kinescope kinescope:project:list --format=table vendor/bin/kinescope kinescope:project:show 00000000-0000-0000-0000-000000000000 # List folders for a project or show one folder vendor/bin/kinescope kinescope:folder:list \ --project-id=00000000-0000-0000-0000-000000000000 \ --format=json vendor/bin/kinescope kinescope:folder:show 11111111-1111-1111-1111-111111111111 \ --project-id=00000000-0000-0000-0000-000000000000 # List videos for a project or folder, or show one video vendor/bin/kinescope kinescope:video:list \ --project-id=00000000-0000-0000-0000-000000000000 \ --folder-id=11111111-1111-1111-1111-111111111111 \ --format=json vendor/bin/kinescope kinescope:video:show 22222222-2222-2222-2222-222222222222 # Include sanitized asset summaries in video rows vendor/bin/kinescope kinescope:video:list \ --project-id=00000000-0000-0000-0000-000000000000 \ --include-assets \ --format=json # Inspect sanitized assets for one video vendor/bin/kinescope kinescope:video:asset:list 22222222-2222-2222-2222-222222222222 # Show account, project, or folder statistics vendor/bin/kinescope kinescope:statistics:show vendor/bin/kinescope kinescope:statistics:show \ --project-id=00000000-0000-0000-0000-000000000000 \ --format=json vendor/bin/kinescope kinescope:statistics:show \ --folder-id=11111111-1111-1111-1111-111111111111 ``` List commands support `table` or deterministic `json` output. Resource show commands print pretty JSON. `kinescope:statistics:show` supports `table` and `json`; without a selector it reports account-wide statistics, or it can be scoped with exactly one of `--project-id` or `--folder-id`. Asset output exposes `video_stream_size`, `video_stream_size_mb`, and booleans such as `has_url`, `has_download_link`, and `downloadable`; raw signed CDN URLs and download links are not printed by default. AI Agent Skill -------------- [](#ai-agent-skill) The package ships a `kinescope-cli` AI skill under `skills/kinescope-cli/` and declares it through `extra.skills.source` for [`llm/skills`](https://github.com/roxblnfk/skills). The skill helps coding agents use `vendor/bin/kinescope` safely: choose the current `kinescope:*` commands, prefer JSON for machine parsing, keep `KINESCOPE_API_KEY` out of output, and avoid exposing signed asset URLs. Install the Composer skill sync plugin in the consumer project: ``` composer require --dev llm/skills ``` Allow the plugin and trust this SDK as a skill donor: ``` { "config": { "allow-plugins": { "llm/skills": true } }, "extra": { "skills": { "trusted": ["mesilov/kinescope-php-sdk"], "aliases": [".claude/skills"] } } } ``` Then sync the skill: ``` composer skills:update mesilov/kinescope-php-sdk --alias=.claude/skills ``` `llm/skills` writes the real skill directory to `.agents/skills/` by default, which works for Codex-style repo skills. The `--alias=.claude/skills` option mirrors the same target for Claude Code without keeping a second copy. If you already added `mesilov/kinescope-php-sdk` to `extra.skills.trusted`, you can omit the package argument and run `composer skills:update`. DTO timestamp properties such as `createdAt`, `updatedAt`, `deletedAt`, and `generatedAt` are `Carbon\CarbonImmutable` instances. `toArray()` keeps API field names such as `created_at` and serializes date values as ISO JSON strings, except that asset stream-size metadata is exported as `video_stream_size` to avoid implying a real downloaded file size. `AssetDTO::$videoStreamSize` maps raw API `assets[].file_size`. This is Kinescope stream metadata, not a guaranteed downloaded file size on disk. For download validation, progress after HTTP metadata is available, disk checks, and storage accounting, use HTTP `Content-Length`, transfer-reported bytes, bytes written, or final `filesize()`. Statistics ---------- [](#statistics) ``` $account = $factory->statistics()->forAccount(); $project = $factory->statistics()->forProject('project-id'); $folder = $factory->statistics()->forFolder('folder-id'); printf( "%d done videos, %d seconds total\n", $account->videosCount, $account->getTotalSeconds(), ); ``` Video Downloader + Events ------------------------- [](#video-downloader--events) `VideoDownloader` fetches video metadata through `Videos`, selects the requested downloadable asset, and transfers the selected video bytes through a dedicated file-transfer boundary. By default it uses `CurlFileTransfer`, which writes directly to the in-progress file without materializing a PSR-18 response body. It also supports event subscriptions for the download lifecycle: - `DownloadStartedEvent` - `DownloadProgressEvent` - `DownloadCompletedEvent` - `DownloadFailedEvent` ``` use Kinescope\Enum\QualityPreference; use Kinescope\Event\Download\DownloadProgressEvent; use Kinescope\Services\Videos\VideoDownloader; $downloader = new VideoDownloader($factory->videos()); $downloader->on(DownloadProgressEvent::class, function (DownloadProgressEvent $event): void { printf("Progress: %.1f%%\n", $event->percent); }); $filePath = $downloader->downloadVideo( videoId: 'your-video-id', destinationDir: __DIR__ . '/downloads', quality: QualityPreference::BEST, ); ``` For custom transfer behavior, inject `FileTransferInterface`. The downloader still owns metadata lookup, asset selection, lifecycle events, `.part` handling, and completed-size validation: ``` use Kinescope\Services\Videos\Download\FileTransferInterface; use Kinescope\Services\Videos\Download\FileTransferProgress; use Kinescope\Services\Videos\Download\FileTransferRequest; use Kinescope\Services\Videos\Download\FileTransferResult; use Kinescope\Services\Videos\VideoDownloader; use RuntimeException; use Symfony\Component\Filesystem\Filesystem; final readonly class AppFileTransfer implements FileTransferInterface { public function transfer(FileTransferRequest $request, ?callable $onProgress = null): FileTransferResult { $source = fopen($request->url, 'rb'); $target = fopen($request->outputPath, 'wb'); $bytesWritten = 0; if ($source === false) { throw new RuntimeException('Transfer stream cannot be opened.'); } if ($target === false) { fclose($source); throw new RuntimeException('Transfer output cannot be opened.'); } try { while (! feof($source)) { $chunk = fread($source, 1024 * 1024); if ($chunk === false || $chunk === '') { continue; } $written = fwrite($target, $chunk); if ($written === false) { throw new RuntimeException('Transfer stream cannot be written.'); } $bytesWritten += $written; if ($onProgress !== null) { $onProgress(new FileTransferProgress($bytesWritten, $request->expectedBytes)); } } } finally { fclose($source); fclose($target); } return new FileTransferResult($request->outputPath, $bytesWritten, $request->expectedBytes); } } $downloader = new VideoDownloader( videos: $factory->videos(), filesystem: new Filesystem(), fileTransfer: new AppFileTransfer(), ); ``` Symfony applications may implement this interface with `HttpClientInterface::request()` using `buffer: false` and `stream()`; `symfony/http-client` is not required by the SDK itself. Default transfer policy: - cURL `GET`, HTTP/HTTPS only, follows up to 5 HTTP/HTTPS redirects. - TLS peer and host verification are enabled. - Only final `2xx` HTTP statuses are successful. - Connection setup timeout is 10 seconds; there is no fixed total transfer timeout. - Stalled transfers fail below 1024 bytes/sec for 60 seconds. - Kinescope API bearer credentials are not sent to video download URLs automatically; only explicit `FileTransferRequest` headers are used. - Progress events are throttled by `VideoDownloader` at 10 MiB intervals. - Downloads are written to a sibling `.part` file first, renamed only after the written byte count matches the transfer-reported byte count or, when absent, the selected asset size, and removed on handled transfer or validation failures. Development ----------- [](#development) ### Setup [](#setup) ``` # Initialize project (first run) make docker-init # Start Docker environment make docker-up # Install dependencies make composer-install ``` ### Testing [](#testing) ``` # Unit tests make test-unit # Integration tests (requires API key) make test-integration # Full test suite make test ``` ### Code Quality [](#code-quality) ``` # Run all linters make lint-all # Static analysis make lint-phpstan # Code style check (dry-run) make lint-cs-fixer # Fix code style make lint-cs-fixer-fix ``` License ------- [](#license) MIT. See [LICENSE](LICENSE) for details. Changelog --------- [](#changelog) See [CHANGELOG.md](CHANGELOG.md) for release history and migration notes. ### Health Score 39 — LowBetter than 84% of packages Maintenance71 Regular maintenance activity Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity50 Maturing project, gaining track record Bus Factor1 Top contributor holds 98.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~33 days Total 4 Last Release 45d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/f73ba25f28c6c24fa54e4d607e0a20800e29633f478eece904a62f5f863f72ed?d=identicon)[mesilov](/maintainers/mesilov) --- Top Contributors [![mesilov](https://avatars.githubusercontent.com/u/1843965?v=4)](https://github.com/mesilov "mesilov (70 commits)")[![claude](https://avatars.githubusercontent.com/u/81847?v=4)](https://github.com/claude "claude (1 commits)") --- Tags apisdkstreamingvideovodlivekinescope ### Code Quality TestsPHPUnit Static AnalysisPHPStan, Rector Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/mesilov-kinescope-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/mesilov-kinescope-php-sdk/health.svg)](https://phpackages.com/packages/mesilov-kinescope-php-sdk) ``` ### Alternatives [flow-php/flow PHP ETL - Extract Transform Load - Data processing framework 85036.3k](/packages/flow-php-flow)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M737](/packages/sylius-sylius)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[drupal/core-recommended Locked core dependencies; require this project INSTEAD OF drupal/core. 6942.5M421](/packages/drupal-core-recommended)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M574](/packages/shopware-core)[typo3/cms TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL. 1.2k1.9M122](/packages/typo3-cms) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)