https://github.com/muxinc/mux-php
Official Mux API wrapper for PHP projects, supporting both Mux Data and Mux Video.
https://github.com/muxinc/mux-php
mux php video video-analytics video-processing video-streaming
Last synced: 6 months ago
JSON representation
Official Mux API wrapper for PHP projects, supporting both Mux Data and Mux Video.
- Host: GitHub
- URL: https://github.com/muxinc/mux-php
- Owner: muxinc
- License: mit
- Created: 2019-03-18T21:01:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T13:42:42.000Z (over 1 year ago)
- Last Synced: 2024-04-13T19:33:36.474Z (over 1 year ago)
- Topics: mux, php, video, video-analytics, video-processing, video-streaming
- Language: PHP
- Homepage:
- Size: 1.37 MB
- Stars: 36
- Watchers: 37
- Forks: 29
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README

Packagist |
Mux Docs |
Mux API Reference# Mux PHP
Official Mux API wrapper for PHP projects, supporting both Mux Data and Mux Video.
[Mux Video](https://mux.com/video) is an API-first platform, powered by data and designed by video experts to make beautiful video possible for every development team.
[Mux Data](https://mux.com/data) is a platform for monitoring your video streaming performance with just a few lines of code. Get in-depth quality of service analytics on web, mobile, and OTT devices.
Not familiar with Mux? Check out https://mux.com/ for more information.
## Requirements
PHP 7.1 or higher.
Dependencies are managed using composer.## Installation
We publish Mux PHP to [Packagist](https://packagist.org/packages/muxinc/mux-php). You should depend on Mux PHP by adding us to your composer.json:
```json
{
"require": {
"muxinc/mux-php": ">=0.0.1"
}
}
```
Then install your dependencies:```sh
composer install
```And then autoload in your code:
```php
require_once 'vendor/autoload.php';
```### Manual Installation
**PLEASE NOTE:** We don't really recommend manual installation and our ability to help if this route doesn't work is minimal. We include this mostly for purposes of completeness.
Download the files and include `autoload.php`:
```php
setUsername(getenv('MUX_TOKEN_ID'))
->setPassword(getenv('MUX_TOKEN_SECRET'));// API Client Initialization
$assetsApi = new MuxPhp\Api\AssetsApi(
new GuzzleHttp\Client(),
$config
);// Create Asset Request
$input = new MuxPhp\Models\InputSettings(["url" => "https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4"]);
$createAssetRequest = new MuxPhp\Models\CreateAssetRequest(["input" => $input, "playback_policy" => [MuxPhp\Models\PlaybackPolicy::_PUBLIC] ]);// Ingest
$result = $assetsApi->createAsset($createAssetRequest);// Print URL
print "Playback URL: https://stream.mux.com/" . $result->getData()->getPlaybackIds()[0]->getId() . ".m3u8\n";
```Be sure to also checkout the [examples directory](examples/):
* [Create an Asset, wait for it to become availiable, and print its playback URL](examples/video/ingest.php)There's also example usage of every API call (also used for testing):
* [Video](examples/video/)
* [Assets](examples/video/exercise-assets.php)
* [Live Streams](examples/video/exercise-live-streams.php)
* [Signing Keys](examples/video/exercise-signing-keys.php)
* [Uploads](examples/video/exercise-uploads.php)
* [Data](examples/data/)
* [Errors](examples/data/exercise-errors.php)
* [Exports](examples/data/exercise-exports.php)
* [Filters](examples/data/exercise-filters.php)
* [Metrics](examples/data/exercise-metrics.php)
* [Video Views](examples/data/exercise-video-views.php)## Documentation
[Be sure to check out the documentation in the `docs` directory.](docs/)
## Issues
If you run into problems, [please raise a GitHub issue](https://github.com/muxinc/mux-php/issues). We'll take a look as soon as possible.
## Contributing
We now accept PRs against this package! Please make your modifications to the templates in `gen/templates`, not the code itself, or [please open an issue.](https://github.com/muxinc/mux-ruby/issues)
## License
[MIT License.](LICENSE) Copyright 2019 Mux, Inc.
## API Endpoints
All URIs are relative to *https://api.mux.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssetsApi* | [**createAsset**](docs/Api/AssetsApi.md#createasset) | **POST** /video/v1/assets | Create an asset
*AssetsApi* | [**createAssetPlaybackId**](docs/Api/AssetsApi.md#createassetplaybackid) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
*AssetsApi* | [**createAssetStaticRendition**](docs/Api/AssetsApi.md#createassetstaticrendition) | **POST** /video/v1/assets/{ASSET_ID}/static-renditions | Create a static rendition for an asset
*AssetsApi* | [**createAssetTrack**](docs/Api/AssetsApi.md#createassettrack) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
*AssetsApi* | [**deleteAsset**](docs/Api/AssetsApi.md#deleteasset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
*AssetsApi* | [**deleteAssetPlaybackId**](docs/Api/AssetsApi.md#deleteassetplaybackid) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
*AssetsApi* | [**deleteAssetStaticRendition**](docs/Api/AssetsApi.md#deleteassetstaticrendition) | **DELETE** /video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID} | Delete a single static rendition for an asset
*AssetsApi* | [**deleteAssetTrack**](docs/Api/AssetsApi.md#deleteassettrack) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
*AssetsApi* | [**generateAssetTrackSubtitles**](docs/Api/AssetsApi.md#generateassettracksubtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles
*AssetsApi* | [**getAsset**](docs/Api/AssetsApi.md#getasset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
*AssetsApi* | [**getAssetInputInfo**](docs/Api/AssetsApi.md#getassetinputinfo) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
*AssetsApi* | [**getAssetPlaybackId**](docs/Api/AssetsApi.md#getassetplaybackid) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
*AssetsApi* | [**listAssets**](docs/Api/AssetsApi.md#listassets) | **GET** /video/v1/assets | List assets
*AssetsApi* | [**updateAsset**](docs/Api/AssetsApi.md#updateasset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an asset
*AssetsApi* | [**updateAssetMasterAccess**](docs/Api/AssetsApi.md#updateassetmasteraccess) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
*AssetsApi* | [**updateAssetMp4Support**](docs/Api/AssetsApi.md#updateassetmp4support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
*DRMConfigurationsApi* | [**getDrmConfiguration**](docs/Api/DRMConfigurationsApi.md#getdrmconfiguration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration
*DRMConfigurationsApi* | [**listDrmConfigurations**](docs/Api/DRMConfigurationsApi.md#listdrmconfigurations) | **GET** /video/v1/drm-configurations | List DRM Configurations
*DeliveryUsageApi* | [**listDeliveryUsage**](docs/Api/DeliveryUsageApi.md#listdeliveryusage) | **GET** /video/v1/delivery-usage | List Usage
*DimensionsApi* | [**listDimensionValues**](docs/Api/DimensionsApi.md#listdimensionvalues) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
*DimensionsApi* | [**listDimensions**](docs/Api/DimensionsApi.md#listdimensions) | **GET** /data/v1/dimensions | List Dimensions
*DirectUploadsApi* | [**cancelDirectUpload**](docs/Api/DirectUploadsApi.md#canceldirectupload) | **PUT** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload
*DirectUploadsApi* | [**createDirectUpload**](docs/Api/DirectUploadsApi.md#createdirectupload) | **POST** /video/v1/uploads | Create a new direct upload URL
*DirectUploadsApi* | [**getDirectUpload**](docs/Api/DirectUploadsApi.md#getdirectupload) | **GET** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info
*DirectUploadsApi* | [**listDirectUploads**](docs/Api/DirectUploadsApi.md#listdirectuploads) | **GET** /video/v1/uploads | List direct uploads
*ErrorsApi* | [**listErrors**](docs/Api/ErrorsApi.md#listerrors) | **GET** /data/v1/errors | List Errors
*ExportsApi* | [**listExports**](docs/Api/ExportsApi.md#listexports) | **GET** /data/v1/exports | List property video view export links
*ExportsApi* | [**listExportsViews**](docs/Api/ExportsApi.md#listexportsviews) | **GET** /data/v1/exports/views | List available property view exports
*FiltersApi* | [**listFilterValues**](docs/Api/FiltersApi.md#listfiltervalues) | **GET** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter
*FiltersApi* | [**listFilters**](docs/Api/FiltersApi.md#listfilters) | **GET** /data/v1/filters | List Filters
*IncidentsApi* | [**getIncident**](docs/Api/IncidentsApi.md#getincident) | **GET** /data/v1/incidents/{INCIDENT_ID} | Get an Incident
*IncidentsApi* | [**listIncidents**](docs/Api/IncidentsApi.md#listincidents) | **GET** /data/v1/incidents | List Incidents
*IncidentsApi* | [**listRelatedIncidents**](docs/Api/IncidentsApi.md#listrelatedincidents) | **GET** /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents
*LiveStreamsApi* | [**createLiveStream**](docs/Api/LiveStreamsApi.md#createlivestream) | **POST** /video/v1/live-streams | Create a live stream
*LiveStreamsApi* | [**createLiveStreamPlaybackId**](docs/Api/LiveStreamsApi.md#createlivestreamplaybackid) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID
*LiveStreamsApi* | [**createLiveStreamSimulcastTarget**](docs/Api/LiveStreamsApi.md#createlivestreamsimulcasttarget) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
*LiveStreamsApi* | [**deleteLiveStream**](docs/Api/LiveStreamsApi.md#deletelivestream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
*LiveStreamsApi* | [**deleteLiveStreamNewAssetSettingsStaticRenditions**](docs/Api/LiveStreamsApi.md#deletelivestreamnewassetsettingsstaticrenditions) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions | Delete a live stream's static renditions setting for new assets
*LiveStreamsApi* | [**deleteLiveStreamPlaybackId**](docs/Api/LiveStreamsApi.md#deletelivestreamplaybackid) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
*LiveStreamsApi* | [**deleteLiveStreamSimulcastTarget**](docs/Api/LiveStreamsApi.md#deletelivestreamsimulcasttarget) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a live stream simulcast target
*LiveStreamsApi* | [**disableLiveStream**](docs/Api/LiveStreamsApi.md#disablelivestream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
*LiveStreamsApi* | [**enableLiveStream**](docs/Api/LiveStreamsApi.md#enablelivestream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
*LiveStreamsApi* | [**getLiveStream**](docs/Api/LiveStreamsApi.md#getlivestream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
*LiveStreamsApi* | [**getLiveStreamPlaybackId**](docs/Api/LiveStreamsApi.md#getlivestreamplaybackid) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID
*LiveStreamsApi* | [**getLiveStreamSimulcastTarget**](docs/Api/LiveStreamsApi.md#getlivestreamsimulcasttarget) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a live stream simulcast target
*LiveStreamsApi* | [**listLiveStreams**](docs/Api/LiveStreamsApi.md#listlivestreams) | **GET** /video/v1/live-streams | List live streams
*LiveStreamsApi* | [**resetStreamKey**](docs/Api/LiveStreamsApi.md#resetstreamkey) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream's stream key
*LiveStreamsApi* | [**signalLiveStreamComplete**](docs/Api/LiveStreamsApi.md#signallivestreamcomplete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
*LiveStreamsApi* | [**updateLiveStream**](docs/Api/LiveStreamsApi.md#updatelivestream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream
*LiveStreamsApi* | [**updateLiveStreamEmbeddedSubtitles**](docs/Api/LiveStreamsApi.md#updatelivestreamembeddedsubtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles
*LiveStreamsApi* | [**updateLiveStreamGeneratedSubtitles**](docs/Api/LiveStreamsApi.md#updatelivestreamgeneratedsubtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles | Update a live stream's generated subtitles
*LiveStreamsApi* | [**updateLiveStreamNewAssetSettingsStaticRenditions**](docs/Api/LiveStreamsApi.md#updatelivestreamnewassetsettingsstaticrenditions) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions | Update live stream static renditions for new assets
*MetricsApi* | [**getMetricTimeseriesData**](docs/Api/MetricsApi.md#getmetrictimeseriesdata) | **GET** /data/v1/metrics/{METRIC_ID}/timeseries | Get metric timeseries data
*MetricsApi* | [**getOverallValues**](docs/Api/MetricsApi.md#getoverallvalues) | **GET** /data/v1/metrics/{METRIC_ID}/overall | Get Overall values
*MetricsApi* | [**listAllMetricValues**](docs/Api/MetricsApi.md#listallmetricvalues) | **GET** /data/v1/metrics/comparison | List all metric values
*MetricsApi* | [**listBreakdownValues**](docs/Api/MetricsApi.md#listbreakdownvalues) | **GET** /data/v1/metrics/{METRIC_ID}/breakdown | List breakdown values
*MetricsApi* | [**listInsights**](docs/Api/MetricsApi.md#listinsights) | **GET** /data/v1/metrics/{METRIC_ID}/insights | List Insights
*MonitoringApi* | [**getMonitoringBreakdown**](docs/Api/MonitoringApi.md#getmonitoringbreakdown) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown | Get Monitoring Breakdown
*MonitoringApi* | [**getMonitoringBreakdownTimeseries**](docs/Api/MonitoringApi.md#getmonitoringbreakdowntimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries | Get Monitoring Breakdown Timeseries
*MonitoringApi* | [**getMonitoringHistogramTimeseries**](docs/Api/MonitoringApi.md#getmonitoringhistogramtimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Monitoring Histogram Timeseries
*MonitoringApi* | [**getMonitoringTimeseries**](docs/Api/MonitoringApi.md#getmonitoringtimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries | Get Monitoring Timeseries
*MonitoringApi* | [**listMonitoringDimensions**](docs/Api/MonitoringApi.md#listmonitoringdimensions) | **GET** /data/v1/monitoring/dimensions | List Monitoring Dimensions
*MonitoringApi* | [**listMonitoringMetrics**](docs/Api/MonitoringApi.md#listmonitoringmetrics) | **GET** /data/v1/monitoring/metrics | List Monitoring Metrics
*PlaybackIDApi* | [**getAssetOrLivestreamId**](docs/Api/PlaybackIDApi.md#getassetorlivestreamid) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an asset or live stream ID
*PlaybackRestrictionsApi* | [**createPlaybackRestriction**](docs/Api/PlaybackRestrictionsApi.md#createplaybackrestriction) | **POST** /video/v1/playback-restrictions | Create a Playback Restriction
*PlaybackRestrictionsApi* | [**deletePlaybackRestriction**](docs/Api/PlaybackRestrictionsApi.md#deleteplaybackrestriction) | **DELETE** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Delete a Playback Restriction
*PlaybackRestrictionsApi* | [**getPlaybackRestriction**](docs/Api/PlaybackRestrictionsApi.md#getplaybackrestriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction
*PlaybackRestrictionsApi* | [**listPlaybackRestrictions**](docs/Api/PlaybackRestrictionsApi.md#listplaybackrestrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions
*PlaybackRestrictionsApi* | [**updateReferrerDomainRestriction**](docs/Api/PlaybackRestrictionsApi.md#updatereferrerdomainrestriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction
*PlaybackRestrictionsApi* | [**updateUserAgentRestriction**](docs/Api/PlaybackRestrictionsApi.md#updateuseragentrestriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent | Update the User Agent Restriction
*RealTimeApi* | [**getRealtimeBreakdown**](docs/Api/RealTimeApi.md#getrealtimebreakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown
*RealTimeApi* | [**getRealtimeHistogramTimeseries**](docs/Api/RealTimeApi.md#getrealtimehistogramtimeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries
*RealTimeApi* | [**getRealtimeTimeseries**](docs/Api/RealTimeApi.md#getrealtimetimeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries
*RealTimeApi* | [**listRealtimeDimensions**](docs/Api/RealTimeApi.md#listrealtimedimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions
*RealTimeApi* | [**listRealtimeMetrics**](docs/Api/RealTimeApi.md#listrealtimemetrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics
*SigningKeysApi* | [**createSigningKey**](docs/Api/SigningKeysApi.md#createsigningkey) | **POST** /system/v1/signing-keys | Create a signing key
*SigningKeysApi* | [**deleteSigningKey**](docs/Api/SigningKeysApi.md#deletesigningkey) | **DELETE** /system/v1/signing-keys/{SIGNING_KEY_ID} | Delete a signing key
*SigningKeysApi* | [**getSigningKey**](docs/Api/SigningKeysApi.md#getsigningkey) | **GET** /system/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a signing key
*SigningKeysApi* | [**listSigningKeys**](docs/Api/SigningKeysApi.md#listsigningkeys) | **GET** /system/v1/signing-keys | List signing keys
*TranscriptionVocabulariesApi* | [**createTranscriptionVocabulary**](docs/Api/TranscriptionVocabulariesApi.md#createtranscriptionvocabulary) | **POST** /video/v1/transcription-vocabularies | Create a Transcription Vocabulary
*TranscriptionVocabulariesApi* | [**deleteTranscriptionVocabulary**](docs/Api/TranscriptionVocabulariesApi.md#deletetranscriptionvocabulary) | **DELETE** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Delete a Transcription Vocabulary
*TranscriptionVocabulariesApi* | [**getTranscriptionVocabulary**](docs/Api/TranscriptionVocabulariesApi.md#gettranscriptionvocabulary) | **GET** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Retrieve a Transcription Vocabulary
*TranscriptionVocabulariesApi* | [**listTranscriptionVocabularies**](docs/Api/TranscriptionVocabulariesApi.md#listtranscriptionvocabularies) | **GET** /video/v1/transcription-vocabularies | List Transcription Vocabularies
*TranscriptionVocabulariesApi* | [**updateTranscriptionVocabulary**](docs/Api/TranscriptionVocabulariesApi.md#updatetranscriptionvocabulary) | **PUT** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Update a Transcription Vocabulary
*URLSigningKeysApi* | [**createUrlSigningKey**](docs/Api/URLSigningKeysApi.md#createurlsigningkey) | **POST** /video/v1/signing-keys | Create a URL signing key
*URLSigningKeysApi* | [**deleteUrlSigningKey**](docs/Api/URLSigningKeysApi.md#deleteurlsigningkey) | **DELETE** /video/v1/signing-keys/{SIGNING_KEY_ID} | Delete a URL signing key
*URLSigningKeysApi* | [**getUrlSigningKey**](docs/Api/URLSigningKeysApi.md#geturlsigningkey) | **GET** /video/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a URL signing key
*URLSigningKeysApi* | [**listUrlSigningKeys**](docs/Api/URLSigningKeysApi.md#listurlsigningkeys) | **GET** /video/v1/signing-keys | List URL signing keys
*VideoViewsApi* | [**getVideoView**](docs/Api/VideoViewsApi.md#getvideoview) | **GET** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View
*VideoViewsApi* | [**listVideoViews**](docs/Api/VideoViewsApi.md#listvideoviews) | **GET** /data/v1/video-views | List Video Views
*WebInputsApi* | [**createWebInput**](docs/Api/WebInputsApi.md#createwebinput) | **POST** /video/v1/web-inputs | Create a new Web Input
*WebInputsApi* | [**deleteWebInput**](docs/Api/WebInputsApi.md#deletewebinput) | **DELETE** /video/v1/web-inputs/{WEB_INPUT_ID} | Delete a Web Input
*WebInputsApi* | [**getWebInput**](docs/Api/WebInputsApi.md#getwebinput) | **GET** /video/v1/web-inputs/{WEB_INPUT_ID} | Retrieve a Web Input
*WebInputsApi* | [**launchWebInput**](docs/Api/WebInputsApi.md#launchwebinput) | **PUT** /video/v1/web-inputs/{WEB_INPUT_ID}/launch | Launch a Web Input
*WebInputsApi* | [**listWebInputs**](docs/Api/WebInputsApi.md#listwebinputs) | **GET** /video/v1/web-inputs | List Web Inputs
*WebInputsApi* | [**reloadWebInput**](docs/Api/WebInputsApi.md#reloadwebinput) | **PUT** /video/v1/web-inputs/{WEB_INPUT_ID}/reload | Reload a Web Input
*WebInputsApi* | [**shutdownWebInput**](docs/Api/WebInputsApi.md#shutdownwebinput) | **PUT** /video/v1/web-inputs/{WEB_INPUT_ID}/shutdown | Shut down a Web Input
*WebInputsApi* | [**updateWebInputUrl**](docs/Api/WebInputsApi.md#updatewebinputurl) | **PUT** /video/v1/web-inputs/{WEB_INPUT_ID}/url | Update Web Input URL## Models
- [AbridgedVideoView](docs/Model/AbridgedVideoView.md)
- [Asset](docs/Model/Asset.md)
- [AssetErrors](docs/Model/AssetErrors.md)
- [AssetGeneratedSubtitleSettings](docs/Model/AssetGeneratedSubtitleSettings.md)
- [AssetMaster](docs/Model/AssetMaster.md)
- [AssetMetadata](docs/Model/AssetMetadata.md)
- [AssetNonStandardInputReasons](docs/Model/AssetNonStandardInputReasons.md)
- [AssetRecordingTimes](docs/Model/AssetRecordingTimes.md)
- [AssetResponse](docs/Model/AssetResponse.md)
- [AssetStaticRenditions](docs/Model/AssetStaticRenditions.md)
- [BreakdownValue](docs/Model/BreakdownValue.md)
- [CreateAssetRequest](docs/Model/CreateAssetRequest.md)
- [CreateLiveStreamRequest](docs/Model/CreateLiveStreamRequest.md)
- [CreatePlaybackIDRequest](docs/Model/CreatePlaybackIDRequest.md)
- [CreatePlaybackIDResponse](docs/Model/CreatePlaybackIDResponse.md)
- [CreatePlaybackRestrictionRequest](docs/Model/CreatePlaybackRestrictionRequest.md)
- [CreateSimulcastTargetRequest](docs/Model/CreateSimulcastTargetRequest.md)
- [CreateStaticRenditionRequest](docs/Model/CreateStaticRenditionRequest.md)
- [CreateStaticRenditionResponse](docs/Model/CreateStaticRenditionResponse.md)
- [CreateTrackRequest](docs/Model/CreateTrackRequest.md)
- [CreateTrackResponse](docs/Model/CreateTrackResponse.md)
- [CreateTranscriptionVocabularyRequest](docs/Model/CreateTranscriptionVocabularyRequest.md)
- [CreateUploadRequest](docs/Model/CreateUploadRequest.md)
- [CreateWebInputRequest](docs/Model/CreateWebInputRequest.md)
- [DRMConfiguration](docs/Model/DRMConfiguration.md)
- [DRMConfigurationResponse](docs/Model/DRMConfigurationResponse.md)
- [DeliveryReport](docs/Model/DeliveryReport.md)
- [DeliveryReportDeliveredSecondsByResolution](docs/Model/DeliveryReportDeliveredSecondsByResolution.md)
- [DimensionValue](docs/Model/DimensionValue.md)
- [DisableLiveStreamResponse](docs/Model/DisableLiveStreamResponse.md)
- [EnableLiveStreamResponse](docs/Model/EnableLiveStreamResponse.md)
- [Error](docs/Model/Error.md)
- [ExportDate](docs/Model/ExportDate.md)
- [ExportFile](docs/Model/ExportFile.md)
- [FilterValue](docs/Model/FilterValue.md)
- [GenerateTrackSubtitlesRequest](docs/Model/GenerateTrackSubtitlesRequest.md)
- [GenerateTrackSubtitlesResponse](docs/Model/GenerateTrackSubtitlesResponse.md)
- [GetAssetInputInfoResponse](docs/Model/GetAssetInputInfoResponse.md)
- [GetAssetOrLiveStreamIdResponse](docs/Model/GetAssetOrLiveStreamIdResponse.md)
- [GetAssetOrLiveStreamIdResponseData](docs/Model/GetAssetOrLiveStreamIdResponseData.md)
- [GetAssetOrLiveStreamIdResponseDataObject](docs/Model/GetAssetOrLiveStreamIdResponseDataObject.md)
- [GetAssetPlaybackIDResponse](docs/Model/GetAssetPlaybackIDResponse.md)
- [GetLiveStreamPlaybackIDResponse](docs/Model/GetLiveStreamPlaybackIDResponse.md)
- [GetMetricTimeseriesDataResponse](docs/Model/GetMetricTimeseriesDataResponse.md)
- [GetMonitoringBreakdownResponse](docs/Model/GetMonitoringBreakdownResponse.md)
- [GetMonitoringBreakdownTimeseriesResponse](docs/Model/GetMonitoringBreakdownTimeseriesResponse.md)
- [GetMonitoringHistogramTimeseriesResponse](docs/Model/GetMonitoringHistogramTimeseriesResponse.md)
- [GetMonitoringHistogramTimeseriesResponseMeta](docs/Model/GetMonitoringHistogramTimeseriesResponseMeta.md)
- [GetMonitoringTimeseriesResponse](docs/Model/GetMonitoringTimeseriesResponse.md)
- [GetOverallValuesResponse](docs/Model/GetOverallValuesResponse.md)
- [GetRealTimeBreakdownResponse](docs/Model/GetRealTimeBreakdownResponse.md)
- [GetRealTimeHistogramTimeseriesResponse](docs/Model/GetRealTimeHistogramTimeseriesResponse.md)
- [GetRealTimeHistogramTimeseriesResponseMeta](docs/Model/GetRealTimeHistogramTimeseriesResponseMeta.md)
- [GetRealTimeTimeseriesResponse](docs/Model/GetRealTimeTimeseriesResponse.md)
- [Incident](docs/Model/Incident.md)
- [IncidentBreakdown](docs/Model/IncidentBreakdown.md)
- [IncidentNotification](docs/Model/IncidentNotification.md)
- [IncidentNotificationRule](docs/Model/IncidentNotificationRule.md)
- [IncidentResponse](docs/Model/IncidentResponse.md)
- [InputFile](docs/Model/InputFile.md)
- [InputInfo](docs/Model/InputInfo.md)
- [InputSettings](docs/Model/InputSettings.md)
- [InputSettingsOverlaySettings](docs/Model/InputSettingsOverlaySettings.md)
- [InputTrack](docs/Model/InputTrack.md)
- [Insight](docs/Model/Insight.md)
- [LaunchWebInputResponse](docs/Model/LaunchWebInputResponse.md)
- [ListAllMetricValuesResponse](docs/Model/ListAllMetricValuesResponse.md)
- [ListAssetsResponse](docs/Model/ListAssetsResponse.md)
- [ListBreakdownValuesResponse](docs/Model/ListBreakdownValuesResponse.md)
- [ListBreakdownValuesResponseMeta](docs/Model/ListBreakdownValuesResponseMeta.md)
- [ListDRMConfigurationsResponse](docs/Model/ListDRMConfigurationsResponse.md)
- [ListDeliveryUsageResponse](docs/Model/ListDeliveryUsageResponse.md)
- [ListDimensionValuesResponse](docs/Model/ListDimensionValuesResponse.md)
- [ListDimensionsResponse](docs/Model/ListDimensionsResponse.md)
- [ListErrorsResponse](docs/Model/ListErrorsResponse.md)
- [ListExportsResponse](docs/Model/ListExportsResponse.md)
- [ListFilterValuesResponse](docs/Model/ListFilterValuesResponse.md)
- [ListFiltersResponse](docs/Model/ListFiltersResponse.md)
- [ListFiltersResponseData](docs/Model/ListFiltersResponseData.md)
- [ListIncidentsResponse](docs/Model/ListIncidentsResponse.md)
- [ListInsightsResponse](docs/Model/ListInsightsResponse.md)
- [ListLiveStreamsResponse](docs/Model/ListLiveStreamsResponse.md)
- [ListMonitoringDimensionsResponse](docs/Model/ListMonitoringDimensionsResponse.md)
- [ListMonitoringDimensionsResponseData](docs/Model/ListMonitoringDimensionsResponseData.md)
- [ListMonitoringMetricsResponse](docs/Model/ListMonitoringMetricsResponse.md)
- [ListPlaybackRestrictionsResponse](docs/Model/ListPlaybackRestrictionsResponse.md)
- [ListRealTimeDimensionsResponse](docs/Model/ListRealTimeDimensionsResponse.md)
- [ListRealTimeMetricsResponse](docs/Model/ListRealTimeMetricsResponse.md)
- [ListRelatedIncidentsResponse](docs/Model/ListRelatedIncidentsResponse.md)
- [ListSigningKeysResponse](docs/Model/ListSigningKeysResponse.md)
- [ListTranscriptionVocabulariesResponse](docs/Model/ListTranscriptionVocabulariesResponse.md)
- [ListUploadsResponse](docs/Model/ListUploadsResponse.md)
- [ListVideoViewExportsResponse](docs/Model/ListVideoViewExportsResponse.md)
- [ListVideoViewsResponse](docs/Model/ListVideoViewsResponse.md)
- [ListWebInputsResponse](docs/Model/ListWebInputsResponse.md)
- [LiveStream](docs/Model/LiveStream.md)
- [LiveStreamEmbeddedSubtitleSettings](docs/Model/LiveStreamEmbeddedSubtitleSettings.md)
- [LiveStreamGeneratedSubtitleSettings](docs/Model/LiveStreamGeneratedSubtitleSettings.md)
- [LiveStreamResponse](docs/Model/LiveStreamResponse.md)
- [LiveStreamStatus](docs/Model/LiveStreamStatus.md)
- [Metric](docs/Model/Metric.md)
- [MonitoringBreakdownTimeseriesDatapoint](docs/Model/MonitoringBreakdownTimeseriesDatapoint.md)
- [MonitoringBreakdownTimeseriesValues](docs/Model/MonitoringBreakdownTimeseriesValues.md)
- [MonitoringBreakdownValue](docs/Model/MonitoringBreakdownValue.md)
- [MonitoringHistogramTimeseriesBucket](docs/Model/MonitoringHistogramTimeseriesBucket.md)
- [MonitoringHistogramTimeseriesBucketValues](docs/Model/MonitoringHistogramTimeseriesBucketValues.md)
- [MonitoringHistogramTimeseriesDatapoint](docs/Model/MonitoringHistogramTimeseriesDatapoint.md)
- [MonitoringTimeseriesDatapoint](docs/Model/MonitoringTimeseriesDatapoint.md)
- [NotificationRule](docs/Model/NotificationRule.md)
- [OverallValues](docs/Model/OverallValues.md)
- [PlaybackID](docs/Model/PlaybackID.md)
- [PlaybackPolicy](docs/Model/PlaybackPolicy.md)
- [PlaybackRestriction](docs/Model/PlaybackRestriction.md)
- [PlaybackRestrictionResponse](docs/Model/PlaybackRestrictionResponse.md)
- [RealTimeBreakdownValue](docs/Model/RealTimeBreakdownValue.md)
- [RealTimeHistogramTimeseriesBucket](docs/Model/RealTimeHistogramTimeseriesBucket.md)
- [RealTimeHistogramTimeseriesBucketValues](docs/Model/RealTimeHistogramTimeseriesBucketValues.md)
- [RealTimeHistogramTimeseriesDatapoint](docs/Model/RealTimeHistogramTimeseriesDatapoint.md)
- [RealTimeTimeseriesDatapoint](docs/Model/RealTimeTimeseriesDatapoint.md)
- [ReferrerDomainRestriction](docs/Model/ReferrerDomainRestriction.md)
- [ReloadWebInputResponse](docs/Model/ReloadWebInputResponse.md)
- [Score](docs/Model/Score.md)
- [ShutdownWebInputResponse](docs/Model/ShutdownWebInputResponse.md)
- [SignalLiveStreamCompleteResponse](docs/Model/SignalLiveStreamCompleteResponse.md)
- [SigningKey](docs/Model/SigningKey.md)
- [SigningKeyResponse](docs/Model/SigningKeyResponse.md)
- [SimulcastTarget](docs/Model/SimulcastTarget.md)
- [SimulcastTargetResponse](docs/Model/SimulcastTargetResponse.md)
- [StaticRendition](docs/Model/StaticRendition.md)
- [Track](docs/Model/Track.md)
- [TranscriptionVocabulary](docs/Model/TranscriptionVocabulary.md)
- [TranscriptionVocabularyResponse](docs/Model/TranscriptionVocabularyResponse.md)
- [UpdateAssetMP4SupportRequest](docs/Model/UpdateAssetMP4SupportRequest.md)
- [UpdateAssetMasterAccessRequest](docs/Model/UpdateAssetMasterAccessRequest.md)
- [UpdateAssetRequest](docs/Model/UpdateAssetRequest.md)
- [UpdateLiveStreamEmbeddedSubtitlesRequest](docs/Model/UpdateLiveStreamEmbeddedSubtitlesRequest.md)
- [UpdateLiveStreamGeneratedSubtitlesRequest](docs/Model/UpdateLiveStreamGeneratedSubtitlesRequest.md)
- [UpdateLiveStreamNewAssetSettings](docs/Model/UpdateLiveStreamNewAssetSettings.md)
- [UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest](docs/Model/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md)
- [UpdateLiveStreamRequest](docs/Model/UpdateLiveStreamRequest.md)
- [UpdateReferrerDomainRestrictionRequest](docs/Model/UpdateReferrerDomainRestrictionRequest.md)
- [UpdateTranscriptionVocabularyRequest](docs/Model/UpdateTranscriptionVocabularyRequest.md)
- [UpdateUserAgentRestrictionRequest](docs/Model/UpdateUserAgentRestrictionRequest.md)
- [UpdateWebInputUrlRequest](docs/Model/UpdateWebInputUrlRequest.md)
- [Upload](docs/Model/Upload.md)
- [UploadError](docs/Model/UploadError.md)
- [UploadResponse](docs/Model/UploadResponse.md)
- [UserAgentRestrictionRequest](docs/Model/UserAgentRestrictionRequest.md)
- [UserAgentRestrictionSettings](docs/Model/UserAgentRestrictionSettings.md)
- [VideoView](docs/Model/VideoView.md)
- [VideoViewEvent](docs/Model/VideoViewEvent.md)
- [VideoViewResponse](docs/Model/VideoViewResponse.md)
- [WebInput](docs/Model/WebInput.md)
- [WebInputResponse](docs/Model/WebInputResponse.md)## Authorization
### accessToken
- **Type**: HTTP basic authentication
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```## Author
devex@mux.com
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `v1`
- Package version: `5.0.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`