 |
Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
|
Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
The "videos" collection of methods. More...
Public Member Functions | |
| call ($name, $arguments, $expected_class=null) | |
| TODO: This function needs simplifying. | |
| delete ($id, $optParams=array()) | |
| Deletes a YouTube video. | |
| getRating ($id, $optParams=array()) | |
| Retrieves the ratings that the authorized user gave to a list of specified videos. | |
| insert ($part, Google_Service_YouTube_Video $postBody, $optParams=array()) | |
| Uploads a video to YouTube and optionally sets the video's metadata. | |
| listVideos ($part, $optParams=array()) | |
| Returns a list of videos that match the API request parameters. | |
| rate ($id, $rating, $optParams=array()) | |
| Add a like or dislike rating to a video or remove a rating from a video. | |
| reportAbuse (Google_Service_YouTube_VideoAbuseReport $postBody, $optParams=array()) | |
| Report abuse for a video. | |
| update ($part, Google_Service_YouTube_Video $postBody, $optParams=array()) | |
| Updates a video's metadata. | |
Protected Member Functions | |
| convertToArrayAndStripNulls ($o) | |
The "videos" collection of methods.
Typical usage is: $youtubeService = new Google_Service_YouTube(...); $videos = $youtubeService->videos;
|
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_Videos_Resource::delete | ( | $id, | |
| $optParams = array() ) |
Deletes a YouTube video.
(videos.delete)
| string | $id | The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. |
| 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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_Videos_Resource::getRating | ( | $id, | |
| $optParams = array() ) |
Retrieves the ratings that the authorized user gave to a list of specified videos.
(videos.getRating)
| string | $id | The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a video resource, the id property specifies the video's ID. |
| 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.
| Google_Service_YouTube_VideoGetRatingResponse |
| Google_Service_YouTube_Videos_Resource::insert | ( | $part, | |
| Google_Service_YouTube_Video | $postBody, | ||
| $optParams = array() ) |
Uploads a video to YouTube and optionally sets the video's metadata.
(videos.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. |
Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
| Google_Video | $postBody | |
| 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 stabilize The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions. @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 notifySubscribers The notifySubscribers parameter indicates whether YouTube should send a notification about the new video to users who subscribe to the video's channel. A parameter value of True indicates that subscribers will be notified of newly uploaded videos. However, a channel owner who is uploading many videos might prefer to set the value to False to avoid sending a notification about each new video to the channel's subscribers. @opt_param bool autoLevels The autoLevels parameter indicates whether YouTube should automatically enhance the video's lighting and color.
| Google_Service_YouTube_Video |
| Google_Service_YouTube_Videos_Resource::listVideos | ( | $part, | |
| $optParams = array() ) |
Returns a list of videos that match the API request parameters.
(videos.listVideos)
| string | $part | The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. |
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.
| 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 string regionCode The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code. @opt_param string locale DEPRECATED @opt_param string videoCategoryId The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category. @opt_param string chart The chart parameter identifies the chart that you want to retrieve. @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set.
Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter. @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.
Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter. @opt_param string hl The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.
If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language. @opt_param string myRating Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. @opt_param string id The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.
| Google_Service_YouTube_VideoListResponse |
| Google_Service_YouTube_Videos_Resource::rate | ( | $id, | |
| $rating, | |||
| $optParams = array() ) |
Add a like or dislike rating to a video or remove a rating from a video.
(videos.rate)
| string | $id | The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed. |
| string | $rating | Specifies the rating to record. |
| array | $optParams | Optional parameters. |
| Google_Service_YouTube_Videos_Resource::reportAbuse | ( | Google_Service_YouTube_VideoAbuseReport | $postBody, |
| $optParams = array() ) |
Report abuse for a video.
(videos.reportAbuse)
| Google_VideoAbuseReport | $postBody | |
| 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.
| Google_Service_YouTube_Videos_Resource::update | ( | $part, | |
| Google_Service_YouTube_Video | $postBody, | ||
| $optParams = array() ) |
Updates a video's metadata.
(videos.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. |
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 video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video'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 video will revert to the default privacy setting.
In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
| Google_Video | $postBody | |
| 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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_Video |
1.11.0