Google_Service_YouTube_LiveStreams_Resource

The "liveStreams" collection of methods.

Defined (1)

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

/src/Google/Service/YouTube.php  
  1. class Google_Service_YouTube_LiveStreams_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes a video stream. (liveStreams.delete) 
  5. * @param string $id The id parameter specifies the YouTube live stream ID for 
  6. * the resource that is being deleted. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  9. * used in a properly authorized request. Note: This parameter is intended 
  10. * exclusively for YouTube content partners. 
  11. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  12. * of the channel to which a video is being added. This parameter is required 
  13. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  14. * and it can only be used in conjunction with that parameter. In addition, the 
  15. * request must be authorized using a CMS account that is linked to the content 
  16. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  17. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  18. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  19. * specifies. 
  20. * This parameter is intended for YouTube content partners that own and manage 
  21. * many different YouTube channels. It allows content owners to authenticate 
  22. * once and perform actions on behalf of the channel specified in the parameter 
  23. * value, without having to provide authentication credentials for each separate 
  24. * channel. 
  25. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  26. * exclusively for YouTube content partners. 
  27. * The onBehalfOfContentOwner parameter indicates that the request's 
  28. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  29. * of the content owner specified in the parameter value. This parameter is 
  30. * intended for YouTube content partners that own and manage many different 
  31. * YouTube channels. It allows content owners to authenticate once and get 
  32. * access to all their video and channel data, without having to provide 
  33. * authentication credentials for each individual channel. The CMS account that 
  34. * the user authenticates with must be linked to the specified YouTube content 
  35. * owner. 
  36. */ 
  37. public function delete($id, $optParams = array()) 
  38. $params = array('id' => $id); 
  39. $params = array_merge($params, $optParams); 
  40. return $this->call('delete', array($params)); 
  41.  
  42. /** 
  43. * Creates a video stream. The stream enables you to send your video to YouTube,  
  44. * which can then broadcast the video to your audience. (liveStreams.insert) 
  45. * @param string $part The part parameter serves two purposes in this operation. 
  46. * It identifies the properties that the write operation will set as well as the 
  47. * properties that the API response will include. 
  48. * The part properties that you can include in the parameter value are id,  
  49. * snippet, cdn, and status. 
  50. * @param Google_LiveStream $postBody 
  51. * @param array $optParams Optional parameters. 
  52. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  53. * used in a properly authorized request. Note: This parameter is intended 
  54. * exclusively for YouTube content partners. 
  55. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  56. * of the channel to which a video is being added. This parameter is required 
  57. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  58. * and it can only be used in conjunction with that parameter. In addition, the 
  59. * request must be authorized using a CMS account that is linked to the content 
  60. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  61. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  62. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  63. * specifies. 
  64. * This parameter is intended for YouTube content partners that own and manage 
  65. * many different YouTube channels. It allows content owners to authenticate 
  66. * once and perform actions on behalf of the channel specified in the parameter 
  67. * value, without having to provide authentication credentials for each separate 
  68. * channel. 
  69. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  70. * exclusively for YouTube content partners. 
  71. * The onBehalfOfContentOwner parameter indicates that the request's 
  72. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  73. * of the content owner specified in the parameter value. This parameter is 
  74. * intended for YouTube content partners that own and manage many different 
  75. * YouTube channels. It allows content owners to authenticate once and get 
  76. * access to all their video and channel data, without having to provide 
  77. * authentication credentials for each individual channel. The CMS account that 
  78. * the user authenticates with must be linked to the specified YouTube content 
  79. * owner. 
  80. * @return Google_Service_YouTube_LiveStream 
  81. */ 
  82. public function insert($part, Google_Service_YouTube_LiveStream $postBody, $optParams = array()) 
  83. $params = array('part' => $part, 'postBody' => $postBody); 
  84. $params = array_merge($params, $optParams); 
  85. return $this->call('insert', array($params), "Google_Service_YouTube_LiveStream"); 
  86.  
  87. /** 
  88. * Returns a list of video streams that match the API request parameters. 
  89. * (liveStreams.listLiveStreams) 
  90. * @param string $part The part parameter specifies a comma-separated list of 
  91. * one or more liveStream resource properties that the API response will 
  92. * include. The part names that you can include in the parameter value are id,  
  93. * snippet, cdn, and status. 
  94. * @param array $optParams Optional parameters. 
  95. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  96. * exclusively for YouTube content partners. 
  97. * The onBehalfOfContentOwner parameter indicates that the request's 
  98. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  99. * of the content owner specified in the parameter value. This parameter is 
  100. * intended for YouTube content partners that own and manage many different 
  101. * YouTube channels. It allows content owners to authenticate once and get 
  102. * access to all their video and channel data, without having to provide 
  103. * authentication credentials for each individual channel. The CMS account that 
  104. * the user authenticates with must be linked to the specified YouTube content 
  105. * owner. 
  106. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  107. * used in a properly authorized request. Note: This parameter is intended 
  108. * exclusively for YouTube content partners. 
  109. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  110. * of the channel to which a video is being added. This parameter is required 
  111. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  112. * and it can only be used in conjunction with that parameter. In addition, the 
  113. * request must be authorized using a CMS account that is linked to the content 
  114. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  115. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  116. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  117. * specifies. 
  118. * This parameter is intended for YouTube content partners that own and manage 
  119. * many different YouTube channels. It allows content owners to authenticate 
  120. * once and perform actions on behalf of the channel specified in the parameter 
  121. * value, without having to provide authentication credentials for each separate 
  122. * channel. 
  123. * @opt_param bool mine The mine parameter can be used to instruct the API to 
  124. * only return streams owned by the authenticated user. Set the parameter value 
  125. * to true to only retrieve your own streams. 
  126. * @opt_param string maxResults The maxResults parameter specifies the maximum 
  127. * number of items that should be returned in the result set. Acceptable values 
  128. * are 0 to 50, inclusive. The default value is 5. 
  129. * @opt_param string pageToken The pageToken parameter identifies a specific 
  130. * page in the result set that should be returned. In an API response, the 
  131. * nextPageToken and prevPageToken properties identify other pages that could be 
  132. * retrieved. 
  133. * @opt_param string id The id parameter specifies a comma-separated list of 
  134. * YouTube stream IDs that identify the streams being retrieved. In a liveStream 
  135. * resource, the id property specifies the stream's ID. 
  136. * @return Google_Service_YouTube_LiveStreamListResponse 
  137. */ 
  138. public function listLiveStreams($part, $optParams = array()) 
  139. $params = array('part' => $part); 
  140. $params = array_merge($params, $optParams); 
  141. return $this->call('list', array($params), "Google_Service_YouTube_LiveStreamListResponse"); 
  142.  
  143. /** 
  144. * Updates a video stream. If the properties that you want to change cannot be 
  145. * updated, then you need to create a new stream with the proper settings. 
  146. * (liveStreams.update) 
  147. * @param string $part The part parameter serves two purposes in this operation. 
  148. * It identifies the properties that the write operation will set as well as the 
  149. * properties that the API response will include. 
  150. * The part properties that you can include in the parameter value are id,  
  151. * snippet, cdn, and status. 
  152. * Note that this method will override the existing values for all of the 
  153. * mutable properties that are contained in any parts that the parameter value 
  154. * specifies. If the request body does not specify a value for a mutable 
  155. * property, the existing value for that property will be removed. 
  156. * @param Google_LiveStream $postBody 
  157. * @param array $optParams Optional parameters. 
  158. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  159. * used in a properly authorized request. Note: This parameter is intended 
  160. * exclusively for YouTube content partners. 
  161. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  162. * of the channel to which a video is being added. This parameter is required 
  163. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  164. * and it can only be used in conjunction with that parameter. In addition, the 
  165. * request must be authorized using a CMS account that is linked to the content 
  166. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  167. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  168. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  169. * specifies. 
  170. * This parameter is intended for YouTube content partners that own and manage 
  171. * many different YouTube channels. It allows content owners to authenticate 
  172. * once and perform actions on behalf of the channel specified in the parameter 
  173. * value, without having to provide authentication credentials for each separate 
  174. * channel. 
  175. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  176. * exclusively for YouTube content partners. 
  177. * The onBehalfOfContentOwner parameter indicates that the request's 
  178. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  179. * of the content owner specified in the parameter value. This parameter is 
  180. * intended for YouTube content partners that own and manage many different 
  181. * YouTube channels. It allows content owners to authenticate once and get 
  182. * access to all their video and channel data, without having to provide 
  183. * authentication credentials for each individual channel. The CMS account that 
  184. * the user authenticates with must be linked to the specified YouTube content 
  185. * owner. 
  186. * @return Google_Service_YouTube_LiveStream 
  187. */ 
  188. public function update($part, Google_Service_YouTube_LiveStream $postBody, $optParams = array()) 
  189. $params = array('part' => $part, 'postBody' => $postBody); 
  190. $params = array_merge($params, $optParams); 
  191. return $this->call('update', array($params), "Google_Service_YouTube_LiveStream");