Skip to content

Latest commit

 

History

History
344 lines (244 loc) · 11.2 KB

SubtitlesApi.md

File metadata and controls

344 lines (244 loc) · 11.2 KB
Raw

SubtitlesApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
createExtractSubtitle POST /extracts/{extract_id}/subtitle
createVideoSubtitle POST /videos/{video_id}/subtitle
getCategoryVideoSubtitles GET /categories/videos/{video_id}/subtitles
getExtractSubtitles GET /extracts/{extract_id}/subtitles
getSubtitles GET /subtitles
getVideoSubtitles GET /videos/{video_id}/subtitles

createExtractSubtitle

\Kinow\Client\Model\SubtitleResponse createExtractSubtitle($extract_id, $body)

Create new Extract Subtitle

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$extract_id = 789; // int | Extract ID to attach the created Subtitle
$body = new \Kinow\Client\Model\CreateExtractSubtitleRequest(); // \Kinow\Client\Model\CreateExtractSubtitleRequest | Subtitle settings

try {
    $result = $api_instance->createExtractSubtitle($extract_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->createExtractSubtitle: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
extract_id int Extract ID to attach the created Subtitle
body \Kinow\Client\Model\CreateExtractSubtitleRequest Subtitle settings

Return type

\Kinow\Client\Model\SubtitleResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

createVideoSubtitle

\Kinow\Client\Model\SubtitleResponse createVideoSubtitle($video_id, $body)

Create new Video Subtitle

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$video_id = 789; // int | Video ID to attach the created Subtitle
$body = new \Kinow\Client\Model\CreateVideoSubtitleRequest(); // \Kinow\Client\Model\CreateVideoSubtitleRequest | Subtitle settings

try {
    $result = $api_instance->createVideoSubtitle($video_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->createVideoSubtitle: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
video_id int Video ID to attach the created Subtitle
body \Kinow\Client\Model\CreateVideoSubtitleRequest Subtitle settings

Return type

\Kinow\Client\Model\SubtitleResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getCategoryVideoSubtitles

\Kinow\Client\Model\SubtitleListResponse getCategoryVideoSubtitles($video_id, $page, $per_page)

Get subtitles of a video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getCategoryVideoSubtitles($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->getCategoryVideoSubtitles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
video_id int Video ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\SubtitleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getExtractSubtitles

\Kinow\Client\Model\ExtractSubtitlesResponse getExtractSubtitles($extract_id, $page, $per_page)

Get subtitles of an extract

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$extract_id = 789; // int | Extract ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getExtractSubtitles($extract_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->getExtractSubtitles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
extract_id int Extract ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\ExtractSubtitlesResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getSubtitles

\Kinow\Client\Model\SubtitleListResponse getSubtitles($page, $per_page)

Get Subtitles list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getSubtitles($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->getSubtitles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\SubtitleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getVideoSubtitles

\Kinow\Client\Model\ExtractSubtitlesResponse getVideoSubtitles($video_id, $page, $per_page)

Get subtitles of a video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\SubtitlesApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getVideoSubtitles($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubtitlesApi->getVideoSubtitles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
video_id int Video ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\ExtractSubtitlesResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined