PHPackages ziggeo/ziggeophpsdk - 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. ziggeo/ziggeophpsdk ActiveLibrary[API Development](/categories/api) ziggeo/ziggeophpsdk =================== Ziggeo API (https://ziggeo.com) allows you to integrate video recording and playback with only two lines of code in your site, service or app. 0.2.0(3mo ago)6224.0k↓28.1%8[1 PRs](https://github.com/Ziggeo/ZiggeoPhpSdk/pulls)Apache-2.0PHPPHP >=8.3 Since Jan 11Pushed 3mo ago11 watchersCompare [ Source](https://github.com/Ziggeo/ZiggeoPhpSdk)[ Packagist](https://packagist.org/packages/ziggeo/ziggeophpsdk)[ RSS](/packages/ziggeo-ziggeophpsdk/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (8)Dependencies (1)Versions (30)Used By (0) Ziggeo's PHP Server SDK ======================= [](#ziggeos-php-server-sdk) latest version: **0.1.30** Index ----- [](#index) 1. [Why Ziggeo's PHP Server Side SDK?](#why-us) 2. [Prerequisites](#prerequisites) 1. [Download](#download) 2. [How to use](#how-to-use) 3. [Dependencies](#dependencies) 3. [Client-Side Integration](#codes-client-side) 4. [Server-Side Integration](#codes-server-side) 1. [Init](#codes-init) 2. [Available Methods](#codes-methods) 3. [Methods for Videos](#method-videos) 1. [Videos Index](#method-videos-index) 2. [Videos Count](#method-videos-count) 3. [Videos Get](#method-videos-get) 4. [Videos Get Bulk](#method-videos-get-bulk) 5. [Videos Stats Bulk](#method-videos-stats-bulk) 6. [Videos Download Video](#method-videos-download-video) 7. [Videos Download Image](#method-videos-download-image) 8. [Videos Get Stats](#method-videos-get-stats) 9. [Videos Push To Service](#method-videos-push-to-service) 10. [Videos Apply Effect](#method-videos-apply-effect) 11. [Videos Apply Meta](#method-videos-apply-meta) 12. [Videos Update](#method-videos-update) 13. [Videos Update Bulk](#method-videos-update-bulk) 14. [Videos Delete](#method-videos-delete) 15. [Videos Create](#method-videos-create) 16. [Videos Analytics](#method-videos-analytics) 4. [Methods for Streams](#method-streams) 1. [Streams Index](#method-streams-index) 2. [Streams Get](#method-streams-get) 3. [Streams Download Video](#method-streams-download-video) 4. [Streams Download Image](#method-streams-download-image) 5. [Streams Push To Service](#method-streams-push-to-service) 6. [Streams Delete](#method-streams-delete) 7. [Streams Create](#method-streams-create) 8. [Streams Attach Image](#method-streams-attach-image) 9. [Streams Attach Video](#method-streams-attach-video) 10. [Streams Attach Subtitle](#method-streams-attach-subtitle) 5. [Methods for Audios](#method-audios) 1. [Audios Index](#method-audios-index) 2. [Audios Count](#method-audios-count) 3. [Audios Get](#method-audios-get) 4. [Audios Get Bulk](#method-audios-get-bulk) 5. [Audios Download Audio](#method-audios-download-audio) 6. [Audios Update](#method-audios-update) 7. [Audios Update Bulk](#method-audios-update-bulk) 8. [Audios Delete](#method-audios-delete) 9. [Audios Create](#method-audios-create) 6. [Methods for Audio Streams](#method-audio-streams) 1. [Audio Streams Index](#method-audio-streams-index) 2. [Audio Streams Get](#method-audio-streams-get) 3. [Audio Streams Download Audio](#method-audio-streams-download-audio) 4. [Audio Streams Delete](#method-audio-streams-delete) 5. [Audio Streams Create](#method-audio-streams-create) 7. [Methods for Authtokens](#method-authtokens) 1. [Authtokens Get](#method-authtokens-get) 2. [Authtokens Update](#method-authtokens-update) 3. [Authtokens Delete](#method-authtokens-delete) 4. [Authtokens Create](#method-authtokens-create) 8. [Methods for Application](#method-application) 1. [Application Get](#method-application-get) 2. [Application Update](#method-application-update) 3. [Application Get Stats](#method-application-get-stats) 9. [Methods for Effect Profiles](#method-effect-profiles) 1. [Effect Profiles Create](#method-effect-profiles-create) 2. [Effect Profiles Index](#method-effect-profiles-index) 3. [Effect Profiles Get](#method-effect-profiles-get) 4. [Effect Profiles Delete](#method-effect-profiles-delete) 5. [Effect Profiles Update](#method-effect-profiles-update) 10. [Methods for Effect Profile Process](#method-effect-profile-process) 1. [Effect Profile Process Index](#method-effect-profile-process-index) 2. [Effect Profile Process Get](#method-effect-profile-process-get) 3. [Effect Profile Process Delete](#method-effect-profile-process-delete) 4. [Effect Profile Process Create Filter Process](#method-effect-profile-process-create-filter-process) 5. [Effect Profile Process Create Watermark Process](#method-effect-profile-process-create-watermark-process) 6. [Effect Profile Process Edit Watermark Process](#method-effect-profile-process-edit-watermark-process) 11. [Methods for Meta Profiles](#method-meta-profiles) 1. [Meta Profiles Create](#method-meta-profiles-create) 2. [Meta Profiles Index](#method-meta-profiles-index) 3. [Meta Profiles Get](#method-meta-profiles-get) 4. [Meta Profiles Delete](#method-meta-profiles-delete) 12. [Methods for Meta Profile Process](#method-meta-profile-process) 1. [Meta Profile Process Index](#method-meta-profile-process-index) 2. [Meta Profile Process Get](#method-meta-profile-process-get) 3. [Meta Profile Process Delete](#method-meta-profile-process-delete) 4. [Meta Profile Process Create Video Analysis Process](#method-meta-profile-process-create-video-analysis-process) 5. [Meta Profile Process Create Audio Transcription Process](#method-meta-profile-process-create-audio-transcription-process) 6. [Meta Profile Process Create Nsfw Process](#method-meta-profile-process-create-nsfw-process) 7. [Meta Profile Process Create Profanity Process](#method-meta-profile-process-create-profanity-process) 13. [Methods for Webhooks](#method-webhooks) 1. [Webhooks Create](#method-webhooks-create) 2. [Webhooks Confirm](#method-webhooks-confirm) 3. [Webhooks Delete](#method-webhooks-delete) 14. [Methods for Analytics](#method-analytics) 1. [Analytics Get](#method-analytics-get) 5. [Useful](#useful) 1. [Using with Docker](#docker) 2. [Testing Webhooks](#testing-webhooks) 6. [License](#license) Why Ziggeo's PHP Server Side SDK? -------------------------------------------------------------------- [](#why-ziggeos-php-server-side-sdk-) [Ziggeo](https://ziggeo.com) is a powerfull, whitelabel video SAAS with a goal to help people with their video revolution. And what better way to do it than with an award winning multimedia API. This server side SDK is designed to help you ease the communication with Ziggeo API. In that it allows you to privately communicate between your server and our server through requests of what you want to happen. It offers you pre-built functionality to call and manipulate and there are demos in /demos/ directory for you to check out and use as starting point. ### Who it is for? [](#who-it-is-for) 1. Do you have a system that requires calls to be made which should not be seen on client side? 2. Want to have an easier time handling the media as it comes to your server? 3. Want something that is simple and easy to use? 4. You need some powerful features high end video services provide? If any of the above is "Yes" then you are in the right place as this SDK is for you! Prerequisites ------------------------------------------------------- [](#prerequisites-) ### Download [](#download-) You will want to either download the SDK zip file or to pull it in as git repository into your own project. To clone it you would go into your project folder and then `php git clone https://github.com/Ziggeo/ZiggeoPhpSdk` ### How to use [](#how-to-use-) To start using the PHP SDK you would need to initialize the Ziggeo class with application token, private token and possibly encryption token. The token and keys can be found within the Ziggeo application once you log into your account, under Overview page. ### Dependencies [](#dependencies) If you are using Auth tokens you would need to install PHPSeclib library, at least for the client auth tokens to be created. If you are using Composer, you would do the following steps: 1. Run `composer require phpseclib/phpseclib` within the folder 2. Edit the Ziggeo.php file and add `require_once 'vendor/autoload.php';` at the very top. -PHPSeclib Client-Side Integration -------------------------------------------------------------------- [](#client-side-integration) For the client-side integration, you need to add these assets to your html file: ``` ``` Then, you need to specify your api token: ``` var ziggeoApplication = new ZiggeoApi.V2.Application({ token: "APPLICATION_TOKEN", webrtc_streaming_if_necessary: true, webrtc_on_mobile: true }); ``` You can specify other global options, [see here](https://ziggeo.com/docs). To fire up a recorder on your page, add: ``` ``` To embed a player for an existing video, add: ``` ``` For the full documentation, please visit [ziggeo.com](https://ziggeo.com/docs). Server-Side Integration -------------------------------------------------------------------- [](#server-side-integration) ### Initialize Ziggeo class in your code [](#initialize-ziggeo-class-in-your-code) You can integrate the Server SDK as follows: ```