Skip to content

Latest commit

 

History

History
300 lines (213 loc) · 9.91 KB

RecordingsApi.md

File metadata and controls

300 lines (213 loc) · 9.91 KB

RecordingsApi

All URIs are relative to https://api.cloud.wowza.com/api/v1.3

Method HTTP request Description
deleteRecording DELETErecordings/{id} Delete a recording
listRecordings GETrecordings Fetch all recordings
showRecording GETrecordings/{id} Fetch a recording
showRecordingState GETrecordings/{id}/state Fetch the state of a recording

deleteRecording

deleteRecording(id)

Delete a recording

This operation deletes a recording.

Example

// Import classes:
package Recordings;

import com.wowza.cloudsdk.client.*;
import com.wowza.cloudsdk.client.auth.*;
import com.wowza.cloudsdk.client.model.*;
import com.wowza.cloudsdk.client.api.RecordingsApi;

import java.io.File;
import java.util.*;

public class DeleteARecording {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

       / Configure API key authorization: wsc-access-key
        ApiKeyAuth wscaccesskey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-access-key");
        wscaccesskey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-access-key.setApiKeyPrefix("Token");

       / Configure API key authorization: wsc-api-key
        ApiKeyAuth wscapikey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-api-key");
        wscapikey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-api-key.setApiKeyPrefix("Token");

	RecordingsApi apiInstance = new RecordingsApi();

	String recordingId = "xxxxxx";

        try {
            apiInstance.deleteRecording(recordingId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordingsApi#deleteRecording");
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String The unique alphanumeric string that identifies the recording.

Return type

null (empty response body)

Authorization

wsc-access-key, wsc-api-key, wsc-signature, wsc-timestamp

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listRecordings

List listRecordings(page, perPage)

Fetch all recordings

This operation shows limited details for all of your recordings. For detailed information, fetch a single recording.

Example

// Import classes:
package Recordings;

import com.wowza.cloudsdk.client.*;
import com.wowza.cloudsdk.client.auth.*;
import com.wowza.cloudsdk.client.model.*;
import com.wowza.cloudsdk.client.api.RecordingsApi;

import java.io.File;
import java.util.*;

public class FetchAllRecordings {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

       / Configure API key authorization: wsc-access-key
        ApiKeyAuth wscaccesskey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-access-key");
        wscaccesskey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-access-key.setApiKeyPrefix("Token");

       / Configure API key authorization: wsc-api-key
        ApiKeyAuth wscapikey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-api-key");
        wscapikey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-api-key.setApiKeyPrefix("Token");

	RecordingsApi apiInstance = new RecordingsApi();

        Integer page = 1;
        Integer perPage = 56;
        try {
            List<IndexRecordings> result = apiInstance.listRecordings(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordingsApi#listRecordings");
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
page Integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see <a href='https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-streaming-cloud-rest-api&#39; target='_blank'Get paginated query results with the Wowza Streaming Cloud REST API</a. [optional]
perPage Integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000. [optional]

Return type

List

Authorization

wsc-access-key, wsc-api-key, wsc-signature, wsc-timestamp

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

showRecording

Recording showRecording(id)

Fetch a recording

This operation shows the details of a specific recording.

Example

// Import classes:
package Recordings;

import com.wowza.cloudsdk.client.*;
import com.wowza.cloudsdk.client.auth.*;
import com.wowza.cloudsdk.client.model.*;
import com.wowza.cloudsdk.client.api.RecordingsApi;

import java.io.File;
import java.util.*;

public class FetchARecording {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

       / Configure API key authorization: wsc-access-key
        ApiKeyAuth wscaccesskey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-access-key");
        wscaccesskey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-access-key.setApiKeyPrefix("Token");

       / Configure API key authorization: wsc-api-key
        ApiKeyAuth wscapikey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-api-key");
        wscapikey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-api-key.setApiKeyPrefix("Token");

	RecordingsApi apiInstance = new RecordingsApi();

	String recordingId = "xxxxxx";

        try {
            Recording result = apiInstance.showRecording(recordingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordingsApi#showRecording");
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String The unique alphanumeric string that identifies the recording.

Return type

Recording

Authorization

wsc-access-key, wsc-api-key, wsc-signature, wsc-timestamp

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

showRecordingState

RecordingState showRecordingState(id)

Fetch the state of a recording

This operation shows the current state of a recording.

Example

// Import classes:
package Recordings;

import com.wowza.cloudsdk.client.*;
import com.wowza.cloudsdk.client.auth.*;
import com.wowza.cloudsdk.client.model.*;
import com.wowza.cloudsdk.client.api.RecordingsApi;

import java.io.File;
import java.util.*;

public class FetchStateOfRecording {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

       / Configure API key authorization: wsc-access-key
        ApiKeyAuth wscaccesskey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-access-key");
        wscaccesskey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-access-key.setApiKeyPrefix("Token");

       / Configure API key authorization: wsc-api-key
        ApiKeyAuth wscapikey = (ApiKeyAuth)defaultClient.getAuthentication("wsc-api-key");
        wscapikey.setApiKey("YOUR API KEY");
       / Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
       /wsc-api-key.setApiKeyPrefix("Token");

	RecordingsApi apiInstance = new RecordingsApi();

	String recordingId = "xxxxxx";

        try {
            RecordingState result = apiInstance.showRecordingState(recordingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordingsApi#showRecordingState");
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String The unique alphanumeric string that identifies the recording.

Return type

RecordingState

Authorization

wsc-access-key, wsc-api-key, wsc-signature, wsc-timestamp

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json