Package video.api.client.api.clients

Class LiveApi.APIlistRequest

java.lang.Object
video.api.client.api.clients.LiveApi.APIlistRequest
Enclosing class:
LiveApi
public class LiveApi.APIlistRequest
extends java.lang.Object

  • Method Details

    • streamKey

      public LiveApi.APIlistRequest streamKey​(java.lang.String streamKey)
      Set streamKey
      Parameters:
      streamKey - The unique stream key that allows you to stream videos. (optional)
      Returns:
      APIlistRequest

    • name

      public LiveApi.APIlistRequest name​(java.lang.String name)
      Set name
      Parameters:
      name - You can filter live streams by their name or a part of their name. (optional)
      Returns:
      APIlistRequest

    • sortBy

      public LiveApi.APIlistRequest sortBy​(java.lang.String sortBy)
      Set sortBy
      Parameters:
      sortBy - Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. (optional)
      Returns:
      APIlistRequest

    • sortOrder

      public LiveApi.APIlistRequest sortOrder​(java.lang.String sortOrder)
      Set sortOrder
      Parameters:
      sortOrder - Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)
      Returns:
      APIlistRequest

    • currentPage

      public LiveApi.APIlistRequest currentPage​(java.lang.Integer currentPage)
      Set currentPage
      Parameters:
      currentPage - Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      Returns:
      APIlistRequest

    • pageSize

      public LiveApi.APIlistRequest pageSize​(java.lang.Integer pageSize)
      Set pageSize
      Parameters:
      pageSize - Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
      Returns:
      APIlistRequest

    • buildCall

      public okhttp3.Call buildCall​(ApiCallback _callback) throws ApiException
      Build call for list
      Parameters:
      _callback - ApiCallback API callback
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 Success -

    • execute

      public Page<LiveStream> execute() throws ApiException
      Execute list request
      Returns:
      LiveStreamListResponse
      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 -

    • executeWithHttpInfo

      public ApiResponse<LiveStreamListResponse> executeWithHttpInfo() throws ApiException
      Execute list request with HTTP info returned
      Returns:
      ApiResponse<LiveStreamListResponse>
      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 -