com.google.api.services.youtube

Class YouTube.Captions.Download

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<java.lang.Void>

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

YouTube.Captions

public class YouTube.Captions.Download
extends YouTubeRequest<java.lang.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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.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	YouTube.Captions.Download(java.lang.String id) Downloads a caption track.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(java.io.OutputStream outputStream)
java.io.InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getId() The id parameter identifies the caption track that is being retrieved.
java.lang.String	getOnBehalfOf() ID of the Google+ Page for the channel that the request is be on behalf of
java.lang.String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
java.lang.String	getTfmt() The tfmt parameter specifies that the caption track should be returned in a specific format.
java.lang.String	getTlang() The tlang parameter specifies that the API response should return a translation of the specified caption track.
YouTube.Captions.Download	set(java.lang.String parameterName, java.lang.Object value)
YouTube.Captions.Download	setAlt(java.lang.String alt) Data format for the response.
YouTube.Captions.Download	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.Captions.Download	setId(java.lang.String id) The id parameter identifies the caption track that is being retrieved.
YouTube.Captions.Download	setKey(java.lang.String key) API key.
YouTube.Captions.Download	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.Captions.Download	setOnBehalfOf(java.lang.String onBehalfOf) ID of the Google+ Page for the channel that the request is be on behalf of
YouTube.Captions.Download	setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Captions.Download	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Captions.Download	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Captions.Download	setTfmt(java.lang.String tfmt) The tfmt parameter specifies that the caption track should be returned in a specific format.
YouTube.Captions.Download	setTlang(java.lang.String tlang) The tlang parameter specifies that the API response should return a translation of the specified caption track.
YouTube.Captions.Download	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YouTube.Captions.Download

protected YouTube.Captions.Download(java.lang.String id)

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. 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 parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(java.io.OutputStream outputStream)
                               throws java.io.IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<java.lang.Void>

Throws:

java.io.IOException

executeMediaAsInputStream

public java.io.InputStream executeMediaAsInputStream()
                                              throws java.io.IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<java.lang.Void>

Throws:

java.io.IOException

executeMedia

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

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<java.lang.Void>

Throws:

java.io.IOException

executeUsingHead

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

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<java.lang.Void>

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<java.lang.Void>

Throws:

java.io.IOException

setAlt

public YouTube.Captions.Download setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<java.lang.Void>

setFields

public YouTube.Captions.Download setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<java.lang.Void>

setKey

public YouTube.Captions.Download setKey(java.lang.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<java.lang.Void>

setOauthToken

public YouTube.Captions.Download setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<java.lang.Void>

setPrettyPrint

public YouTube.Captions.Download setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<java.lang.Void>

setQuotaUser

public YouTube.Captions.Download setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<java.lang.Void>

setUserIp

public YouTube.Captions.Download setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class YouTubeRequest<java.lang.Void>

getId

public java.lang.String getId()

The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

setId

public YouTube.Captions.Download setId(java.lang.String id)

The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

getOnBehalfOf

public java.lang.String getOnBehalfOf()

ID of the Google+ Page for the channel that the request is be on behalf of

setOnBehalfOf

public YouTube.Captions.Download setOnBehalfOf(java.lang.String onBehalfOf)

ID of the Google+ Page for the channel that the request is be on behalf of

getOnBehalfOfContentOwner

public java.lang.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(java.lang.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 java.lang.String getTfmt()

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

setTfmt

public YouTube.Captions.Download setTfmt(java.lang.String tfmt)

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

getTlang

public java.lang.String getTlang()

The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

setTlang

public YouTube.Captions.Download setTlang(java.lang.String tlang)

The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

set

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

Overrides:

set in class YouTubeRequest<java.lang.Void>