Google_LiveStreamsServiceResource

The "liveStreams" collection of methods.

Defined (1)

The class is defined in the following location(s).

/src/contrib/Google_YouTubeService.php  
  1. class Google_LiveStreamsServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes a video stream. (liveStreams.delete) 
  5. * @param string $id The id parameter specifies the YouTube live stream ID for the resource that is being deleted. 
  6. * @param array $optParams Optional parameters. 
  7. */ 
  8. public function delete($id, $optParams = array()) { 
  9. $params = array('id' => $id); 
  10. $params = array_merge($params, $optParams); 
  11. $data = $this->__call('delete', array($params)); 
  12. return $data; 
  13. /** 
  14. * Creates a video stream. The stream enables you to send your video to YouTube, which can then 
  15. * broadcast the video to your audience. (liveStreams.insert) 
  16. * @param string $part 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. 
  17. The part properties that you can include in the parameter value are id, snippet, cdn, and status. 
  18. * @param Google_LiveStream $postBody 
  19. * @param array $optParams Optional parameters. 
  20. * @return Google_LiveStream 
  21. */ 
  22. public function insert($part, Google_LiveStream $postBody, $optParams = array()) { 
  23. $params = array('part' => $part, 'postBody' => $postBody); 
  24. $params = array_merge($params, $optParams); 
  25. $data = $this->__call('insert', array($params)); 
  26. if ($this->useObjects()) { 
  27. return new Google_LiveStream($data); 
  28. } else { 
  29. return $data; 
  30. /** 
  31. * Returns a list of video streams that match the API request parameters. (liveStreams.list) 
  32. * @param string $part 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. 
  33. * @param array $optParams Optional parameters. 
  34. * @opt_param string id The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID. 
  35. * @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5. 
  36. * @opt_param bool mine The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams. 
  37. * @opt_param string pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. 
  38. * @return Google_LiveStreamList 
  39. */ 
  40. public function listLiveStreams($part, $optParams = array()) { 
  41. $params = array('part' => $part); 
  42. $params = array_merge($params, $optParams); 
  43. $data = $this->__call('list', array($params)); 
  44. if ($this->useObjects()) { 
  45. return new Google_LiveStreamList($data); 
  46. } else { 
  47. return $data; 
  48. /** 
  49. * Updates a video stream. If the properties that you want to change cannot be updated, then you 
  50. * need to create a new stream with the proper settings. (liveStreams.update) 
  51. * @param string $part 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. 
  52. The part properties that you can include in the parameter value are id, snippet, cdn, and status. 
  53. 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. 
  54. * @param Google_LiveStream $postBody 
  55. * @param array $optParams Optional parameters. 
  56. * @return Google_LiveStream 
  57. */ 
  58. public function update($part, Google_LiveStream $postBody, $optParams = array()) { 
  59. $params = array('part' => $part, 'postBody' => $postBody); 
  60. $params = array_merge($params, $optParams); 
  61. $data = $this->__call('update', array($params)); 
  62. if ($this->useObjects()) { 
  63. return new Google_LiveStream($data); 
  64. } else { 
  65. return $data;