Package video.api.client.api.clients

Class LiveStreamsApi

  • public class LiveStreamsApi
extends Object

    • Constructor Detail

      • LiveStreamsApi

        public LiveStreamsApi​(ApiClient apiClient)

      • LiveStreamsApi

        public LiveStreamsApi()
        Constructor for LiveStreamsApi production environment where API key is not required.

      • LiveStreamsApi

        public LiveStreamsApi​(String basePath)
        Constructor for LiveStreamsApi with custom API base path where API key is not required.
        Parameters:
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • LiveStreamsApi

        public LiveStreamsApi​(Environment environment)
        Constructor for LiveStreamsApi with custom API base path where API key is not required.
        Parameters:
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

      • LiveStreamsApi

        public LiveStreamsApi​(String apiKey,
                      String basePath)
        Constructor for LiveStreamsApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

      • LiveStreamsApi

        public LiveStreamsApi​(String apiKey,
                      Environment environment)
        Constructor for LiveStreamsApi with custom API base path
        Parameters:
        apiKey - the api key to use to authenticate to the API
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • create

        public LiveStream create​(LiveStreamCreationPayload liveStreamCreationPayload)
                  throws ApiException
        Create live stream Creates a livestream object.
        Parameters:
        liveStreamCreationPayload - (required)
        Returns:
        LiveStream
        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 -

      • createWithHttpInfo

        public ApiResponse<LiveStream> createWithHttpInfo​(LiveStreamCreationPayload liveStreamCreationPayload)
                                           throws ApiException
        Create live stream Creates a livestream object.
        Parameters:
        liveStreamCreationPayload - (required)
        Returns:
        ApiResponse<LiveStream>
        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 -

      • createAsync

        public okhttp3.Call createAsync​(LiveStreamCreationPayload liveStreamCreationPayload,
                                ApiCallback<LiveStream> _callback)
                         throws ApiException
        Create live stream (asynchronously) Creates a livestream object.
        Parameters:
        liveStreamCreationPayload - (required)
        _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 -
        400 Bad Request -

      • get

        public LiveStream get​(String liveStreamId)
               throws ApiException
        Retrieve live stream Get a livestream by id.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to watch. (required)
        Returns:
        LiveStream
        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 -

      • getWithHttpInfo

        public ApiResponse<LiveStream> getWithHttpInfo​(String liveStreamId)
                                        throws ApiException
        Retrieve live stream Get a livestream by id.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to watch. (required)
        Returns:
        ApiResponse<LiveStream>
        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 -

      • getAsync

        public okhttp3.Call getAsync​(String liveStreamId,
                             ApiCallback<LiveStream> _callback)
                      throws ApiException
        Retrieve live stream (asynchronously) Get a livestream by id.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to watch. (required)
        _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 -

      • update

        public LiveStream update​(String liveStreamId,
                         LiveStreamUpdatePayload liveStreamUpdatePayload)
                  throws ApiException
        Update a live stream Updates the livestream object.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off. (required)
        liveStreamUpdatePayload - (required)
        Returns:
        LiveStream
        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 -

      • updateWithHttpInfo

        public ApiResponse<LiveStream> updateWithHttpInfo​(String liveStreamId,
                                                  LiveStreamUpdatePayload liveStreamUpdatePayload)
                                           throws ApiException
        Update a live stream Updates the livestream object.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off. (required)
        liveStreamUpdatePayload - (required)
        Returns:
        ApiResponse<LiveStream>
        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 -

      • updateAsync

        public okhttp3.Call updateAsync​(String liveStreamId,
                                LiveStreamUpdatePayload liveStreamUpdatePayload,
                                ApiCallback<LiveStream> _callback)
                         throws ApiException
        Update a live stream (asynchronously) Updates the livestream object.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off. (required)
        liveStreamUpdatePayload - (required)
        _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 -
        400 Bad Request -

      • delete

        public void delete​(String liveStreamId)
            throws ApiException
        Delete a live stream If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to remove. (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 -

      • deleteWithHttpInfo

        public ApiResponse<Void> deleteWithHttpInfo​(String liveStreamId)
                                     throws ApiException
        Delete a live stream If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to remove. (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 -

      • deleteAsync

        public okhttp3.Call deleteAsync​(String liveStreamId,
                                ApiCallback<Void> _callback)
                         throws ApiException
        Delete a live stream (asynchronously) If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.
        Parameters:
        liveStreamId - The unique ID for the live stream that you want to remove. (required)
        _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
        204 No Content -

      • list

        public LiveStreamsApi.APIlistRequest list()
        List all live streams Get the list of livestreams on the workspace.
        Returns:
        APIlistRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -

      • uploadThumbnail

        public LiveStream uploadThumbnail​(String liveStreamId,
                                  File file)
                           throws ApiException
        Upload a thumbnail Upload the thumbnail for the livestream.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to upload. (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        Returns:
        LiveStream
        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 -

      • uploadThumbnailWithHttpInfo

        public ApiResponse<LiveStream> uploadThumbnailWithHttpInfo​(String liveStreamId,
                                                           File file)
                                                    throws ApiException
        Upload a thumbnail Upload the thumbnail for the livestream.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to upload. (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        Returns:
        ApiResponse<LiveStream>
        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 -

      • uploadThumbnailAsync

        public okhttp3.Call uploadThumbnailAsync​(String liveStreamId,
                                         File file,
                                         ApiCallback<LiveStream> _callback)
                                  throws ApiException
        Upload a thumbnail (asynchronously) Upload the thumbnail for the livestream.
        Parameters:
        liveStreamId - The unique ID for the live stream you want to upload. (required)
        file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)
        _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
        201 Created -
        400 Bad Request -
        404 Not Found -

      • deleteThumbnail

        public LiveStream deleteThumbnail​(String liveStreamId)
                           throws ApiException
        Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.
        Parameters:
        liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (required)
        Returns:
        LiveStream
        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 -

      • deleteThumbnailWithHttpInfo

        public ApiResponse<LiveStream> deleteThumbnailWithHttpInfo​(String liveStreamId)
                                                    throws ApiException
        Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.
        Parameters:
        liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (required)
        Returns:
        ApiResponse<LiveStream>
        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 -

      • deleteThumbnailAsync

        public okhttp3.Call deleteThumbnailAsync​(String liveStreamId,
                                         ApiCallback<LiveStream> _callback)
                                  throws ApiException
        Delete a thumbnail (asynchronously) Send the unique identifier for a live stream to delete its thumbnail.
        Parameters:
        liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (required)
        _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 -
        404 Not Found -