Package video.api.client.api.clients

Class ChaptersApi

java.lang.Object
video.api.client.api.clients.ChaptersApi
public class ChaptersApi
extends java.lang.Object

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    class  ChaptersApi.APIlistRequest  

  • Constructor Summary

    Constructors
    Constructor Description
    ChaptersApi​(ApiClient apiClient)  

  • Method Summary

    Modifier and Type Method Description
    void delete​(java.lang.String videoId, java.lang.String language)
    Delete a chapter
    ApiResponse<java.lang.Void> deleteWithHttpInfo​(java.lang.String videoId, java.lang.String language)
    Delete a chapter
    Chapter get​(java.lang.String videoId, java.lang.String language)
    Show a chapter
    ApiClient getApiClient()  
    ApiResponse<Chapter> getWithHttpInfo​(java.lang.String videoId, java.lang.String language)
    Show a chapter
    ChaptersApi.APIlistRequest list​(java.lang.String videoId)
    List video chapters Retrieve a list of all chapters for a specified video.
    void setApiClient​(ApiClient apiClient)  
    Chapter upload​(java.lang.String videoId, java.lang.String language, java.io.File file)
    Upload a chapter Chapters help break the video into sections.
    ApiResponse<Chapter> uploadWithHttpInfo​(java.lang.String videoId, java.lang.String language, java.io.File file)
    Upload a chapter Chapters help break the video into sections.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ChaptersApi

      public ChaptersApi​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • delete

      public void delete​(java.lang.String videoId, java.lang.String language) throws ApiException
      Delete a chapter
      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<java.lang.Void> deleteWithHttpInfo​(java.lang.String videoId, java.lang.String language) throws ApiException
      Delete a chapter
      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​(java.lang.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 -

    • get

      public Chapter get​(java.lang.String videoId, java.lang.String language) throws ApiException
      Show a chapter
      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​(java.lang.String videoId, java.lang.String language) throws ApiException
      Show a chapter
      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 -

    • upload

      public Chapter upload​(java.lang.String videoId, java.lang.String language, java.io.File file) throws ApiException
      Upload a chapter 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​(java.lang.String videoId, java.lang.String language, java.io.File file) throws ApiException
      Upload a chapter 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 -