Package video.api.client.api.clients

Class VideosApi

  • public class VideosApi
extends Object

    • Constructor Detail

      • VideosApi

        public VideosApi​(ApiClient apiClient)

      • VideosApi

        public VideosApi()
        Constructor for VideosApi production environment where API key is not required.

      • VideosApi

        public VideosApi​(String basePath)
        Constructor for VideosApi with custom API base path where API key is not required.
        Parameters:
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • VideosApi

        public VideosApi​(Environment environment)
        Constructor for VideosApi with custom API base path where API key is not required.
        Parameters:
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

      • VideosApi

        public VideosApi​(String apiKey,
                 String basePath)
        Constructor for VideosApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • VideosApi

        public VideosApi​(String apiKey,
                 Environment environment)
        Constructor for VideosApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • create

        public Video create​(VideoCreationPayload videoCreationPayload)
             throws ApiException
        Create a video object Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1).
        Parameters:
        videoCreationPayload - video to create (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        202 Accepted -
        400 Bad Request -

      • createWithHttpInfo

        public ApiResponse<Video> createWithHttpInfo​(VideoCreationPayload videoCreationPayload)
                                      throws ApiException
        Create a video object Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1).
        Parameters:
        videoCreationPayload - video to create (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        202 Accepted -
        400 Bad Request -

      • createAsync

        public okhttp3.Call createAsync​(VideoCreationPayload videoCreationPayload,
                                ApiCallback<Video> _callback)
                         throws ApiException
        Create a video object (asynchronously) Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1).
        Parameters:
        videoCreationPayload - video to create (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        202 Accepted -
        400 Bad Request -

      • upload

        public Video upload​(String videoId,
                    File file)
             throws ApiException
        Upload a video To upload a video to the videoId you created. You can only upload your video to the videoId once. We offer 2 types of upload: Regular upload Progressive upload The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload) allow to send a video source "progressively", i.e., before before knowing the total size of the video. Once all chunks have been sent, they are reaggregated to one source file. The video source is considered as "completely sent" when the "last" chunk is sent (i.e., the chunk that "completes" the upload).
        Parameters:
        videoId - Enter the videoId you want to use to upload your video. (required)
        file - The path to the video you would like to upload. The path must be local. If you want to use a video from an online source, you must use the \\\"/videos\\\" endpoint and add the \\\"source\\\" parameter when you create a new video. (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -
        404 Not Found -

      • upload

        public Video upload​(String videoId,
                    File file,
                    UploadProgressListener uploadProgressListener)
             throws ApiException
        Upload a video To upload a video to the videoId you created. You can only upload your video to the videoId once. We offer 2 types of upload: Regular upload Progressive upload The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload) allow to send a video source "progressively", i.e., before before knowing the total size of the video. Once all chunks have been sent, they are reaggregated to one source file. The video source is considered as "completely sent" when the "last" chunk is sent (i.e., the chunk that "completes" the upload).
        Parameters:
        videoId - Enter the videoId you want to use to upload your video. (required)
        file - The path to the video you would like to upload. The path must be local. If you want to use a video from an online source, you must use the \\\"/videos\\\" endpoint and add the \\\"source\\\" parameter when you create a new video. (required)
        uploadProgressListener - An upload progress listener
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -
        404 Not Found -

      • uploadWithHttpInfo

        public ApiResponse<Video> uploadWithHttpInfo​(String videoId,
                                             File file)
                                      throws ApiException
        Upload a video To upload a video to the videoId you created. You can only upload your video to the videoId once. We offer 2 types of upload: Regular upload Progressive upload The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload) allow to send a video source "progressively", i.e., before before knowing the total size of the video. Once all chunks have been sent, they are reaggregated to one source file. The video source is considered as "completely sent" when the "last" chunk is sent (i.e., the chunk that "completes" the upload).
        Parameters:
        videoId - Enter the videoId you want to use to upload your video. (required)
        file - The path to the video you would like to upload. The path must be local. If you want to use a video from an online source, you must use the \\\"/videos\\\" endpoint and add the \\\"source\\\" parameter when you create a new video. (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -
        404 Not Found -

      • uploadWithHttpInfo

        public ApiResponse<Video> uploadWithHttpInfo​(String videoId,
                                             File file,
                                             UploadProgressListener uploadProgressListener)
                                      throws ApiException
        Upload a video To upload a video to the videoId you created. You can only upload your video to the videoId once. We offer 2 types of upload: Regular upload Progressive upload The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload) allow to send a video source "progressively", i.e., before before knowing the total size of the video. Once all chunks have been sent, they are reaggregated to one source file. The video source is considered as "completely sent" when the "last" chunk is sent (i.e., the chunk that "completes" the upload).
        Parameters:
        videoId - Enter the videoId you want to use to upload your video. (required)
        file - The path to the video you would like to upload. The path must be local. If you want to use a video from an online source, you must use the \\\"/videos\\\" endpoint and add the \\\"source\\\" parameter when you create a new video. (required)
        uploadProgressListener - An upload progress listener
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -
        404 Not Found -

      • uploadWithUploadToken

        public Video uploadWithUploadToken​(String token,
                                   File file)
                            throws ApiException
        Upload with an delegated upload token This method allows you to send a video using an upload token. Upload tokens are especially useful when the upload is done from the client side. If you want to upload a video from your server-side application, you'd better use the [standard upload method](#upload).
        Parameters:
        token - The unique identifier for the token you want to use to upload a video. (required)
        file - The path to the video you want to upload. (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -

      • uploadWithUploadToken

        public Video uploadWithUploadToken​(String token,
                                   File file,
                                   String videoId,
                                   UploadProgressListener uploadProgressListener)
                            throws ApiException
        Upload with an delegated upload token This method allows you to send a video using an upload token. Upload tokens are especially useful when the upload is done from the client side. If you want to upload a video from your server-side application, you'd better use the [standard upload method](#upload).
        Parameters:
        token - The unique identifier for the token you want to use to upload a video. (required)
        file - The path to the video you want to upload. (required)
        uploadProgressListener - An upload progress listener
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -

      • uploadWithUploadToken

        public Video uploadWithUploadToken​(String token,
                                   File file,
                                   UploadProgressListener uploadProgressListener)
                            throws ApiException
        Upload with an delegated upload token This method allows you to send a video using an upload token. Upload tokens are especially useful when the upload is done from the client side. If you want to upload a video from your server-side application, you'd better use the [standard upload method](#upload).
        Parameters:
        token - The unique identifier for the token you want to use to upload a video. (required)
        file - The path to the video you want to upload. (required)
        uploadProgressListener - An upload progress listener
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -

      • uploadWithUploadTokenWithHttpInfo

        public ApiResponse<Video> uploadWithUploadTokenWithHttpInfo​(String token,
                                                            File file)
                                                     throws ApiException
        Upload with an delegated upload token This method allows you to send a video using an upload token. Upload tokens are especially useful when the upload is done from the client side. If you want to upload a video from your server-side application, you'd better use the [standard upload method](#upload).
        Parameters:
        token - The unique identifier for the token you want to use to upload a video. (required)
        file - The path to the video you want to upload. (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -

      • uploadWithUploadTokenWithHttpInfo

        public ApiResponse<Video> uploadWithUploadTokenWithHttpInfo​(String token,
                                                            File file,
                                                            String videoId,
                                                            UploadProgressListener uploadProgressListener)
                                                     throws ApiException
        Upload with an delegated upload token This method allows you to send a video using an upload token. Upload tokens are especially useful when the upload is done from the client side. If you want to upload a video from your server-side application, you'd better use the [standard upload method](#upload).
        Parameters:
        token - The unique identifier for the token you want to use to upload a video. (required)
        file - The path to the video you want to upload. (required)
        uploadProgressListener - An upload progress listener
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        400 Bad Request -

      • get

        public Video get​(String videoId)
          throws ApiException
        Retrieve a video object This call provides the same information provided on video creation. For private videos, it will generate a unique token url. Use this to retrieve any details you need about a video, or set up a private viewing URL.
        Parameters:
        videoId - The unique identifier for the video you want details about. (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • getWithHttpInfo

        public ApiResponse<Video> getWithHttpInfo​(String videoId)
                                   throws ApiException
        Retrieve a video object This call provides the same information provided on video creation. For private videos, it will generate a unique token url. Use this to retrieve any details you need about a video, or set up a private viewing URL.
        Parameters:
        videoId - The unique identifier for the video you want details about. (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • getAsync

        public okhttp3.Call getAsync​(String videoId,
                             ApiCallback<Video> _callback)
                      throws ApiException
        Retrieve a video object (asynchronously) This call provides the same information provided on video creation. For private videos, it will generate a unique token url. Use this to retrieve any details you need about a video, or set up a private viewing URL.
        Parameters:
        videoId - The unique identifier for the video you want details about. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • update

        public Video update​(String videoId,
                    VideoUpdatePayload videoUpdatePayload)
             throws ApiException
        Update a video object Updates the parameters associated with a video ID. The video object you are updating is determined by the video ID you provide. NOTE: If you are updating an array, you must provide the entire array as what you provide here overwrites what is in the system rather than appending to it.
        Parameters:
        videoId - The video ID for the video you want to update. (required)
        videoUpdatePayload - (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • updateWithHttpInfo

        public ApiResponse<Video> updateWithHttpInfo​(String videoId,
                                             VideoUpdatePayload videoUpdatePayload)
                                      throws ApiException
        Update a video object Updates the parameters associated with a video ID. The video object you are updating is determined by the video ID you provide. NOTE: If you are updating an array, you must provide the entire array as what you provide here overwrites what is in the system rather than appending to it.
        Parameters:
        videoId - The video ID for the video you want to update. (required)
        videoUpdatePayload - (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • updateAsync

        public okhttp3.Call updateAsync​(String videoId,
                                VideoUpdatePayload videoUpdatePayload,
                                ApiCallback<Video> _callback)
                         throws ApiException
        Update a video object (asynchronously) Updates the parameters associated with a video ID. The video object you are updating is determined by the video ID you provide. NOTE: If you are updating an array, you must provide the entire array as what you provide here overwrites what is in the system rather than appending to it.
        Parameters:
        videoId - The video ID for the video you want to update. (required)
        videoUpdatePayload - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • delete

        public void delete​(String videoId)
            throws ApiException
        Delete a video object If you do not need a video any longer, you can send a request to delete it. All you need is the videoId.
        Parameters:
        videoId - The video ID for the video you want to delete. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        404 Not Found -

      • deleteWithHttpInfo

        public ApiResponse<Void> deleteWithHttpInfo​(String videoId)
                                     throws ApiException
        Delete a video object If you do not need a video any longer, you can send a request to delete it. All you need is the videoId.
        Parameters:
        videoId - The video ID for the video you want to delete. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        404 Not Found -

      • deleteAsync

        public okhttp3.Call deleteAsync​(String videoId,
                                ApiCallback<Void> _callback)
                         throws ApiException
        Delete a video object (asynchronously) If you do not need a video any longer, you can send a request to delete it. All you need is the videoId.
        Parameters:
        videoId - The video ID for the video you want to delete. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        404 Not Found -

      • list

        public VideosApi.APIlistRequest list()
        List all video objects This method returns a list of your videos (with all their details). With no parameters added, the API returns the first page of all videos. You can filter videos using the parameters described below.
        Returns:
        APIlistRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -

      • uploadThumbnail

        public Video uploadThumbnail​(String videoId,
                             File file)
                      throws ApiException
        Upload a thumbnail The thumbnail is the poster that appears in the player window before video playback begins. This endpoint allows you to upload an image for the thumbnail. To select a still frame from the video using a time stamp, use the [dedicated method](#pickThumbnail) to pick a time in the video. Note: There may be a short delay before the new thumbnail is delivered to our CDN.
        Parameters:
        videoId - Unique identifier of the chosen video (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • uploadThumbnailWithHttpInfo

        public ApiResponse<Video> uploadThumbnailWithHttpInfo​(String videoId,
                                                      File file)
                                               throws ApiException
        Upload a thumbnail The thumbnail is the poster that appears in the player window before video playback begins. This endpoint allows you to upload an image for the thumbnail. To select a still frame from the video using a time stamp, use the [dedicated method](#pickThumbnail) to pick a time in the video. Note: There may be a short delay before the new thumbnail is delivered to our CDN.
        Parameters:
        videoId - Unique identifier of the chosen video (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • uploadThumbnailAsync

        public okhttp3.Call uploadThumbnailAsync​(String videoId,
                                         File file,
                                         ApiCallback<Video> _callback)
                                  throws ApiException
        Upload a thumbnail (asynchronously) The thumbnail is the poster that appears in the player window before video playback begins. This endpoint allows you to upload an image for the thumbnail. To select a still frame from the video using a time stamp, use the [dedicated method](#pickThumbnail) to pick a time in the video. Note: There may be a short delay before the new thumbnail is delivered to our CDN.
        Parameters:
        videoId - Unique identifier of the chosen video (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad Request -
        404 Not Found -

      • pickThumbnail

        public Video pickThumbnail​(String videoId,
                           VideoThumbnailPickPayload videoThumbnailPickPayload)
                    throws ApiException
        Set a thumbnail Pick a thumbnail from the given time code. If you'd like to upload an image for your thumbnail, use the dedicated [method](#uploadThumbnail). There may be a short delay for the thumbnail to update.
        Parameters:
        videoId - Unique identifier of the video you want to add a thumbnail to, where you use a section of your video as the thumbnail. (required)
        videoThumbnailPickPayload - (required)
        Returns:
        Video
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • pickThumbnailWithHttpInfo

        public ApiResponse<Video> pickThumbnailWithHttpInfo​(String videoId,
                                                    VideoThumbnailPickPayload videoThumbnailPickPayload)
                                             throws ApiException
        Set a thumbnail Pick a thumbnail from the given time code. If you'd like to upload an image for your thumbnail, use the dedicated [method](#uploadThumbnail). There may be a short delay for the thumbnail to update.
        Parameters:
        videoId - Unique identifier of the video you want to add a thumbnail to, where you use a section of your video as the thumbnail. (required)
        videoThumbnailPickPayload - (required)
        Returns:
        ApiResponse<Video>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • pickThumbnailAsync

        public okhttp3.Call pickThumbnailAsync​(String videoId,
                                       VideoThumbnailPickPayload videoThumbnailPickPayload,
                                       ApiCallback<Video> _callback)
                                throws ApiException
        Set a thumbnail (asynchronously) Pick a thumbnail from the given time code. If you'd like to upload an image for your thumbnail, use the dedicated [method](#uploadThumbnail). There may be a short delay for the thumbnail to update.
        Parameters:
        videoId - Unique identifier of the video you want to add a thumbnail to, where you use a section of your video as the thumbnail. (required)
        videoThumbnailPickPayload - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • getStatus

        public VideoStatus getStatus​(String videoId)
                      throws ApiException
        Retrieve video status and details This method provides upload status & encoding status to determine when the video is uploaded or ready to playback. Once encoding is completed, the response also lists the available stream qualities.
        Parameters:
        videoId - The unique identifier for the video you want the status for. (required)
        Returns:
        VideoStatus
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • getStatusWithHttpInfo

        public ApiResponse<VideoStatus> getStatusWithHttpInfo​(String videoId)
                                               throws ApiException
        Retrieve video status and details This method provides upload status & encoding status to determine when the video is uploaded or ready to playback. Once encoding is completed, the response also lists the available stream qualities.
        Parameters:
        videoId - The unique identifier for the video you want the status for. (required)
        Returns:
        ApiResponse<VideoStatus>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -

      • getStatusAsync

        public okhttp3.Call getStatusAsync​(String videoId,
                                   ApiCallback<VideoStatus> _callback)
                            throws ApiException
        Retrieve video status and details (asynchronously) This method provides upload status & encoding status to determine when the video is uploaded or ready to playback. Once encoding is completed, the response also lists the available stream qualities.
        Parameters:
        videoId - The unique identifier for the video you want the status for. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -