diff --git a/docs/Api/AnalyticsApi.md b/docs/Api/AnalyticsApi.md index 9f4dfc4..6fd483b 100644 --- a/docs/Api/AnalyticsApi.md +++ b/docs/Api/AnalyticsApi.md @@ -40,24 +40,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\AnalyticsPlaysResponse**](../Model/AnalyticsPlaysResponse.md) -### Example - -```php -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. -)); -``` @@ -94,24 +76,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\AnalyticsPlaysResponse**](../Model/AnalyticsPlaysResponse.md) -### Example - -```php -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. -)); -``` diff --git a/docs/Api/CaptionsApi.md b/docs/Api/CaptionsApi.md index 5789132..c98635e 100644 --- a/docs/Api/CaptionsApi.md +++ b/docs/Api/CaptionsApi.md @@ -34,20 +34,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Caption**](../Model/Caption.md) -### Example - -```php -captions()->upload($videoId, $language, $file); -``` @@ -76,19 +62,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Caption**](../Model/Caption.md) -### Example - -```php -captions()->get($videoId, $language); -``` @@ -116,22 +89,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Caption**](../Model/Caption.md) -### Example - -```php -setDefault(true); - -$caption = $client->captions()->update($videoId, $language, $captionsUpdatePayload); -``` @@ -158,19 +115,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -captions()->delete($videoId, $language); -``` @@ -206,21 +150,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\CaptionsListResponse**](../Model/CaptionsListResponse.md) -### Example - -```php -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.) -)); -``` diff --git a/docs/Api/ChaptersApi.md b/docs/Api/ChaptersApi.md index ab57fb9..1fa105d 100644 --- a/docs/Api/ChaptersApi.md +++ b/docs/Api/ChaptersApi.md @@ -35,20 +35,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Chapter**](../Model/Chapter.md) -### Example - -```php -chapters()->upload($videoId, $language, $file); -``` @@ -75,19 +61,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Chapter**](../Model/Chapter.md) -### Example - -```php -chapters()->delete($videoId, $language); -``` @@ -114,19 +87,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -chapters()->delete($videoId, $language); -``` @@ -162,21 +122,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\ChaptersListResponse**](../Model/ChaptersListResponse.md) -### Example - -```php -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.) -)); -``` diff --git a/docs/Api/LiveStreamsApi.md b/docs/Api/LiveStreamsApi.md index c03d5f0..6c186e6 100644 --- a/docs/Api/LiveStreamsApi.md +++ b/docs/Api/LiveStreamsApi.md @@ -34,28 +34,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStream**](../Model/LiveStream.md) -### Example - -```php -liveStreams()->create((new \ApiVideo\Client\Model\LiveStreamCreationPayload()) - ->setRecord(false) // Whether you are recording or not. True for record, false for not record. - ->setName("My Live Stream Video") // Add a name for your live stream here. - ->setPublic(true) // Whether your video can be viewed by everyone, or requires authentication to see it. - ->setPlayerId("pl4f4ferf5erfr5zed4fsdd")); // The unique identifier for the player. - ->setRestreams(array( // Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. - new RestreamsRequestObject(['name' => 'My RTMP server', 'serverUrl' => 'rtmp://my.broadcast.example.com/app', 'streamKey' => 'dw-dew8-q6w9-k67w-1ws8']))); -``` @@ -81,23 +59,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStream**](../Model/LiveStream.md) -### Example - -```php -liveStreams()->get($liveStreamId); -``` @@ -124,33 +85,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStream**](../Model/LiveStream.md) -### Example - -```php -setName("My Live Stream Video") // The name you want to use for your live stream.) - ->setPublic(true) // Whether your video can be viewed by everyone, or requires authentication to see it. ) - ->setRecord(true) // Use this to indicate whether you want the recording on or off. On is true, off is false.) - ->setPlayerId("pl45KFKdlddgk654dspkze") // The unique ID for the player associated with a live stream that you want to update.) - ->setRestreams(array( - new RestreamsRequestObject(['name' => 'My RTMP server', 'serverUrl' => 'rtmp://my.broadcast.example.com/app', 'streamKey' => 'dw-dew8-q6w9-k67w-1ws8']))); - - -$liveStream = $client->liveStreams()->update($liveStreamId, $liveStreamUpdatePayload); -``` @@ -176,23 +110,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -liveStreams()->deleteThumbnail($liveStreamId); -``` @@ -229,41 +146,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStreamListResponse**](../Model/LiveStreamListResponse.md) -### Example - -```php -liveStreams()->list(); - -// retrieve the livestreams having a given name -$liveStreams2 = $client->liveStreams()->list(array( - 'name' => 'My livestream' -)); - -// retrieve the livestreams having a given stream key -$liveStreams2 = $client->liveStreams()->list(array( - 'streamKey' => '30087931-229e-42cf-b5f9-e91bcc1f7332' -)); - -// retrieve the second page of 30 items sorted by name desc -$liveStreams3 = $client->liveStreams()->list(array( - 'sortBy' => 'name', - 'sortOrder' => 'desc', - 'currentPage' => 2, - 'pageSize' => 30 -)); -``` @@ -290,25 +172,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStream**](../Model/LiveStream.md) -### Example - -```php -liveStreams()->uploadThumbnail($liveStreamId, $file); -``` @@ -334,23 +197,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\LiveStream**](../Model/LiveStream.md) -### Example - -```php -liveStreams()->get(liveStreamId); -``` diff --git a/docs/Api/PlayerThemesApi.md b/docs/Api/PlayerThemesApi.md index f1fcbfa..1ef7d28 100644 --- a/docs/Api/PlayerThemesApi.md +++ b/docs/Api/PlayerThemesApi.md @@ -34,32 +34,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\PlayerTheme**](../Model/PlayerTheme.md) -### Example - -```php -setText("rgba(255, 255, 255, 1)") // RGBA color for timer text. Default: rgba(255, 255, 255, 1)) - ->setLink("rgba(255, 255, 255, 1)") // RGBA color for all controls. Default: rgba(255, 255, 255, 1)) - ->setLinkHover("rgba(255, 255, 255, 1)") // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)) - ->setTrackPlayed("rgba(255, 255, 255, 1)") // RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)) - ->setTrackUnplayed("rgba(255, 255, 255, 1)") // RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)) - ->setTrackBackground("rgba(255, 255, 255, 1)") // RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)) - ->setBackgroundTop("rgba(255, 255, 255, 1)") // RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)) - ->setBackgroundBottom("rgba(255, 255, 255, 1)") // RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)) - ->setBackgroundText("rgba(255, 255, 255, 1)") // RGBA color for title text. Default: rgba(255, 255, 255, 1)) - ->setEnableApi(true) // enable/disable player SDK access. Default: true) - ->setEnableControls(true) // enable/disable player controls. Default: true) - ->setForceAutoplay(true) // enable/disable player autoplay. Default: false) - ->setHideTitle(true) // enable/disable title. Default: false) - ->setForceLoop(true); // enable/disable looping. Default: false) - -$playerTheme = $client->playerThemes()->create($playerThemeCreationPayload); -``` @@ -85,17 +59,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\PlayerTheme**](../Model/PlayerTheme.md) -### Example - -```php -playerThemes()->get($playerId); -``` @@ -124,35 +87,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\PlayerTheme**](../Model/PlayerTheme.md) -### Example - -```php -setText("rgba(255, 255, 255, 1)") // RGBA color for timer text. Default: rgba(255, 255, 255, 1)) - ->setLink("rgba(255, 255, 255, 1)") // RGBA color for all controls. Default: rgba(255, 255, 255, 1)) - ->setLinkHover("rgba(255, 255, 255, 1)") // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)) - ->setTrackPlayed("rgba(255, 255, 255, 1)") // RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)) - ->setTrackUnplayed("rgba(255, 255, 255, 1)") // RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)) - ->setTrackBackground("rgba(255, 255, 255, 1)") // RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)) - ->setBackgroundTop("rgba(255, 255, 255, 1)") // RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)) - ->setBackgroundBottom("rgba(255, 255, 255, 1)") // RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)) - ->setBackgroundText("rgba(255, 255, 255, 1)") // RGBA color for title text. Default: rgba(255, 255, 255, 1)) - ->setEnableApi(true) // enable/disable player SDK access. Default: true) - ->setEnableControls(true) // enable/disable player controls. Default: true) - ->setForceAutoplay(true) // enable/disable player autoplay. Default: false) - ->setHideTitle(true) // enable/disable title. Default: false) - ->setForceLoop(true); // enable/disable looping. Default: false) - - -$playerTheme = $client->playerThemes()->update($playerId, $playerThemeUpdatePayload); -``` @@ -178,17 +112,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -playerThemes()->delete($playerId); -``` @@ -223,21 +146,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\PlayerThemesListResponse**](../Model/PlayerThemesListResponse.md) -### Example - -```php -playerThemes()->list(array( - 'sortBy' => 'createdAt', // createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. - 'sortOrder' => 'asc', // ->setAllowed(asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.) - '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. -)); -``` @@ -265,20 +173,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\PlayerTheme**](../Model/PlayerTheme.md) -### Example - -```php -playerThemes()->uploadLogo($playerId, $file, $link); -``` @@ -304,17 +198,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -playerThemes()->deleteLogo($playerId); -``` diff --git a/docs/Api/RawStatisticsApi.md b/docs/Api/RawStatisticsApi.md index 0d449c0..2f954e8 100644 --- a/docs/Api/RawStatisticsApi.md +++ b/docs/Api/RawStatisticsApi.md @@ -39,19 +39,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\RawStatisticsListLiveStreamAnalyticsResponse**](../Model/RawStatisticsListLiveStreamAnalyticsResponse.md) -### Example - -```php -const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" }); - -const liveStreamId = 'vi4k0jvEUuaTdRAEjQ4Jfrgz'; // The unique identifier for the live stream you want to retrieve analytics for. -const period = '2019-01-01'; // Period must have one of the following formats: - For a day : "2018-01-01", - For a week: "2018-W01", - For a month: "2018-01" - For a year: "2018" For a range period: - Date range: "2018-01-01/2018-01-15" -const currentPage = 2; // Choose the number of search results to return per page. Minimum value: 1 -const pageSize = 30; // Results per page. Allowed values 1-100, default is 25. - -// RawStatisticsListLiveStreamAnalyticsResponse -const liveStreamSessions = await client.rawStatistics.listLiveStreamSessions({ liveStreamId, period, currentPage, pageSize }) -``` @@ -87,21 +74,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\RawStatisticsListPlayerSessionEventsResponse**](../Model/RawStatisticsListPlayerSessionEventsResponse.md) -### Example - -```php -rawStatistics()->listSessionEvents($sessionId, array( - '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. -)); -``` @@ -139,25 +111,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\RawStatisticsListSessionsResponse**](../Model/RawStatisticsListSessionsResponse.md) -### Example - -```php -rawStatistics()->listVideoSessions($videoId, array( - 'period' => '2018-01', // Period must have one of the following formats: - For a day : 2018-01-01, - For a week: 2018-W01, - For a month: 2018-01 - For a year: 2018 For a range period: - Date range: 2018-01-01/2018-01-15 - 'metadata' => array( // Metadata and Dynamic Metadata filter. Send an array of key value pairs you want to filter sessions with. - 'key' => 'value' - ), - '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. -)); -``` diff --git a/docs/Api/UploadTokensApi.md b/docs/Api/UploadTokensApi.md index ea3f771..e835200 100644 --- a/docs/Api/UploadTokensApi.md +++ b/docs/Api/UploadTokensApi.md @@ -31,23 +31,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\UploadToken**](../Model/UploadToken.md) -### Example - -```php -uploadTokens()->deleteToken($uploadToken); -``` @@ -73,23 +56,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\UploadToken**](../Model/UploadToken.md) -### Example - -```php -uploadTokens()->getToken($uploadTokenId); -``` @@ -115,23 +81,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -uploadTokens()->getToken($uploadTokenId); -``` @@ -166,22 +115,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\TokenListResponse**](../Model/TokenListResponse.md) -### Example - -```php -uploadTokens()->list(); -``` diff --git a/docs/Api/VideosApi.md b/docs/Api/VideosApi.md index 5f81a3f..dbff5c9 100644 --- a/docs/Api/VideosApi.md +++ b/docs/Api/VideosApi.md @@ -39,47 +39,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload())->setTitle("Maths video")); - -// create a video using an existing source -$existingSourceVideo = $client->videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload()) - ->setTitle("Maths video") - ->setSource("https://www.myvideo.url.com/video.mp4")); - -// create a private video -$privateVideo = $client->videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload()) - ->setTitle("Maths video") - ->setPublic(false)); - -// create a video using all available attributes -$anotherVideo = $client->videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload()) - ->setTitle("Maths video") // The title of your new video. - ->setDescription("A video about string theory.") // A brief description of your video. - ->setSource("https://www.myvideo.url.com/video.mp4") // If you add a video already on the web, this is where you enter the url for the video. - ->setPublic(true) // Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. - ->setPanoramic(false) // Indicates if your video is a 360/immersive video. - ->setMp4Support(true) // Enables mp4 version in addition to streamed version. - ->setPlayerId("pl45KFKdlddgk654dspkze") // The unique identification number for your video player. - ->setTags(array("TAG1", "TAG2")) // A list of tags you want to use to describe your video. - ->setMetadata(array( // A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. You can also just use the pairs as another way to tag and categorize your videos. - new \ApiVideo\Client\Model\Metadata(['key' => 'key1', 'value' => 'key1value1']), - new \ApiVideo\Client\Model\Metadata(['key' => 'key2', 'value' => 'key2value1'])))); -``` @@ -125,34 +84,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload())->setTitle('Uploaded video')); -$client->videos()->upload($myVideo->getVideoId(), new SplFileObject(__DIR__ . '/558k.mp4')); - -// create a new video & upload a video file using progressive upload (the file is uploaded by parts) -$myVideo2 = $client->videos()->create((new \ApiVideo\Client\Model\VideoCreationPayload())->setTitle('Uploaded video (progressive upload)')); - -$progressiveSession = $client->videos()->createUploadProgressiveSession($myVideo2->getVideoId()); - -$progressiveSession->uploadPart(new SplFileObject(__DIR__ . '/10m.mp4.part.a')); -$progressiveSession->uploadPart(new SplFileObject(__DIR__ . '/10m.mp4.part.b')); - -$progressiveSession->uploadLastPart(new SplFileObject(__DIR__ . '/10m.mp4.part.c')); -``` @@ -181,25 +112,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->pickThumbnail($videoId, (new \ApiVideo\Client\Model\VideoThumbnailPickPayload()) - ->setTimecode("00:01:00.000")); // Frame in video to be used as a placeholder before the video plays. -``` @@ -225,23 +137,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->getStatus($videoId); -``` @@ -274,34 +169,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->update($videoId, (new \ApiVideo\Client\Model\VideoUpdatePayload()) - ->setPlayerId("pl4k0jvEUuaTdRAEjQ4Jfrgz") // The unique ID for the player you want to associate with your video. - ->setTitle("The new title") // The title you want to use for your video. - ->setDescription("A new description") // A brief description of the video. - ->setPublic(false) // Whether the video is publicly available or not. False means it is set to private. - ->setPanoramic(false) // Whether the video is a 360 degree or immersive video. - ->setMp4Support(true) // Whether the player supports the mp4 format. - ->setTags(["tag1", "tag2"]) // A list of terms or words you want to tag the video with. Make sure the list includes all the tags you want as whatever you send in this list will overwrite the existing list for the video. - ->setMetadata(array( // A list (array) of dictionaries where each dictionary contains a key value pair that describes the video. As with tags, you must send the complete list of metadata you want as whatever you send here will overwrite the existing metadata for the video. - new \ApiVideo\Client\Model\Metadata(["key" => "aa", 'value' => "bb"]), - new \ApiVideo\Client\Model\Metadata(["key" => "aa2", 'value' => "bb2"])))); -``` @@ -327,23 +194,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -videos()->delete($videoId); -``` @@ -383,34 +233,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\VideosListResponse**](../Model/VideosListResponse.md) -### Example - -```php -videos()->list([]); - $allVideos = array_merge($allVideos, $currentPage->getData()); -} while($currentPage->getPagination()->getCurrentPage() < $currentPage->getPagination()->getPagesTotal()); - -// list videos that have all the given tags (only first results page) -$videosWithTag = $client->videos()->list(['tags' => ['TAG2','TAG1']]); - -// list videos that have all the given metadata values (only first results page) -$videosWithMetadata = $client->videos()->list(['metadata' => ['key1' => 'key1value1', 'key2' => 'key2value1']]); -``` @@ -449,25 +271,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->uploadThumbnail($videoId, $thumbnail); -``` @@ -504,25 +307,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Video**](../Model/Video.md) -### Example - -```php -videos()->pickThumbnail($videoId, (new \ApiVideo\Client\Model\VideoThumbnailPickPayload()) - ->setTimecode("00:01:00.000")); // Frame in video to be used as a placeholder before the video plays. -``` @@ -548,23 +332,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\VideoStatus**](../Model/VideoStatus.md) -### Example - -```php -videos()->getStatus($videoId); -``` diff --git a/docs/Api/WatermarksApi.md b/docs/Api/WatermarksApi.md index d5a195e..28bab17 100644 --- a/docs/Api/WatermarksApi.md +++ b/docs/Api/WatermarksApi.md @@ -30,37 +30,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Watermark**](../Model/Watermark.md) -### Example - -```php -watermarks()->upload(new SplFileObject(__DIR__ . '/watermark.png')); - -// create a new video with the watermark -$video = $client->videos()->create((new VideoCreationPayload()) - ->setWatermark((new VideoWatermark()) - ->setId($watermark->getWatermarkId()) - ->setTop("0px") - ->setLeft("0px") - ->setWidth("100px") - ->setHeight("100px")) - ->setTitle("Test PHP watermark") -); - -// upload the video -$client->videos()->upload($video->getVideoId(), new SplFileObject(__DIR__ . '/558k.mp4')); -``` @@ -86,24 +55,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -watermarks->delete(watermarkId); -``` @@ -138,30 +89,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\WatermarksListResponse**](../Model/WatermarksListResponse.md) -### Example - -```php -watermarks()->list(); - -// retrieve the 5 first watermarks, ordered by creation date -$watermarks2 = $client->watermarks()->list(array( - 'pageSize' => 5, - 'sortBy' => 'createdAt', - 'sortOrder' => 'asc' -)); -``` diff --git a/docs/Api/WebhooksApi.md b/docs/Api/WebhooksApi.md index d64af60..45028bc 100644 --- a/docs/Api/WebhooksApi.md +++ b/docs/Api/WebhooksApi.md @@ -39,20 +39,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Webhook**](../Model/Webhook.md) -### Example - -```php -setEvents(['video.encoding.quality.completed']) // A list of the webhooks that you are subscribing to. There are Currently four webhook options: * ```video.encoding.quality.completed``` Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like ```{ "type": "video.encoding.quality.completed", "emittedAt": "2021-01-29T16:46:25.217+01:00", "videoId": "viXXXXXXXX", "encoding": "hls", "quality": "720p"} ```. This request says that the 720p HLS encoding was completed. * ```live-stream.broadcast.started``` When a lives tream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * ```live-stream.broadcast.ended``` This event fires when the live stream has finished broadcasting, and the broadcasting parameter flips from false to true. * ```video.source.recorded``` Occurs when a live stream is recorded and submitted for encoding.) - ->setUrl("https://example.com/webhooks"); // The url to which HTTP notifications are sent. It could be any http or https URL.) - -$webhook = $client->webhooks()->create($webhooksCreationPayload); -``` @@ -78,18 +64,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\Webhook**](../Model/Webhook.md) -### Example - -```php -webhooks()->get($webhookId); -``` @@ -115,17 +89,6 @@ Name | Type | Description | Notes void (empty response body) -### Example - -```php -webhooks()->delete($webhookId); -``` @@ -161,18 +124,6 @@ Name | Type | Description | Notes [**\ApiVideo\Client\Model\WebhooksListResponse**](../Model/WebhooksListResponse.md) -### Example - -```php -const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" }); - -const events = 'video.encoding.quality.completed'; // The webhook event that you wish to filter on. -const currentPage = 2; // Choose the number of search results to return per page. Minimum value: 1 -const pageSize = 30; // Results per page. Allowed values 1-100, default is 25. - -// WebhooksListResponse -const webhooks = await client.webhooks.list({ events, currentPage, pageSize }); -```