Documentation

Google_Service_YouTube_Resource_LiveBroadcasts extends Google_Service_Resource
in package

Application

The "liveBroadcasts" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
bind() : Google_Service_YouTube_LiveBroadcast: Bind a broadcast to a stream. (liveBroadcasts.bind)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
control() : Google_Service_YouTube_LiveBroadcast: Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api- liveBroadcast-control (liveBroadcasts.control)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Delete a given broadcast. (liveBroadcasts.delete)
insert() : Google_Service_YouTube_LiveBroadcast: Inserts a new stream for the authenticated user. (liveBroadcasts.insert)
listLiveBroadcasts() : Google_Service_YouTube_LiveBroadcastListResponse: Retrieve the list of broadcasts associated with the given channel.
transition() : Google_Service_YouTube_LiveBroadcast: Transition a broadcast to a given status. (liveBroadcasts.transition)
update() : Google_Service_YouTube_LiveBroadcast: Updates an existing broadcast for the authenticated user.
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 —

bind()

Bind a broadcast to a stream. (liveBroadcasts.bind)


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

Parameters

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

Return values

Google_Service_YouTube_LiveBroadcast —

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 —

control()

Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api- liveBroadcast-control (liveBroadcasts.control)


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

Parameters

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

Return values

Google_Service_YouTube_LiveBroadcast —

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()

Delete a given broadcast. (liveBroadcasts.delete)


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

Parameters

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

Return values

mixed —

insert()

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


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

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, contentDetails, and status.
$postBody : Google_Service_YouTube_LiveBroadcast
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_LiveBroadcast —

listLiveBroadcasts()

Retrieve the list of broadcasts associated with the given channel.


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

(liveBroadcasts.listLiveBroadcasts)

Parameters

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

Return values

Google_Service_YouTube_LiveBroadcastListResponse —

transition()

Transition a broadcast to a given status. (liveBroadcasts.transition)


    public
                transition(string $id, string $broadcastStatus, string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_LiveBroadcast

Parameters

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

Return values

Google_Service_YouTube_LiveBroadcast —

update()

Updates an existing broadcast for the authenticated user.


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

(liveBroadcasts.update)

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, contentDetails, 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. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.
$postBody : Google_Service_YouTube_LiveBroadcast
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_LiveBroadcast —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —