Google_Service_YouTube_LiveBroadcasts_Resource

The "liveBroadcasts" collection of methods.

Defined (1)

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

/src/Google/Service/YouTube.php  
  1. class Google_Service_YouTube_LiveBroadcasts_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Binds a YouTube broadcast to a stream or removes an existing binding between 
  5. * a broadcast and a stream. A broadcast can only be bound to one video stream. 
  6. * (liveBroadcasts.bind) 
  7. * @param string $id The id parameter specifies the unique ID of the broadcast 
  8. * that is being bound to a video stream. 
  9. * @param string $part The part parameter specifies a comma-separated list of 
  10. * one or more liveBroadcast resource properties that the API response will 
  11. * include. The part names that you can include in the parameter value are id,  
  12. * snippet, contentDetails, and status. 
  13. * @param array $optParams Optional parameters. 
  14. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  15. * used in a properly authorized request. Note: This parameter is intended 
  16. * exclusively for YouTube content partners. 
  17. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  18. * of the channel to which a video is being added. This parameter is required 
  19. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  20. * and it can only be used in conjunction with that parameter. In addition, the 
  21. * request must be authorized using a CMS account that is linked to the content 
  22. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  23. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  24. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  25. * specifies. 
  26. * This parameter is intended for YouTube content partners that own and manage 
  27. * many different YouTube channels. It allows content owners to authenticate 
  28. * once and perform actions on behalf of the channel specified in the parameter 
  29. * value, without having to provide authentication credentials for each separate 
  30. * channel. 
  31. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  32. * exclusively for YouTube content partners. 
  33. * The onBehalfOfContentOwner parameter indicates that the request's 
  34. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  35. * of the content owner specified in the parameter value. This parameter is 
  36. * intended for YouTube content partners that own and manage many different 
  37. * YouTube channels. It allows content owners to authenticate once and get 
  38. * access to all their video and channel data, without having to provide 
  39. * authentication credentials for each individual channel. The CMS account that 
  40. * the user authenticates with must be linked to the specified YouTube content 
  41. * owner. 
  42. * @opt_param string streamId The streamId parameter specifies the unique ID of 
  43. * the video stream that is being bound to a broadcast. If this parameter is 
  44. * omitted, the API will remove any existing binding between the broadcast and a 
  45. * video stream. 
  46. * @return Google_Service_YouTube_LiveBroadcast 
  47. */ 
  48. public function bind($id, $part, $optParams = array()) 
  49. $params = array('id' => $id, 'part' => $part); 
  50. $params = array_merge($params, $optParams); 
  51. return $this->call('bind', array($params), "Google_Service_YouTube_LiveBroadcast"); 
  52.  
  53. /** 
  54. * Controls the settings for a slate that can be displayed in the broadcast 
  55. * stream. (liveBroadcasts.control) 
  56. * @param string $id The id parameter specifies the YouTube live broadcast ID 
  57. * that uniquely identifies the broadcast in which the slate is being updated. 
  58. * @param string $part The part parameter specifies a comma-separated list of 
  59. * one or more liveBroadcast resource properties that the API response will 
  60. * include. The part names that you can include in the parameter value are id,  
  61. * snippet, contentDetails, and status. 
  62. * @param array $optParams Optional parameters. 
  63. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  64. * exclusively for YouTube content partners. 
  65. * The onBehalfOfContentOwner parameter indicates that the request's 
  66. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  67. * of the content owner specified in the parameter value. This parameter is 
  68. * intended for YouTube content partners that own and manage many different 
  69. * YouTube channels. It allows content owners to authenticate once and get 
  70. * access to all their video and channel data, without having to provide 
  71. * authentication credentials for each individual channel. The CMS account that 
  72. * the user authenticates with must be linked to the specified YouTube content 
  73. * owner. 
  74. * @opt_param bool displaySlate The displaySlate parameter specifies whether the 
  75. * slate is being enabled or disabled. 
  76. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  77. * used in a properly authorized request. Note: This parameter is intended 
  78. * exclusively for YouTube content partners. 
  79. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  80. * of the channel to which a video is being added. This parameter is required 
  81. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  82. * and it can only be used in conjunction with that parameter. In addition, the 
  83. * request must be authorized using a CMS account that is linked to the content 
  84. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  85. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  86. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  87. * specifies. 
  88. * This parameter is intended for YouTube content partners that own and manage 
  89. * many different YouTube channels. It allows content owners to authenticate 
  90. * once and perform actions on behalf of the channel specified in the parameter 
  91. * value, without having to provide authentication credentials for each separate 
  92. * channel. 
  93. * @opt_param string offsetTimeMs The offsetTimeMs parameter specifies a 
  94. * positive time offset when the specified slate change will occur. The value is 
  95. * measured in milliseconds from the beginning of the broadcast's monitor 
  96. * stream, which is the time that the testing phase for the broadcast began. 
  97. * Even though it is specified in milliseconds, the value is actually an 
  98. * approximation, and YouTube completes the requested action as closely as 
  99. * possible to that time. 
  100. * If you do not specify a value for this parameter, then YouTube performs the 
  101. * action as soon as possible. See the Getting started guide for more details. 
  102. * Important: You should only specify a value for this parameter if your 
  103. * broadcast stream is delayed. 
  104. * @opt_param string walltime The walltime parameter specifies the wall clock 
  105. * time at which the specified slate change will occur. The value is specified 
  106. * in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. 
  107. * @return Google_Service_YouTube_LiveBroadcast 
  108. */ 
  109. public function control($id, $part, $optParams = array()) 
  110. $params = array('id' => $id, 'part' => $part); 
  111. $params = array_merge($params, $optParams); 
  112. return $this->call('control', array($params), "Google_Service_YouTube_LiveBroadcast"); 
  113.  
  114. /** 
  115. * Deletes a broadcast. (liveBroadcasts.delete) 
  116. * @param string $id The id parameter specifies the YouTube live broadcast ID 
  117. * for the resource that is being deleted. 
  118. * @param array $optParams Optional parameters. 
  119. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  120. * used in a properly authorized request. Note: This parameter is intended 
  121. * exclusively for YouTube content partners. 
  122. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  123. * of the channel to which a video is being added. This parameter is required 
  124. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  125. * and it can only be used in conjunction with that parameter. In addition, the 
  126. * request must be authorized using a CMS account that is linked to the content 
  127. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  128. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  129. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  130. * specifies. 
  131. * This parameter is intended for YouTube content partners that own and manage 
  132. * many different YouTube channels. It allows content owners to authenticate 
  133. * once and perform actions on behalf of the channel specified in the parameter 
  134. * value, without having to provide authentication credentials for each separate 
  135. * channel. 
  136. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  137. * exclusively for YouTube content partners. 
  138. * The onBehalfOfContentOwner parameter indicates that the request's 
  139. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  140. * of the content owner specified in the parameter value. This parameter is 
  141. * intended for YouTube content partners that own and manage many different 
  142. * YouTube channels. It allows content owners to authenticate once and get 
  143. * access to all their video and channel data, without having to provide 
  144. * authentication credentials for each individual channel. The CMS account that 
  145. * the user authenticates with must be linked to the specified YouTube content 
  146. * owner. 
  147. */ 
  148. public function delete($id, $optParams = array()) 
  149. $params = array('id' => $id); 
  150. $params = array_merge($params, $optParams); 
  151. return $this->call('delete', array($params)); 
  152.  
  153. /** 
  154. * Creates a broadcast. (liveBroadcasts.insert) 
  155. * @param string $part The part parameter serves two purposes in this operation. 
  156. * It identifies the properties that the write operation will set as well as the 
  157. * properties that the API response will include. 
  158. * The part properties that you can include in the parameter value are id,  
  159. * snippet, contentDetails, and status. 
  160. * @param Google_LiveBroadcast $postBody 
  161. * @param array $optParams Optional parameters. 
  162. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  163. * used in a properly authorized request. Note: This parameter is intended 
  164. * exclusively for YouTube content partners. 
  165. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  166. * of the channel to which a video is being added. This parameter is required 
  167. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  168. * and it can only be used in conjunction with that parameter. In addition, the 
  169. * request must be authorized using a CMS account that is linked to the content 
  170. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  171. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  172. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  173. * specifies. 
  174. * This parameter is intended for YouTube content partners that own and manage 
  175. * many different YouTube channels. It allows content owners to authenticate 
  176. * once and perform actions on behalf of the channel specified in the parameter 
  177. * value, without having to provide authentication credentials for each separate 
  178. * channel. 
  179. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  180. * exclusively for YouTube content partners. 
  181. * The onBehalfOfContentOwner parameter indicates that the request's 
  182. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  183. * of the content owner specified in the parameter value. This parameter is 
  184. * intended for YouTube content partners that own and manage many different 
  185. * YouTube channels. It allows content owners to authenticate once and get 
  186. * access to all their video and channel data, without having to provide 
  187. * authentication credentials for each individual channel. The CMS account that 
  188. * the user authenticates with must be linked to the specified YouTube content 
  189. * owner. 
  190. * @return Google_Service_YouTube_LiveBroadcast 
  191. */ 
  192. public function insert($part, Google_Service_YouTube_LiveBroadcast $postBody, $optParams = array()) 
  193. $params = array('part' => $part, 'postBody' => $postBody); 
  194. $params = array_merge($params, $optParams); 
  195. return $this->call('insert', array($params), "Google_Service_YouTube_LiveBroadcast"); 
  196.  
  197. /** 
  198. * Returns a list of YouTube broadcasts that match the API request parameters. 
  199. * (liveBroadcasts.listLiveBroadcasts) 
  200. * @param string $part The part parameter specifies a comma-separated list of 
  201. * one or more liveBroadcast resource properties that the API response will 
  202. * include. The part names that you can include in the parameter value are id,  
  203. * snippet, contentDetails, and status. 
  204. * @param array $optParams Optional parameters. 
  205. * @opt_param string broadcastStatus The broadcastStatus parameter filters the 
  206. * API response to only include broadcasts with the specified status. 
  207. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  208. * exclusively for YouTube content partners. 
  209. * The onBehalfOfContentOwner parameter indicates that the request's 
  210. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  211. * of the content owner specified in the parameter value. This parameter is 
  212. * intended for YouTube content partners that own and manage many different 
  213. * YouTube channels. It allows content owners to authenticate once and get 
  214. * access to all their video and channel data, without having to provide 
  215. * authentication credentials for each individual channel. The CMS account that 
  216. * the user authenticates with must be linked to the specified YouTube content 
  217. * owner. 
  218. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  219. * used in a properly authorized request. Note: This parameter is intended 
  220. * exclusively for YouTube content partners. 
  221. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  222. * of the channel to which a video is being added. This parameter is required 
  223. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  224. * and it can only be used in conjunction with that parameter. In addition, the 
  225. * request must be authorized using a CMS account that is linked to the content 
  226. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  227. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  228. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  229. * specifies. 
  230. * This parameter is intended for YouTube content partners that own and manage 
  231. * many different YouTube channels. It allows content owners to authenticate 
  232. * once and perform actions on behalf of the channel specified in the parameter 
  233. * value, without having to provide authentication credentials for each separate 
  234. * channel. 
  235. * @opt_param bool mine The mine parameter can be used to instruct the API to 
  236. * only return broadcasts owned by the authenticated user. Set the parameter 
  237. * value to true to only retrieve your own broadcasts. 
  238. * @opt_param string maxResults The maxResults parameter specifies the maximum 
  239. * number of items that should be returned in the result set. 
  240. * @opt_param string pageToken The pageToken parameter identifies a specific 
  241. * page in the result set that should be returned. In an API response, the 
  242. * nextPageToken and prevPageToken properties identify other pages that could be 
  243. * retrieved. 
  244. * @opt_param string id The id parameter specifies a comma-separated list of 
  245. * YouTube broadcast IDs that identify the broadcasts being retrieved. In a 
  246. * liveBroadcast resource, the id property specifies the broadcast's ID. 
  247. * @return Google_Service_YouTube_LiveBroadcastListResponse 
  248. */ 
  249. public function listLiveBroadcasts($part, $optParams = array()) 
  250. $params = array('part' => $part); 
  251. $params = array_merge($params, $optParams); 
  252. return $this->call('list', array($params), "Google_Service_YouTube_LiveBroadcastListResponse"); 
  253.  
  254. /** 
  255. * Changes the status of a YouTube live broadcast and initiates any processes 
  256. * associated with the new status. For example, when you transition a 
  257. * broadcast's status to testing, YouTube starts to transmit video to that 
  258. * broadcast's monitor stream. Before calling this method, you should confirm 
  259. * that the value of the status.streamStatus property for the stream bound to 
  260. * your broadcast is active. (liveBroadcasts.transition) 
  261. * @param string $broadcastStatus The broadcastStatus parameter identifies the 
  262. * state to which the broadcast is changing. Note that to transition a broadcast 
  263. * to either the testing or live state, the status.streamStatus must be active 
  264. * for the stream that the broadcast is bound to. 
  265. * @param string $id The id parameter specifies the unique ID of the broadcast 
  266. * that is transitioning to another status. 
  267. * @param string $part The part parameter specifies a comma-separated list of 
  268. * one or more liveBroadcast resource properties that the API response will 
  269. * include. The part names that you can include in the parameter value are id,  
  270. * snippet, contentDetails, and status. 
  271. * @param array $optParams Optional parameters. 
  272. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  273. * used in a properly authorized request. Note: This parameter is intended 
  274. * exclusively for YouTube content partners. 
  275. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  276. * of the channel to which a video is being added. This parameter is required 
  277. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  278. * and it can only be used in conjunction with that parameter. In addition, the 
  279. * request must be authorized using a CMS account that is linked to the content 
  280. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  281. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  282. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  283. * specifies. 
  284. * This parameter is intended for YouTube content partners that own and manage 
  285. * many different YouTube channels. It allows content owners to authenticate 
  286. * once and perform actions on behalf of the channel specified in the parameter 
  287. * value, without having to provide authentication credentials for each separate 
  288. * channel. 
  289. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  290. * exclusively for YouTube content partners. 
  291. * The onBehalfOfContentOwner parameter indicates that the request's 
  292. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  293. * of the content owner specified in the parameter value. This parameter is 
  294. * intended for YouTube content partners that own and manage many different 
  295. * YouTube channels. It allows content owners to authenticate once and get 
  296. * access to all their video and channel data, without having to provide 
  297. * authentication credentials for each individual channel. The CMS account that 
  298. * the user authenticates with must be linked to the specified YouTube content 
  299. * owner. 
  300. * @return Google_Service_YouTube_LiveBroadcast 
  301. */ 
  302. public function transition($broadcastStatus, $id, $part, $optParams = array()) 
  303. $params = array('broadcastStatus' => $broadcastStatus, 'id' => $id, 'part' => $part); 
  304. $params = array_merge($params, $optParams); 
  305. return $this->call('transition', array($params), "Google_Service_YouTube_LiveBroadcast"); 
  306.  
  307. /** 
  308. * Updates a broadcast. For example, you could modify the broadcast settings 
  309. * defined in the liveBroadcast resource's contentDetails object. 
  310. * (liveBroadcasts.update) 
  311. * @param string $part The part parameter serves two purposes in this operation. 
  312. * It identifies the properties that the write operation will set as well as the 
  313. * properties that the API response will include. 
  314. * The part properties that you can include in the parameter value are id,  
  315. * snippet, contentDetails, and status. 
  316. * Note that this method will override the existing values for all of the 
  317. * mutable properties that are contained in any parts that the parameter value 
  318. * specifies. For example, a broadcast's privacy status is defined in the status 
  319. * part. As such, if your request is updating a private or unlisted broadcast,  
  320. * and the request's part parameter value includes the status part, the 
  321. * broadcast's privacy setting will be updated to whatever value the request 
  322. * body specifies. If the request body does not specify a value, the existing 
  323. * privacy setting will be removed and the broadcast will revert to the default 
  324. * privacy setting. 
  325. * @param Google_LiveBroadcast $postBody 
  326. * @param array $optParams Optional parameters. 
  327. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  328. * used in a properly authorized request. Note: This parameter is intended 
  329. * exclusively for YouTube content partners. 
  330. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  331. * of the channel to which a video is being added. This parameter is required 
  332. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  333. * and it can only be used in conjunction with that parameter. In addition, the 
  334. * request must be authorized using a CMS account that is linked to the content 
  335. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  336. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  337. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  338. * specifies. 
  339. * This parameter is intended for YouTube content partners that own and manage 
  340. * many different YouTube channels. It allows content owners to authenticate 
  341. * once and perform actions on behalf of the channel specified in the parameter 
  342. * value, without having to provide authentication credentials for each separate 
  343. * channel. 
  344. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  345. * exclusively for YouTube content partners. 
  346. * The onBehalfOfContentOwner parameter indicates that the request's 
  347. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  348. * of the content owner specified in the parameter value. This parameter is 
  349. * intended for YouTube content partners that own and manage many different 
  350. * YouTube channels. It allows content owners to authenticate once and get 
  351. * access to all their video and channel data, without having to provide 
  352. * authentication credentials for each individual channel. The CMS account that 
  353. * the user authenticates with must be linked to the specified YouTube content 
  354. * owner. 
  355. * @return Google_Service_YouTube_LiveBroadcast 
  356. */ 
  357. public function update($part, Google_Service_YouTube_LiveBroadcast $postBody, $optParams = array()) 
  358. $params = array('part' => $part, 'postBody' => $postBody); 
  359. $params = array_merge($params, $optParams); 
  360. return $this->call('update', array($params), "Google_Service_YouTube_LiveBroadcast");