Package video.api.client.api.clients

Class PlayersApi

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    class  PlayersApi.APIlistRequest  

  • Constructor Summary

    Constructors
    Constructor Description
    PlayersApi​(ApiClient apiClient)  

  • Method Summary

    Modifier and Type Method Description
    Player create​(PlayerCreationPayload playerCreationPayload)
    Create a player Create a player for your video, and customise it.
    ApiResponse<Player> createWithHttpInfo​(PlayerCreationPayload playerCreationPayload)
    Create a player Create a player for your video, and customise it.
    void delete​(java.lang.String playerId)
    Delete a player Delete a player if you no longer need it.
    java.lang.Object deleteLogo​(java.lang.String playerId)
    Delete logo
    ApiResponse<java.lang.Object> deleteLogoWithHttpInfo​(java.lang.String playerId)
    Delete logo
    ApiResponse<java.lang.Void> deleteWithHttpInfo​(java.lang.String playerId)
    Delete a player Delete a player if you no longer need it.
    Player get​(java.lang.String playerId)
    Show a player Use a player ID to retrieve details about the player and display it for viewers.
    ApiClient getApiClient()  
    ApiResponse<Player> getWithHttpInfo​(java.lang.String playerId)
    Show a player Use a player ID to retrieve details about the player and display it for viewers.
    PlayersApi.APIlistRequest list()
    List all players Retrieve a list of all the players you created, as well as details about each one.
    void setApiClient​(ApiClient apiClient)  
    Player update​(java.lang.String playerId, PlayerUpdatePayload playerUpdatePayload)
    Update a player Use a player ID to update specific details for a player.
    ApiResponse<Player> updateWithHttpInfo​(java.lang.String playerId, PlayerUpdatePayload playerUpdatePayload)
    Update a player Use a player ID to update specific details for a player.
    Player uploadLogo​(java.lang.String playerId, java.io.File file, java.lang.String link)
    Upload a logo The uploaded image maximum size should be 200x100 and its weight should be 200KB.
    ApiResponse<Player> uploadLogoWithHttpInfo​(java.lang.String playerId, java.io.File file, java.lang.String link)
    Upload a logo The uploaded image maximum size should be 200x100 and its weight should be 200KB.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlayersApi

      public PlayersApi​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • delete

      public void delete​(java.lang.String playerId) throws ApiException
      Delete a player Delete a player if you no longer need it. You can delete any player that you have the player ID for.
      Parameters:
      playerId - The unique identifier for the player 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<java.lang.Void> deleteWithHttpInfo​(java.lang.String playerId) throws ApiException
      Delete a player Delete a player if you no longer need it. You can delete any player that you have the player ID for.
      Parameters:
      playerId - The unique identifier for the player 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 -

    • deleteLogo

      public java.lang.Object deleteLogo​(java.lang.String playerId) throws ApiException
      Delete logo
      Parameters:
      playerId - The unique identifier for the player. (required)
      Returns:
      Object
      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 -

    • deleteLogoWithHttpInfo

      public ApiResponse<java.lang.Object> deleteLogoWithHttpInfo​(java.lang.String playerId) throws ApiException
      Delete logo
      Parameters:
      playerId - The unique identifier for the player. (required)
      Returns:
      ApiResponse<Object>
      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 PlayersApi.APIlistRequest list()
      List all players Retrieve a list of all the players you created, as well as details about each one.
      Returns:
      APIlistRequest
      Http Response Details:
      Status Code Description Response Headers
      200 Success -
      400 Bad Request -

    • get

      public Player get​(java.lang.String playerId) throws ApiException
      Show a player Use a player ID to retrieve details about the player and display it for viewers.
      Parameters:
      playerId - The unique identifier for the player you want to retrieve. (required)
      Returns:
      Player
      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<Player> getWithHttpInfo​(java.lang.String playerId) throws ApiException
      Show a player Use a player ID to retrieve details about the player and display it for viewers.
      Parameters:
      playerId - The unique identifier for the player you want to retrieve. (required)
      Returns:
      ApiResponse<Player>
      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 Player update​(java.lang.String playerId, PlayerUpdatePayload playerUpdatePayload) throws ApiException
      Update a player Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.
      Parameters:
      playerId - The unique identifier for the player. (required)
      playerUpdatePayload - (required)
      Returns:
      Player
      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 -

    • updateWithHttpInfo

      public ApiResponse<Player> updateWithHttpInfo​(java.lang.String playerId, PlayerUpdatePayload playerUpdatePayload) throws ApiException
      Update a player Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.
      Parameters:
      playerId - The unique identifier for the player. (required)
      playerUpdatePayload - (required)
      Returns:
      ApiResponse<Player>
      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 -

    • create

      public Player create​(PlayerCreationPayload playerCreationPayload) throws ApiException
      Create a player Create a player for your video, and customise it.
      Parameters:
      playerCreationPayload - (required)
      Returns:
      Player
      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 -

    • createWithHttpInfo

      public ApiResponse<Player> createWithHttpInfo​(PlayerCreationPayload playerCreationPayload) throws ApiException
      Create a player Create a player for your video, and customise it.
      Parameters:
      playerCreationPayload - (required)
      Returns:
      ApiResponse<Player>
      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 -

    • uploadLogo

      public Player uploadLogo​(java.lang.String playerId, java.io.File file, java.lang.String link) throws ApiException
      Upload a logo The uploaded image maximum size should be 200x100 and its weight should be 200KB. It will be scaled down to 30px height and converted to PNG to be displayed in the player.
      Parameters:
      playerId - The unique identifier for the player. (required)
      file - The name of the file you want to use for your logo. (required)
      link - The path to the file you want to upload and use as a logo. (required)
      Returns:
      Player
      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 -

    • uploadLogoWithHttpInfo

      public ApiResponse<Player> uploadLogoWithHttpInfo​(java.lang.String playerId, java.io.File file, java.lang.String link) throws ApiException
      Upload a logo The uploaded image maximum size should be 200x100 and its weight should be 200KB. It will be scaled down to 30px height and converted to PNG to be displayed in the player.
      Parameters:
      playerId - The unique identifier for the player. (required)
      file - The name of the file you want to use for your logo. (required)
      link - The path to the file you want to upload and use as a logo. (required)
      Returns:
      ApiResponse<Player>
      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 -