Skip to content

Commit

Permalink
Fix code sample fields to x-doctave
Browse files Browse the repository at this point in the history
  • Loading branch information
szekelyzol authored Sep 8, 2023
1 parent 99269a0 commit a309ea9
Show file tree
Hide file tree
Showing 10 changed files with 0 additions and 902 deletions.
36 changes: 0 additions & 36 deletions docs/Api/AnalyticsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,24 +40,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\AnalyticsPlaysResponse**](../Model/AnalyticsPlaysResponse.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$from = new \DateTime("2023-06-01"); // Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format.
$dimension = "liveStreamId"; // Use this query parameter to define the dimension that you want analytics for. - `liveStreamId`: Returns analytics based on the public live stream identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - `browser`: Returns analytics based on the browser used by the viewers during the play event.

$plays = $client->analytics()->getLiveStreamsPlays($from, $dimension, array(
'to' => new \DateTime('2023-06-10'), // Use this optional query parameter to set the end date for the time period that you want analytics for. - If you do not specify a `to` date, the API returns analytics data starting from the `from` date up until today, and excluding today. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format.
'filter' => "liveStreamId:li3q7HxhApxRF1c8F8r6VeaI", // Use this query parameter to filter your results to a specific live stream in a project that you want analytics for. You must use the `liveStreamId:` prefix when specifying a live stream ID.
'currentPage' => 2, // Choose the number of search results to return per page. Minimum value: 1
'pageSize' => 30 // Results per page. Allowed values 1-100, default is 25.
));
```



Expand Down Expand Up @@ -94,24 +76,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\AnalyticsPlaysResponse**](../Model/AnalyticsPlaysResponse.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$from = new \DateTime("2023-06-01"); // Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format.
$dimension = "videoId"; // Use this query parameter to define the dimension that you want analytics for. - `videoId`: Returns analytics based on the public video identifiers. - `emittedAt`: Returns analytics based on the times of the play events. The API returns data in specific interval groups. When the date period you set in `from` and `to` is less than or equals to 2 days, the response for this dimension is grouped in hourly intervals. Otherwise, it is grouped in daily intervals. - `country`: Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). - `deviceType`: Returns analytics based on the type of device used by the viewers during the play event. - `operatingSystem`: Returns analytics based on the operating system used by the viewers during the play event. - `browser`: Returns analytics based on the browser used by the viewers during the play event.

$plays = $client->analytics()->getVideosPlays($from, $dimension, array(
'to' => new \DateTime('2023-06-10'), // Use this optional query parameter to set the end date for the time period that you want analytics for. - If you do not specify a `to` date, the API returns analytics data starting from the `from` date up until today, and excluding today. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format.
'filter' => "videoId:vi3q7HxhApxRF1c8F8r6VeaI", // Use this query parameter to filter your results to a specific video in a project that you want analytics for. You must use the `videoId:` prefix when specifying a video ID.
'currentPage' => 2, // Choose the number of search results to return per page. Minimum ->setvalue(1)
'pageSize' => 30 // Results per page. Allowed values 1-100, default is 25.
));
```



71 changes: 0 additions & 71 deletions docs/Api/CaptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\Caption**](../Model/Caption.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklg'; // The unique identifier for the video you want to add a caption to.
$language = 'en'; // A valid BCP 47 language representation.
$file = new SplFileObject(__DIR__ . '/en.vtt'); // The video text track (VTT) you want to upload.

$caption = $client->captions()->upload($videoId, $language, $file);
```



Expand Down Expand Up @@ -76,19 +62,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\Caption**](../Model/Caption.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklg'; // The unique identifier for the video you want captions for.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation

$client->captions()->get($videoId, $language);
```



Expand Down Expand Up @@ -116,22 +89,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\Caption**](../Model/Caption.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklg'; // The unique identifier for the video you want to have automatic captions for.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.

$captionsUpdatePayload = (new \ApiVideo\Client\Model\CaptionsUpdatePayload())
->setDefault(true);

$caption = $client->captions()->update($videoId, $language, $captionsUpdatePayload);
```



Expand All @@ -158,19 +115,6 @@ Name | Type | Description | Notes

void (empty response body)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklgc'; // The unique identifier for the video you want to delete a caption from.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.

$client->captions()->delete($videoId, $language);
```



Expand Down Expand Up @@ -206,21 +150,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\CaptionsListResponse**](../Model/CaptionsListResponse.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklg'; // The unique identifier for the video you want to retrieve a list of captions for.

$captions = $client->captions()->list($videoId, array(
'currentPage' => 2, // Choose the number of search results to return per page. Minimum value: 1)
'pageSize' => 30 // Results per page. Allowed values 1-100, default is 25.)
));
```



55 changes: 0 additions & 55 deletions docs/Api/ChaptersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\Chapter**](../Model/Chapter.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Jfrgz'; // The unique identifier for the video you want to upload a chapter for.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
$file = new SplFileObject(__DIR__ . '/en.vtt'); // The VTT file describing the chapters you want to upload.

$chapter = $client->chapters()->upload($videoId, $language, $file);
```



Expand All @@ -75,19 +61,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\Chapter**](../Model/Chapter.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Jfrgz'; // The unique identifier for the video you want to delete a chapter from.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.

$client->chapters()->delete($videoId, $language);
```



Expand All @@ -114,19 +87,6 @@ Name | Type | Description | Notes

void (empty response body)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Jfrgz'; // The unique identifier for the video you want to delete a chapter from.
$language = 'en'; // A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.

$client->chapters()->delete($videoId, $language);
```



Expand Down Expand Up @@ -162,21 +122,6 @@ Name | Type | Description | Notes

[**\ApiVideo\Client\Model\ChaptersListResponse**](../Model/ChaptersListResponse.md)

### Example

```php
<?php
// First install the api client: "composer require api-video/php-api-client"

require __DIR__ . '/vendor/autoload.php';

$videoId = 'vi4k0jvEUuaTdRAEjQ4Prklg'; // The unique identifier for the video you want to retrieve a list of chapters for.

$captions = $client->chapters()->list($videoId, array(
'currentPage' => 2, // Choose the number of search results to return per page. Minimum value: 1)
'pageSize' => 30 // Results per page. Allowed values 1-100, default is 25.)
));
```



Loading

0 comments on commit a309ea9

Please sign in to comment.