Documentation

Google_Service_YouTube_Resource_Captions extends Google_Service_Resource
in package

Application

The "captions" collection of methods.

Typical usage is: $youtubeService = new Google_Service_YouTube(...); $captions = $youtubeService->captions;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a resource. (captions.delete)
download() : mixed: Downloads a caption track. (captions.download)
insert() : Google_Service_YouTube_Caption: Inserts a new resource into this collection. (captions.insert)
listCaptions() : Google_Service_YouTube_CaptionListResponse: Retrieves a list of resources, possibly filtered. (captions.listCaptions)
update() : Google_Service_YouTube_Caption: Updates an existing resource. (captions.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a resource. (captions.delete)


    public
                delete(string $id[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$id : string
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

download()

Downloads a caption track. (captions.download)


    public
                download(string $id[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$id : string: The ID of the caption track to download, required for One Platform.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

insert()

Inserts a new resource into this collection. (captions.insert)


    public
                insert(string|array<string|int, mixed> $part, Google_Service_YouTube_Caption $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Caption

Parameters

$part : string|array<string|int, mixed>: The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
$postBody : Google_Service_YouTube_Caption
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Caption —

listCaptions()

Retrieves a list of resources, possibly filtered. (captions.listCaptions)


    public
                listCaptions(string $videoId, string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_CaptionListResponse

Parameters

$videoId : string: Returns the captions for the specified video.
$part : string|array<string|int, mixed>: The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_CaptionListResponse —

update()

Updates an existing resource. (captions.update)


    public
                update(string|array<string|int, mixed> $part, Google_Service_YouTube_Caption $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Caption

Parameters

$part : string|array<string|int, mixed>: The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.
$postBody : Google_Service_YouTube_Caption
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Caption —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —