Documentation

Google_Service_YouTube_Resource_LiveStreams extends Google_Service_Resource
in package

Application

The "liveStreams" collection of methods.

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

$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 an existing stream for the authenticated user. (liveStreams.delete)
insert() : Google_Service_YouTube_LiveStream: Inserts a new stream for the authenticated user. (liveStreams.insert)
listLiveStreams() : Google_Service_YouTube_LiveStreamListResponse: Retrieve the list of streams associated with the given channel. -- (liveStreams.listLiveStreams)
update() : Google_Service_YouTube_LiveStream: Updates an existing stream for the authenticated user. (liveStreams.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 an existing stream for the authenticated user. (liveStreams.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 —

insert()

Inserts a new stream for the authenticated user. (liveStreams.insert)


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

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status.
$postBody : Google_Service_YouTube_LiveStream
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_LiveStream —

listLiveStreams()

Retrieve the list of streams associated with the given channel. -- (liveStreams.listLiveStreams)


    public
                listLiveStreams(string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_LiveStreamListResponse

Parameters

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

Return values

Google_Service_YouTube_LiveStreamListResponse —

update()

Updates an existing stream for the authenticated user. (liveStreams.update)


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

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.
$postBody : Google_Service_YouTube_LiveStream
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_LiveStream —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —