diff --git a/docs/Api/CaptionsApi.md b/docs/Api/CaptionsApi.md index c98635e..813c4a8 100644 --- a/docs/Api/CaptionsApi.md +++ b/docs/Api/CaptionsApi.md @@ -15,7 +15,7 @@ Method | Description | HTTP request -Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/reference/captions) +Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions) ### Arguments diff --git a/docs/Api/ChaptersApi.md b/docs/Api/ChaptersApi.md index 1fa105d..1b1bdae 100644 --- a/docs/Api/ChaptersApi.md +++ b/docs/Api/ChaptersApi.md @@ -16,7 +16,7 @@ Method | Description | HTTP request Upload a VTT file to add chapters to your video. -Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos) for more details. +Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details. ### Arguments diff --git a/docs/Api/UploadTokensApi.md b/docs/Api/UploadTokensApi.md index e835200..a1a8e38 100644 --- a/docs/Api/UploadTokensApi.md +++ b/docs/Api/UploadTokensApi.md @@ -14,7 +14,7 @@ Method | Description | HTTP request -Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens) +Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/vod/delegated-upload-tokens) ### Arguments diff --git a/docs/Api/VideosApi.md b/docs/Api/VideosApi.md index dbff5c9..bd62954 100644 --- a/docs/Api/VideosApi.md +++ b/docs/Api/VideosApi.md @@ -20,7 +20,7 @@ Method | Description | HTTP request -Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1). +Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/api/Videos). @@ -216,7 +216,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- `title` | **string**| The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. | [optional] `tags` | [**string[]**](../Model/string.md)| A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. | [optional] - `metadata` | [**array**](../Model/string.md)| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. | [optional] + `metadata` | [**array**](../Model/string.md)| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. | [optional] `description` | **string**| Retrieve video objects by `description`. | [optional] `liveStreamId` | **string**| Retrieve video objects that were recorded from a live stream by `liveStreamId`. | [optional] `sortBy` | **string**| Use this parameter to sort videos by the their created time, published time, updated time, or by title. | [optional] diff --git a/docs/Model/LiveStream.md b/docs/Model/LiveStream.md index f6a399c..ad22790 100644 --- a/docs/Model/LiveStream.md +++ b/docs/Model/LiveStream.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **liveStreamId** | **string** | The unique identifier for the live stream. Live stream IDs begin with \"li.\" | **name** | **string** | The name of your live stream. | [optional] **streamKey** | **string** | The unique, private stream key that you use to begin streaming. | [optional] -**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). | [optional] +**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). | [optional] **assets** | [**\ApiVideo\Client\Model\LiveStreamAssets**](LiveStreamAssets.md) | | [optional] **playerId** | **string** | The unique identifier for the player. | [optional] **broadcasting** | **bool** | Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not. | [optional] diff --git a/docs/Model/LiveStreamCreationPayload.md b/docs/Model/LiveStreamCreationPayload.md index 2f08c26..a5822f7 100644 --- a/docs/Model/LiveStreamCreationPayload.md +++ b/docs/Model/LiveStreamCreationPayload.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Add a name for your live stream here. | -**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). | [optional] +**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). | [optional] **playerId** | **string** | The unique identifier for the player. | [optional] **restreams** | [**\ApiVideo\Client\Model\RestreamsRequestObject[]**](RestreamsRequestObject.md) | 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. | [optional] diff --git a/docs/Model/LiveStreamUpdatePayload.md b/docs/Model/LiveStreamUpdatePayload.md index 45555c6..23c9579 100644 --- a/docs/Model/LiveStreamUpdatePayload.md +++ b/docs/Model/LiveStreamUpdatePayload.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | The name you want to use for your live stream. | [optional] -**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). | [optional] +**public** | **bool** | 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). | [optional] **playerId** | **string** | The unique ID for the player associated with a live stream that you want to update. | [optional] **restreams** | [**\ApiVideo\Client\Model\RestreamsRequestObject[]**](RestreamsRequestObject.md) | 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. This operation updates all restream destinations in the same request. If you do not want to modify an existing restream destination, you need to include it in your request, otherwise it is removed. | [optional] diff --git a/docs/Model/Video.md b/docs/Model/Video.md index 2ec3a5a..92fa0cb 100644 --- a/docs/Model/Video.md +++ b/docs/Model/Video.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **publishedAt** | [**\DateTime**](\DateTime.md) | The date and time the API created the video. Date and time are provided using ISO-8601 UTC format. | [optional] **updatedAt** | [**\DateTime**](\DateTime.md) | The date and time the video was updated. Date and time are provided using ISO-8601 UTC format. | [optional] **tags** | **string[]** | One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces. | [optional] -**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. | [optional] +**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. | [optional] **source** | [**\ApiVideo\Client\Model\VideoSource**](VideoSource.md) | | [optional] **assets** | [**\ApiVideo\Client\Model\VideoAssets**](VideoAssets.md) | | [optional] **playerId** | **string** | The id of the player that will be applied on the video. | [optional] -**public** | **bool** | Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos). | [optional] +**public** | **bool** | Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). | [optional] **panoramic** | **bool** | Defines if video is panoramic. | [optional] **mp4Support** | **bool** | This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video. | [optional] diff --git a/docs/Model/VideoCreationPayload.md b/docs/Model/VideoCreationPayload.md index 7b153d2..7182f81 100644 --- a/docs/Model/VideoCreationPayload.md +++ b/docs/Model/VideoCreationPayload.md @@ -7,12 +7,12 @@ Name | Type | Description | Notes **title** | **string** | The title of your new video. | **description** | **string** | A brief description of your video. | [optional] **source** | **string** | You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` of one of the videos you already have on your api.video acccount, and this will generate a copy of your video. Creating a copy of a video can be especially useful if you want to keep your original video and trim or apply a watermark onto the copy you would create. | [optional] -**public** | **bool** | Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos) | [optional] [default to true] +**public** | **bool** | Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management) | [optional] [default to true] **panoramic** | **bool** | Indicates if your video is a 360/immersive video. | [optional] [default to false] **mp4Support** | **bool** | Enables mp4 version in addition to streamed version. | [optional] [default to true] **playerId** | **string** | The unique identification number for your video player. | [optional] **tags** | **string[]** | A list of tags you want to use to describe your video. | [optional] -**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | 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. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata). | [optional] +**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | 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. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata/). | [optional] **clip** | [**\ApiVideo\Client\Model\VideoClip**](VideoClip.md) | | [optional] **watermark** | [**\ApiVideo\Client\Model\VideoWatermark**](VideoWatermark.md) | | [optional] diff --git a/docs/Model/VideoUpdatePayload.md b/docs/Model/VideoUpdatePayload.md index 157280b..1e64d27 100644 --- a/docs/Model/VideoUpdatePayload.md +++ b/docs/Model/VideoUpdatePayload.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **playerId** | **string** | The unique ID for the player you want to associate with your video. | [optional] **title** | **string** | The title you want to use for your video. | [optional] **description** | **string** | A brief description of the video. | [optional] -**public** | **bool** | Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos). | [optional] +**public** | **bool** | Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). | [optional] **panoramic** | **bool** | Whether the video is a 360 degree or immersive video. | [optional] **mp4Support** | **bool** | Whether the player supports the mp4 format. | [optional] **tags** | **string[]** | 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. | [optional] -**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | 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. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. | [optional] +**metadata** | [**\ApiVideo\Client\Model\Metadata[]**](Metadata.md) | 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. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. | [optional] [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/src/Model/LiveStream.php b/src/Model/LiveStream.php index 30b58ac..4887a2f 100644 --- a/src/Model/LiveStream.php +++ b/src/Model/LiveStream.php @@ -249,7 +249,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). + * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). * * @return self */ diff --git a/src/Model/LiveStreamCreationPayload.php b/src/Model/LiveStreamCreationPayload.php index db6e916..60709ce 100644 --- a/src/Model/LiveStreamCreationPayload.php +++ b/src/Model/LiveStreamCreationPayload.php @@ -160,7 +160,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). + * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). * * @return self */ diff --git a/src/Model/LiveStreamUpdatePayload.php b/src/Model/LiveStreamUpdatePayload.php index 3d9cf9a..6169e60 100644 --- a/src/Model/LiveStreamUpdatePayload.php +++ b/src/Model/LiveStreamUpdatePayload.php @@ -157,7 +157,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). + * @param bool|null $public 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. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). * * @return self */ diff --git a/src/Model/Video.php b/src/Model/Video.php index 2145f98..f67aed6 100644 --- a/src/Model/Video.php +++ b/src/Model/Video.php @@ -370,7 +370,7 @@ public function getMetadata() /** * Sets metadata * - * @param \ApiVideo\Client\Model\Metadata[]|null $metadata Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. + * @param \ApiVideo\Client\Model\Metadata[]|null $metadata Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. * * @return self */ @@ -466,7 +466,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos). + * @param bool|null $public Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). * * @return self */ diff --git a/src/Model/VideoCreationPayload.php b/src/Model/VideoCreationPayload.php index 7c31092..43bd0ea 100644 --- a/src/Model/VideoCreationPayload.php +++ b/src/Model/VideoCreationPayload.php @@ -253,7 +253,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos) + * @param bool|null $public Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management) * * @return self */ @@ -373,7 +373,7 @@ public function getMetadata() /** * Sets metadata * - * @param \ApiVideo\Client\Model\Metadata[]|null $metadata 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. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata). + * @param \ApiVideo\Client\Model\Metadata[]|null $metadata 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. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata/). * * @return self */ diff --git a/src/Model/VideoUpdatePayload.php b/src/Model/VideoUpdatePayload.php index 9849058..ab01091 100644 --- a/src/Model/VideoUpdatePayload.php +++ b/src/Model/VideoUpdatePayload.php @@ -239,7 +239,7 @@ public function getPublic() /** * Sets public * - * @param bool|null $public Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos). + * @param bool|null $public Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). * * @return self */ @@ -335,7 +335,7 @@ public function getMetadata() /** * Sets metadata * - * @param \ApiVideo\Client\Model\Metadata[]|null $metadata 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. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. + * @param \ApiVideo\Client\Model\Metadata[]|null $metadata 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. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. * * @return self */