Package video.api.client.api.clients

Class LiveStreamsApi.APIlistRequest

    • Method Detail

      • streamKey

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

      • name

        public LiveStreamsApi.APIlistRequest name​(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 LiveStreamsApi.APIlistRequest sortBy​(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 LiveStreamsApi.APIlistRequest sortOrder​(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 LiveStreamsApi.APIlistRequest currentPage​(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 LiveStreamsApi.APIlistRequest pageSize​(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 -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Page<LiveStream>> _callback)
                          throws ApiException
        Execute list request (asynchronously)
        Parameters:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -