Mux PHP

https://github.com/muxinc/mux-php
Admin
Official Mux API wrapper for PHP projects, supporting both Mux Data and Mux Video functionality.
Tokens:109,973
Snippets:627
Trust Score:9.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with Composer

Source: https://github.com/muxinc/mux-php/blob/master/README.md

Run composer install to install the project dependencies after adding Mux PHP to composer.json.

```sh
composer install
```

--------------------------------

### PHP example using getMonitoringTimeseries()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MonitoringApi.md

Full example that configures HTTP basic authorization, creates a MonitoringApi instance, and calls getMonitoringTimeseries() with the required parameters. The example prints the result or catches and displays an exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\MonitoringApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$monitoring_metric_id = current-concurrent-viewers; // string | ID of the Monitoring Metric
$filters = array('filters_example'); // string[] | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`
$timestamp = 56; // int | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.

try {
    $result = $apiInstance->getMonitoringTimeseries($monitoring_metric_id, $filters, $timestamp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MonitoringApi->getMonitoringTimeseries: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### listIncidents() example

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/IncidentsApi.md

Example of calling listIncidents with all parameters. Requires HTTP basic authorization with accessToken. The example prints the result or catches an exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\IncidentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`
$order_by = 'order_by_example'; // string | Value to order the results by
$order_direction = 'order_direction_example'; // string | Sort order.
$status = 'status_example'; // string | Status to filter incidents by
$severity = 'severity_example'; // string | Severity to filter incidents by

try {
    $result = $apiInstance->listIncidents($limit, $page, $order_by, $order_direction, $status, $severity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IncidentsApi->listIncidents: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### PHP example: listDimensionValues()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/DimensionsApi.md

Complete PHP example that configures the Mux client with access token credentials, creates a DimensionsApi instance, and calls listDimensionValues() with example parameters. It prints the result or catches and displays an exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\DimensionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$dimension_id = abcd1234; // string | ID of the Dimension
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`
$filters = array('filters_example'); // string[] | Filter results using key:value pairs. Must be provided as an array query string parameter.  **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]=!dimension:value` - Exclude rows where dimension equals value  **For trace dimensions (like video_cdn_trace):** * `filters[]=+dimension:value` - Include rows where trace contains value * `filters[]=-dimension:value` - Exclude rows where trace contains value * `filters[]=dimension:[value1,value2]` - Exact trace match  **Examples:** * `filters[]=country:US` - US views only * `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN
$metric_filters = array('metric_filters_example'); // string[] | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.  Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.  Example:    * `metric_filters[]=aggregate_startup_time>=1000`
$timeframe = array('timeframe_example'); // string[] | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`

try {
    $result = $apiInstance->listDimensionValues($dimension_id, $limit, $page, $filters, $metric_filters, $timeframe);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DimensionsApi->listDimensionValues: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### PHP example: Calling MetricsApi::getOverallValues

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MetricsApi.md

Example PHP code that configures HTTP basic authorization, creates a MetricsApi instance, and calls getOverallValues with example parameters. It prints the result or catches and displays an exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\MetricsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$metric_id = video_startup_time; // string | ID of the Metric
$timeframe = array('timeframe_example'); // string[] | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
$filters = array('filters_example'); // string[] | Filter results using key:value pairs. Must be provided as an array query string parameter.  **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]=!dimension:value` - Exclude rows where dimension equals value  **For trace dimensions (like video_cdn_trace):** * `filters[]=+dimension:value` - Include rows where trace contains value * `filters[]=-dimension:value` - Exclude rows where trace contains value * `filters[]=dimension:[value1,value2]` - Exact trace match  **Examples:** * `filters[]=country:US` - US views only * `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN
$metric_filters = array('metric_filters_example'); // string[] | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.  Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.  Example:    * `metric_filters[]=aggregate_startup_time>=1000`
$measurement = 'measurement_example'; // string | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`

try {
    $result = $apiInstance->getOverallValues($metric_id, $timeframe, $filters, $metric_filters, $measurement);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getOverallValues: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### PHP example: createLiveStreamSimulcastTarget()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/LiveStreamsApi.md

Full example showing how to configure HTTP basic authorization, instantiate the LiveStreamsApi client, and call createLiveStreamSimulcastTarget. The example uses json_decode() to create the request body from a JSON string.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\LiveStreamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$live_stream_id = 'live_stream_id_example'; // string | The live stream ID

// This API method wants a \MuxPhp\Models\CreateSimulcastTargetRequest
// as the second parameter.  That being said, these API docs are 
// auto-generated from our OpenAPI specification, which 
// gives us the example parameter as a JSON string.  In this example,
// we'll use json_decode() to turn it into an associative array, which
// is compatible with the model.
//
// In your own code you should use an associative array, or
// use a "new \MuxPhp\Models\CreateSimulcastTargetRequest" directly.
$create_simulcast_target_request = json_decode('{"url":"rtmp://live.example.com/app","stream_key":"abcdefgh","passthrough":"Example"}',true); // \MuxPhp\Models\CreateSimulcastTargetRequest

try {
    $result = $apiInstance->createLiveStreamSimulcastTarget($live_stream_id, $create_simulcast_target_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LiveStreamsApi->createLiveStreamSimulcastTarget: ', $e->getMessage(), PHP_EOL;
}
?>
```

--------------------------------

### Example: getAssetInputInfo() usage

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AssetsApi.md

Example of calling getAssetInputInfo with an asset ID, using HTTP basic authorization. Prints the result or catches an exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$asset_id = 'asset_id_example'; // string | The asset ID.

try {
    $result = $apiInstance->getAssetInputInfo($asset_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAssetInputInfo: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### PHP Example: updateLiveStreamNewAssetSettingsStaticRenditions()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/LiveStreamsApi.md

Full PHP example showing how to call the method. It configures HTTP basic authorization, creates the API client, and passes a JSON-decoded request. The example uses json_decode() to create the request array, but you can also use a model instance directly.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\LiveStreamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$live_stream_id = 'live_stream_id_example'; // string | The live stream ID

// This API method wants a \MuxPhp\Models\UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
// as the second parameter.  That being said, these API docs are 
// auto-generated from our OpenAPI specification, which 
// gives us the example parameter as a JSON string.  In this example,
// we'll use json_decode() to turn it into an associative array, which
// is compatible with the model.
//
// In your own code you should use an associative array, or
// use a "new \MuxPhp\Models\UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest" directly.
$update_live_stream_new_asset_settings_static_renditions_request = json_decode('{"static_renditions":[{"resolution":"audio-only"},{"resolution":"highest"}]}',true); // \MuxPhp\Models\UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest

try {
    $result = $apiInstance->updateLiveStreamNewAssetSettingsStaticRenditions($live_stream_id, $update_live_stream_new_asset_settings_static_renditions_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LiveStreamsApi->updateLiveStreamNewAssetSettingsStaticRenditions: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### PHP example using FiltersApi::listFilters()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/FiltersApi.md

Example usage of the FiltersApi with HTTP basic authorization. Requires your Mux access token credentials. The example creates a FiltersApi instance, calls listFilters(), and prints the result or catches exceptions.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\FiltersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listFilters();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FiltersApi->listFilters: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### Manual installation autoload

Source: https://github.com/muxinc/mux-php/blob/master/README.md

For manual installation, download the files and include the autoload.php file from the MuxPhp vendor directory. This method is not recommended.

```php
<?php
require_once('/path/to/MuxPhp/vendor/autoload.php');
```

--------------------------------

### listDeliveryUsage example

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/DeliveryUsageApi.md

An example demonstrating how to configure the API client and call the listDeliveryUsage method to retrieve usage data.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\DeliveryUsageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Offset by this many pages, of the size of `limit`
$limit = 100; // int | Number of items to include in the response
$asset_id = 'asset_id_example'; // string | Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
$live_stream_id = 'live_stream_id_example'; // string | Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
$timeframe = array('timeframe_example'); // string[] | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.

try {
    $result = $apiInstance->listDeliveryUsage($page, $limit, $asset_id, $live_stream_id, $timeframe);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryUsageApi->listDeliveryUsage: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### Example usage of listAllMetricValues

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MetricsApi.md

Complete example of calling listAllMetricValues with HTTP basic authorization. Configures the API client, sets up parameters, and handles the response or exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\MetricsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$timeframe = array('timeframe_example'); // string[] | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
$filters = array('filters_example'); // string[] | Filter results using key:value pairs. Must be provided as an array query string parameter.  **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]=!dimension:value` - Exclude rows where dimension equals value  **For trace dimensions (like video_cdn_trace):** * `filters[]=+dimension:value` - Include rows where trace contains value * `filters[]=-dimension:value` - Exclude rows where trace contains value * `filters[]=dimension:[value1,value2]` - Exact trace match  **Examples:** * `filters[]=country:US` - US views only * `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN
$metric_filters = array('metric_filters_example'); // string[] | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.  Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.  Example:    * `metric_filters[]=aggregate_startup_time>=1000`
$dimension = 'dimension_example'; // string | Dimension the specified value belongs to
$value = 'value_example'; // string | Value to show all available metrics for

try {
    $result = $apiInstance->listAllMetricValues($timeframe, $filters, $metric_filters, $dimension, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->listAllMetricValues: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### PHP example: createAssetTrack with authentication

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AssetsApi.md

Full example of calling createAssetTrack. Configures HTTP basic auth with accessToken, creates a CreateTrackRequest from JSON, and handles the response or exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$asset_id = 'asset_id_example'; // string | The asset ID.

// This API method wants a \MuxPhp\Models\CreateTrackRequest
// as the second parameter.  That being said, these API docs are 
// auto-generated from our OpenAPI specification, which 
// gives us the example parameter as a JSON string.  In this example,
// we'll use json_decode() to turn it into an associative array, which
// is compatible with the model.
//
// In your own code you should use an associative array, or
// use a "new \MuxPhp\Models\CreateTrackRequest" directly.
$create_track_request = json_decode('{"url":"https://example.com/myVideo_en.srt","type":"text","text_type":"subtitles","language_code":"en-US","name":"English","closed_captions":true,"passthrough":"English"}',true); // \MuxPhp\Models\CreateTrackRequest

try {
    $result = $apiInstance->createAssetTrack($asset_id, $create_track_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->createAssetTrack: ', $e->getMessage(), PHP_EOL;
}
?>
```

--------------------------------

### PHP example using URLSigningKeysApi->listUrlSigningKeys

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/URLSigningKeysApi.md

Complete example that configures HTTP basic authorization with an access token, creates a URLSigningKeysApi instance, and calls listUrlSigningKeys with limit and page. Prints the result or catches exceptions.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\URLSigningKeysApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`

try {
    $result = $apiInstance->listUrlSigningKeys($limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling URLSigningKeysApi->listUrlSigningKeys: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### getAnnotation PHP example

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AnnotationsApi.md

PHP example using MuxPhp\Api\AnnotationsApi to get an annotation. Requires HTTP basic authorization with accessToken. The result is printed with print_r.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AnnotationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$annotation_id = 'annotation_id_example'; // string | The annotation ID

try {
    $result = $apiInstance->getAnnotation($annotation_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationsApi->getAnnotation: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### PHP example using WebInputsApi::launchWebInput

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/WebInputsApi.md

Example of launching a Web Input using the WebInputsApi. Configures HTTP basic authorization with accessToken, creates the API client, and calls launchWebInput with a web input ID, printing the result or catching exceptions.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\WebInputsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$web_input_id = abcd1234; // string | The Web Input ID

try {
    $result = $apiInstance->launchWebInput($web_input_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebInputsApi->launchWebInput: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### Get Metric Timeseries Data with Mux PHP SDK

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MetricsApi.md

Use this snippet to retrieve metric timeseries data from the Mux Metrics API. It configures HTTP basic authentication with your credentials, initializes the MetricsApi client, and calls getMetricTimeseriesData with the required metric_id and optional timeframe, filters, measurement, and other parameters. The example prints the result or catches and displays an exception on failure.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\MetricsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$metric_id = video_startup_time; // string | ID of the Metric
$timeframe = array('timeframe_example'); // string[] | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
$filters = array('filters_example'); // string[] | Filter results using key:value pairs. Must be provided as an array query string parameter.  **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]=!dimension:value` - Exclude rows where dimension equals value  **For trace dimensions (like video_cdn_trace):** * `filters[]=+dimension:value` - Include rows where trace contains value * `filters[]=-dimension:value` - Exclude rows where trace contains value * `filters[]=dimension:[value1,value2]` - Exact trace match  **Examples:** * `filters[]=country:US` - US views only * `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN
$metric_filters = array('metric_filters_example'); // string[] | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.  Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.  Example:    * `metric_filters[]=aggregate_startup_time>=1000`
$measurement = 'measurement_example'; // string | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: "sum" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` "median" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` "avg" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score` "count" : `started_views`, `unique_viewers`
$order_direction = 'order_direction_example'; // string | Sort order.
$group_by = 'group_by_example'; // string | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.

try {
    $result = $apiInstance->getMetricTimeseriesData($metric_id, $timeframe, $filters, $metric_filters, $measurement, $order_direction, $group_by);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getMetricTimeseriesData: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### Example: listSigningKeys usage with accessToken

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/SigningKeysApi.md

Full example for listing signing keys. Requires HTTP basic authorization with accessToken credentials. Calls the API with limit and page parameters and catches exceptions.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\SigningKeysApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`

try {
    $result = $apiInstance->listSigningKeys($limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SigningKeysApi->listSigningKeys: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### Create a live stream with createLiveStream()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/LiveStreamsApi.md

Use this example to create a new live stream. It configures HTTP basic authorization with your credentials, instantiates the LiveStreamsApi client, and sends a CreateLiveStreamRequest with playback policies. The example uses json_decode() to convert the JSON request body into an associative array, which is compatible with the model. The response is printed, and any exceptions are caught and displayed.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\LiveStreamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

// This API method wants a \MuxPhp\Models\CreateLiveStreamRequest
// as the second parameter.  That being said, these API docs are 
// auto-generated from our OpenAPI specification, which 
// gives us the example parameter as a JSON string.  In this example,
// we'll use json_decode() to turn it into an associative array, which
// is compatible with the model.
//
// In your own code you should use an associative array, or
// use a "new \MuxPhp\Models\CreateLiveStreamRequest" directly.
$create_live_stream_request = json_decode('{"playback_policies":["public"],"new_asset_settings":{"playback_policies":["public"]}}',true); // \MuxPhp\Models\CreateLiveStreamRequest

try {
    $result = $apiInstance->createLiveStream($create_live_stream_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LiveStreamsApi->createLiveStream: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### deleteAnnotation PHP example

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AnnotationsApi.md

PHP example using MuxPhp\Api\AnnotationsApi to delete an annotation. Requires HTTP basic authorization with accessToken. The example catches exceptions and prints an error message.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AnnotationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$annotation_id = 'annotation_id_example'; // string | The annotation ID

try {
    $apiInstance->deleteAnnotation($annotation_id);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationsApi->deleteAnnotation: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### PHP example: createAssetStaticRendition()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AssetsApi.md

Full example that configures HTTP basic authorization, creates an AssetsApi client, and calls createAssetStaticRendition() with a JSON-decoded request. Prints the result or catches exceptions.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$asset_id = 'asset_id_example'; // string | The asset ID.

// This API method wants a \MuxPhp\Models\CreateStaticRenditionRequest
// as the second parameter.  That being said, these API docs are 
// auto-generated from our OpenAPI specification, which 
// gives us the example parameter as a JSON string.  In this example,
// we'll use json_decode() to turn it into an associative array, which
// is compatible with the model.
//
// In your own code you should use an associative array, or
// use a "new \MuxPhp\Models\CreateStaticRenditionRequest" directly.
$create_static_rendition_request = json_decode('{"resolution":"highest"}',true); // \MuxPhp\Models\CreateStaticRenditionRequest

try {
    $result = $apiInstance->createAssetStaticRendition($asset_id, $create_static_rendition_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->createAssetStaticRendition: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### deleteAssetPlaybackId() - Delete a playback ID

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/AssetsApi.md

Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before deletion may be able to watch the entire video for a limited duration. The example configures authorization, creates an AssetsApi instance, and calls deleteAssetPlaybackId() with asset_id and playback_id parameters.

```php
deleteAssetPlaybackId($asset_id, $playback_id)
```

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$asset_id = 'asset_id_example'; // string | The asset ID.
$playback_id = 'playback_id_example'; // string | The live stream's playback ID.

try {
    $apiInstance->deleteAssetPlaybackId($asset_id, $playback_id);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->deleteAssetPlaybackId: ', $e->getMessage(), PHP_EOL;
}

```

--------------------------------

### launchWebInput()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/WebInputsApi.md

Launches a Web Input, loading the specified URL and streaming to the Live Stream.

```APIDOC
## `launchWebInput()`

### Description
Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream.

### Method
POST

### Endpoint
`/video/v1/web-inputs/{web_input_id}/launch`

### Parameters
#### Path Parameters
- **web_input_id** (string) - Required - The Web Input ID

### Request Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

$apiInstance = new MuxPhp\Api\WebInputsApi(
    new GuzzleHttp\Client(),
    $config
);
$web_input_id = abcd1234; // string | The Web Input ID

try {
    $result = $apiInstance->launchWebInput($web_input_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebInputsApi->launchWebInput: ', $e->getMessage(), PHP_EOL;
}
```

### Response
#### Success Response (200)
- **LaunchWebInputResponse** (object) - The response containing the launched Web Input details.

#### Response Example
```json
{
  "data": {}
}
```

### Authorization
- **accessToken** - HTTP basic authorization

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
```

--------------------------------

### GET /data/v1/metrics/{METRIC_ID}/overall

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MetricsApi.md

Get overall values for a specific metric.

```APIDOC
## GET /data/v1/metrics/{METRIC_ID}/overall

### Description
Get overall values for a specific metric.

### Method
GET

### Endpoint
/data/v1/metrics/{METRIC_ID}/overall

### Parameters
#### Path Parameters
- **metric_id** (string) - Required - The metric ID to retrieve overall values for.

### Response
#### Success Response (200)
- **data** (object) - Overall metric values.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### PHP example for listWebInputs()

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/WebInputsApi.md

Demonstrates how to call listWebInputs() using the Mux PHP client with HTTP basic authorization. It configures the client, sets optional limit and page parameters, and handles the response or exception.

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\WebInputsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`

try {
    $result = $apiInstance->listWebInputs($limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebInputsApi->listWebInputs: ', $e->getMessage(), PHP_EOL;
}
```

--------------------------------

### GET /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries

Source: https://github.com/muxinc/mux-php/blob/master/docs/Api/MonitoringApi.md

Gets timeseries information for a specific metric.

```APIDOC
## GET /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries

### Description
Gets timeseries information for a specific metric.

### Method
GET

### Endpoint
/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries

### Parameters
#### Path Parameters
- **monitoring_metric_id** (string) - Required - ID of the Monitoring Metric

#### Query Parameters
- **timestamp** (int) - Optional - Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
- **filters** (array of string) - Optional - Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: `filters[]=operating_system:windows&filters[]=!country:US`
- **order_by** (string) - Optional - Value to order the results by
- **order_direction** (string) - Optional - Sort order.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **GetMonitoringTimeseriesResponse** - The response containing timeseries data.

#### Response Example
(Not provided in source)

### Authorization
accessToken

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
```
Tokens:
Raw