Package video.api.client.api.clients

Class ChaptersApi

  • public class ChaptersApi
extends Object

    • Constructor Detail

      • ChaptersApi

        public ChaptersApi​(ApiClient apiClient)

      • ChaptersApi

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

      • ChaptersApi

        public ChaptersApi​(String basePath)
        Constructor for ChaptersApi 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.

      • ChaptersApi

        public ChaptersApi​(String apiKey,
                   String basePath)
        Constructor for ChaptersApi 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.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • upload

        public Chapter upload​(String videoId,
                      String language,
                      File file)
               throws ApiException
        Upload a chapter 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.
        Parameters:
        videoId - The unique identifier for the video you want to upload a chapter for. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
        file - The VTT file describing the chapters you want to upload. (required)
        Returns:
        Chapter
        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 -

      • uploadWithHttpInfo

        public ApiResponse<Chapter> uploadWithHttpInfo​(String videoId,
                                               String language,
                                               File file)
                                        throws ApiException
        Upload a chapter 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.
        Parameters:
        videoId - The unique identifier for the video you want to upload a chapter for. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
        file - The VTT file describing the chapters you want to upload. (required)
        Returns:
        ApiResponse<Chapter>
        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 -

      • get

        public Chapter get​(String videoId,
                   String language)
            throws ApiException
        Retrieve a chapter Retrieve a chapter for a video in a specific language. Chapters help your viewers find the sections of the video they are most interested in viewing. Tutorials that use the [chapters endpoint](https://api.video/blog/endpoints/chapters).
        Parameters:
        videoId - The unique identifier for the video you want to show a chapter for. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
        Returns:
        Chapter
        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<Chapter> getWithHttpInfo​(String videoId,
                                            String language)
                                     throws ApiException
        Retrieve a chapter Retrieve a chapter for a video in a specific language. Chapters help your viewers find the sections of the video they are most interested in viewing. Tutorials that use the [chapters endpoint](https://api.video/blog/endpoints/chapters).
        Parameters:
        videoId - The unique identifier for the video you want to show a chapter for. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
        Returns:
        ApiResponse<Chapter>
        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 -

      • delete

        public void delete​(String videoId,
                   String language)
            throws ApiException
        Delete a chapter Delete a chapter in a specific language by providing the video ID for the video you want to delete the chapter from and the language the chapter is in.
        Parameters:
        videoId - The unique identifier for the video you want to delete a chapter from. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (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,
                                            String language)
                                     throws ApiException
        Delete a chapter Delete a chapter in a specific language by providing the video ID for the video you want to delete the chapter from and the language the chapter is in.
        Parameters:
        videoId - The unique identifier for the video you want to delete a chapter from. (required)
        language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (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 -

      • list

        public ChaptersApi.APIlistRequest list​(String videoId)
        List video chapters Retrieve a list of all chapters for a specified video.
        Parameters:
        videoId - The unique identifier for the video you want to retrieve a list of chapters for. (required)
        Returns:
        APIlistRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        404 Not Found -