 |
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
|
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
The "liveBroadcasts" collection of methods. More...
Public Member Functions | |
| bind ($id, $part, $optParams=array()) | |
| Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. | |
| bind_direct ($id, $part, $optParams=array()) | |
| Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. | |
| call ($name, $arguments, $expected_class=null) | |
| TODO: This function needs simplifying. | |
| control ($id, $part, $optParams=array()) | |
| Controls the settings for a slate that can be displayed in the broadcast stream. | |
| delete ($id, $optParams=array()) | |
| Deletes a broadcast. | |
| insert ($part, Google_Service_YouTube_LiveBroadcast $postBody, $optParams=array()) | |
| Creates a broadcast. | |
| listLiveBroadcasts ($part, $optParams=array()) | |
| Returns a list of YouTube broadcasts that match the API request parameters. | |
| transition ($broadcastStatus, $id, $part, $optParams=array()) | |
| Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. | |
| update ($part, Google_Service_YouTube_LiveBroadcast $postBody, $optParams=array()) | |
| Updates a broadcast. | |
Protected Member Functions | |
| convertToArrayAndStripNulls ($o) | |
The "liveBroadcasts" collection of methods.
Typical usage is: $youtubeService = new Google_Service_YouTube(...); $liveBroadcasts = $youtubeService->liveBroadcasts;
| Google_Service_YouTube_LiveBroadcasts_Resource::bind | ( | $id, | |
| $part, | |||
| $optParams = array() ) |
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream.
A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. (liveBroadcasts.bind)
| string | $id | The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. |
| string | $part | 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. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param string streamId The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
| Google_Service_YouTube_LiveBroadcast |
| Google_Service_YouTube_LiveBroadcasts_Resource::bind_direct | ( | $id, | |
| $part, | |||
| $optParams = array() ) |
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream.
A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. (liveBroadcasts.bind_direct)
| string | $id | The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. |
| string | $part | 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. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param string streamId The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
| Google_Service_YouTube_LiveBroadcast |
|
inherited |
TODO: This function needs simplifying.
| $name | |
| $arguments | |
| $expected_class | - optional, the expected class name |
| Google_Http_Request|expected_class |
| Google_Exception |
| Google_Service_YouTube_LiveBroadcasts_Resource::control | ( | $id, | |
| $part, | |||
| $optParams = array() ) |
Controls the settings for a slate that can be displayed in the broadcast stream.
(liveBroadcasts.control)
| string | $id | The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. |
| string | $part | 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. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param bool displaySlate The displaySlate parameter specifies whether the slate is being enabled or disabled. @opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string offsetTimeMs The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time.
If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details.
Important: You should only specify a value for this parameter if your broadcast stream is delayed. @opt_param string walltime The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
| Google_Service_YouTube_LiveBroadcast |
| Google_Service_YouTube_LiveBroadcasts_Resource::delete | ( | $id, | |
| $optParams = array() ) |
Deletes a broadcast.
(liveBroadcasts.delete)
| string | $id | The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_LiveBroadcasts_Resource::insert | ( | $part, | |
| Google_Service_YouTube_LiveBroadcast | $postBody, | ||
| $optParams = array() ) |
Creates a broadcast.
(liveBroadcasts.insert)
| 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. |
The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
| Google_LiveBroadcast | $postBody | |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_LiveBroadcast |
| Google_Service_YouTube_LiveBroadcasts_Resource::listLiveBroadcasts | ( | $part, | |
| $optParams = array() ) |
Returns a list of YouTube broadcasts that match the API request parameters.
(liveBroadcasts.listLiveBroadcasts)
| string | $part | 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. |
| array | $optParams | Optional parameters. |
@opt_param string broadcastStatus The broadcastStatus parameter filters the API response to only include broadcasts with the specified status. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param bool mine The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts. @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. @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. @opt_param string id The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.
| Google_Service_YouTube_LiveBroadcastListResponse |
| Google_Service_YouTube_LiveBroadcasts_Resource::transition | ( | $broadcastStatus, | |
| $id, | |||
| $part, | |||
| $optParams = array() ) |
Changes the status of a YouTube live broadcast and initiates any processes associated with the new status.
For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. (liveBroadcasts.transition)
| string | $broadcastStatus | The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to. |
| string | $id | The id parameter specifies the unique ID of the broadcast that is transitioning to another status. |
| string | $part | 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. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_LiveBroadcast |
| Google_Service_YouTube_LiveBroadcasts_Resource::update | ( | $part, | |
| Google_Service_YouTube_LiveBroadcast | $postBody, | ||
| $optParams = array() ) |
Updates a broadcast.
For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. (liveBroadcasts.update)
| 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. |
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.
| Google_LiveBroadcast | $postBody | |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_LiveBroadcast |
1.11.0