Package video.api.client.api.clients

Class CaptionsApi

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    class  CaptionsApi.APIlistRequest  

  • Constructor Summary

    Constructors
    Constructor Description
    CaptionsApi​(ApiClient apiClient)  

  • Method Summary

    Modifier and Type Method Description
    void delete​(java.lang.String videoId, java.lang.String language)
    Delete a caption Delete a caption in a specific language by providing the video ID for the video you want to delete the caption from and the language the caption is in.
    ApiResponse<java.lang.Void> deleteWithHttpInfo​(java.lang.String videoId, java.lang.String language)
    Delete a caption Delete a caption in a specific language by providing the video ID for the video you want to delete the caption from and the language the caption is in.
    Subtitle get​(java.lang.String videoId, java.lang.String language)
    Show a caption Display a caption for a video in a specific language.
    ApiClient getApiClient()  
    ApiResponse<Subtitle> getWithHttpInfo​(java.lang.String videoId, java.lang.String language)
    Show a caption Display a caption for a video in a specific language.
    CaptionsApi.APIlistRequest list​(java.lang.String videoId)
    List video captions Retrieve a list of available captions for the videoId you provide.
    void setApiClient​(ApiClient apiClient)  
    Subtitle update​(java.lang.String videoId, java.lang.String language, CaptionsUpdatePayload captionsUpdatePayload)
    Update caption To have the captions on automatically, use this PATCH to set default: true.
    ApiResponse<Subtitle> updateWithHttpInfo​(java.lang.String videoId, java.lang.String language, CaptionsUpdatePayload captionsUpdatePayload)
    Update caption To have the captions on automatically, use this PATCH to set default: true.
    Subtitle upload​(java.lang.String videoId, java.lang.String language, java.io.File file)
    Upload a caption Upload a VTT file to add captions to your video.
    ApiResponse<Subtitle> uploadWithHttpInfo​(java.lang.String videoId, java.lang.String language, java.io.File file)
    Upload a caption Upload a VTT file to add captions to your video.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CaptionsApi

      public CaptionsApi​(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 caption Delete a caption in a specific language by providing the video ID for the video you want to delete the caption from and the language the caption is in.
      Parameters:
      videoId - The unique identifier for the video you want to delete a caption 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 caption Delete a caption in a specific language by providing the video ID for the video you want to delete the caption from and the language the caption is in.
      Parameters:
      videoId - The unique identifier for the video you want to delete a caption 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 CaptionsApi.APIlistRequest list​(java.lang.String videoId)
      List video captions Retrieve a list of available captions for the videoId you provide.
      Parameters:
      videoId - The unique identifier for the video you want to retrieve a list of captions for. (required)
      Returns:
      APIlistRequest
      Http Response Details:
      Status Code Description Response Headers
      200 Success -
      404 Not Found -

    • get

      public Subtitle get​(java.lang.String videoId, java.lang.String language) throws ApiException
      Show a caption Display a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a response indicating the caption was not found.
      Parameters:
      videoId - The unique identifier for the video you want captions for. (required)
      language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation (required)
      Returns:
      Subtitle
      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<Subtitle> getWithHttpInfo​(java.lang.String videoId, java.lang.String language) throws ApiException
      Show a caption Display a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a response indicating the caption was not found.
      Parameters:
      videoId - The unique identifier for the video you want captions for. (required)
      language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation (required)
      Returns:
      ApiResponse<Subtitle>
      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 -

    • update

      public Subtitle update​(java.lang.String videoId, java.lang.String language, CaptionsUpdatePayload captionsUpdatePayload) throws ApiException
      Update caption To have the captions on automatically, use this PATCH to set default: true.
      Parameters:
      videoId - The unique identifier for the video you want to have automatic captions for. (required)
      language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
      captionsUpdatePayload - (required)
      Returns:
      Subtitle
      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<Subtitle> updateWithHttpInfo​(java.lang.String videoId, java.lang.String language, CaptionsUpdatePayload captionsUpdatePayload) throws ApiException
      Update caption To have the captions on automatically, use this PATCH to set default: true.
      Parameters:
      videoId - The unique identifier for the video you want to have automatic captions for. (required)
      language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)
      captionsUpdatePayload - (required)
      Returns:
      ApiResponse<Subtitle>
      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 -

    • upload

      public Subtitle upload​(java.lang.String videoId, java.lang.String language, java.io.File file) throws ApiException
      Upload a caption Upload a VTT file to add captions to your video. Read our [captioning tutorial](https://api.video/blog/tutorials/adding-captions) for more details.
      Parameters:
      videoId - The unique identifier for the video you want to add a caption to. (required)
      language - A valid BCP 47 language representation. (required)
      file - The video text track (VTT) you want to upload. (required)
      Returns:
      Subtitle
      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<Subtitle> uploadWithHttpInfo​(java.lang.String videoId, java.lang.String language, java.io.File file) throws ApiException
      Upload a caption Upload a VTT file to add captions to your video. Read our [captioning tutorial](https://api.video/blog/tutorials/adding-captions) for more details.
      Parameters:
      videoId - The unique identifier for the video you want to add a caption to. (required)
      language - A valid BCP 47 language representation. (required)
      file - The video text track (VTT) you want to upload. (required)
      Returns:
      ApiResponse<Subtitle>
      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 -