• Home
• com.google.apis
• google-api-services-youtube
• v3-rev20240303-2.0.0
• source code
• YouTube.Captions.Download.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.youtube.YouTube.Captions.Download.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube
Class YouTube.Captions.Download



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>


com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>


com.google.api.services.youtube.YouTubeRequest<Void>


com.google.api.services.youtube.YouTube.Captions.Download

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
YouTube.Captions




public class YouTube.Captions.Download
extends YouTubeRequest<Void>











Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Download(String id)
Downloads a caption track.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


com.google.api.client.http.GenericUrl
buildHttpRequestUrl() 


com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead() 


com.google.api.client.http.HttpResponse
executeMedia() 


void
executeMediaAndDownloadTo(OutputStream outputStream) 


InputStream
executeMediaAsInputStream() 


com.google.api.client.http.HttpResponse
executeUsingHead() 


String
getId()
The ID of the caption track to download, required for One Platform.



String
getOnBehalfOf()
ID of the Google+ Page for the channel that the request is be on behalf of



String
getOnBehalfOfContentOwner()
Note:* This parameter is intended exclusively for YouTube content partners.



String
getTfmt()
Convert the captions into this format.



String
getTlang()
tlang is the language code; machine translate the captions into this language.



YouTube.Captions.Download
set(String parameterName,
   Object value) 


YouTube.Captions.Download
set$Xgafv(String $Xgafv)
V1 error format.



YouTube.Captions.Download
setAccessToken(String accessToken)
OAuth access token.



YouTube.Captions.Download
setAlt(String alt)
Data format for response.



YouTube.Captions.Download
setCallback(String callback)
JSONP



YouTube.Captions.Download
setFields(String fields)
Selector specifying which fields to include in a partial response.



YouTube.Captions.Download
setId(String id)
The ID of the caption track to download, required for One Platform.



YouTube.Captions.Download
setKey(String key)
API key.



YouTube.Captions.Download
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



YouTube.Captions.Download
setOnBehalfOf(String onBehalfOf)
ID of the Google+ Page for the channel that the request is be on behalf of



YouTube.Captions.Download
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
*Note:* This parameter is intended exclusively for YouTube content partners.



YouTube.Captions.Download
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



YouTube.Captions.Download
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



YouTube.Captions.Download
setTfmt(String tfmt)
Convert the captions into this format.



YouTube.Captions.Download
setTlang(String tlang)
tlang is the language code; machine translate the captions into this language.



YouTube.Captions.Download
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



YouTube.Captions.Download
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.







Methods inherited from class com.google.api.services.youtube.YouTubeRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders





Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue





Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Download
protected Download(String id)
Downloads a caption track.

 Create a request for the method "captions.download".

 This request holds the parameters needed by the the youtube server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 

 YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
 must be called to initialize this instance immediately after invoking the constructor. 

Parameters:
id - The ID of the caption track to download, required for One Platform.
Since:
1.13










Method Detail





executeMediaAndDownloadTo
public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:
executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>
Throws:
IOException








executeMediaAsInputStream
public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:
executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>
Throws:
IOException








executeMedia
public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws IOException

Overrides:
executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>
Throws:
IOException








buildHttpRequestUrl
public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:
buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>








executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>
Throws:
IOException








buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>
Throws:
IOException








set$Xgafv
public YouTube.Captions.Download set$Xgafv(String $Xgafv)
Description copied from class: YouTubeRequest
V1 error format.

Overrides:
set$Xgafv in class YouTubeRequest<Void>








setAccessToken
public YouTube.Captions.Download setAccessToken(String accessToken)
Description copied from class: YouTubeRequest
OAuth access token.

Overrides:
setAccessToken in class YouTubeRequest<Void>








setAlt
public YouTube.Captions.Download setAlt(String alt)
Description copied from class: YouTubeRequest
Data format for response.

Overrides:
setAlt in class YouTubeRequest<Void>








setCallback
public YouTube.Captions.Download setCallback(String callback)
Description copied from class: YouTubeRequest
JSONP

Overrides:
setCallback in class YouTubeRequest<Void>








setFields
public YouTube.Captions.Download setFields(String fields)
Description copied from class: YouTubeRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class YouTubeRequest<Void>








setKey
public YouTube.Captions.Download setKey(String key)
Description copied from class: YouTubeRequest
API key. Your API key identifies your project and provides you with API access, quota, and
 reports. Required unless you provide an OAuth 2.0 token.

Overrides:
setKey in class YouTubeRequest<Void>








setOauthToken
public YouTube.Captions.Download setOauthToken(String oauthToken)
Description copied from class: YouTubeRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class YouTubeRequest<Void>








setPrettyPrint
public YouTube.Captions.Download setPrettyPrint(Boolean prettyPrint)
Description copied from class: YouTubeRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class YouTubeRequest<Void>








setQuotaUser
public YouTube.Captions.Download setQuotaUser(String quotaUser)
Description copied from class: YouTubeRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.

Overrides:
setQuotaUser in class YouTubeRequest<Void>








setUploadType
public YouTube.Captions.Download setUploadType(String uploadType)
Description copied from class: YouTubeRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class YouTubeRequest<Void>








setUploadProtocol
public YouTube.Captions.Download setUploadProtocol(String uploadProtocol)
Description copied from class: YouTubeRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class YouTubeRequest<Void>








getId
public String getId()
The ID of the caption track to download, required for One Platform.







setId
public YouTube.Captions.Download setId(String id)
The ID of the caption track to download, required for One Platform.







getOnBehalfOf
public String getOnBehalfOf()
ID of the Google+ Page for the channel that the request is be on behalf of







setOnBehalfOf
public YouTube.Captions.Download setOnBehalfOf(String onBehalfOf)
ID of the Google+ Page for the channel that the request is be on behalf of







getOnBehalfOfContentOwner
public String getOnBehalfOfContentOwner()
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.







setOnBehalfOfContentOwner
public YouTube.Captions.Download setOnBehalfOfContentOwner(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.







getTfmt
public String getTfmt()
Convert the captions into this format. Supported options are sbv, srt, and vtt.







setTfmt
public YouTube.Captions.Download setTfmt(String tfmt)
Convert the captions into this format. Supported options are sbv, srt, and vtt.







getTlang
public String getTlang()
tlang is the language code; machine translate the captions into this language.







setTlang
public YouTube.Captions.Download setTlang(String tlang)
tlang is the language code; machine translate the captions into this language.







set
public YouTube.Captions.Download set(String parameterName,
                                     Object value)

Overrides:
set in class YouTubeRequest<Void>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.